diff options
Diffstat (limited to 'docs/clamp/acm/design-impl')
6 files changed, 18 insertions, 18 deletions
diff --git a/docs/clamp/acm/design-impl/clamp-gui-controlloop.rst b/docs/clamp/acm/design-impl/clamp-gui-controlloop.rst index 41e3558c..28bebe90 100644 --- a/docs/clamp/acm/design-impl/clamp-gui-controlloop.rst +++ b/docs/clamp/acm/design-impl/clamp-gui-controlloop.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. _clamp-gui-controlloop: +.. _clamp-gui-acm: The Policy GUI for Control Loops ******************************** diff --git a/docs/clamp/acm/design-impl/participants/http-participant.rst b/docs/clamp/acm/design-impl/participants/http-participant.rst index be0349ea..f58f03d2 100644 --- a/docs/clamp/acm/design-impl/participants/http-participant.rst +++ b/docs/clamp/acm/design-impl/participants/http-participant.rst @@ -35,7 +35,7 @@ participant is running two HTTP Automation Composition Elements, one for Automat Automation Composition B. Configuring a Automation Composition Element on the HTTP participant for a Automation Composition ------------------------------------------------------------------------------ +------------------------------------------------------------------------------------------------- A *Configuration Entity* describes a concept that is managed by the HTTP participant. A Configuration Entity can be created, Read, Updated, and Deleted (CRUD). The user defines the Configuration Entities that it wants its HTTP Automation Composition Element to manage and diff --git a/docs/clamp/acm/design-impl/participants/k8s-participant.rst b/docs/clamp/acm/design-impl/participants/k8s-participant.rst index 9de18070..366c8430 100644 --- a/docs/clamp/acm/design-impl/participants/k8s-participant.rst +++ b/docs/clamp/acm/design-impl/participants/k8s-participant.rst @@ -44,7 +44,7 @@ Sample tosca template defining a participant and a automation composition elemen Configuring a Automation Composition Element on the kubernetes participant for a Automation Composition ------------------------------------------------------------------------------------ +------------------------------------------------------------------------------------------------------- The user configures the following properties in the TOSCA template for the kubernetes participant: 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 diff --git a/docs/clamp/acm/design-impl/participants/participants.rst b/docs/clamp/acm/design-impl/participants/participants.rst index 15aee04d..9cf38bc7 100644 --- a/docs/clamp/acm/design-impl/participants/participants.rst +++ b/docs/clamp/acm/design-impl/participants/participants.rst @@ -1,9 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. _clamp-controlloop-participants: +.. _clamp-acm-participants: -Control Loop Participants -######################### +Automation Composition Participants +################################### A Participant is a component that acts as a bridge between the CLAMP Automation Composition Management runtime and components such as the Policy Framework, DCAE, or a Kubernetes cluster that are taking part in automation composition management. It listens diff --git a/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst b/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst index 1ef38b3e..9ce120c0 100644 --- a/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst +++ b/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst @@ -54,7 +54,7 @@ The Policy Participant uses the following steps for Policy Type References: #. The Policy Participant reads the Policy Type ID from the policyType property specified for the Automation Composition Element. #. It checks if a Policy Type with that Policy Type ID has been specified in the ToscaServiceTemplateFragment field in - the AutomationCompositionElement definition in the AutomationCompositionUpdate message, see :ref:`clampacm-participant-protocol-label`. + the AutomationCompositionElement definition in the AutomationCompositionUpdate message, see :ref:`acm-participant-protocol-label`. #. If the Policy Type has been specified, the Participant stores the Policy Type in the Policy framework. If the Policy Type is successfully stored, execution proceeds, otherwise an error is reported. @@ -70,7 +70,7 @@ The Policy Participant uses the following steps for Policy References: #. The Policy Participant reads the Policy ID from the policyId property specified for the Automation Composition Element. #. It checks if a Policy with that Policy ID has been specified in the ToscaServiceTemplateFragment field in the - AutomationCompositionElement definition in the AutomationCompositionUpdate message, :ref:`clampacm-participant-protocol-label`. + AutomationCompositionElement definition in the AutomationCompositionUpdate message, :ref:`acm-participant-protocol-label`. #. If the Policy has been specified, the Participant stores the Policy in the Policy framework. If the Policy is successfully stored, execution proceeds, otherwise an error is reported. |