aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/design-impl/participants/participant-intermediary.rst
diff options
context:
space:
mode:
authoradheli.tavares <adheli.tavares@est.tech>2022-04-05 14:21:40 +0100
committerLiam Fallon <liam.fallon@est.tech>2022-04-11 07:49:05 +0000
commit12a315f76a189a4d3a00d6f0335dccf979b9608a (patch)
tree4db364e1ae890b1a7b826a18046eafb9bb7f506a /docs/clamp/acm/design-impl/participants/participant-intermediary.rst
parent21389fc50ae79f7f980534c2d2b5346744f4315c (diff)
Updating Clamp documentation
- update rest apis definitions with renaming of control loop to acm - rename control loop to automation composition - fix a few cross-references missed Issue-ID: POLICY-4063 Change-Id: Ib88074e1d2d08fe38da244b5e1eb2e5783c84a86 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
Diffstat (limited to 'docs/clamp/acm/design-impl/participants/participant-intermediary.rst')
-rw-r--r--docs/clamp/acm/design-impl/participants/participant-intermediary.rst20
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/clamp/acm/design-impl/participants/participant-intermediary.rst b/docs/clamp/acm/design-impl/participants/participant-intermediary.rst
index 95c1a7ac..d9d24ceb 100644
--- a/docs/clamp/acm/design-impl/participants/participant-intermediary.rst
+++ b/docs/clamp/acm/design-impl/participants/participant-intermediary.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. _clamp-clamp-acm-participant-intermediary:
+.. _clamp-acm-participant-intermediary:
Participant Intermediary
########################
@@ -58,55 +58,55 @@ Design of a PARTICIPANT_DEREGISTER message
- Participant is not monitored.
Design of a creation of an Automation Composition Type
--------------------------------------------
+------------------------------------------------------
- If there are participants registered with CL-runtime, it triggers the execution to send a broadcast PARTICIPANT_UPDATE message
- the message is built by ParticipantUpdatePublisher using Tosca Service Template data (to fill the list of ParticipantDefinition)
- Participant-intermediary will receive a PARTICIPANT_UDPATE message and stores the Tosca Service Template data on ParticipantHandler
Design of a deletion of an Automation Composition Type
--------------------------------------------
+------------------------------------------------------
- if there are participants registered, CL-runtime triggers the execution to send a broadcast PARTICIPANT_UPDATE message
- the message is built by ParticipantUpdatePublisher with an empty list of ParticipantDefinition
- It deletes the Automation Composition Type from DB
- Participant-intermediary will receive a PARTICIPANT_UDPATE message and deletes the Tosca Service Template data on ParticipantHandler
Design of a creation of an Automation Composition
---------------------------------------
+-------------------------------------------------
- AUTOMATION_COMPOSITION_UPDATE message with instantiation details and UNINITIALISED state is sent to participants
- Participant-intermediary validates the current state change
- Participant-intermediary will recieve AUTOMATION_COMPOSITION_UPDATE message and sends the details of AutomationCompositionElements to participants
- Each participant performs its designated job of deployment by interacting with respective frameworks
Design of a deletion of an Automation Composition
---------------------------------------
+-------------------------------------------------
- AUTOMATION_COMPOSITION_STATE_CHANGE message with UNINITIALISED state is sent to participants
- Participant-intermediary validates the current state change
- Participant-intermediary will recieve AUTOMATION_COMPOSITION_STATE_CHANGE message and sends the details of AutomationCompositionElements to participants
- Each participant performs its designated job of undeployment by interacting with respective frameworks
Design of "issues automation composition commands to automation compositions" - case UNINITIALISED to PASSIVE
------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------
- AUTOMATION_COMPOSITION_STATE_CHANGE message with state changed from UNINITIALISED to PASSIVE is sent to participants
- Participant-intermediary validates the current state change
- Participant-intermediary will recieve AUTOMATION_COMPOSITION_STATE_CHANGE message and sends the details of state change to participants
- Each participant performs its designated job of state change by interacting with respective frameworks
Design of "issues automation composition commands to automation compositions" - case PASSIVE to UNINITIALISED
------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------
- AUTOMATION_COMPOSITION_STATE_CHANGE message with state changed from PASSIVE to UNINITIALISED is sent to participants
- Participant-intermediary validates the current state change
- Participant-intermediary will recieve AUTOMATION_COMPOSITION_STATE_CHANGE message and sends the details of state change to participants
- Each participant performs its designated job of state change by interacting with respective frameworks
Design of "issues automation composition commands to automation compositions" - case PASSIVE to RUNNING
------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------
- AUTOMATION_COMPOSITION_STATE_CHANGE message with state changed from PASSIVE to RUNNING is sent to participants
- Participant-intermediary validates the current state change
- Participant-intermediary will recieve AUTOMATION_COMPOSITION_STATE_CHANGE message and sends the details of state change to participants
- Each participant performs its designated job of state change by interacting with respective frameworks
Design of "issues automation composition commands to automation compositions" - case RUNNING to PASSIVE
------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------
- AUTOMATION_COMPOSITION_STATE_CHANGE message with state changed from RUNNING to PASSIVE is sent to participants
- Participant-intermediary validates the current state change
- Participant-intermediary will recieve AUTOMATION_COMPOSITION_STATE_CHANGE message and sends the details of state change to participants
@@ -119,7 +119,7 @@ Design of a PARTICIPANT_STATUS message
- PARTICIPANT_STATUS message holds a special attribute to return Tosca definitions, this attribute is populated only in response to PARTICIPANT_STATUS_REQ
Design of a AUTOMATIONCOMPOSITION_UPDATE_ACK message
-------------------------------------------
+----------------------------------------------------
- A participant sends AUTOMATIONCOMPOSITION_UPDATE_ACK message in response to a AUTOMATIONCOMPOSITION_UPDATE message.
- For each CL-elements moved to the ordered state as indicated by the AUTOMATIONCOMPOSITION_UPDATE
- AutomationCompositionUpdateAckListener in CL-runtime collects the messages from DMaap