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.
Control Loop Commissioning and Decommissioning
...
Automation Composition Priming and De-Priming
When 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-commissionedprimed, 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 LoopAutomation Compositions: Architecture and DesignDesign#4.1ACMVersionManagement.
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 handling of a ControlLoopStateChange startPhase in the Definition of TOSCA fundamental Automation Composition Types is particularly important in Automation Composition state changes because sometimes the user wishes to control the order in which the state changes in Automation Composition Elements in an Automation Composition. In-state changes from UNITITIALISED → PASSIVE and from PASSIVE → RUNNING, Automation Composition elements are started in increasing order of their startPhase. In-state changes from RUNNING → PASSIVE and from PASSIVE → UNITITIALISED, 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 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
Participant Registration
Participant Registration Ack
Participant Update
Participant Update Ack
Participant Deregistration
Participant Deregistration Ack
Control Loop Update
Control Loop Update Ack
Control Loop State Change
Control Loop State Change
Participant Status
| Warning |
|---|
This page is updated for Istanbul to this point. |
Participant handles 4 types of messages
...
2. Control Loop Update: This message creates the control loop elements and brings them from UNINITIALIZED to PASSIVE state.
ControlLoopUpdate message contains full ToscaServiceTemplate describing all components participating in a control loop.
This acts as a template for any control loop to be created according to the template.
When participant-intermediary receives this message, it triggers creation of policy-types and policies in Policy-Framework by Policy-Participant,
and deploys DCAE from DCAE-participant
3. Control Loop State change: This message is used to order a state change in control loop element.
Runtime can order one of the following ordered states.
UNINITIALIZED : The control loop or control loop element should become uninitialized on participants, it should not exist on participants.
PASSIVE : The control loop or control loop element should initialized on the participants and be passive, that is,
it is not handling control loop messages yet.
RUNNING : The control loop or control loop element should running and is executing control loops. Once any of above states are ordered, then control loop element transitions into
UNINITIALIZED : The control loop or control loop element is not initialized on participants, it does not exist on participants.
UNINITIALIZED2PASSIVE : The control loop or control loop element is changing from uninitialized to passive,
it is being initialized onto participants.
PASSIVE : The control loop or control loop element is initialized on the participants but is passive, that is, it is not
handling control loop messages yet.
PASSIVE2RUNNING : The control loop or control loop element is changing from passive to running,
the participants are preparing to execute control loops.
RUNNING : The control loop or control loop element is running and is executing control loops.
RUNNING2PASSIVE : The control loop or control loop element is completing execution of current control loops but
will not start running any more control loops and will become passive.
PASSIVE2UNINITIALIZED : The control loop or control loop element is changing from passive to uninitialized,
the control loop is being removed from participants
4. Participant Healthcheck: This message is used to learn the health status of a participant.
As a response to any of the above message participant returns a Participant Status message, holding respective message response.
Runtime receives Participant Status message and stores relevant information in database, Or performs respective actions.
Participant Pass Through
| Warning |
|---|
The information in this section is speculative |
For Control Loop Elements on certain participants, there may be a need to provide domain specific directives to a Control Loop Element or elements such as a microservice or a collection of microservices while a Control Loop Instance is running.
Drawio
| 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 Automation Composition Type Definitions | ||||
| ParticipantRegisterAck | CLAMP Runtime | Participant | Acknowledgment of Participant Registration | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| Result | Success/Fail | ||||
| Message | A message indicating the reason for failure | ||||
| ParticipantUpdate | CLAMP Runtime | Participant | CLAMP Runtime sends Automation Composition Element Definitions and Common Parameter Values to Participants | ParticipantDefinitionUpdateMap | Map with Participant ID as its key, each value on the map is an ACMElementDefintionMap |
| ACMElementDefintionMap | List of ACMElementDefinition values for a particular participant, keyed by its Automation Composition Element Definition ID | ||||
| ACMElementDefinition | An ACMElementToscaServiceTemplate containing the definition of the Automation Composition Element and a CommonPropertiesMap with the values of the common property values for Automation Composition Elements of this type | ||||
| ACMElementToscaServiceTemplate | The definition of the 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 | Acknowledgment of Participant Update | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| Result | Success/Fail | ||||
| 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 Automation Composition Type Definitions | ||||
| ParticipantDeregisterAck | CLAMP Runtime | Participant | Acknowledgment of Participant Deregistration | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| Result | Success/Fail | ||||
| Message | A message indicating the reason for failure | ||||
| ACMUpdate | CLAMP Runtime | Participant | CLAMP Runtime sends Automation Composition Element instances and Instance Specific Parameter Values for an Automation Composition Instance to Participants | ACMId | The name and version of the Automation Composition |
| ParticipantUpdateMap | Map with Participant ID as its key, each value on the map is an ACMElementList | ||||
| ACMElementList | List of ACMElement values for the Automation Composition | ||||
| ACMElement | An ACMElement, which contains among other things a PropertiesMap with the values of property values for this 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. | ||||
| ACMUpdateAck | Participant | CLAMP Runtime | Acknowledgment of Automation Composition Update | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| ACMId | The name and version of the Automation Composition | ||||
| ACMResult | Holds a Result and Message for the overall operation on the participant and a map of Result and Message fields for each Automation Composition Element of the Automation Composition on this participant | ||||
| Result | Success/Fail | ||||
| Message | A message indicating the reason for failure | ||||
| ACMStateChange | CLAMP Runtime | Participant | CLAMP Runtime asks Participants to change the state of an Automation Composition | ACMId | The name and version of the Automation Composition |
| currentState | The current state of the Automation Composition | ||||
| orderedState | The state that the Automation Composition should transition to | ||||
| startPhase | The start phase to which this ACMStateChange message applies | ||||
| ACMStateChangeAck | Participant | CLAMP Runtime | Acknowledgment of Automation Composition State Change | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| ACMId | The name and version of the Automation 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 Automation Composition Element of the Automation Composition on this participant | ||||
| Result | Success/Fail | ||||
| 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, Automation Composition Status, and Automation Composition Statistics | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in 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 uptime, or messages processed. Can include participant specific data in a string blob that is opaque to CLAMP | ||||
| ACMInfoMap | A map of ACMInfo types indexed by ACMId, one entry for each Automation Composition running on the participant | ||||
| ACMInfo | The ACMStatus and ACMStatistics for a given Automation Composition | ||||
| ACMStatus | The current status of the Automation Composition for monitoring | ||||
| ACMStatistics | Statistics on the Automation Composition such as uptime, or messages processed. Can include participant specific data in a string blob that is opaque to CLAMP | ||||