Add allowed operations in docs

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

2 files changed, 132 insertions, 0 deletions

diff --git a/docs/clamp/acm/allowed-operations.rst b/docs/clamp/acm/allowed-operations.rst
new file mode 100755
index 00000000..62de7ffc
--- /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.

+

+.. _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        |

++------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+

diff --git a/docs/clamp/clamp.rst b/docs/clamp/clamp.rst
index 0f051155..193b55cc 100644
--- 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