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 could provide an interface to manage a certain topology via the ui page, such as submit a topology
Schema
Application Definition
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 or CLASS |
| description | String | description on this topology |
| version | String | topology version |
Topology Execution Service
- Service name: TopologyExecutionService
- Entity: TopologyExecutionEntityService name: ApplicationManagementService
- Table name: eagle_metadata
- Prefix: application_managementtopologyExecution
- 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 name |
| application | String | |
| topology | String | application/topology name |
fields | mainClassfullName | String | application main classtopology execution name: eagle_${site}_${application}_${topology} |
| jarFileurl | Stringjar file path | topology tracking url |
| environmentdescription | String | cluster nametopology running status description |
| status | String | {SUCCESS, FAILURE} |
...
application running status {NEW, STARTING, STOPPING, 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: ClusterDefinitionServiceTopologyOperationService
- Entity: TopologyOperationEntity
- Table name: eagleeagle_metadata
- Prefix: application_clustertopologyOperation
| Attribute | Type | Description |
---|
tags | nameoperation | Stringcluster name | {START, STOP, STATUS} |
| typesite | String | e.g., storm, spark |
| configapplication | String | cluster config |
Use cases
...
- create a topology definition entity
...
- click START button
- check the topology's current status on the nimbus host
- a new thread is created to execute the submitting topology task
- update status
|
| operationID | String | |
| topology | String | topology name: ${topology} |
fields | status | String | {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 |
...