Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Status

Status
titleIMPROVING

Principle

  • Minimize user operations for managing and monitoring topologies
  • REST Service centralized metadata management
  • Consistent UI experience

Objective

  1. Make sure consistent semantics between the term application (user space) and topology (physical space only)
  2. Topology configuration can be edited on UI
  3. Use REST Service as only entry to manage application (START/STOP) and ApplicationManager to schedule the task execution and update the execution information 
  4. Eagle UI should support to manage/monitor the application on site/application page
  5. 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

Gliffy Diagram
nameApplicationTopologyArch

Gliffy Diagram
nametopologyManagerArch

Schema

Topology Description Service

  • Service name: TopologyDescriptionService
  • Entity: TopologyDescriptionEntity
  • Table name: eagle_metadata
  • Prefix: topologyDescription
 AttributeTypeDescription
tagetopologyStringtopology name
fieldsexeClassStringtopology entry class
 typeStringtopology type: DSL or CLASS
 descriptionStringdescription on this topology
 versionStringtopology version

Topology Execution Service 

...

  • Service name: AppManagementServiceTopologyExecutionService
  • Entity: TopologyExecutionEntity
  • Table name: application_definitioneagle_metadata
  • Prefix: topologyExecution
  • Description: define the relation between an application and an topology, and maintain the execution status as well
appNameconfigFile
 AttributeTypeDescription
tagssiteStringtopology site name
 applicationString 
 topologyString application/topology name
fieldsmainClassfullNameStringtopology execution name: eagle_${site}_${application}_${topology}
 urlStringtopology tracking urlapplication main class
 jarFiledescriptionStringjar file pathtopology running status description
 statusStringapplication configuration file pathrunning status {NEW, STARTING, STOPPING, STARTED, STOPPED}
 deployEnvironmentmodeStringcluster nametopology running mode: cluster or local
 statusenvironmentString{SUCCESS, FAILURE}

...

topology execution environment, e.g., storm
 lastModifiedDatelonglast status update time

Topology Operation Service

  • Service name: ClusterDefinitionServiceTopologyOperationService
  • Entity: TopologyOperationEntity
  • Table name: cluster_definitioneagle_metadata
  • Prefix: topologyOperation
typee.g., storm, sparkconfigcluster config
 AttributeTypeDescription
tagsnameoperationStringcluster name{START, STOP, STATUS}
 siteString 
 applicationString 

...

 
  1. NEW
    1. create a topology definition entity
  2. START
    1. click START button
    2. check the topology's current status on the nimbus host
    3. a new thread is created to execute the submitting topology task
    4. update status
  3. STOP
    1. click STOP button
    2. check the topology's current status on nimbus host
    3. a new thread is created to stop the topology
    4. update status
operationIDString 
 topologyStringtopology name: ${topology}
fieldsstatusString{INITIALIZED, PENDING, FAILED, SUCCESS}
 messageStringexception message
 lastModifiedDatelonglast status update time

Customized Restful Apis

HTTP MethodURLPayloadDescription
POST/app/operationTopologyOperationEntitycreate an topology operation
DELETE/app/topology/{topology} delete a topology description

...