1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. _system-level-label:
5 ACM System Level Dialogues
6 ##########################
7 Priming The CLAMP Automation Composition Runtime Lifecycle Management uses the following system-level dialogues. These dialogues enable the CLAMP runtime capabilities described in Section 2 of TOSCA Defined Automation Compositions: Architecture and Design. Design Time dialogues will be described in future releases of the system.
14 1 Dialogues on Participants
15 ===========================
16 1.1 Register a Participant
17 --------------------------
19 Participant Registration is performed by a Participant when it starts up. It registers its ID and the ACM Element Types it supports with the ACM runtime.
21 .. image:: ../images/system-dialogues/RegisterParticipant.png
23 1.2 Deregister a Participant
24 ----------------------------
25 Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime.
27 .. image:: ../images/system-dialogues/DeregisterParticipant.png
29 1.3 Supervise Participants
30 --------------------------
31 Participant Supervision is performed periodically between participants and the ACM runtime server to ensure that registered participants are available over time. Participants send a heartbeat message to the ACM runtime at a configured interval. The heartbeat message contains updated status information for each AC Element Instance that has changed status since the last Heartbeat message sent by the participant.
33 .. image:: ../images/system-dialogues/SuperviseParticipantsStatusUpdate.png
35 The ACM runtime regularly checks the heartbeat reports from participants and takes action if participants time out. If a heartbeat message is not received for a participant in the Timeout Interval, the participant is marked as timed out and its ACM element instances are informed.
37 .. image:: ../images/system-dialogues/SuperviseParticipantsTimeout.png
39 1.4 Get Participant Information
40 -------------------------------
41 The information on participants is available over a REST endpoint.
43 .. image:: ../images/system-dialogues/GetParticipantInformation.png
45 1.5 Order Full Participant Report
46 ---------------------------------
48 .. image:: ../images/system-dialogues/FullParticipantReport.png
50 2 Dialogues on Automation Composition Types
51 ===========================================
52 Commissioning dialogues are used to commission and decommission Automation Composition Types and to set the values of Common Parameters. The values of common parameters are included in the TOSCA YAML file that defines the full Automation Composition Type.
54 2.1 Commission or Update an Automation Composition Type
55 -------------------------------------------------------
56 Create on a POST and update on a PUT.
58 .. image:: ../images/system-dialogues/CommissionUpdateAcType.png
60 2.2 Commission an Automation Composition Type using SDC
61 -------------------------------------------------------
63 .. image:: ../images/system-dialogues/CommissionAcTypeSDC.png
65 2.3 Decommission an Automation Composition Type
66 -----------------------------------------------
68 .. image:: ../images/system-dialogues/DecommissionAcType.png
70 2.4 Prime an Automation Composition Type on Participants
71 --------------------------------------------------------
72 The Priming operation sends Automation Composition Types and common property values to participants for each Automation Composition Element Type in the Automation Composition Type.
74 .. image:: ../images/system-dialogues/PrimeAcTypeOnPpnts.png
76 A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become primed. Note that if more than one participant can support an Automation Composition Element Type the ACM Runtime uses the participant in the first response it receives for that Automation Composition Element Type.
78 .. image:: ../images/system-dialogues/PrimeAcTypeMultiplePpnts.png
80 The ACM Runtime updates the priming information in the database.
82 .. image:: ../images/system-dialogues/PrimeInfoUpdatedInDb.png
84 2.5 Deprime an Automation Composition Type on Participants
85 ----------------------------------------------------------
86 The Depriming operation removes Automation Composition Types and common property values on participants for each Automation Composition Element Type in the Automation Composition Type.
88 .. image:: ../images/system-dialogues/DeprimeOnParticipants.png
90 A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become deprimed.
92 .. image:: ../images/system-dialogues/DeprimeElements.png
94 The ACM Runtime updates the priming information in the database.
96 .. image:: ../images/system-dialogues/UpdateDeprimeInDb.png
98 2.6 Get Automation Composition Types
99 ------------------------------------
100 This dialogue allows an Automation Composition Type to be read.
102 .. image:: ../images/system-dialogues/GetAcTypes.png
104 3. Instantiation Dialogues
105 ==========================
106 Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
108 3.1 Create an Automation Composition Instance
109 ---------------------------------------------
111 .. image:: ../images/system-dialogues/CreateAcInstance.png
113 Note that this dialogue creates the Automation Composition Instance in the ACM database. The instance is sent to the participants using the process described in the dialogue in Section 3.3.
115 3.2 Delete an Automation Composition Instance
116 ---------------------------------------------
117 The user requests the AC Instance to be deleted using a REST endpoint. The ACM Runtime orders the AC Instance to be deleted.
119 .. image:: ../images/system-dialogues/DeleteAcInstance.png
121 Each participant deletes its AC Element Instances from the AC Instance
123 .. image:: ../images/system-dialogues/DeleteInstanceElements.png
125 The ACM Runtime receives and stores the responses, when all instances element are deleted, it delete the instance.
127 .. image:: ../images/system-dialogues/DeleteResponseStored.png
129 3.3 Deploy Automation Composition Instance
130 ------------------------------------------
131 The user requests the AC Instance to be deployed using a REST endpoint. The ACM Runtime orders the AC Instance to be deployed to Participants.
133 .. image:: ../images/system-dialogues/DeployAcInstance.png
135 Each participant deploys its AC Element Instances from the AC Instance.
137 .. image:: ../images/system-dialogues/DeployAcInstanceElements.png
139 The ACM Runtime receives and stores the responses.
141 .. image:: ../images/system-dialogues/DeployResponseStored.png
143 3.4 Update Automation Composition Instance
144 ------------------------------------------
145 The user requests the AC Instance to be updated using a REST endpoint. The ACM Runtime orders the AC Instance to be updated.
147 .. image:: ../images/system-dialogues/UpdateAcInstance.png
149 Each participant updates its AC Element from the AC Instance
151 .. image:: ../images/system-dialogues/UpdateAcElements.png
153 The ACM Runtime receives and stores the responses.
155 .. image:: ../images/system-dialogues/UpdateAcElementsResponse.png
157 3.5 Migrate Automation Composition Instance
158 -------------------------------------------
159 The user requests the AC Instance to be migrated using a REST endpoint. The ACM Runtime orders the AC Instance to be migrated.
161 .. image:: ../images/system-dialogues/MigrateAcInstance.png
163 Each participant migrated its AC Element from the AC Instance
165 .. image:: ../images/system-dialogues/MigrateAcElements.png
167 The ACM Runtime receives and stores the responses.
169 .. image:: ../images/system-dialogues/MigrateAcElementsResponse.png
171 3.6 Undeploy Automation Composition Instance
172 --------------------------------------------
173 The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.
175 .. image:: ../images/system-dialogues/UndeployInstance.png
177 Each participant undeploys its AC Element Instances from the AC Instance
179 .. image:: ../images/system-dialogues/UndeployInstanceElements.png
181 The ACM Runtime receives and stores the responses.
183 .. image:: ../images/system-dialogues/UndeployResponseStored.png
185 3.7 Read Automation Composition Instances
186 -----------------------------------------
188 .. image:: ../images/system-dialogues/ReadAcInstances.png
190 3.8 Unlock Automation Composition Instance
191 ------------------------------------------
192 The user requests the AC Instance to be unlocked using a REST endpoint. The ACM Runtime orders the AC Instance to be unlocked on Participants.
194 .. image:: ../images/system-dialogues/OrderInstanceUnlock.png
196 Each participant unlocks its AC Element Instances from the AC Instance.
198 .. image:: ../images/system-dialogues/UnlockInstanceElements.png
200 The ACM Runtime receives and stores the responses.
202 .. image:: ../images/system-dialogues/UnlockResponseStored.png
204 3.9 Lock Automation Composition Instance
205 ----------------------------------------
206 The user requests the AC Instance to be locked using a REST endpoint. The ACM Runtime orders the AC Instance to be locked on Participants.
208 .. image:: ../images/system-dialogues/LockAcInstance.png
210 Each participant locks its AC Element Instances from the AC Instance.
212 .. image:: ../images/system-dialogues/LockAcInstanceElements.png
214 The ACM Runtime receives and stores the responses.
216 .. image:: ../images/system-dialogues/LockResponseStored.png
218 3.10 Update Operational State on Automation Composition Instance
219 ----------------------------------------------------------------
221 .. image:: ../images/system-dialogues/UpdateOperationalState.png
223 3.11 Update Usage State on Automation Composition Instance
224 ----------------------------------------------------------
226 .. image:: ../images/system-dialogues/UpdateUsageState.png
228 3.12 Failure handling in ACM
229 ----------------------------
230 After any ACM operation is completed, one of the following result messages will be updated in the ACM. These result values are
231 updated along with the overall state of the ACM instance.
237 The enum result values 'NO_ERROR' and 'FAILED' have to be set by the participants while reporting the CompositionState back to the runtime.
239 If the operation succeeds, the participant is required to update the result value with 'NO_ERROR' while reporting the composition state.
241 .. image:: ../images/system-dialogues/SuccessAcmResult.png
243 The result value should be updated as 'FAILED' by the participants when any failures occurred.
244 Also in case of failures, the overall state of the composition remains in any of the transitioning states (DEPLOYING, UNDEPLOYING, PRIMING, UPDATING)
245 with the appropriate result values updated by the participant.
247 .. image:: ../images/system-dialogues/FailedAcmResult.png
249 Runtime marks the operation result with the value 'TIMEOUT' when the participant gets disconnected from the ACM-R in the middle of any ACM operation.
250 When the participant fails to report the periodic heartbeat during an ACM operation, the operation result is then marked as 'TIMEOUT' by the ACM-R after the configured waiting limit is
253 .. image:: ../images/system-dialogues/TimeoutAcmResult.png
255 The following parameter is set in the application properties for the runtime to configure the 'TIMEOUT' value in milliseconds.
260 participantParameters:
261 maxStatusWaitMs: 100000 --> Denotes the maximum wait time by the runtime to receive the periodic status update from the participants
263 An ACM operation has to be completed and updated with any of the above specified result values in order to allow the user to trigger subsequent requests.
264 The user cannot trigger any state change events before the operation gets completed. When an operation is marked 'TIMEOUT', the following scenarios are applicable.
266 - The participant might come back ONLINE and complete the operation to mark the result with 'NO_ERROR' or 'FAILED'
267 - The user can trigger another state change event to the ACM.