Status
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 configuration can be edited on UI
- Use REST Service as only entry to manage application (START/STOP) 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 should could provide an interface to manage a certain topology via the ui page, such as START, STOP, or STATUS
Design
submit a topology
| Gliffy Diagram |
|---|
| |
|---|
| name | ApplicationTopologyArch |
|---|
|
Schema
Topology Description Service
...
- Service name: AppManagementServiceTopologyDescriptionService
- Entity: TopologyDescriptionEntity
- Table name: application_definitioneagle_metadata
- Prefix: topologyDescription
| | Attribute | Type | Description | tags
|---|
| tage | appNametopology | String | application/topology name |
| fields | mainClassexeClass | String | application main topology entry class |
| | jarFile | String | jar file path |
| | configFile | String | application configuration file path |
| type | String | topology type: DSL or CLASS |
| | 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 | |
| fields | fullName | String | topology execution name: eagle_${site}_${application}_${topology} |
| | url | String | topology tracking url |
| | description | String | topology running status description | | deployEnvironment | String | deploy cluster name initialized |
| | status | String | application running status : INITIALIZED{NEW, STARTING, RUNINGSTOPPING, FAILED, STOPPED |
Cluster Definition
| STARTED, STOPPED} |
| | mode | String | topology running mode: cluster or local |
| | environment | String | topology execution environment, e.g., storm |
| | lastModifiedDate | long | last status update time |
Topology Operation Service
- Service name: TopologyOperationService
- Entity: TopologyOperationEntityService name: ClusterDefinitionService
- Table name: cluster_definitioneagle_metadata
- Prefix: topologyOperation
| | Attribute | Type | Description |
|---|
| tagsname | operation | String | {START, STOP, STATUS} |
| | site | String | |
| | application | String | |
| | operationID | String | |
| | topology | String | cluster topology name: ${topology} |
| fields | typestatus | String | e.g., storm, spark | | config | json | cluster config{INITIALIZED, PENDING, FAILED, SUCCESS} |
| | message | String | exception message |
| | lastModifiedDate | long | last status update time |
Customized Restful Apis
| HTTP Method | URL | Payload | Description |
|---|
| POST | /app/operation | TopologyOperationEntity | create an topology operation |
| DELETE | /app/topology/{topology} | | delete a topology description |
