From 99a61c4ca3cd02424c90894199627843c8d79b1c Mon Sep 17 00:00:00 2001
From: FrancescoFioraEst <francesco.fiora@est.tech>
Date: Fri, 23 Feb 2024 15:50:13 +0000
Subject: Update documentation for timeout in system level dialogues

Issue-ID: POLICY-4936
Change-Id: I525c33f3d8ac0847676f185c5a8173c41cba9aff
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
---
 .../system-dialogues/OfflineAcmResult.puml         | 19 ++++++++++
 .../system-dialogues/TimeoutAcmResult.puml         | 17 +++++++++
 .../system-dialogues/TimeoutParticipant.puml       | 42 ++++++++++++++++++++++
 3 files changed, 78 insertions(+)
 create mode 100644 docs/clamp/acm/plantuml/system-dialogues/OfflineAcmResult.puml
 create mode 100644 docs/clamp/acm/plantuml/system-dialogues/TimeoutAcmResult.puml
 create mode 100644 docs/clamp/acm/plantuml/system-dialogues/TimeoutParticipant.puml

(limited to 'docs/clamp/acm/plantuml')

diff --git a/docs/clamp/acm/plantuml/system-dialogues/OfflineAcmResult.puml b/docs/clamp/acm/plantuml/system-dialogues/OfflineAcmResult.puml
new file mode 100644
index 00000000..1cbdaa51
--- /dev/null
+++ b/docs/clamp/acm/plantuml/system-dialogues/OfflineAcmResult.puml
@@ -0,0 +1,19 @@
+@startuml
+
+  Rest -> "ACM Runtime": ACM operation triggered by the user
+  activate "ACM Runtime"
+  "ACM Runtime" -> "ACM Database": Read Automation Composition information
+  activate Participant
+  "ACM Runtime" -> Participant : [ASYNC] Send the state change event to the participant
+  "ACM Runtime" -> "ACM Database": Mark the AC element into transitioning state
+  deactivate  "ACM Runtime"
+  Participant -> Participant: Goes OFF_LINE due to an unexpected error
+  deactivate Participant
+
+  activate "ACM Runtime"
+  "ACM Runtime" -> "ACM Database": Mark OFF_LINE reached for the participant status report
+  "ACM Runtime" -> "ACM Database": Mark TIMEOUT reached for the AC instance
+  deactivate  "ACM Runtime"
+
+
+@enduml
diff --git a/docs/clamp/acm/plantuml/system-dialogues/TimeoutAcmResult.puml b/docs/clamp/acm/plantuml/system-dialogues/TimeoutAcmResult.puml
new file mode 100644
index 00000000..25209d0d
--- /dev/null
+++ b/docs/clamp/acm/plantuml/system-dialogues/TimeoutAcmResult.puml
@@ -0,0 +1,17 @@
+@startuml
+
+  Rest -> "ACM Runtime": ACM operation triggered by the user
+  activate "ACM Runtime"
+  "ACM Runtime" -> "ACM Database": Read Automation Composition information
+  activate Participant
+  "ACM Runtime" -> Participant : [ASYNC] Send the state change event to the participant
+  "ACM Runtime" -> "ACM Database": Mark the AC element into transitioning state
+  deactivate  "ACM Runtime"
+  Participant -> Participant: state change operation get stuck
+  deactivate Participant
+
+  activate "ACM Runtime"
+  "ACM Runtime" -> "ACM Database": Mark TIMEOUT reached for the AC instance
+  deactivate  "ACM Runtime"
+
+@enduml
diff --git a/docs/clamp/acm/plantuml/system-dialogues/TimeoutParticipant.puml b/docs/clamp/acm/plantuml/system-dialogues/TimeoutParticipant.puml
new file mode 100644
index 00000000..c88cd04b
--- /dev/null
+++ b/docs/clamp/acm/plantuml/system-dialogues/TimeoutParticipant.puml
@@ -0,0 +1,42 @@
+@startuml
+
+alt "Deploying the instance"
+  Rest -> "ACM Runtime": Deploy triggered by the user
+  activate "ACM Runtime"
+  "ACM Runtime" -> "Participant-intermediary" : [ASYNC] Deploying the instance
+  deactivate  "ACM Runtime"
+
+  activate "Participant-intermediary"
+  activate Participant
+  "Participant-intermediary" -> Participant : Create Deploy thread
+  deactivate "Participant-intermediary"
+  note right
+  Deploy thread is stuck
+  end note
+end
+
+alt "Instance in Timeout"
+  activate "ACM Runtime"
+  "ACM Runtime" -> "ACM Runtime" : set instance in Timeout
+  deactivate  "ACM Runtime"
+end
+
+alt "Undeploying the instance"
+  Rest -> "ACM Runtime": Undeploy triggered by the user
+  activate "ACM Runtime"
+  activate "Participant-intermediary"
+  "ACM Runtime" -> "Participant-intermediary" : [ASYNC] Undeploying the instance
+  deactivate  "ACM Runtime"
+  "Participant-intermediary" -> Participant : Terminate Deploy thread
+  deactivate Participant
+  "Participant-intermediary" -> Participant : Create Undeploy thread
+  activate Participant
+  deactivate "Participant-intermediary"
+  Participant -> "Participant-intermediary" : instance Undeployed
+  activate "Participant-intermediary"
+  deactivate Participant
+  "Participant-intermediary" -> "ACM Runtime" : [ASYNC] instance Undeployed
+  deactivate "Participant-intermediary"
+end
+
+@enduml
-- 
cgit 1.2.3-korg