| Table of Contents |
|---|
The idea of using control loops to automatically (or autonomously) perform network management has been the subject of much research in the Network Management research community, see this paper for some background. However, it is only with the advent of ONAP that we have a platform that supports control loops for network management. Before ONAP, Control Loops have been deployed by hard-coding components together and hard coding logic into components. ONAP has taken a step forward towards automatic deployment of Control Loops by allowing parameterization of Control Loops that work on the premise that the Control Loops use a set of analytic, policy, and control components connected together in set ways.
The goal of the work is to extend and enhance the current ONAP Control Loop support to provide a complete open-source framework for Control Loops. This will enhance the current support to provide TOSCA based Control Loop definition, development, deployment and run-time management. The participants that comprise a Control Loop and the metadata needed to link the participants together to create a Control Loop are specified in a standardized way using the OASIS TOSCA modelling language. The TOSCA description is then used to deploy and manage the Control Loops in the run time system.
| draw.io Diagram | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
1: Overall Architecture
The diagram below shows an overview of the architecture of TOSCA based Control Loop management.
| draw.io Diagram | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The Design Time Catalogue contains the the metadata primitives for composition of control loops. As shown in the figure above, the Design time component provides a system where Control Loops can be designed and defined in metadata. This means that a Control Loop can have any arbitrary structure and the Control Loop developers can use whatever analytic, policy, or control primitives they like to implement their Control Loop. At deployment time, the user parameterises the Control Loop and deploys it. A design time catalogue is created. This catalogue contains the primitive metadata for any components that can be used to compose a Control Loop. A Control Loop SDK is used to compose a Control Loop by aggregating the metadata for the components chosen to be used in a Control Loop and by constructing the references between the components.
Once the Control Loop is composed, it is deployed to the run time part of the system, where it is stored in the run time catalogue and is available for instantiation.
When a user wishes to instantiate a Control Loop, they set values for the parameters of the Control Loop. Once the parameterization has been carried out, the Control Loop instantiated, with the metadata and whatever other artifacts are required being passed to the participants in the Control Loop. At runtime, the Control Loop can be monitored and analysed. It can also be updated as required and can be deleted when it is on longer needed.
The Control Loop Runtime Management will use ONAP services for non-functional aspects such as inventory, topology and data delivery.
1.1: Class Diagrams
1.1.1 Design Time
| draw.io Diagram | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
1.1.2 Runtime
| draw.io Diagram | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
2: Control Loop Modelling
Joseph O'Leary to pad out this section
node_templates which makes up the loop itself.
Applications can be a DCAE microservice, an operational policy, or any other application as long as it can be modeled, and the targeted ecosystem to has a participant client waiting for the event distributions from CLAMP via DMaaP Message Router.
2.1: Control Loop TOSCA file definition
2.1.1 Control Loop Component Definition
A Control Loop Component that can be part of a control loop, it defines the components that partake in a control loop, and are implemented at run time by participants. The control loop component definition is truly dynamic and, as long as the participant that the control loop component definition relates to understands its definition, it can be anything. However, we have designed a base control loop component attribute that's generic and that can act as a good starting point.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
node_types:
org.onap.CL_Component:
properties:
component_name:
type: string
description: Human readable name for the component.
required: true
provider:
type: string
description: Provider of the component and of the descriptor.
required: true
component_version:
type: string
description: Software version of the component.
required: true
resource_id:
type: string
description: >The ID of the resource,
should be provided if the resource was uploaded to the entity's inventory already.
required: false
resource_content:
type: string
description: the contents of the component resource, to be uploaded during deploy phase of loop.
required: false
monitoring_policy:
type: string
description: A reference to the monitoring policy if applicable.
required: false
version: 0.0.1
derived_from: tosca.nodes.Root |
2.1.2 Loop Definition
The loop definition is implicit in the node_templates within the topology_template, any node contained within is expected to be a part of the control loop managed by CLAMP.
| Warning |
|---|
The below example doesn't explicitly include any order, ordering of deployment is to be considered in the future which likely would lead to changes to this |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
topology_template:
inputs:
pm_docker_image:
type: string
description: docker image used for deploying the PMSH service.
required: true
operational_policy_name:
type: string
description: name of the operational policy to be triggered on MR when subscription is created.
required: true
outbound_topic_name:
type: string
description: Name of topic used for messages to policy.
required: true
feedback_topic_name:
type: string
description: Name of topic used for feedback from policy.
required: true
inventory_notification_topic_name:
type: string
description: Name of topic used for inventory inventory notifications.
required: true
pmsh_resource_id:
type: string
description: ID of the PMSH blueprint in the inventory.
required: true
node_templates:
org.onap.PM_Subscription_Handler:
type: org.onap.CL_Component
properties:
application_name: PMSH
provider: DCAE
application_Version: '1.0.1'
resource_id: { get_input: pmsh_resource_id }
monitoring_policy: 'monitoring_policy_id'
application_config:
tag_version: { get_input: pm_docker_image }
operational_policy_name: { get_input: operational_policy_name }
pmsh_publish_topic_name: { get_input: outbound_topic_name }
policy_feedback_topic_name: { get_input: feedback_topic_name }
aai_notification_topic_name: { get_input: inventory_notification_topic_name }
|
2.1.3 Example
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_3
node_types:
org.onap.CL_Component:
properties:
application_name:
type: string
description: Human readable name for the application.
required: true
provider:
type: string
description: Provider of the application and of the descriptor.
required: true
application_version:
type: string
description: Software version of the application.
required: true
resource_id:
type: string
description: >The ID of the resource,
should be provided if the resource was uploaded to the entity's inventory already.
required: false
resource_content:
type: string
description: the contents of the application resource, to be uploaded during deploy phase of loop.
required: false
monitoring_policy:
type: string
description: A reference to the monitoring policy if applicable.
required: false
version: 0.0.1
derived_from: tosca.nodes.Root
topology_template:
inputs:
pm_docker_image:
type: string
description: docker image used for deploying the PMSH service.
required: true
operational_policy_name:
type: string
description: name of the operational policy to be triggered on MR when subscription is created.
required: true
outbound_topic_name:
type: string
description: Name of topic used for messages to policy.
required: true
feedback_topic_name:
type: string
description: Name of topic used for feedback from policy.
required: true
inventory_notification_topic_name:
type: string
description: Name of topic used for inventory inventory notifications.
required: true
pmsh_resource_id:
type: string
description: ID of the PMSH blueprint in the inventory.
required: true
node_templates:
org.onap.PM_Subscription_Handler:
type: org.onap.Cl_Component
properties:
application_name: PMSH
provider: DCAE
application_Version: '1.0.1'
resource_id: { get_input: pmsh_resource_id }
monitoring_policy: 'monitoring_policy_id'
application_config:
tag_version: { get_input: pm_docker_image }
operational_policy_name: { get_input: operational_policy_name }
pmsh_publish_topic_name: { get_input: outbound_topic_name }
policy_feedback_topic_name: { get_input: feedback_topic_name }
aai_notification_topic_name: { get_input: inventory_notification_topic_name }
|
2.2: Modelling from TOSCA to Deployment Data in Run Time Catalogue
2.3: Modelling from TOSCA to Instance Data Run Time Catalogue
3: APIs and Sequence Diagrams
3.1: Deployment
Ajay Deep Singh to pad out this section
This section defines Deployment/CRUD Operations that can be performed on ControlLoops.
A Client, in this case CLAMP, can perform CRUD operations or can deploy ControlLoops from DesignTime to RunTime Catalogue Database.
DesignTime/RunTime Catalogue Database stores ControlLoop definitions, CRUD operations on database supported by REST Endpoints like Get, Delete, Create allowing selection of a particular ControlLoop to be addressed, below sequence diagram will help you understand flow how a client(Clamp) application can initiate Rest call for performing different operations on Database.
API_Gateway Service is for interacting to different database DesignTime/RunTime and should be responsible for responding success or failure status on different operations.
The deployment of ControlLoops definition from DesignTime to RunTime Catalogue Database can we achived using deploy Rest Endpoint, in this process when a rest request is initiated from a client(Clamp) the API_Gateway Service take cares of fetching ControlLoops metadata from DesignTime and creates in RunTime Catalogue Database, Deploy API ControlLoop Sequence diagram will help you understand the flow.
| Warning |
|---|
In future deploy Rest Endpoint might be updated to push ControlLoops not only in RunTime Database but to the participants involved in ControlLoop. |
3.1.1: Deployment REST API
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
openapi: 3.0.3
info:
description: >-
The ControlLoop Deployment API allows users to search and perform
CRUD action on Controlloop Tosca exported data sets.
version: 1.0.0
title: Control Loop Deployment API
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0'
contact:
email: lego@est.tech
servers:
- url: '{scheme}://onap/controlloop/v2/'
variables:
scheme:
description: 'The Data Set API is accessible via https and http'
enum:
- 'https'
- 'http'
default: 'http'
tags:
- name: Control Loop
description: Deployment API
- name: design-catalogue
description: CRUD actions on an designtime Control Loop data sets.
- name: runtime-catalogue
description: CRUD actions on an runtime Control Loop data sets.
paths:
/design-catalogue/loops:
get:
tags:
- design-catalogue
operationId: getAllLoopsUsingGET
summary: Returns a list of all available Control Loops.
responses:
'200':
description: OK
content:
application/yaml:
schema:
type: array
items:
$ref: '#/components/schemas/ControlLoop'
/design-catalogue/loop/{controlLoopId}:
get:
tags:
- design-catalogue
summary: >-
Returns a specific control loop.
description: >-
This GET API returns a specific control loop.
operationId: getLoopByIdUsingGET
parameters:
- name: controlLoopId
in: path
description: 'Id of the control loop.'
required: true
example: "org.onap.PM_CDS_Blueprint"
schema:
type: string
responses:
'200':
description: OK
content:
application/yaml:
schema:
$ref: '#/components/schemas/ControlLoop'
delete:
tags:
- design-catalogue
summary: Delete a specific Control Loop by ID.
operationId: deleteLoopByIdUsingDELETE
parameters:
- name: controlLoopId
in: path
description: Identity for the control loop
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
'404':
description: Control Loop not present
post:
tags:
- design-catalogue
summary: >-
Accepts a Tosca Service Template representing a Control Loop.
description: >-
This API Create a Control Loop.
operationId: createLoopWithIDUsingPOST
parameters:
- name: controlLoopId
in: path
description: Identity for the control loop
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
'409':
description: Control Loop already exist.
put:
tags:
- design-catalogue
summary: Updates a Control Loop.
operationId: updateLoopWithIDUsingPUT
parameters:
- name: controlLoopId
in: path
description: Identity for the control loop
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
'404':
description: Control Loop not found
/runtime-catalogue/deploy:
post:
tags:
- runtime-catalogue
summary: >-
Deploys Tosca Service Template in RunTime Catalogue.
description: >-
This API Deploys Tosca Service Template in RunTime Catalogue DB.
operationId: deployLoopWithPOST
responses:
'200':
description: OK
'404':
description: No matching record found for the given criteria.
/runtime-catalogue/loop/{controlLoopId}:
get:
tags:
- runtime-catalogue
summary: >-
Returns a specific control loop.
description: >-
This GET API returns a specific control loop.
operationId: getLoopByIdUsing
parameters:
- name: controlLoopId
in: path
description: 'Id of the control loop.'
required: true
example: "org.onap.PM_CDS_Blueprint"
schema:
type: string
responses:
'200':
description: OK
content:
application/yaml:
schema:
type: array
items:
$ref: '#/components/schemas/ControlLoop'
delete:
tags:
- runtime-catalogue
summary: Delete a specific Control Loop by ID.
operationId: deleteLoopByIdUsing
parameters:
- name: controlLoopId
in: path
description: Identity for the control loop
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
'404':
description: Control Loop not present
post:
tags:
- runtime-catalogue
summary: >-
Accepts a Tosca Service Template representing a Control Loop.
description: >-
This API Create a Control Loop.
operationId: createLoopWithIDUsing
parameters:
- name: controlLoopId
in: path
description: Identity for the control loop
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
'409':
description: Control Loop already exist.
put:
tags:
- runtime-catalogue
summary: Updates a Control Loop.
operationId: updateLoopWithIDUsing
parameters:
- name: controlLoopId
in: path
description: Identity for the control loop
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
'404':
description: Control Loop not found
components:
schemas:
ControlLoop:
title: ControlLoop
type: object
properties:
id:
type: string
ControlLoop:
type: string
|
3.1.2: Deployment Sequence Diagrams
GET, DELETE, CREATE API ControlLoop Sequence Diagram
PlantUML Macro title GET, DELETE, CREATE API Sequence Diag @startuml actor CLAMP participant API_Gateway database Database note over Database: It can be DesiginTime Or RuntTime Catalogue Database CLAMP -> API_Gateway: Rest API Request (JSON/Yaml) API_Gateway -> Database: Get, Delete Or Create ControlLoops activate API_Gateway note over API_Gateway,Database: Pull, Delete existing Or Create New ControlLoops in Database alt successful case Database -> API_Gateway : Return List of ControlLoops Or able to Delete, Create ControlLoop in Database API_Gateway -> CLAMP: Return Success else failure case API_Gateway <- Database: Return either Empty List for Get ControlLoops Or Failure Status for Delete, Create Request deactivate API_Gateway note over Database: No ControlLoops exist Or Failed in Deleting, Creating ControlLoops API_Gateway -> CLAMP : Return Failure end @endumlDeploy API ControlLoop Sequence Diagram
PlantUML Macro title Deploy API ControlLoop Sequence Diag @startuml actor CLAMP participant API_Gateway database DesignTime_Catalogue_Database database RunTime_Catalogue_Database participant Dmaap collections Participants CLAMP -> API_Gateway: Rest Deploy API Request (JSON/Yaml) API_Gateway -> DesignTime_Catalogue_Database: Fetch ControlLoop from DesignTime Catalogue Database activate API_Gateway note over API_Gateway,DesignTime_Catalogue_Database: Fetch existing ControlLoops from DesignTime Catalogue Database alt successful case DesignTime_Catalogue_Database -> API_Gateway : Return List of existing ControlLoops from DesignTime Catalogue Database note over DesignTime_Catalogue_Database, RunTime_Catalogue_Database: Populate RunTime Catalogue with ControlLoops existing in DesignTime Catalogue Database API_Gateway -> RunTime_Catalogue_Database: Push ControlLoop to RunTime Catalogue Database note over Dmaap: Putting ControlLoop Metadata for individual Participant API_Gateway -> Dmaap: Push ControlLoop to individual Participants(App) over Dmaap note over Dmaap,Participants: Asynchronous communication Dmaap -> Participants API_Gateway -> CLAMP: Return Success else failure case API_Gateway <- DesignTime_Catalogue_Database: Return Empty ControlLoop List, No ControlLoop exist in DesignTime Catalogue deactivate API_Gateway note over API_Gateway, DesignTime_Catalogue_Database: DesignTime Catalogue Database is Empty, cannot deploy ControLoop in RunTime Catalogue Database API_Gateway -> CLAMP : Return Failure end @enduml
3.2: Instantiation
Robertas Rimkus to pad out this section
This section refers to Instantiation of a Deployed control loop. A client, in this case CLAMP (potentially DCAEMOD, etc in the future) will render the deployed control loops allowing selection of a particular control loop to be instantiated. User will then provide the configurations needed to instantiate the selected control loop which will be sent onto the CL_Instance_Control Service. The service will then distribute the configurations to DMaaP topic. Participants (agents) will pull the event containing the config and pick out their control loop components to be instantiated and start/set up those particular components. CL_Instance_Control Service will be waiting for a response back from all participants involved in the instantiation of the control loop, in regards to the state of instantiation. In successful response case the service will store the CL Instance LCM data into the runtime DB as well as providing a message back to the client of the successful instantiation. In failure to receive the response case, a timeout will be called, which will result in a teardown event being sent to DMaaP. The participants will then receive the event and proceed to teardown the components that were instantiated or check that they have failed to instantiate in the first place and send a Teardown ACK back to the CL_Instance_Control Service. No CL Instance LCM data will be stored and a message indicating failure to instantiate the CL along side with the error will be sent back to the client (CLAMP).
3.2.1: Instantiation REST API
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
openapi: 3.0.3
info:
title: Swagger Control Loop Instantiation
description: ""
version: 1.0.0
servers:
- url: '{scheme}://onap/controlloop/v2/'
variables:
scheme:
description: 'The Data Set API is accessible via https and http'
enum:
- 'https'
- 'http'
default: 'http'
tags:
- name: instantiate
description: Control Loop Instantiation
paths:
/runtime-catalogue/instantiate:
post:
tags:
- instantiate
summary: Instantiate a deployed control loop
operationId: instantiateLoop
requestBody:
description: Control loop that is to be instantiated
content:
application/json:
schema:
$ref: '#/components/schemas/ControlLoop'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiResponse'
404:
description: No Control Loop found
405:
description: Invalid input
/runtime-catalogue/loops/instantiated:
get:
tags:
- instantiate
summary: Get a list of instantiated control loops
responses:
200:
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ControlLoop'
404:
description: No instantiated control loops found
/runtime-catalogue/loops/instantiated/{loop-id}:
get:
tags:
- instantiate
summary: Get an instantiated control loop by id
parameters:
- name: loop-id
in: path
description: ID of instantiated loop to return
required: true
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ControlLoop'
404:
description: Control Loop not found
put:
tags:
- instantiate
summary: Update an instantiated control loop
parameters:
- name: loop-id
in: path
description: ID of instantiated loop
required: true
schema:
type: string
requestBody:
description: Control loop to be updated
content:
application/json:
schema:
$ref: '#/components/schemas/ControlLoop'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ControlLoop'
404:
description: Control Loop not found
delete:
tags:
- instantiate
summary: Delete an instantiated control loop
parameters:
- name: loop-id
in: path
description: ID of instantiated loop
required: true
schema:
type: string
responses:
200:
description: OK
404:
description: Control Loop not found
components:
schemas:
ControlLoop:
title: ControlLoop
type: object
properties:
id:
type: string
controlLoopTosca:
type: string
ApiResponse:
type: object
properties:
code:
type: integer
format: int32
status:
type: string |
3.2.2: Instantiation Sequence Diagrams
| PlantUML Macro | ||
|---|---|---|
| ||
@startuml actor CLAMP participant Deployment_API database Runtime_DB control CL_Instance_Control participant DmaaP collections Participants CLAMP -> Deployment_API : Fetch all Deployed Control Loops Deployment_API -> Runtime_DB : Rest call to get the Deployed Control Loops Runtime_DB -> Deployment_API : Return all Deployed Loops which reside in the database Deployment_API -> CLAMP : Provide the data CLAMP -> CLAMP : Select Control Loop to be instantiated and provide configurations for it CLAMP -> CL_Instance_Control : Instantiate CL POST REST API call alt case where CLAMP sends deployed CL id instead of the full CL in the body CL_Instance_Control -> Runtime_DB : Fetch the Deployed Control Loop from Models table Runtime_DB -> CL_Instance_Control : Return the requested Deployed Control Loop data end CL_Instance_Control -> DmaaP : INSTANTIATE Event (JSON/Yaml) note over CL_Instance_Control, DmaaP : List of Participant ID's containing Participant Metadata Blocks Participants -> DmaaP : Pulls its part of CL and tries to Instantiate alt failure case note over CL_Instance_Control : TIMEOUT, Instantiation ACK not received by monitoring service \nSupervision_Service requests a teardown CL_Instance_Control -> DmaaP : TEARDOWN Event (JSON/Yaml) Participants -> DmaaP : Pulls its part of CL and starts Teardown end @enduml |
3.2.3: Instantiation DMaaP API
Initial Thought for an event to be sent from CL_Instance_Control onto DMaaP for Participants to consume. The event would go onto an output topic which the Participants would be polling/subscribed to
e.g url : https://{{ONAPIP}}:{{DMaaPPort}}/events/CL_INSTANCE_CONTROL_OUTPUT
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"instance-id":"myCLInstance1",
"action":"INSTANTIATE",
"configurations":[
{
"participant-id":"Participant_DCAE",
"applications":[
{
"application-id":"example.pmsh",
"config":{
}
},
{
"application-id":"example.dfc",
"config":{
}
}
]
},
{
"participant-id":"Participant_Policy",
"applications":[
{
"application-id":"example.OperationalPolicy",
"config":{
}
}
]
}
]
} |
*Preferred solution is to send TOSCA in the body. Meaning we could reuse the parsing code which is already present and provide it to the participant.
3.2.4: Instantiation Participant API
*Suggestion was to put JAVA API code in this section for the participant talking to DMaaP. TBD
3.3: Monitoring
In this case it refers to monitoring the data that the participants will provide to DMaaP. Participants will send events to DMaaP which will be pulled by the CL_Monitoring_Service. The data provided should include a reference id to the control loops that are instantiated on the participant, as well as the applications that have been instantiated as a part of that control loop for that participant. Data should also include the time that the application has started, state of it (running/terminated) and any other critical information which would help to determine the health of an instantiated control loop and its components. Idea is for the participant to provide events every certain period of time, similar to a health-check, in order to provide consistent monitoring.
3.3.1: Monitoring REST API
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
openapi: 3.0.3
info:
title: Swagger Control Loop Monitoring
description: ""
version: 1.0.0
servers:
- url: '{scheme}://onap/controlloop/v2/'
variables:
scheme:
description: 'The Data Set API is accessible via https and http'
enum:
- 'https'
- 'http'
default: 'http'
tags:
- name: monitoring
description: Control Loop Monitoring
paths:
/runtime-catalogue/monitoring:
post:
tags:
- monitoring
summary: Input monitoring data into the database
requestBody:
description: Monitoring data to be input
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringData'
required: true
responses:
200:
description: OK
405:
description: Invalid input
get:
tags:
- monitoring
summary: Get monitoring data for all participants
responses:
200:
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonitoringData'
404:
description: No monitoring data found
/runtime-catalogue/monitoring/{participant-id}:
get:
tags:
- monitoring
summary: Get monitoring data for a participant by participant id
parameters:
- name: participant-id
in: path
description: ID of a participant
required: true
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringData'
404:
description: Monitoring data for the participant not found
put:
tags:
- monitoring
summary: Update monitoring data for a participant by participant id
parameters:
- name: participant-id
in: path
description: ID of a participant
required: true
schema:
type: string
requestBody:
description: Monitoring data to be updated
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringData'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringData'
404:
description: Monitoring data for the participant not found
delete:
tags:
- monitoring
summary: Delete monitoring data for a participant by participant id
parameters:
- name: participant-id
in: path
description: ID of a participant
required: true
schema:
type: string
responses:
200:
description: OK
404:
description: Monitoring data for the participant not found
components:
schemas:
MonitoringData:
properties:
participant-id:
type: string
control-loops:
type: array
items:
properties:
cl-instance-id:
type: string
applications:
type: array
items:
properties:
application-id:
type: string
status:
type: string
enum:
- INSTANTIATION_STARTED
- INSTANTIATED_RUNNING
- INSTANTIATED_FAILED
other-data:
type: string |
3.3.2: Monitoring Sequence Diagrams
| PlantUML Macro | ||
|---|---|---|
| ||
@startuml control CL_Instance_Control database Runtime_DB participant Monitoring_Service participant DMaaP collections Participants CL_Instance_Control -> DMaaP : INSTANTIATE Event (JSON/Yaml) Participants -> DMaaP : Pulls its part of CL and starts instantiation of components Participants -> DMaaP : Starts sending monitoring events once instantiation of components begins note over DMaaP : Events are sent at set intervals Monitoring_Service -> DMaaP : Consistently pulls events off the monitoring topic Monitoring_Service -> Runtime_DB : Puts and updates the monitoring data on the DB @enduml |
3.3.3: Monitoring DMaaP API
Participants will send an event containing monitoring data to a DMaaP topic at a set interval after participant has received an event to instantiate a control loop
e.g url: https://{{ONAPIP}}:{{DMaaPPort}}/events/CL_MONITORING_SERVICE_INPUT
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"timestamp":"1605689254",
"participant-id":"Participant_DCAE",
"control-loops":[
{
"instance-id":"myCLInstance1",
"applications":[
{
"application-id":"example.pmsh",
"status":"INSTANTIATION_STARTED"
},
{
"application-id":"example.dfc",
"status":"INSTANTIATION_STARTED"
}
]
},
{
"instance-id":"myCLInstance2",
"applications":[
{
"application-id":"example.pmsh",
"status":"INSTANTIATED"
}
]
}
]
} |
3.3.4: Monitoring Participant API
Presume similar thinking to Instantiation Participant API
*Suggestion was to put JAVA API code in this section for the participant talking to DMaaP. TBD
3.4: Supervision
Supervision is responsible for ensuring that
- control loops are established once their initiation has been ordered
- control loops are running correctly once their initiation is completed
- control loops are correctly removed once their removal has been ordered
3.4.1: Supervision Sequence Diagrams
| PlantUML Macro | ||
|---|---|---|
| ||
@startuml actor Client participant Deployment_API control CL_Instance_Control database Runtime_DB participant Supervision_Service participant Monitoring_Service participant DMaaP collections Participants ==Instantation== Client -> Deployment_API : Fetch all Deployed Control Loops Deployment_API -> Runtime_DB : Rest call to get Deployed Control Loops Runtime_DB -> Deployment_API : Return Deployed Control Loops Deployment_API -> Client : Provide the data Client -> Client : Select CL for instantiation and provide config Client -> CL_Instance_Control : Instantiate CL POST REST API call alt case where Client sends deployed CL id instead of the full CL in the body CL_Instance_Control -> Runtime_DB : Fetch the Deployed Control Loop from Models table Runtime_DB -> CL_Instance_Control : Return the requested Deployed Control Loop data end CL_Instance_Control -> DMaaP : INSTANTIATE Event (JSON/Yaml) note over CL_Instance_Control, DMaaP : List of Participant ID's containing Participant Metadata Blocks Participants -> DMaaP : Pulls its part of CL and tries to Instantiate ==Monitoring== Participants -> DMaaP : Starts sending monitoring events \nOnce instantiation of components begins note over DMaaP : Events are sent at set intervals, one per participant Monitoring_Service -> DMaaP : Consistently pulls events off the monitoring topic Monitoring_Service -> Runtime_DB : Puts and updates the monitoring data on the DB ==Supervision== Supervision_Service -> Runtime_DB : Periodic check on monitoring data alt CL successfully instantiated Supervision_Service -> Client : Return Instantiation Successful else CL failed to instantiate ... TIMEOUT CL state not changed to INSTANTIATED ... Supervision_Service -> CL_Instance_Control : Timeout, error occured CL_Instance_Control -> DMaaP : TEARDOWN Event (JSON/Yaml) Participants -> DMaaP : Pulls its part of CL and starts Teardown note over Monitoring_Service : Monitoring Service receives events and updates state note over Supervision_Service : Supervision Service finds that status has changed Supervision_Service -> Client : Return Instantiation Failed (http code and an error message) end @enduml |
3.4.2: Supervision APIs to other components
4: Design
4.1: Server Side
4.1.1 Database Schema and JPA
4.1.2: TOSCA Processing
4.1.3: Instance Control
4.1.4: Execution Monitoring
4.2: Participant Side
4.2.1: Participant Agent
4.2.2: Policy Participant Agent
4.2.3: CDS Participant Agent
4.2.4: DCAE Participant Agent
4.2.5: SO Participant Agent
4.3: Client Side
4.3.1: Client SDK: Composition of Control Loop Tosca
4.3.2: Client User Interface
4.4 Other Considerations
4.4.1 Upgrade
Performing a hot upgrade of the Control Loop at run time as well as handling an upgrade of the software in one or more of the participants in an Control Loop is a particularly challenging issue because upgrading must handle the following cases without tearing down the Control Loop:
- Upgrade and changes of the configuration data of participants
- Addition of or removal of participants in an Control Loop
- Upgrade of software in one or more participants in an Control Loop
- Maintenance of compatibility between participants when an update of more than one participant must be done together to ensure compatibility, for example, when a protocol being used by two participants to communicate is upgraded
5: Goals
5.1:
- Design of Management Apps
- Specifying the source data
- Specifying the analytics, machine learning, and AI algorithms they want to use in their App
- Specifying the policies that govern the App
- Specifying the format, parameters, and mechanisms required to allow the App to autonomically adjust the network
- Preparing and specifying use cases to demonstrate the applicability of Management Apps
- Life cycle management of Management Apps
- Deployment of Apps
- Bringing the App itself and all its constituent components to life
- Stitching the data links between the components in the App together
- Initiating generation of the data that triggers the App to execute
- Updating of Management Apps
- Allowing the parameters, algorithms, policy, of controller configuration data to be modified on executing Apps
- Deletion of Apps
- Life cycle management is demonstrated using the use cases specified in the design phase
- Deployment of Apps
- Monitoring and analysis of Management Apps
- Specification of metrics for monitoring and analysis
- Allowing general App data and data specific to particular Apps to be collected at run time
- Storing of the monitored data
- Running general App algorithms or algorithms for specific components of Apps on the monitored data to ensure that the Apps are running correctly and optimally
- Feedback of App performance results to users
- Allowing the autonomic Apps themselves to have autonomic self-healing.
- Monitoring and analysis is demonstrated using the use cases developed in the project
5.2: MVP
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
- Design Time
- Support design of multiple control loops*
- Support design of individual control loop component**
- Support composition of control loops**
- Runtime
- Participant registration and participant deregistration
- Support deployments of control loops
- Ingestion with artifact references*
- Ingestion with artifact embedded**
- Support instantiation of control loop
- Support instantiation of control loop TOSCA to DMaaP MR*
- Support instantiation of config for the control loop*
- Support monitoring of control loops
- Receive control loop heartbeat events (heartbeat starts when component of control loop is running)*
- Support supervision of control loops
- Periodically check monitored data, and update state of control loop*
- Participants
- Agent library*
- Reference(test) participant*
- CDS participant*
- DCAE participant*
- Policy participant*
- Demo**
- Throwaway Monitoring/Control GUI