diff options
Diffstat (limited to 'docs/clamp/acm')
15 files changed, 139 insertions, 10 deletions
diff --git a/docs/clamp/acm/acm-states.rst b/docs/clamp/acm/acm-states.rst index f6a10e66..215baf71 100644 --- a/docs/clamp/acm/acm-states.rst +++ b/docs/clamp/acm/acm-states.rst @@ -19,7 +19,7 @@ Participant states are NOT managed by ACM but the state of a participant is reco Automation Composition Type State ================================= -The states that an Automation Composition Type can have are shown in the diagram below. +The states that an Automation Composition Type can have, are shown in the diagram below. .. image:: images/acm-states/AcTypeStates.png @@ -33,6 +33,11 @@ The states that an Automation Composition Element Type can have on a Participant .. image:: images/acm-states/AcElementTypeStatesOnPpnt.png +The states diagram below, shows the fail and timeout scenario. +In that diagram the state is presented using this combination [ Composition Element Type State : Composition Type State : StateChangeResult ]. + +.. image:: images/acm-states/AcTypeStatesFail.png + Automation Composition Instance State ===================================== The states that an Automation Composition Instance can have are shown in the diagram below. @@ -49,4 +54,29 @@ The states that an Automation Composition Element Instance can have on a Partici .. image:: images/acm-states/AcElementInstanceStatesOnPpnt.png +Automation Composition State with fail and timeout +================================================== +The states that an Automation Composition Element Instance can have for each flow, are shown in the diagrams below. +For each diagram the state is presented using this combination [ Instance Element State : Instance State : StateChangeResult ]. + +Deploy +------ + +.. image:: images/acm-states/AcInstanceStatesDeploy.png + +Update +------ + +.. image:: images/acm-states/AcInstanceStatesUpdate.png + +Migrate +------- + +.. image:: images/acm-states/AcInstanceStatesMigrate.png + +Delete +------ + +.. image:: images/acm-states/AcInstanceStatesDelete.png + End of Document diff --git a/docs/clamp/acm/images/acm-states/AcElementInstanceStatesOnRuntime.png b/docs/clamp/acm/images/acm-states/AcElementInstanceStatesOnRuntime.png Binary files differindex ca9b2c1e..8d1ace14 100644 --- a/docs/clamp/acm/images/acm-states/AcElementInstanceStatesOnRuntime.png +++ b/docs/clamp/acm/images/acm-states/AcElementInstanceStatesOnRuntime.png diff --git a/docs/clamp/acm/images/acm-states/AcInstanceStates.png b/docs/clamp/acm/images/acm-states/AcInstanceStates.png Binary files differindex 72dff824..ef17ba7a 100644 --- a/docs/clamp/acm/images/acm-states/AcInstanceStates.png +++ b/docs/clamp/acm/images/acm-states/AcInstanceStates.png diff --git a/docs/clamp/acm/images/acm-states/AcInstanceStatesDelete.png b/docs/clamp/acm/images/acm-states/AcInstanceStatesDelete.png Binary files differnew file mode 100644 index 00000000..29c96b53 --- /dev/null +++ b/docs/clamp/acm/images/acm-states/AcInstanceStatesDelete.png diff --git a/docs/clamp/acm/images/acm-states/AcInstanceStatesDeploy.png b/docs/clamp/acm/images/acm-states/AcInstanceStatesDeploy.png Binary files differnew file mode 100644 index 00000000..412dcc3b --- /dev/null +++ b/docs/clamp/acm/images/acm-states/AcInstanceStatesDeploy.png diff --git a/docs/clamp/acm/images/acm-states/AcInstanceStatesMigrate.png b/docs/clamp/acm/images/acm-states/AcInstanceStatesMigrate.png Binary files differnew file mode 100644 index 00000000..205c2e95 --- /dev/null +++ b/docs/clamp/acm/images/acm-states/AcInstanceStatesMigrate.png diff --git a/docs/clamp/acm/images/acm-states/AcInstanceStatesUpdate.png b/docs/clamp/acm/images/acm-states/AcInstanceStatesUpdate.png Binary files differnew file mode 100644 index 00000000..e5f85024 --- /dev/null +++ b/docs/clamp/acm/images/acm-states/AcInstanceStatesUpdate.png diff --git a/docs/clamp/acm/images/acm-states/AcTypeStatesFail.png b/docs/clamp/acm/images/acm-states/AcTypeStatesFail.png Binary files differnew file mode 100644 index 00000000..6a9bc59a --- /dev/null +++ b/docs/clamp/acm/images/acm-states/AcTypeStatesFail.png diff --git a/docs/clamp/acm/plantuml/states/AcElementInstanceStatesOnRuntime.puml b/docs/clamp/acm/plantuml/states/AcElementInstanceStatesOnRuntime.puml index c27b320c..13faeacf 100644 --- a/docs/clamp/acm/plantuml/states/AcElementInstanceStatesOnRuntime.puml +++ b/docs/clamp/acm/plantuml/states/AcElementInstanceStatesOnRuntime.puml @@ -3,20 +3,24 @@ [*] --> UNDEPLOYED: Create UNDEPLOYED --> [*]: Delete UNDEPLOYED --> DEPLOYING: Deploy -DEPLOYING --> DEPLOYED: AC Element\nInstance DEPLOYED +DEPLOYING --> DEPLOYED: AC Instance\nElement DEPLOYED DEPLOYING --> UNDEPLOYING: Undeploy DEPLOYED --> UNDEPLOYING: Undeploy -UNDEPLOYING --> UNDEPLOYED: AC Element\nInstance UNDEPLOYED +DEPLOYED --> UPDATING: Update +DEPLOYED --> MIGRATING: Migrate +MIGRATING --> DEPLOYED: AC Instance\nElement MIGRATED +UNDEPLOYING --> UNDEPLOYED: AC Instance\nElement UNDEPLOYED +UNDEPLOYING --> UNDEPLOYED: AC Instance\nElement UNDEPLOYED state DEPLOYED { [*] --> LOCKED: Deploy LOCKED --> [*]: Undeploy LOCKED --> UNLOCKING: Unlock - UNLOCKING --> UNLOCKED: AC Element\nInstance UNLOCKED + UNLOCKING --> UNLOCKED: AC Instance\nElement UNLOCKED UNLOCKED --> LOCKING: Lock UNLOCKING --> LOCKING: Lock - LOCKING --> LOCKED: AC Element\nInstance LOCKED + LOCKING --> LOCKED: AC Instance\nElement LOCKED } @enduml diff --git a/docs/clamp/acm/plantuml/states/AcInstanceStates.puml b/docs/clamp/acm/plantuml/states/AcInstanceStates.puml index 17958411..f8483ffe 100644 --- a/docs/clamp/acm/plantuml/states/AcInstanceStates.puml +++ b/docs/clamp/acm/plantuml/states/AcInstanceStates.puml @@ -3,20 +3,23 @@ [*] --> UNDEPLOYED: Create UNDEPLOYED --> [*]: Delete UNDEPLOYED --> DEPLOYING: Deploy -DEPLOYING --> DEPLOYED: AC Element Instances\nall DEPLOYED +DEPLOYING --> DEPLOYED: AC Instance Elements\nall DEPLOYED DEPLOYING --> UNDEPLOYING: Undeploy DEPLOYED --> UNDEPLOYING: Undeploy -UNDEPLOYING --> UNDEPLOYED: AC Element Types\nall UNDEPLOYED - +DEPLOYED --> UPDATING: Update +DEPLOYED --> MIGRATING: Migrate +UPDATING --> DEPLOYED: AC Instance Elements\nall UPDATED +MIGRATING --> DEPLOYED: AC Instance Elements\nall MIGRATED +UNDEPLOYING --> UNDEPLOYED: AC Instance Elements\nall UNDEPLOYED state DEPLOYED { [*] --> LOCKED: Deploy LOCKED --> [*]: Undeploy LOCKED --> UNLOCKING: Unlock - UNLOCKING --> UNLOCKED: AC Element Types\nall UNLOCKED + UNLOCKING --> UNLOCKED: AC Instance Elements\nall UNLOCKED UNLOCKED --> LOCKING: Lock UNLOCKING --> LOCKING: Lock - LOCKING --> LOCKED: AC Element Types\nall LOCKED + LOCKING --> LOCKED: AC Instance Elements\nall LOCKED } @enduml diff --git a/docs/clamp/acm/plantuml/states/AcInstanceStatesDelete.puml b/docs/clamp/acm/plantuml/states/AcInstanceStatesDelete.puml new file mode 100644 index 00000000..c6dae42d --- /dev/null +++ b/docs/clamp/acm/plantuml/states/AcInstanceStatesDelete.puml @@ -0,0 +1,12 @@ +@startuml + +UNDEPLOYED:UNDEPLOYED:NO_ERROR --> DELETING:DELETING: Delete +DELETING:DELETING --> UNDEPLOYED:DELETING:FAILED: Delete failed +DELETING:DELETING --> DELETING:DELETING:TIMEOUT +DELETING:DELETING --> [*]: Deleted +UNDEPLOYED:DELETING:FAILED --> DELETING:DELETING: Delete +DELETING:DELETING:TIMEOUT --> UNDEPLOYED:DELETING:FAILED: Delete failed +DELETING:DELETING:TIMEOUT --> DELETING:DELETING: Delete +DELETING:DELETING:TIMEOUT --> [*]: Deleted + +@enduml diff --git a/docs/clamp/acm/plantuml/states/AcInstanceStatesDeploy.puml b/docs/clamp/acm/plantuml/states/AcInstanceStatesDeploy.puml new file mode 100644 index 00000000..1d0f0920 --- /dev/null +++ b/docs/clamp/acm/plantuml/states/AcInstanceStatesDeploy.puml @@ -0,0 +1,25 @@ +@startuml + +[*] --> UNDEPLOYED:UNDEPLOYED:NO_ERROR: Create +UNDEPLOYED:UNDEPLOYED:NO_ERROR --> [*]: Delete +UNDEPLOYED:UNDEPLOYED:NO_ERROR --> DEPLOYING:DEPLOYING: Deploy +DEPLOYING:DEPLOYING --> DEPLOYED:DEPLOYED:NO_ERROR: Deployed +DEPLOYING:DEPLOYING --> UNDEPLOYED:DEPLOYING:FAILED: Deploy failed +DEPLOYING:DEPLOYING --> DEPLOYING:DEPLOYING:TIMEOUT: Deploy timeout +DEPLOYING:DEPLOYING:TIMEOUT --> DEPLOYED:DEPLOYED:NO_ERROR: Deployed +DEPLOYING:DEPLOYING:TIMEOUT --> UNDEPLOYED:DEPLOYING:FAILED: Deploy failed +DEPLOYING:DEPLOYING:TIMEOUT --> DEPLOYING:DEPLOYING: Deploy +UNDEPLOYED:DEPLOYING:FAILED --> DEPLOYING:DEPLOYING: Deploy +UNDEPLOYED:DEPLOYING:FAILED --> UNDEPLOYING:UNDEPLOYING: Undeploy +DEPLOYED:DEPLOYED:NO_ERROR --> UNDEPLOYING:UNDEPLOYING: Undeploy +UNDEPLOYING:UNDEPLOYING --> UNDEPLOYED:UNDEPLOYED:NO_ERROR: Undeployed +UNDEPLOYING:UNDEPLOYING --> DEPLOYED:UNDEPLOYING:FAILED: Undeploy failed +UNDEPLOYING:UNDEPLOYING --> UNDEPLOYING:UNDEPLOYING:TIMEOUT: Undeploy timeout +DEPLOYED:UNDEPLOYING:FAILED --> UNDEPLOYING:UNDEPLOYING: Undeploy +DEPLOYED:UNDEPLOYING:FAILED --> DEPLOYING:DEPLOYING: Deploy +UNDEPLOYING:UNDEPLOYING:TIMEOUT --> UNDEPLOYED:UNDEPLOYED:NO_ERROR: Undeployed +UNDEPLOYING:UNDEPLOYING:TIMEOUT --> DEPLOYED:UNDEPLOYING:FAILED: Undeploy failed +UNDEPLOYING:UNDEPLOYING:TIMEOUT --> UNDEPLOYING:UNDEPLOYING: Undeploy +UNDEPLOYING:UNDEPLOYING:TIMEOUT --> DEPLOYING:DEPLOYING: Deploy + +@enduml diff --git a/docs/clamp/acm/plantuml/states/AcInstanceStatesMigrate.puml b/docs/clamp/acm/plantuml/states/AcInstanceStatesMigrate.puml new file mode 100644 index 00000000..b3875e81 --- /dev/null +++ b/docs/clamp/acm/plantuml/states/AcInstanceStatesMigrate.puml @@ -0,0 +1,12 @@ +@startuml + +DEPLOYED:DEPLOYED:NO_ERROR --> MIGRATING:MIGRATING: Migrate +MIGRATING:MIGRATING --> DEPLOYED:DEPLOYED:NO_ERROR: Migrated +MIGRATING:MIGRATING --> DEPLOYED:MIGRATING:FAILED: Migrate failed +MIGRATING:MIGRATING --> MIGRATING:MIGRATING:TIMEOUT: Migrate timeout +DEPLOYED:MIGRATING:FAILED --> UNDEPLOYING:UNDEPLOYING: Undeploy +MIGRATING:MIGRATING:TIMEOUT --> DEPLOYED:MIGRATING:FAILED: Migrate failed +MIGRATING:MIGRATING:TIMEOUT --> UNDEPLOYING:UNDEPLOYING: Undeploy +MIGRATING:MIGRATING:TIMEOUT --> DEPLOYED:DEPLOYED:NO_ERROR: Migrated + +@enduml diff --git a/docs/clamp/acm/plantuml/states/AcInstanceStatesUpdate.puml b/docs/clamp/acm/plantuml/states/AcInstanceStatesUpdate.puml new file mode 100644 index 00000000..f5531b4c --- /dev/null +++ b/docs/clamp/acm/plantuml/states/AcInstanceStatesUpdate.puml @@ -0,0 +1,14 @@ +@startuml + +DEPLOYED:DEPLOYED:NO_ERROR --> UPDATING:UPDATING: Update +UPDATING:UPDATING --> DEPLOYED:DEPLOYED:NO_ERROR: Updated +UPDATING:UPDATING --> DEPLOYED:UPDATING:FAILED: Update failed +UPDATING:UPDATING --> UPDATING:UPDATING:TIMEOUT: Update timeout +DEPLOYED:UPDATING:FAILED --> UPDATING:UPDATING: Update +DEPLOYED:UPDATING:FAILED --> UNDEPLOYING:UNDEPLOYING: Undeploy +UPDATING:UPDATING:TIMEOUT --> UPDATING:UPDATING: Update +UPDATING:UPDATING:TIMEOUT --> DEPLOYED:UPDATING:FAILED: Update failed +UPDATING:UPDATING:TIMEOUT --> UNDEPLOYING:UNDEPLOYING: Undeploy +UPDATING:UPDATING:TIMEOUT --> DEPLOYED:DEPLOYED:NO_ERROR: Updated + +@enduml diff --git a/docs/clamp/acm/plantuml/states/AcTypeStatesFail.puml b/docs/clamp/acm/plantuml/states/AcTypeStatesFail.puml new file mode 100644 index 00000000..d9ff69bf --- /dev/null +++ b/docs/clamp/acm/plantuml/states/AcTypeStatesFail.puml @@ -0,0 +1,29 @@ +@startuml + +COMMISSIONED:COMMISSIONED:NO_ERROR --> PRIMING:PRIMING: Prime + +PRIMING:PRIMING --> PRIMED:PRIMED:NO_ERROR: AC Element Types\nall PRIMED +PRIMING:PRIMING --> COMMISSIONED:PRIMING:FAIL: Prime Failed +PRIMING:PRIMING --> PRIMING:PRIMING:TIMEOUT: Prime Timeout + +COMMISSIONED:PRIMING:FAIL --> DEPRIMING:DEPRIMING: Deprime +COMMISSIONED:PRIMING:FAIL --> PRIMING:PRIMING: Prime Again + +PRIMING:PRIMING:TIMEOUT --> DEPRIMING:DEPRIMING: Deprime +PRIMING:PRIMING:TIMEOUT --> PRIMING:PRIMING: Prime Again +PRIMING:PRIMING:TIMEOUT --> PRIMED:PRIMED:NO_ERROR: AC Element Types\nall PRIMED + +DEPRIMING:DEPRIMING --> COMMISSIONED:COMMISSIONED:NO_ERROR: AC Element Types\nall DEPRIMED +DEPRIMING:DEPRIMING --> PRIMED:DEPRIMING:FAIL: Deprime Failed +DEPRIMING:DEPRIMING --> DEPRIMING:DEPRIMING:TIMEOUT: Deprime Timeout + +PRIMED:DEPRIMING:FAIL --> DEPRIMING:DEPRIMING: Deprime Again +PRIMED:DEPRIMING:FAIL --> PRIMING:PRIMING: Prime + +DEPRIMING:DEPRIMING:TIMEOUT --> DEPRIMING:DEPRIMING: Deprime Again +DEPRIMING:DEPRIMING:TIMEOUT --> PRIMING:PRIMING: Prime +DEPRIMING:DEPRIMING:TIMEOUT --> COMMISSIONED:COMMISSIONED:NO_ERROR: AC Element Types\nall DEPRIMED + +PRIMED:PRIMED:NO_ERROR --> DEPRIMING:DEPRIMING: Deprime + +@enduml |
