Status
IMPROVING
Principle
- Minimize user operations for managing and monitoring topologies
- REST Service centralized metadata management
- Consistent UI experience
Objective
- Make sure consistent semantics between the term application (user space) and topology (physical space only)
- Topology should read configuration from TopologyDescService#config instead of configuration file
- Use REST Service as only entry to manage application (START/STOP/HEALTH CHECKING) and ApplicationManager to schedule the task execution and update the execution information
- Eagle UI should support to manage/monitor the application on site/application page
- Single site/application may have more than one topologies (for example hdfsAuditLogMonitoring and userProfileMonitoring should have topologies running separately)
Architecture
To have a better user experience with EAGLE ui, we could provide an interface to manage a certain topology via the ui page, such as submit a topology
Schema
Topology Description Service
- Service name: TopologyDescriptionService
- Entity: TopologyDescriptionEntity
- Table name: eagle_metadata
- Prefix: topologyDescription
Attribute | Type | Description | |
---|---|---|---|
tage | topology | String | topology name |
fields | exeClass | String | topology entry class |
type | String | topology type: DSL topology or main-class topology | |
description | String | description on this topology | |
version | String | topology version |
Topology Execution Service
- Service name: TopologyExecutionService
- Entity: TopologyExecutionEntity
- Table name: eagle_metadata
- Prefix: topologyExecution
- Description: define the relation between an application and an topology, and maintain the execution status as well
Attribute | Type | Description | |
---|---|---|---|
tags | site | String | topology site |
application | String | ||
topology | String | topology execution name: eagle_${site}_${application}_${topology} | |
fields | url | String | topology tracking url |
deploy | String | deploy environment description | |
status | String | application running status {STARTED, STOPPED} | |
lastUpdateTime | long | last status update time |
Topology Operation Service
- Service name: TopologyOperationService
- Entity: TopologyOperationEntity
- Table name: eagle_metadata
- Prefix: topologyOperation
Attribute | Type | Description | |
---|---|---|---|
tags | operation | String | {START, STOP, STATUS} |
site | String | ||
application | String | ||
uuid | String | ||
fields | topology | String | topology name: ${topology} |
status | String | {INITIALIZED, PENDING, FAILED, SUCCESS} | |
lastUpdateTime | long | last status update time |
Use Cases in BPMN diagram
1. user define a topology entity
2. user add multiply topologies to an application
3. user start/stop a topology
4. Edit topology configuration
5. Periodically check/update topology healthy status
6. Edit deployment cluster?