The CLAMP Control Loop Automation Composition Participant protocol is an asynchronous protocol that is used by the CLAMP runtime to coordinate life cycle lifecycle management of Control Loop Automation Composition instances. The protocol supports the functions described in the sections below.
| Table of Contents |
|---|
Protocol Dialogues
The protocol supports the dialogues described below.
Participant Registration and De-Registration
Registration when a participant comes up and update of participant with control loop Automation Composition type information and common parameter values for its control loop Automation Composition types.
De-registration is executed as a participant goes down.
...
Automation Composition Priming and De-Priming
When a control loop an Automation Composition is primed, the portion of the Control Loop Automation Composition Type Definition and Common Property values for the participants of each participant type mentioned in the Control Loop Automation Composition Definition are sent to the participants.
When a control loop an Automation Composition is de-primed, the portion of the Control Loop Automation Composition Type Definition and Common Property values for the participants of each participant type mentioned in the Control Loop Automation Composition Definition are deleted on participants.
...
Automation Composition Update
Control Loop Automation Composition Update handles creation, change, and deletion of control loops Automation Compositions on participants. Change of control loops Automation Compositions uses a semantic versioning approach and follow follows the semantics described on the page TOSCA Defined Control LoopsAutomation Compositions: Architecture and Design#4.1ControlLoopVersionManagement1ACMVersionManagement.
The handling of a ControlLoopUpdate an ACMUpdate message in each participant is as shown below.
...
Automation Composition State Change
This dialogue is used to change the state of Control Loops Automation Compositions and their Control Loop Automation Composition Elements. the CLAMP Runtime sends a Control Loop an Automation Composition State Change message on the control loop Automation Composition to all participants. Participants that have Control Loop Automation Composition Elements in that Control Loop Automation Composition attempt an update on the state of the control loop Automation Composition elements they have for that control loopAutomation Composition, and report the result back.
The startPhase in the Definition of TOSCA fundamental Control Loop Automation Composition Types is particularly important in control loop Automation Composition state changes because sometime sometimes the user wishes to control the order in which the state changes in Control Loop Automation Composition Elements in a control loopan Automation Composition. In-state changes from UNITITIALISED → PASSIVE and from PASSIVE → RUNNING, control loop Automation Composition elements are started in increasing order of their startPhase. In-state changes from RUNNING → PASSIVE and from PASSIVE → UNITITIALISED, control loop Automation Composition elements are started in decreasing order of their startPhase.
The CLAMP runtime controls the state change process described in the diagram below. The CLAMP runtime sends an Automation Composition State Change message on DMaaP to all participants in a particular Start Phase so, in each state change multiple Automation Composition State Change messages are sent, one for each Start Phase in the Automation Composition. If more than one Automation Composition Element has the same Start Phase, those Automation Composition Elements receive the same Automation Composition State Change message from DMaaP and start in parallel.
The Participant reads each State Change Message it sees on DMaaP. If the Start Phase on the Automation Composition State Change message matches the Start Phase of the Automation Composition Element, the participant processes the State Change message. Otherwise, the participant ignores the message.
The handling of a ControlLoopStateChange an ACMStateChange message in each participant is as shown below.
...
Automation Composition Monitoring and Reporting
This dialogue is used as a heartbeat mechanism for participants, to monitor the status of Control Loop Automation Composition Elements, and to gather statistics on control loopsAutomation Compositions. The ParticipantStatus message is sent periodically by each participant. The reporting interval for sending the message is configurable.
Messages
The CLAMP Control Loop Automation Composition Participant Protocol uses the following messages. The descriptions below give an overview of each message. For the precise definition of the messages, see the CLAMP code at: https://github.com/onap/policy-clamp/tree/master/models/src/main/java/org/onap/policy/clamp/controlloopACM/models/messages/dmaap/participant. All messages are carried on DMaaP.
| Message | Source | Target | Purpose | Important Fields | Field Descriptions | |
|---|---|---|---|---|---|---|
| ParticipantRegister | Participant | CLAMP Runtime | Participant registers with the CLAMP runtime | ParticipantId | The ID of this participant | |
| ParticipantType | The type of the participant, ; maps to the capabilities of the participant in Control Loop Automation Composition Type Definitions | |||||
| ParticipantRegisterAck | CLAMP Runtime | Participant | Acknowledgement Acknowledgment of Participant Registration | ParticipantId | The ID of this participant | |
| ParticipantType | The type of the participant, ; maps to the capabilities of the participant in Control Loop Automation Composition Type Definitions | |||||
| Result | Success/Fail | |||||
| Message | Message A message indicating the reason for failure | |||||
| ParticipantUpdate | CLAMP Runtime | Participant | CLAMP Runtime sends Control Loop Automation Composition Element Definitions and Common Parameter Values to Participants | ParticipantDefinitionUpdateMap | Map with Participant ID as its key, each value on the map is a ControlLoopElementDefintionMapan ACMElementDefintionMap | |
| ControlLoopElementDefintionMapACMElementDefintionMap | List of ControlLoopElementDefinition ACMElementDefinition values for a particular participant, keyed by its Control Loop Automation Composition Element Definition ID | |||||
| ControlLoopElementDefinitionACMElementDefinition | A ControlLoopElementToscaServiceTemplate An ACMElementToscaServiceTemplate containing the definition of the Control Loop Automation Composition Element and a CommonPropertiesMap with the values of the common property values for Control Loop Automation Composition Elements of this type | |||||
| ControlLoopElementToscaServiceTemplateACMElementToscaServiceTemplate | The definition of the Control Loop Automation Composition Element in TOSCA | |||||
| CommonPropertiesMap | A <String, String> map indexed by the property name. Each map entry is the serialized value of the property, which can be deserialized into an instance of the type of the property. | |||||
| ParticipantUpdateAck | Participant | CLAMP Runtime | Acknowledgement Acknowledgment of Participant Update | ParticipantId | The ID of this participant | |
| ParticipantType | The type of the participant, ; maps to the capabilities of the participant in Control Loop Automation Composition Type Definitions | |||||
| Result | Success/Fail | |||||
| Message | Message A message indicating the reason for failure | |||||
| ParticipantDeregister | Participant | CLAMP Runtime | Participant deregisters with the CLAMP runtime | ParticipantId | The ID of this participant | |
| ParticipantType | The type of the participant, ; maps to the capabilities of the participant in Control Loop Automation Composition Type Definitions | |||||
| ParticipantDeregisterAck | CLAMP Runtime | Participant | Acknowledgement Acknowledgment of Participant DeegistrationDeregistration | ParticipantId | The ID of this participant | |
| ParticipantType | The type of the participant, ; maps to the capabilities of the participant in Control Loop Automation Composition Type Definitions | |||||
| Result | Success/Fail | |||||
| Message | Message A message indicating the reason for failure | |||||
| ControlLoopUpdateACMUpdate | CLAMP Runtime | Participant | CLAMP Runtime sends Control Loop Automation Composition Element instances and Instance Specific Parameter Values for a Control Loop an Automation Composition Instance to Participants | ControlLoopIdACMId | The name and version of the Control LoopAutomation Composition | |
| ParticipantUpdateMap | Map with Participant ID as its key, each value on the map is a ControlLoopElementListan ACMElementList | |||||
| ControlLoopElementListACMElementList | List of ControlLoopElement ACMElement values for the Control LoopAutomation Composition | |||||
| ControlLoopElementACMElement | A ControlLoopElementAn ACMElement, which contains among other things a PropertiesMap with the values of the the property values for this Control Loop Automation Composition Element instance and a ToscaServiceTemplateFragment with extra concept definitions and instances that a participant may need. | |||||
| PropertiesMap | A <String, String> map indexed by the property name. Each map entry is the serialized value of the property, which can be deserialized into an instance of the type of the property. | |||||
| ToscaServiceTemplateFragment | A well-formed TOSCA service template containing extra concept definitions and instances that a participant may need. For example, the Policy Participant may need policy type definitions or policy instances to be provided if they are not already stored in the Policy Framework. | |||||
| ControlLoopUpdateACMUpdateAck | Participant | CLAMP Runtime | Acknowledgement Acknowledgment of Control Loop Automation Composition Update | ParticipantId | The ID of this participant | |
| ParticipantType | The type of the participant, ; maps to the capabilities of the participant in Control Loop Automation Composition Type Definitions | |||||
| ControlLoopIdACMId | The name and version of the Control LoopAutomation Composition | |||||
| ControlLoopResultACMResult | Holds a Result and Message for the overall operation on the participant and a map of Result and Message fields for each Control Loop Automation Composition Element of the control loop Automation Composition on this participant | |||||
| Result | Success/Fail | |||||
| Message | Message A message indicating the reason for failure | ControlLoopStateChange|||||
| ACMStateChange | CLAMP Runtime | Participant | CLAMP Runtime asks Participants to change the state of | a Control LoopControlLoopIdan Automation Composition | ACMId | The name and version of the Control LoopAutomation Composition |
| currentState | The current state of the Control LoopAutomation Composition | |||||
| orderedState | The state that the Control Loop Automation Composition should transition to | |||||
| startPhase | The start phase to which this ACMStateChange message applies | |||||
| ACMStateChangeAck | Participant | CLAMP Runtime | AcknowledgementAcknowledgment of | Control LoopAutomation Composition State Change | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant, ; maps to the capabilities of the participant in Control Loop Automation Composition Type Definitions | |||||
| ControlLoopIdACMId | The name and version of the Control Loop | ControlLoopResultAutomation Composition | ||||
| startPhase | The start phase to which this ACMStateChangeAck message applies | |||||
| ACMResult | Holds a Result and Message for the overall operation on the participant and a map of Result and Message fields for each Control Loop Automation Composition Element of the control loop Automation Composition on this participant | |||||
| Result | Success/Fail | |||||
| Message | Message A message indicating the reason for failure | |||||
| ParticipantStatusReq | CLAMP Runtime | Participant | Request that the specified participants return a ParticipantStatus message immediately | ParticipantId | The ID of this participant, if not specified, all participants respond. | |
| ParticipantStatus | Participant | CLAMP Runtime | Periodic or on-demand report for heartbeat, Participant Status, Control Loop Automation Composition Status, and Control Loop Automation Composition Statistics | ParticipantId | The ID of this participant | |
| ParticipantType | The type of the participant, ; maps to the capabilities of the participant in Control Loop Automation Composition Type Definitions | |||||
| ParticipantDefinitionUpdateMap (returned in repsonse to ParticipantStatusReq only) | See ParticipantUpdate message above for the definition of this field | |||||
| ParticipantStatus | The current status of the participant for monitoring | |||||
| ParticipantStatistics | Statistics on the participant such as up timeuptime, or messages processed. Can include participant specific data in a string blob that is opaque to CLAMP | |||||
| ControlLoopInfoMapACMInfoMap | A map of ControlLoopInfo ACMInfo types indexed by ControlLoopId ACMId, one entry for each control loop Automation Composition running on the participant | |||||
| ControlLoopInfoACMInfo | The ControlLoopStatus ACMStatus and ControlLoopStatistics ACMStatistics for a given control loopAutomation Composition | |||||
| ControlLoopStatusACMStatus | The current status of the control loop Automation Composition for monitoring | |||||
| ControlLoopStatisticsACMStatistics | Statistics on the control loop Automation Composition such as up timeuptime, or messages processed. Can include participant specific data in a string blob that is opaque to CLAMP | |||||
...