1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. _system-level-label:
ACM System Level Dialogues
##########################
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.
.. contents::
:depth: 4
1 Dialogues on Participants
===========================
1.1 Register a Participant
--------------------------
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.
.. image:: ../images/system-dialogues/RegisterParticipant.png
1.2 Deregister a Participant
----------------------------
Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime.
.. image:: ../images/system-dialogues/DeregisterParticipant.png
1.3 Supervise Participants
--------------------------
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.
.. image:: ../images/system-dialogues/SuperviseParticipantsStatusUpdate.png
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.
.. image:: ../images/system-dialogues/SuperviseParticipantsTimeout.png
1.4 Get Participant Information
-------------------------------
The information on participants is available over a REST endpoint.
.. image:: ../images/system-dialogues/GetParticipantInformation.png
1.5 Order Full Participant Report
---------------------------------
.. image:: ../images/system-dialogues/FullParticipantReport.png
2 Dialogues on Automation Composition Types
===========================================
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.
2.1 Commission or Update an Automation Composition Type
-------------------------------------------------------
Create on a POST and update on a PUT.
.. image:: ../images/system-dialogues/CommissionUpdateAcType.png
2.2 Commission an Automation Composition Type using SDC
-------------------------------------------------------
.. image:: ../images/system-dialogues/CommissionAcTypeSDC.png
2.3 Decommission an Automation Composition Type
-----------------------------------------------
.. image:: ../images/system-dialogues/DecommissionAcType.png
2.4 Prime an Automation Composition Type on Participants
--------------------------------------------------------
The Priming operation sends Automation Composition Types and common property values to participants for each Automation Composition Element Type in the Automation Composition Type.
.. image:: ../images/system-dialogues/PrimeAcTypeOnPpnts.png
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.
.. image:: ../images/system-dialogues/PrimeAcTypeMultiplePpnts.png
The ACM Runtime updates the priming information in the database.
.. image:: ../images/system-dialogues/PrimeInfoUpdatedInDb.png
2.5 Deprime an Automation Composition Type on Participants
----------------------------------------------------------
The Depriming operation removes Automation Composition Types and common property values on participants for each Automation Composition Element Type in the Automation Composition Type.
.. image:: ../images/system-dialogues/DeprimeOnParticipants.png
A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become deprimed.
.. image:: ../images/system-dialogues/DeprimeElements.png
The ACM Runtime updates the priming information in the database.
.. image:: ../images/system-dialogues/UpdateDeprimeInDb.png
2.6 Get Automation Composition Types
------------------------------------
This dialogue allows an Automation Composition Type to be read.
.. image:: ../images/system-dialogues/GetAcTypes.png
3. Instantiation Dialogues
==========================
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
3.1 Create an Automation Composition Instance
---------------------------------------------
.. image:: ../images/system-dialogues/CreateAcInstance.png
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.
3.2 Delete an Automation Composition Instance
---------------------------------------------
The user requests the AC Instance to be deleted using a REST endpoint. The ACM Runtime orders the AC Instance to be deleted.
.. image:: ../images/system-dialogues/DeleteAcInstance.png
Each participant deletes its AC Element Instances from the AC Instance
.. image:: ../images/system-dialogues/DeleteInstanceElements.png
The ACM Runtime receives and stores the responses, when all instances element are deleted, it delete the instance.
.. image:: ../images/system-dialogues/DeleteResponseStored.png
3.3 Deploy Automation Composition Instance
------------------------------------------
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.
.. image:: ../images/system-dialogues/DeployAcInstance.png
Each participant deploys its AC Element Instances from the AC Instance.
.. image:: ../images/system-dialogues/DeployAcInstanceElements.png
The ACM Runtime receives and stores the responses.
.. image:: ../images/system-dialogues/DeployResponseStored.png
3.4 Update Automation Composition Instance
------------------------------------------
The user requests the AC Instance to be updated using a REST endpoint. The ACM Runtime orders the AC Instance to be updated.
.. image:: ../images/system-dialogues/UpdateAcInstance.png
Each participant updates its AC Element from the AC Instance
.. image:: ../images/system-dialogues/UpdateAcElements.png
The ACM Runtime receives and stores the responses.
.. image:: ../images/system-dialogues/UpdateAcElementsResponse.png
3.5 Migrate Automation Composition Instance
-------------------------------------------
The user requests the AC Instance to be migrated using a REST endpoint. The ACM Runtime orders the AC Instance to be migrated.
.. image:: ../images/system-dialogues/MigrateAcInstance.png
Each participant migrated its AC Element from the AC Instance
.. image:: ../images/system-dialogues/MigrateAcElements.png
The ACM Runtime receives and stores the responses.
.. image:: ../images/system-dialogues/MigrateAcElementsResponse.png
3.6 Undeploy Automation Composition Instance
--------------------------------------------
The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.
.. image:: ../images/system-dialogues/UndeployInstance.png
Each participant undeploys its AC Element Instances from the AC Instance
.. image:: ../images/system-dialogues/UndeployInstanceElements.png
The ACM Runtime receives and stores the responses.
.. image:: ../images/system-dialogues/UndeployResponseStored.png
3.7 Read Automation Composition Instances
-----------------------------------------
.. image:: ../images/system-dialogues/ReadAcInstances.png
3.8 Unlock Automation Composition Instance
------------------------------------------
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.
.. image:: ../images/system-dialogues/OrderInstanceUnlock.png
Each participant unlocks its AC Element Instances from the AC Instance.
.. image:: ../images/system-dialogues/UnlockInstanceElements.png
The ACM Runtime receives and stores the responses.
.. image:: ../images/system-dialogues/UnlockResponseStored.png
3.9 Lock Automation Composition Instance
----------------------------------------
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.
.. image:: ../images/system-dialogues/LockAcInstance.png
Each participant locks its AC Element Instances from the AC Instance.
.. image:: ../images/system-dialogues/LockAcInstanceElements.png
The ACM Runtime receives and stores the responses.
.. image:: ../images/system-dialogues/LockResponseStored.png
3.10 Update Operational State on Automation Composition Instance
----------------------------------------------------------------
.. image:: ../images/system-dialogues/UpdateOperationalState.png
3.11 Update Usage State on Automation Composition Instance
----------------------------------------------------------
.. image:: ../images/system-dialogues/UpdateUsageState.png
3.12 Failure handling in ACM
----------------------------
After any ACM operation is completed, one of the following result messages will be updated in the ACM. These result values are
updated along with the overall state of the ACM instance.
- NO_ERROR
- TIMEOUT
- FAILED
The enum result values 'NO_ERROR' and 'FAILED' have to be set by the participants while reporting the CompositionState back to the runtime.
If the operation succeeds, the participant is required to update the result value with 'NO_ERROR' while reporting the composition state.
.. image:: ../images/system-dialogues/SuccessAcmResult.png
The result value should be updated as 'FAILED' by the participants when any failures occurred.
Also in case of failures, the overall state of the composition/instance remains in any of the transitioning states (DEPLOYING, UNDEPLOYING, PRIMING, DEPRIMING, UPDATING, MIGRATING)
with the appropriate result values updated by the participant.
.. image:: ../images/system-dialogues/FailedAcmResult.png
Runtime marks the operation result with the value 'TIMEOUT' when the participant fails to report the message back during an ACM operation,
the operation result is then marked as 'TIMEOUT' by the ACM-R after the configured waiting limit is reached.
.. image:: ../images/system-dialogues/TimeoutAcmResult.png
The following parameter is set in the application properties for the runtime to configure the 'TIMEOUT' value in milliseconds.
.. code-block:: yaml
runtime:
participantParameters:
maxStatusWaitMs: 100000 --> Denotes the maximum wait time by the runtime to receive the periodic status update from the participants
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.
The user cannot trigger any state change events before the operation gets completed. When an operation is marked 'TIMEOUT', the following scenarios are applicable.
- The participant might complete the operation to mark the result with 'NO_ERROR' or 'FAILED'
- The user can trigger another state change event to the ACM.
The following flow shown and example of deployment that get stuck, and the user decide to undeploy.
.. image:: ../images/system-dialogues/TimeoutParticipant.png
3.13 OFF_LINE handling in ACM
-----------------------------
Runtime marks the participant state with the value 'OFF_LINE' when the participant fails to report the periodic heartbeat,
the participant state is then marked as 'OFF_LINE' by the ACM-R after the configured waiting limit is reached.
That scenario might happen when participant is shutdown, in that scenario all on going operations with that participant are marked 'TIMEOUT' due the missing messages back.
The user cannot trigger any state change events when participant state is 'OFF_LINE'.
.. image:: ../images/system-dialogues/OfflineAcmResult.png
When a participant state is marked 'OFF_LINE', it might come back ONLINE and the user can trigger state change events to the ACM.
End of Document
|
