Update docs for configurable timeout support in ACM

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

diff --git a/docs/clamp/acm/acm-user-guide.rst b/docs/clamp/acm/acm-user-guide.rst
index 41f521b..dc8f81f 100644 (file)
--- a/docs/clamp/acm/acm-user-guide.rst
+++ b/docs/clamp/acm/acm-user-guide.rst
@@ -33,6 +33,23 @@ An example scenario is considered where we have a microservice that can be insta
 configured via REST api to perform some operation.This functionality can be realised as a composition in Tosca standard.
 The various sections of the composition definition includes:
 
+Metadata:
+---------
+The user can define 'TIMEOUT' for Prime and Deprime:
+
+primeTimeoutMs:
+  Denotes the maximum wait time during prime operation by the runtime to receive the state change update from participant
+
+deprimeTimeoutMs:
+  Denotes the maximum wait time during deprime operation by the runtime to receive the state change update from participant
+
+.. code-block:: yaml
+
+  metadata:
+    primeTimeoutMs: 200000
+    deprimeTimeoutMs: 100000
+
+
 Data Types:
 -----------
 The user can define their own data types to be used in the composition definition. In this use case, we are defining three data types as follows.
@@ -214,6 +231,24 @@ Request payload
 .. literalinclude:: files/AC-instantiation.json
    :language: json
 
+The following properties will be used by ACM-runtime:
+
+deployTimeoutMs:
+  Denotes the maximum wait time during deploy operation by the runtime to receive the state change update from participant
+
+undeployTimeoutMs:
+  Denotes the maximum wait time during undeploy operation by the runtime to receive the state change update from participant
+
+updateTimeoutMs:
+  Denotes the maximum wait time during update operation by the runtime to receive the state change update from participant
+
+migrateTimeoutMs:
+  Denotes the maximum wait time migrate deploy operation by the runtime to receive the state change update from participant
+
+deleteTimeoutMs:
+  Denotes the maximum wait time during delete operation by the runtime to receive the state change update from participant
+
+
 Update AC instance properties (Optional)
 ----------------------------------------
 Before the AC instance is deployed, the user is allowed to update the instance property values if needed. The runtime updates these new values

diff --git a/docs/clamp/acm/api-protocol/system-level-dialogues.rst b/docs/clamp/acm/api-protocol/system-level-dialogues.rst
index b7a05cc..5c47aff 100644 (file)
--- a/docs/clamp/acm/api-protocol/system-level-dialogues.rst
+++ b/docs/clamp/acm/api-protocol/system-level-dialogues.rst
@@ -298,7 +298,26 @@ the operation result is then marked as 'TIMEOUT' by the ACM-R after the configur
 
 .. image:: ../images/system-dialogues/TimeoutAcmResult.png
 
-The following parameters are set in the application properties for the runtime to configure the 'TIMEOUT' value in milliseconds.
+'TIMEOUT' is configurable for each operations. Prime and Deprime could be configured into the composition definition.
+
+.. code-block:: yaml
+
+  metadata:
+    primeTimeoutMs: 200000
+    deprimeTimeoutMs: 100000
+
+All other operations for the instance could be configured into the instance element properties.
+
+.. code-block:: yaml
+
+    properties:
+      deployTimeoutMs: 200000
+      undeployTimeoutMs: 150000
+      updateTimeoutMs: 200000
+      migrateTimeoutMs: 200000
+      deleteTimeoutMs: 100000
+
+The following parameters are set in the application properties for the runtime to configure the default 'TIMEOUT' value in milliseconds.
 
 .. code-block:: yaml
 
@@ -308,10 +327,8 @@ The following parameters are set in the application properties for the runtime t
             maxOperationWaitMs: 100000  --> Denotes the maximum wait time by the runtime to receive the state change update from the participants
 
 An ACM operation has to be completed and updated with any of the above specified result values in order to allow the user to trigger subsequent requests.
-The user cannot trigger any state change events before the operation gets completed. When an operation is marked 'TIMEOUT', the following scenarios are applicable.
-
- - The participant might complete the operation to mark the result with 'NO_ERROR' or 'FAILED'
- - The user can trigger another state change event to the ACM.
+The user cannot trigger any state change events before the operation gets completed. When an operation is marked 'TIMEOUT',
+the participants stop the operation and the user can trigger another state change event to the ACM.
 
 The following flow shown and example of deployment that get stuck, and the user decide to undeploy.
 

diff --git a/docs/clamp/acm/files/AC-instantiation.json b/docs/clamp/acm/files/AC-instantiation.json
index 8cffff6..64bdc6f 100644 (file)
--- a/docs/clamp/acm/files/AC-instantiation.json
+++ b/docs/clamp/acm/files/AC-instantiation.json
@@ -12,6 +12,11 @@
       },
       "description": "Starter Automation Composition Element for the Demo",
       "properties": {
+        "deployTimeoutMs": "200000",
+        "undeployTimeoutMs": "150000",
+        "updateTimeoutMs": "200000",
+        "migrateTimeoutMs": "200000",
+        "deleteTimeoutMs": "100000",
         "chart": {
           "chartId": {
             "name": "acelement",
@@ -39,6 +44,11 @@
       },
       "description": "Starter Automation Composition Element for the Demo",
       "properties": {
+        "deployTimeoutMs": "200000",
+        "undeployTimeoutMs": "150000",
+        "updateTimeoutMs": "200000",
+        "migrateTimeoutMs": "200000",
+        "deleteTimeoutMs": "100000",
         "baseUrl": "http://acm-starter-ac-element-impl:8084",
         "httpHeaders": {
           "Content-Type": "application/json",
@@ -68,4 +78,4 @@
     }
 
   }
-}
\ No newline at end of file
+}

diff --git a/docs/clamp/acm/files/AC-migrate.json b/docs/clamp/acm/files/AC-migrate.json
index 27932fc..5ce45ea 100755 (executable)
--- a/docs/clamp/acm/files/AC-migrate.json
+++ b/docs/clamp/acm/files/AC-migrate.json
@@ -9,12 +9,22 @@
     "709c62b3-8918-41b9-a747-d21eb79c6c21": {
       "id": "709c62b3-8918-41b9-a747-d21eb79c6c21",
       "properties": {
+        "deployTimeoutMs": "200000",
+        "undeployTimeoutMs": "150000",
+        "updateTimeoutMs": "200000",
+        "migrateTimeoutMs": "200000",
+        "deleteTimeoutMs": "100000",
         "baseUrl": "http://acm-starter-ac-element-impl_updated:8084"
       }
     },
     "709c62b3-8918-41b9-a747-d21eb79c6c22": {
       "id": "709c62b3-8918-41b9-a747-d21eb79c6c22",
       "properties": {
+        "deployTimeoutMs": "200000",
+        "undeployTimeoutMs": "150000",
+        "updateTimeoutMs": "200000",
+        "migrateTimeoutMs": "200000",
+        "deleteTimeoutMs": "100000",
         "baseUrl": "http://acm-sink-ac-element-impl_updated:8085"
       }
     }

diff --git a/docs/clamp/acm/files/AC-update.json b/docs/clamp/acm/files/AC-update.json
index 79ee133..d8a44e5 100644 (file)
--- a/docs/clamp/acm/files/AC-update.json
+++ b/docs/clamp/acm/files/AC-update.json
@@ -8,8 +8,13 @@
     "709c62b3-8918-41b9-a747-d21eb79c6c21": {
       "id": "709c62b3-8918-41b9-a747-d21eb79c6c21",
       "properties": {
+        "deployTimeoutMs": "200000",
+        "undeployTimeoutMs": "150000",
+        "updateTimeoutMs": "200000",
+        "migrateTimeoutMs": "200000",
+        "deleteTimeoutMs": "100000",
         "baseUrl": "http://acm-starter-ac-element-impl_updated:8084"
       }
     }
   }
-}
\ No newline at end of file
+}