Updating doc for ACM Smoke Testing

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

diff --git a/docs/development/devtools/smoke/acm-participants-smoke.rst b/docs/development/devtools/smoke/acm-participants-smoke.rst
index ad37776..869205a 100644 (file)
--- a/docs/development/devtools/smoke/acm-participants-smoke.rst
+++ b/docs/development/devtools/smoke/acm-participants-smoke.rst
@@ -21,6 +21,8 @@ This article assumes that:
 * Your local maven repository is in the location *~/.m2/repository*
 * You have copied the settings.xml from oparent to *~/.m2/* directory
 * You have added settings to access the ONAP Nexus to your M2 configuration, see `Maven Settings Example <https://wiki.onap.org/display/DW/Setting+Up+Your+Development+Environment>`_ (bottom of the linked page)
+* Your local helm is in the location /usr/local/bin/helm
+* Your local kubectl is in the location /usr/local/bin/kubectl
 
 The procedure documented in this article has been verified using Ubuntu 20.04 LTS VM.
 
@@ -92,6 +94,9 @@ And into the file 'participant/participant-impl/participant-impl-kubernetes/src/
 .. literalinclude:: files/participant-kubernetes-application.yaml
    :language: yaml
 
+If the helm location is not '/usr/local/bin/helm' or the kubectl location is not '/usr/local/bin/kubectl', you have to update
+the file 'participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/helm/HelmClient.java'.
+
 2.3.3 Automation composition Runtime
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 To start the automation composition runtime service, we need to execute the following maven command from the "runtime-acm" directory in the clamp repo. Automation composition runtime uses the config file "src/main/resources/application.yaml" by default.
@@ -130,7 +135,7 @@ For building docker images of runtime-acm and participants:
 
 .. code-block:: bash
 
-   cd ~/git/onap/policy/clamp/packages/
+   cd ~/git/onap/policy/clamp/
    mvn clean install -P docker
 
 
@@ -174,6 +179,8 @@ Request body:
         "primeOrder": "PRIME"
    }
 
+A successful prime request gives 202 responses in the postman client.
+
 3.3 Create New Instances of Automation composition
 ==================================================
 Once AC definition is primes, we can instantiate automation composition instances. This will create the instances with default state "UNDEPLOYED".
@@ -188,6 +195,8 @@ Request body:
 
 :download:`Instantiation json <json/acm-instantiation.json>`
 
+A successful creation of new instance gives 201 responses in the postman client.
+
 3.4 Change the State of the Instance
 ====================================
 When the automation composition is updated with state “DEPLOYED”, the Kubernetes participant fetches the node template for all automation composition elements and deploys the helm chart of each AC element into the cluster. The following sample json input is passed on the request body.
@@ -206,6 +215,7 @@ Automation Composition Update Endpoint:
    }
 
 
+A successful deploy request gives 202 responses in the postman client.
 After the state changed to "DEPLOYED", nginx-ingress pod is deployed in the kubernetes cluster. And http participant should have posted the dummy data to the configured URL in the tosca template.
 
 The following command can be used to verify the pods deployed successfully by kubernetes participant.

diff --git a/docs/development/devtools/smoke/clamp-ac-participant-protocol-smoke.rst b/docs/development/devtools/smoke/clamp-ac-participant-protocol-smoke.rst
index 95a27ee..8bcdc3b 100644 (file)
--- a/docs/development/devtools/smoke/clamp-ac-participant-protocol-smoke.rst
+++ b/docs/development/devtools/smoke/clamp-ac-participant-protocol-smoke.rst
@@ -67,7 +67,6 @@ Test result:
 
 - Observe PARTICIPANT_REGISTER going from participant to runtime
 - Observe PARTICIPANT_REGISTER_ACK going from runtime to participant
-- Observe PARTICIPANT_PRIME going from runtime to participant
 
 3.2 Participant Deregistration
 ==============================
@@ -89,7 +88,8 @@ Test result:
 
 - Observe PARTICIPANT_PRIME going from runtime to participant with acm type definitions and common property values for participant types
 - Observe that the acm type definitions and common property values for participant types are stored on ParticipantHandler
-- Observe PARTICIPANT_PRIME_ACK going from runtime to participant
+- Observe PARTICIPANT_PRIME_ACK going from participant to runtime
+- Observe PARTICIPANT_SYNC_MSG going from runtime to participant
 
 3.4 Participant DePriming
 =========================
@@ -103,7 +103,8 @@ Test result:
 - If acm instances exist in runtime database, return a response for the REST API with error response saying "Cannot decommission acm type definition"
 - If no acm instances exist in runtime database, Observe PARTICIPANT_PRIME going from runtime to participant with definitions as null
 - Observe that the acm type definitions and common property values for participant types are removed on ParticipantHandler
-- Observe PARTICIPANT_PRIME_ACK going from runtime to participant
+- Observe PARTICIPANT_PRIME_ACK going from participant to runtime
+- Observe PARTICIPANT_SYNC_MSG going from runtime to participant
 
 3.5 Automation Composition Instance
 ===================================
@@ -128,6 +129,7 @@ Test result:
 - Observe that the AutomationCompositionElements deploy state is DEPLOYED
 - Observe that the acm deploy state is DEPLOYED
 - Observe AUTOMATION_COMPOSITION_DEPLOY_ACK going from participant to runtime
+- Observe PARTICIPANT_SYNC_MSG going from runtime to participant
 
 3.7 Automation Composition lock state change to UNLOCK
 ======================================================
@@ -140,6 +142,7 @@ Test result:
 - Observe that the AutomationCompositionElements lock state is UNLOCK
 - Observe that the acm state is UNLOCK
 - Observe AUTOMATION_COMPOSITION_STATE_CHANGE_ACK going from participant to runtime
+- Observe PARTICIPANT_SYNC_MSG going from runtime to participant
 
 3.8 Automation Composition lock state change to LOCK
 ====================================================
@@ -152,6 +155,7 @@ Test result:
 - Observe that the AutomationCompositionElements lock state is LOCK
 - Observe that the acm lock state is LOCK
 - Observe AUTOMATION_COMPOSITION_STATE_CHANGE_ACK going from participant to runtime
+- Observe PARTICIPANT_SYNC_MSG going from runtime to participant
 
 3.9 Automation Composition deploy state change to UNDEPLOYED
 ============================================================
@@ -166,6 +170,7 @@ Test result:
 - Observe that the AutomationCompositionElements undeploy the instances from respective frameworks
 - Observe that the automation composition instances are removed from participants
 - Observe AUTOMATION_COMPOSITION_STATE_CHANGE_ACK going from participant to runtime
+- Observe PARTICIPANT_SYNC_MSG going from runtime to participant
 
 3.10 Automation Composition monitoring and reporting
 ====================================================
@@ -176,8 +181,7 @@ Action: Bring up participant
 Test result:
 
 - Observe that PARTICIPANT_STATUS message is sent from participants to runtime in a regular interval
-- Trigger a PARTICIPANT_STATUS_REQ from runtime and observe a PARTICIPANT_STATUS message with tosca definitions of automation composition type definitions sent
-  from all the participants to runtime
+- Trigger a PARTICIPANT_STATUS_REQ from runtime and observe a PARTICIPANT_STATUS message from all the participants to runtime
 
 This concluded the required smoke tests
 

diff --git a/docs/development/devtools/smoke/clamp-smoke.rst b/docs/development/devtools/smoke/clamp-smoke.rst
index 2f4a7c9..d1ca6fa 100644 (file)
--- a/docs/development/devtools/smoke/clamp-smoke.rst
+++ b/docs/development/devtools/smoke/clamp-smoke.rst
@@ -121,7 +121,7 @@ Running on the Command Line
    .. code-block:: bash
 
       cd ~/git/clamp/runtime-acm
-      java -jar target/policy-clamp-runtime-acm-7.1.3-SNAPSHOT.jar
+      java -jar target/policy-clamp-runtime-acm-8.1.0-SNAPSHOT.jar
 
 
 Running participant simulator
@@ -132,7 +132,7 @@ Run the following commands:
    .. code-block:: bash
 
       cd ~/git/clamp/participant/participant-impl/participant-impl-simulator
-      java -jar target/policy-clamp-participant-impl-simulator-7.1.3-SNAPSHOT.jar
+      java -jar target/policy-clamp-participant-impl-simulator-8.1.0-SNAPSHOT.jar
 
 
 Running the CLAMP automation composition docker image

diff --git a/docs/development/devtools/smoke/files/participant-http-application.yaml b/docs/development/devtools/smoke/files/participant-http-application.yaml
index 142c24e..edf324b 100644 (file)
--- a/docs/development/devtools/smoke/files/participant-http-application.yaml
+++ b/docs/development/devtools/smoke/files/participant-http-application.yaml
@@ -1,20 +1,28 @@
 
 participant:
   intermediaryParameters:
+    topics:
+      operationTopic: policy-acruntime-participant
+      syncTopic: acm-ppnt-sync
     reportingTimeIntervalMs: 120000
     description: Participant Description
     participantId: 101c62b3-8918-41b9-a747-d21eb79c6c01
     clampAutomationCompositionTopics:
       topicSources:
-        - topic: policy-acruntime-participant
+        - topic: ${participant.intermediaryParameters.topics.operationTopic}
           servers:
-            - ${topicServer:localhost:29092}
+            - localhost:29092
+          topicCommInfrastructure: kafka
+          fetchTimeout: 15000
+        - topic: ${participant.intermediaryParameters.topics.syncTopic}
+          servers:
+            - localhost:29092
           topicCommInfrastructure: kafka
           fetchTimeout: 15000
       topicSinks:
-        - topic: policy-acruntime-participant
+        - topic: ${participant.intermediaryParameters.topics.operationTopic}
           servers:
-            - ${topicServer:localhost:29092}
+            - localhost:29092
           topicCommInfrastructure: kafka
     participantSupportedElementTypes:
       -

diff --git a/docs/development/devtools/smoke/files/participant-kubernetes-application.yaml b/docs/development/devtools/smoke/files/participant-kubernetes-application.yaml
index 9b25c61..59732bb 100644 (file)
--- a/docs/development/devtools/smoke/files/participant-kubernetes-application.yaml
+++ b/docs/development/devtools/smoke/files/participant-kubernetes-application.yaml
@@ -3,22 +3,28 @@ participant:
   localChartDirectory: /home/policy/local-charts
   infoFileName: CHART_INFO.json
   intermediaryParameters:
+    topics:
+      operationTopic: policy-acruntime-participant
+      syncTopic: acm-ppnt-sync
     reportingTimeIntervalMs: 120000
     description: Participant Description
     participantId: 101c62b3-8918-41b9-a747-d21eb79c6c02
     clampAutomationCompositionTopics:
       topicSources:
-        -
-          topic: policy-acruntime-participant
+        - topic: ${participant.intermediaryParameters.topics.operationTopic}
           servers:
-            - ${topicServer:localhost:29092}
+            - localhost:29092
+          topicCommInfrastructure: kafka
+          fetchTimeout: 15000
+        - topic: ${participant.intermediaryParameters.topics.syncTopic}
+          servers:
+            - localhost:29092
           topicCommInfrastructure: kafka
           fetchTimeout: 15000
       topicSinks:
-        -
-          topic: policy-acruntime-participant
+        - topic: ${participant.intermediaryParameters.topics.operationTopic}
           servers:
-            - ${topicServer:localhost:29092}
+            - localhost:29092
           topicCommInfrastructure: kafka
     participantSupportedElementTypes:
       -

diff --git a/docs/development/devtools/smoke/files/participant-policy-application.yaml b/docs/development/devtools/smoke/files/participant-policy-application.yaml
index 5b87d1b..c42146a 100644 (file)
--- a/docs/development/devtools/smoke/files/participant-policy-application.yaml
+++ b/docs/development/devtools/smoke/files/participant-policy-application.yaml
@@ -18,22 +18,28 @@ participant:
     useHttps: false
     allowSelfSignedCerts: false
   intermediaryParameters:
+    topics:
+      operationTopic: policy-acruntime-participant
+      syncTopic: acm-ppnt-sync
     reportingTimeIntervalMs: 120000
     description: Participant Description
     participantId: 101c62b3-8918-41b9-a747-d21eb79c6c03
     clampAutomationCompositionTopics:
       topicSources:
-        -
-          topic: policy-acruntime-participant
+        - topic: ${participant.intermediaryParameters.topics.operationTopic}
           servers:
-            - ${topicServer:localhost:29092}
+            - localhost:29092
+          topicCommInfrastructure: kafka
+          fetchTimeout: 15000
+        - topic: ${participant.intermediaryParameters.topics.syncTopic}
+          servers:
+            - localhost:29092
           topicCommInfrastructure: kafka
           fetchTimeout: 15000
       topicSinks:
-        -
-          topic: policy-acruntime-participant
+        - topic: ${participant.intermediaryParameters.topics.operationTopic}
           servers:
-            - ${topicServer:localhost:29092}
+            - localhost:29092
           topicCommInfrastructure: kafka
     participantSupportedElementTypes:
       -

diff --git a/docs/development/devtools/smoke/files/participant-sim-application.yaml b/docs/development/devtools/smoke/files/participant-sim-application.yaml
index 2d23c12..2a7efc3 100644 (file)
--- a/docs/development/devtools/smoke/files/participant-sim-application.yaml
+++ b/docs/development/devtools/smoke/files/participant-sim-application.yaml
@@ -1,20 +1,28 @@
 
 participant:
   intermediaryParameters:
+    topics:
+      operationTopic: policy-acruntime-participant
+      syncTopic: acm-ppnt-sync
     reportingTimeIntervalMs: 120000
     description: Participant Description
     participantId: 101c62b3-8918-41b9-a747-d21eb79c6c90
     clampAutomationCompositionTopics:
       topicSources:
-        - topic: policy-acruntime-participant
+        - topic: ${participant.intermediaryParameters.topics.operationTopic}
           servers:
-            - ${topicServer:localhost:29092}
+            - localhost:29092
+          topicCommInfrastructure: kafka
+          fetchTimeout: 15000
+        - topic: ${participant.intermediaryParameters.topics.syncTopic}
+          servers:
+            - localhost:29092
           topicCommInfrastructure: kafka
           fetchTimeout: 15000
       topicSinks:
-        - topic: policy-acruntime-participant
+        - topic: ${participant.intermediaryParameters.topics.operationTopic}
           servers:
-            - ${topicServer:localhost:29092}
+            - localhost:29092
           topicCommInfrastructure: kafka
     participantSupportedElementTypes:
       -

diff --git a/docs/development/devtools/smoke/files/runtime-application.yaml b/docs/development/devtools/smoke/files/runtime-application.yaml
index f798d5b..d963922 100644 (file)
--- a/docs/development/devtools/smoke/files/runtime-application.yaml
+++ b/docs/development/devtools/smoke/files/runtime-application.yaml
@@ -1,21 +1,26 @@
 
 runtime:
+  topics:
+    operationTopic: policy-acruntime-participant
+    syncTopic: acm-ppnt-sync
   participantParameters:
     heartBeatMs: 20000
     maxStatusWaitMs: 200000
   topicParameterGroup:
     topicSources:
-      -
-        topic: policy-acruntime-participant
+      - topic: ${runtime.topics.operationTopic}
         servers:
-          - ${topicServer:localhost:29092}
+          - localhost:29092
         topicCommInfrastructure: kafka
         fetchTimeout: 15000
     topicSinks:
-      -
-        topic: policy-acruntime-participant
+      - topic: ${runtime.topics.operationTopic}
         servers:
-          - ${topicServer:localhost:29092}
+          - localhost:29092
+        topicCommInfrastructure: kafka
+      - topic: ${runtime.topics.syncTopic}
+        servers:
+          - localhost:29092
         topicCommInfrastructure: kafka
   acmParameters:
     toscaElementName: org.onap.policy.clamp.acm.AutomationCompositionElement

diff --git a/docs/development/devtools/smoke/json/acm-instantiation.json b/docs/development/devtools/smoke/json/acm-instantiation.json
index 2cf009c..85f2289 100644 (file)
--- a/docs/development/devtools/smoke/json/acm-instantiation.json
+++ b/docs/development/devtools/smoke/json/acm-instantiation.json
@@ -15,7 +15,7 @@
                 "chart": {
                     "chartId": {
                         "name": "nginx-ingress",
-                        "version": "0.11.0"
+                        "version": "1.4.1"
                     },
                     "releaseName": "nginxapp",
                     "namespace": "onap"