aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/api-protocol
diff options
context:
space:
mode:
authorFrancescoFioraEst <francesco.fiora@est.tech>2024-08-19 10:11:56 +0100
committerFrancesco Fiora <francesco.fiora@est.tech>2024-08-20 14:46:37 +0000
commitea9018a2a5c5596be978b7a8dff89b52442d23ab (patch)
treee752488b5f565a147d06a10feca37ec114529423 /docs/clamp/acm/api-protocol
parentc6a838fe921454dd8069ab8126d4c710a1b5397c (diff)
Update docs for prepare review migration-precheck in ACM runtime
Update docs for prepare, review, migration-precheck and using stage in ACM states and ACM runtime. Issue-ID: POLICY-5109 Change-Id: I059a57d406f9588ef11a694882e7324dad643805 Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
Diffstat (limited to 'docs/clamp/acm/api-protocol')
-rw-r--r--docs/clamp/acm/api-protocol/system-level-dialogues.rst71
1 files changed, 58 insertions, 13 deletions
diff --git a/docs/clamp/acm/api-protocol/system-level-dialogues.rst b/docs/clamp/acm/api-protocol/system-level-dialogues.rst
index f3612b49..ec03353c 100644
--- a/docs/clamp/acm/api-protocol/system-level-dialogues.rst
+++ b/docs/clamp/acm/api-protocol/system-level-dialogues.rst
@@ -133,7 +133,22 @@ The ACM Runtime receives and stores the responses, when all instances element ar
.. image:: ../images/system-dialogues/DeleteResponseStored.png
-3.3 Deploy Automation Composition Instance
+3.3 Prepare Automation Composition Instance
+-------------------------------------------
+Prepare is a check system from participant before the deployment of an instance, the result will stored in outProperties and not other changes are allowed.
+The user requests the AC Instance to be prepared using a REST endpoint. The ACM Runtime orders the AC Instance to be prepared to Participants.
+
+.. image:: ../images/system-dialogues/PrepareAcInstance.png
+
+Each participant prepares its AC Element Instances from the AC Instance.
+
+.. image:: ../images/system-dialogues/PrepareAcInstanceElements.png
+
+The ACM Runtime receives and stores the responses, and send sync message to all replicas.
+
+.. image:: ../images/system-dialogues/PrepareResponseStored.png
+
+3.4 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.
@@ -147,7 +162,22 @@ The ACM Runtime receives and stores the responses, and send sync message to all
.. image:: ../images/system-dialogues/DeployResponseStored.png
-3.4 Update Automation Composition Instance
+3.5 Review Automation Composition Instance
+------------------------------------------
+Review is a check system from participant after the deployment of an instance, the result will stored in outProperties and not other changes are allowed.
+The user requests the AC Instance to be Reviewed using a REST endpoint. The ACM Runtime orders the AC Instance to be reviewed to Participants.
+
+.. image:: ../images/system-dialogues/ReviewAcInstance.png
+
+Each participant reviews its AC Element Instances from the AC Instance.
+
+.. image:: ../images/system-dialogues/ReviewAcInstanceElements.png
+
+The ACM Runtime receives and stores the responses, and send sync message to all replicas.
+
+.. image:: ../images/system-dialogues/ReviewResponseStored.png
+
+3.6 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.
@@ -161,7 +191,22 @@ The ACM Runtime receives and stores the responses, and send sync message to all
.. image:: ../images/system-dialogues/UpdateAcElementsResponse.png
-3.5 Migrate Automation Composition Instance
+3.7 Migration Precheck Automation Composition Instance
+------------------------------------------------------
+Migration Precheck is a check system from participant before the migration of an instance, the result will stored in outProperties and not other changes are allowed.
+The user requests a Migration Precheck for the AC Instance using a REST endpoint. The ACM Runtime orders the Migration Precheck for AC Instance to Participants.
+
+.. image:: ../images/system-dialogues/MigrationPrecheckAcInstance.png
+
+Each participant execute a Migration Precheck to its AC Element Instances from the AC Instance.
+
+.. image:: ../images/system-dialogues/MigrationPrecheckAcInstanceElements.png
+
+The ACM Runtime receives and stores the responses, and send sync message to all replicas.
+
+.. image:: ../images/system-dialogues/MigrationPrecheckResponseStored.png
+
+3.8 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.
@@ -175,7 +220,7 @@ The ACM Runtime receives and stores the responses, and send sync message to all
.. image:: ../images/system-dialogues/MigrateAcElementsResponse.png
-3.6 Undeploy Automation Composition Instance
+3.9 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.
@@ -189,13 +234,13 @@ The ACM Runtime receives and stores the responses, and send sync message to all
.. image:: ../images/system-dialogues/UndeployResponseStored.png
-3.7 Read Automation Composition Instances
------------------------------------------
+3.10 Read Automation Composition Instances
+------------------------------------------
.. image:: ../images/system-dialogues/ReadAcInstances.png
-3.8 Unlock Automation Composition Instance
-------------------------------------------
+3.11 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
@@ -208,8 +253,8 @@ The ACM Runtime receives and stores the responses, and send sync message to all
.. image:: ../images/system-dialogues/UnlockResponseStored.png
-3.9 Lock Automation Composition Instance
-----------------------------------------
+3.12 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
@@ -222,12 +267,12 @@ The ACM Runtime receives and stores the responses, and send sync message to all
.. image:: ../images/system-dialogues/LockResponseStored.png
-3.10 Update Operational State, Use State and outProperties on Automation Composition Instance
+3.13 Update Operational State, Use State and outProperties on Automation Composition Instance
---------------------------------------------------------------------------------------------
.. image:: ../images/system-dialogues/UpdateOperationalState.png
-3.11 Failure handling in ACM
+3.14 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.
@@ -272,7 +317,7 @@ The following flow shown and example of deployment that get stuck, and the user
.. image:: ../images/system-dialogues/TimeoutParticipant.png
-3.12 OFF_LINE handling in ACM
+3.15 OFF_LINE handling in ACM
-----------------------------
Runtime marks the participant state with the value 'OFF_LINE' when the participant replica fails to report the periodic heartbeat,
the participant replica state is then marked as 'OFF_LINE' by the ACM-R after the configured waiting limit is reached.