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 should read configuration from SiteApplicationEntity#config instead of configuration fileconfiguration can be edited on UI
- 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)
...
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
| Gliffy Diagram |
|---|
| |
|---|
| name | ApplicationTopologyArch |
|---|
|
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: topologyExecution
- Description: application_managementdefine 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 | |
| fields | fullName | String | topology execution name: eagle_ application physical topology = ${site}_${application}_${topology} | fields
| | mainClassurl | Stringapplication main class | topology tracking url |
| | jarFiledescription | String | jar file pathtopology running status description |
| | environmentstatus | Stringenvironment name | application running status {NEW, STARTING, STOPPING, STARTED, STOPPED} |
| | urlmode | Stringapplication tracking url | topology running mode: cluster or local |
| | statusenvironment | String{ | SUCCESS, FAILURE}topology execution environment, e.g., storm |
| | descriptionlastModifiedDate | String | application description |
...
| long | last status update time |
Topology Operation Service
- Service name: TopologyOperationService
- Entity: ApplicationEnvironmentServiceTopologyOperationEntity
- Table name: eagleeagle_metadata
- Prefix: application_environmenttopologyOperation
| | Attribute | Type | Description |
|---|
| tagsname | operation | String | {START, STOP, STATUS} |
| | site | String | |
| | application | String | |
| | operationID | String | |
| | topology | String | environment topology name: ${topology} |
| fields | typestatus | String | e.g., storm, spark{INITIALIZED, PENDING, FAILED, SUCCESS} |
| | configmessage | 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
| 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 |
...
