Add allowed operations in docs

Issue-ID: POLICY-4897
Change-Id: I3656d0a0f1e480e202930d5b8fd8d376b2520c52
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>

diff --git a/docs/clamp/acm/allowed-operations.rst b/docs/clamp/acm/allowed-operations.rst
new file mode 100755 (executable)
index 0000000..62de7ff
--- /dev/null
+++ b/docs/clamp/acm/allowed-operations.rst
@@ -0,0 +1,131 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+\r
+.. _allowed-operations-label:\r
+\r
+Allowed operations in ACM\r
+#########################\r
+\r
+.. contents::\r
+    :depth: 4\r
+\r
+CRUD Automation Composition Definition\r
+--------------------------------------\r
+\r
++------------+--------------+----------------------------------+\r
+| **Action** | **state**    | **Description**                  |\r
++------------+--------------+----------------------------------+\r
+|   Create   |              |  Create new AC Definition        |\r
++------------+--------------+----------------------------------+\r
+|   Update   | COMMISSIONED |  Update the AC Definition        |\r
++------------+--------------+----------------------------------+\r
+|   Delete   | COMMISSIONED |  Delete the AC Definition        |\r
++------------+--------------+----------------------------------+\r
+\r
+Change status of Automation Composition Definition\r
+--------------------------------------------------\r
+\r
++------------+--------------+---------------------+-------------------------------------------------------+\r
+| **Action** | **state**    |   **stChResult**    | **Description**                                       |\r
++------------+--------------+---------------------+-------------------------------------------------------+\r
+|            | COMMISSIONED |                     | Start Priming transition                              |\r
++            +--------------+---------------------+-------------------------------------------------------+\r
+|            | PRIMING      |   FAILED            | Start Priming transition after PRIMING is failed      |\r
++   Prime    +--------------+---------------------+-------------------------------------------------------+\r
+|            | PRIMING      |   TIMEOUT           | Start Priming transition after PRIMING got timeout    |\r
++            +--------------+---------------------+-------------------------------------------------------+\r
+|            | DEPRIMING    |   FAILED            | Start Priming transition after DEPRIMING is failed    |\r
++            +--------------+---------------------+-------------------------------------------------------+\r
+|            | DEPRIMING    |   TIMEOUT           | Start Priming transition after DEPRIMING got timeout  |\r
++------------+--------------+---------------------+-------------------------------------------------------+\r
+|            | PRIMED       |   NO_ERROR          | Start Depriming the AC Definition.                    |\r
+|            |              |                     | No instances connected to this AC Definition.         |\r
++            +--------------+---------------------+-------------------------------------------------------+\r
+|            | DEPRIMING    |   FAILED            | Start Depriming after DEPRIMING is failed             |\r
++  Deprime   +--------------+---------------------+-------------------------------------------------------+\r
+|            | DEPRIMING    |   TIMEOUT           | Start Depriming after DEPRIMING got timeout           |\r
++            +--------------+---------------------+-------------------------------------------------------+\r
+|            | PRIMING      |   FAILED            | Start Depriming after PRIMING is failed               |\r
++            +--------------+---------------------+-------------------------------------------------------+\r
+|            | PRIMING      |   TIMEOUT           | Start Depriming after PRIMING got timeout             |\r
++------------+--------------+---------------------+-------------------------------------------------------+\r
+\r
+**Note**: "stChResult" = stateChangeResult.\r
+\r
+CRUD Automation Composition Instance\r
+------------------------------------\r
+AC Definition is PRIMED with NO_ERROR.\r
+\r
++------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+| **Action** | **deployState** | **lockState** | **stChResult** | **Description**                                                                      |\r
++------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+| Create     |                 |               |                | Create a new AC instance                                                             |\r
++------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+| Update     | UNDEPLOYED      |               |                | Update the AC Instance                                                               |\r
++            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        |  LOCKED       |                | Update the AC Instance and send update to participants                               |\r
++            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+|            | UPDATING        |  LOCKED       |  FAILED        | Start Updating transition and send update to participants after UPDATING is failed   |\r
++            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+|            | UPDATING        |  LOCKED       |  TIMEOUT       | Start Updating transition and send update to participants after UPDATING got timeout |\r
++------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+| Migrate    | DEPLOYED               |  LOCKED       |                | Start Migrating transition and send migrate to participants                          |\r
++------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+|            | UNDEPLOYED      |               |                | Start Deleting transition and send delete to participants                            |\r
++            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+| Delete     | DELETING        |  NONE         |  FAILED        | Start Deleting transition and send delete to participants after DELETING is failed   |\r
++            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+|            | DELETING        |  NONE         |  TIMEOUT       | Start Deleting transition and send delete to participants after DELETING got timeout |\r
++------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
+\r
+Change status of Automation Composition Instance\r
+------------------------------------------------\r
+\r
++------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+| **Action** | **deployState** | **lockState** | **stChResult** | **Description**                                                                             |\r
++------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | UNDEPLOYED      |               |                | Start Deploying transition and send deploy to participants                                  |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYING       |  NONE         |  FAILED        | Start Deploying transition and send deploy to participants after DEPLOYING is failed        |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|  Deploy    | DEPLOYING       |  NONE         |  TIMEOUT       | Start Deploying transition and send deploy to participants after DEPLOYING got timeout      |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | UNDEPLOYING     |  NONE         |  FAILED        | Start Deploying transition and send deploy to participants after UNDEPLOYING is failed      |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | UNDEPLOYING     |  NONE         |  TIMEOUT       | Start Deploying transition and send deploy to participants after UNDEPLOYING got timeout    |\r
++------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        |  LOCKED       |                | Start Undeploying transition and send undeploy to participants                              |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYING       |  NONE         |  FAILED        | Start Undeploying transition and send undeploy to participants after DEPLOYING is failed    |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | UNDEPLOYING     |  NONE         |  FAILED        | Start Undeploying transition and send undeploy to participants after UNDEPLOYING is failed  |\r
++  Undeploy  +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | UNDEPLOYING     |  NONE         |  TIMEOUT       | Start Undeploying transition and send undeploy to participants after UNDEPLOYING got timeout|\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | UPDATING        |  LOCKED       |  FAILED        | Start Undeploying transition and send update to participants after UPDATING is failed       |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | UPDATING        |  LOCKED       |  TIMEOUT       | Start Undeploying transition and send update to participants after UPDATING got timeout     |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | MIGRATING       |  LOCKED       |  FAILED        | Start Undeploying transition and send update to participants after MIGRATING is failed      |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | MIGRATING       |  LOCKED       |  TIMEOUT       | Start Undeploying transition and send update to participants after MIGRATING got timeout    |\r
++------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        |  UNLOCKED     |                | Start Locking transition and send lock to participants                                      |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        |  UNLOCKING    |  FAILED        | Start Locking transition and send lock to participants after UNLOCKING is failed            |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|   Lock     | DEPLOYED        |  UNLOCKING    |  TIMEOUT       | Start Locking transition and send lock to participants after UNLOCKING got timeout          |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        |  LOCKING      |  FAILED        | Start Locking transition and send lock to participants after LOCKING is failed              |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        |  LOCKING      |  TIMEOUT       | Start Locking transition and send lock to participants after LOCKING got timeout            |\r
++------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        | LOCKED        |                | Start Unlocking transition and send unlock to participants                                  |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        | UNLOCKING     |  FAILED        | Start Unlocking transition and send unlock to participants after UNLOCKING is failed        |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|  Unlock    | DEPLOYED        | UNLOCKING     |  TIMEOUT       | Start Unlocking transition and send unlock to participants after UNLOCKING got timeout      |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        | LOCKING       |  FAILED        | Start Unlocking transition and send unlock to participants after LOCKING is failed          |\r
++            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
+|            | DEPLOYED        | LOCKING       |  TIMEOUT       | Start Unlocking transition and send unlock to participants after LOCKING got timeout        |\r
++------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r

diff --git a/docs/clamp/clamp.rst b/docs/clamp/clamp.rst
index 0f05115..193b55c 100644 (file)
--- a/docs/clamp/clamp.rst
+++ b/docs/clamp/clamp.rst
@@ -16,6 +16,7 @@ described in TOSCA.
    acm/defining-acms
    acm/api-protocol/api-protocol-tree
    acm/design-impl/design-impl
+   acm/allowed-operations
    acm/acm-user-guide
    acm/acm-participant-guide