aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/allowed-operations.rst
blob: 62de7ffc67c508db31d2b2d4a0043c64169e772b (plain)
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
.. This work is licensed under a Creative Commons Attribution 4.0 International License.

.. _allowed-operations-label:

Allowed operations in ACM
#########################

.. contents::
    :depth: 4

CRUD Automation Composition Definition
--------------------------------------

+------------+--------------+----------------------------------+
| **Action** | **state**    | **Description**                  |
+------------+--------------+----------------------------------+
|   Create   |              |  Create new AC Definition        |
+------------+--------------+----------------------------------+
|   Update   | COMMISSIONED |  Update the AC Definition        |
+------------+--------------+----------------------------------+
|   Delete   | COMMISSIONED |  Delete the AC Definition        |
+------------+--------------+----------------------------------+

Change status of Automation Composition Definition
--------------------------------------------------

+------------+--------------+---------------------+-------------------------------------------------------+
| **Action** | **state**    |   **stChResult**    | **Description**                                       |
+------------+--------------+---------------------+-------------------------------------------------------+
|            | COMMISSIONED |                     | Start Priming transition                              |
+            +--------------+---------------------+-------------------------------------------------------+
|            | PRIMING      |   FAILED            | Start Priming transition after PRIMING is failed      |
+   Prime    +--------------+---------------------+-------------------------------------------------------+
|            | PRIMING      |   TIMEOUT           | Start Priming transition after PRIMING got timeout    |
+            +--------------+---------------------+-------------------------------------------------------+
|            | DEPRIMING    |   FAILED            | Start Priming transition after DEPRIMING is failed    |
+            +--------------+---------------------+-------------------------------------------------------+
|            | DEPRIMING    |   TIMEOUT           | Start Priming transition after DEPRIMING got timeout  |
+------------+--------------+---------------------+-------------------------------------------------------+
|            | PRIMED       |   NO_ERROR          | Start Depriming the AC Definition.                    |
|            |              |                     | No instances connected to this AC Definition.         |
+            +--------------+---------------------+-------------------------------------------------------+
|            | DEPRIMING    |   FAILED            | Start Depriming after DEPRIMING is failed             |
+  Deprime   +--------------+---------------------+-------------------------------------------------------+
|            | DEPRIMING    |   TIMEOUT           | Start Depriming after DEPRIMING got timeout           |
+            +--------------+---------------------+-------------------------------------------------------+
|            | PRIMING      |   FAILED            | Start Depriming after PRIMING is failed               |
+            +--------------+---------------------+-------------------------------------------------------+
|            | PRIMING      |   TIMEOUT           | Start Depriming after PRIMING got timeout             |
+------------+--------------+---------------------+-------------------------------------------------------+

**Note**: "stChResult" = stateChangeResult.

CRUD Automation Composition Instance
------------------------------------
AC Definition is PRIMED with NO_ERROR.

+------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
| **Action** | **deployState** | **lockState** | **stChResult** | **Description**                                                                      |
+------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
| Create     |                 |               |                | Create a new AC instance                                                             |
+------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
| Update     | UNDEPLOYED      |               |                | Update the AC Instance                                                               |
+            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
|            | DEPLOYED        |  LOCKED       |                | Update the AC Instance and send update to participants                               |
+            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
|            | UPDATING        |  LOCKED       |  FAILED        | Start Updating transition and send update to participants after UPDATING is failed   |
+            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
|            | UPDATING        |  LOCKED       |  TIMEOUT       | Start Updating transition and send update to participants after UPDATING got timeout |
+------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
| Migrate    | DEPLOYED	       |  LOCKED       |                | Start Migrating transition and send migrate to participants                          |
+------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
|            | UNDEPLOYED      |               |                | Start Deleting transition and send delete to participants                            |
+            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
| Delete     | DELETING        |  NONE         |  FAILED        | Start Deleting transition and send delete to participants after DELETING is failed   |
+            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+
|            | DELETING        |  NONE         |  TIMEOUT       | Start Deleting transition and send delete to participants after DELETING got timeout |
+------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+

Change status of Automation Composition Instance
------------------------------------------------

+------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
| **Action** | **deployState** | **lockState** | **stChResult** | **Description**                                                                             |
+------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | UNDEPLOYED      |               |                | Start Deploying transition and send deploy to participants                                  |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYING       |  NONE         |  FAILED        | Start Deploying transition and send deploy to participants after DEPLOYING is failed        |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|  Deploy    | DEPLOYING       |  NONE         |  TIMEOUT       | Start Deploying transition and send deploy to participants after DEPLOYING got timeout      |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | UNDEPLOYING     |  NONE         |  FAILED        | Start Deploying transition and send deploy to participants after UNDEPLOYING is failed      |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | UNDEPLOYING     |  NONE         |  TIMEOUT       | Start Deploying transition and send deploy to participants after UNDEPLOYING got timeout    |
+------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        |  LOCKED       |                | Start Undeploying transition and send undeploy to participants                              |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYING       |  NONE         |  FAILED        | Start Undeploying transition and send undeploy to participants after DEPLOYING is failed    |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | UNDEPLOYING     |  NONE         |  FAILED        | Start Undeploying transition and send undeploy to participants after UNDEPLOYING is failed  |
+  Undeploy  +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | UNDEPLOYING     |  NONE         |  TIMEOUT       | Start Undeploying transition and send undeploy to participants after UNDEPLOYING got timeout|
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | UPDATING        |  LOCKED       |  FAILED        | Start Undeploying transition and send update to participants after UPDATING is failed       |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | UPDATING        |  LOCKED       |  TIMEOUT       | Start Undeploying transition and send update to participants after UPDATING got timeout     |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | MIGRATING       |  LOCKED       |  FAILED        | Start Undeploying transition and send update to participants after MIGRATING is failed      |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | MIGRATING       |  LOCKED       |  TIMEOUT       | Start Undeploying transition and send update to participants after MIGRATING got timeout    |
+------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        |  UNLOCKED     |                | Start Locking transition and send lock to participants                                      |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        |  UNLOCKING    |  FAILED        | Start Locking transition and send lock to participants after UNLOCKING is failed            |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|   Lock     | DEPLOYED        |  UNLOCKING    |  TIMEOUT       | Start Locking transition and send lock to participants after UNLOCKING got timeout          |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        |  LOCKING      |  FAILED        | Start Locking transition and send lock to participants after LOCKING is failed              |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        |  LOCKING      |  TIMEOUT       | Start Locking transition and send lock to participants after LOCKING got timeout            |
+------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        | LOCKED        |                | Start Unlocking transition and send unlock to participants                                  |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        | UNLOCKING     |  FAILED        | Start Unlocking transition and send unlock to participants after UNLOCKING is failed        |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|  Unlock    | DEPLOYED        | UNLOCKING     |  TIMEOUT       | Start Unlocking transition and send unlock to participants after UNLOCKING got timeout      |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        | LOCKING       |  FAILED        | Start Unlocking transition and send unlock to participants after LOCKING is failed          |
+            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+
|            | DEPLOYED        | LOCKING       |  TIMEOUT       | Start Unlocking transition and send unlock to participants after LOCKING got timeout        |
+------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+