Update documentation for ACM S3P test in Kohn

Issue-ID: POLICY-4383
Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech>
Change-Id: I78e226bdc5156d6597f640915f3a40a946c71bc7

diff --git a/docs/development/devtools/clamp-s3p-results/Stability_after_stats.png b/docs/development/devtools/clamp-s3p-results/Stability_after_stats.png
index 8370f0d..3824286 100644 (file)
Binary files a/docs/development/devtools/clamp-s3p-results/Stability_after_stats.png and b/docs/development/devtools/clamp-s3p-results/Stability_after_stats.png differ

diff --git a/docs/development/devtools/clamp-s3p-results/Stability_before_stats.png b/docs/development/devtools/clamp-s3p-results/Stability_before_stats.png
deleted file mode 100644 (file)
index 46eaddf..0000000
Binary files a/docs/development/devtools/clamp-s3p-results/Stability_before_stats.png and /dev/null differ

diff --git a/docs/development/devtools/clamp-s3p-results/acm_performance_jmeter.png b/docs/development/devtools/clamp-s3p-results/acm_performance_jmeter.png
new file mode 100644 (file)
index 0000000..bad1cf7
Binary files /dev/null and b/docs/development/devtools/clamp-s3p-results/acm_performance_jmeter.png differ

diff --git a/docs/development/devtools/clamp-s3p-results/acm_stability_jmeter.png b/docs/development/devtools/clamp-s3p-results/acm_stability_jmeter.png
index abe1537..2f57650 100644 (file)
Binary files a/docs/development/devtools/clamp-s3p-results/acm_stability_jmeter.png and b/docs/development/devtools/clamp-s3p-results/acm_stability_jmeter.png differ

diff --git a/docs/development/devtools/clamp-s3p-results/acm_stability_table.png b/docs/development/devtools/clamp-s3p-results/acm_stability_table.png
index 70c14fe..28942ef 100644 (file)
Binary files a/docs/development/devtools/clamp-s3p-results/acm_stability_table.png and b/docs/development/devtools/clamp-s3p-results/acm_stability_table.png differ

diff --git a/docs/development/devtools/clamp-s3p-results/cl-s3p-performance-result-jmeter.png b/docs/development/devtools/clamp-s3p-results/cl-s3p-performance-result-jmeter.png
deleted file mode 100644 (file)
index a9a8e01..0000000
Binary files a/docs/development/devtools/clamp-s3p-results/cl-s3p-performance-result-jmeter.png and /dev/null differ

diff --git a/docs/development/devtools/clamp-s3p.rst b/docs/development/devtools/clamp-s3p.rst
index 639b295..eb17d89 100644 (file)
--- a/docs/development/devtools/clamp-s3p.rst
+++ b/docs/development/devtools/clamp-s3p.rst
@@ -13,8 +13,54 @@ Policy Clamp Automation Composition
 Both the Performance and the Stability tests were executed by performing requests
 against acm components installed as docker images in local environment.
 
 Both the Performance and the Stability tests were executed by performing requests
 against acm components installed as docker images in local environment.
 

-Setup Details
-+++++++++++++
+
+ACM Deployment
+++++++++++++++
+
+The docker containers can be deployed via Policy CSIT script.
+Clone the Policy/docker repo to the local vm
+
+.. code-block:: bash
+
+    git clone "https://gerrit.onap.org/r/policy/docker"
+
+Set the following environment variables on the system before deploying the containers.
+
+.. code-block:: bash
+
+    export CONTAINER_LOCATION=nexus3.onap.org:10001/
+    export PROJECT=clamp
+
+Invoke the following script from the ~/docker/csit folder.
+
+.. code-block:: bash
+
+    ./start-all.sh
+
+This script installs the docker containers of ACM and Policy components required for running the tests.
+
+
+Jmeter setup
+++++++++++++
+
+Apache jmeter tool is installed either on the same virtual machine or on a different virtual machine.
+
+.. code-block:: bash
+
+    # Install required packages
+    sudo apt install -y wget unzip
+
+    # Install JMeter
+    mkdir -p jmeter
+    cd jmeter
+    wget https://dlcdn.apache.org//jmeter/binaries/apache-jmeter-5.5.zip # check if valid version
+    unzip -q apache-jmeter-5.5.zip
+    rm apache-jmeter-5.5.zip
+
+
+Setup Verification
+++++++++++++++++++
+Ensure the following components are up and running before executing the test.

 
 - acm runtime component docker image is started and running.
 - Participant docker images policy-clamp-cl-pf-ppnt, policy-clamp-cl-http-ppnt, policy-clamp-cl-k8s-ppnt are started and running.
 
 - acm runtime component docker image is started and running.
 - Participant docker images policy-clamp-cl-pf-ppnt, policy-clamp-cl-http-ppnt, policy-clamp-cl-k8s-ppnt are started and running.


@@ -32,7 +78,7 @@ The 72 hours stability test ran the following steps sequentially in a single thr
 
 - **Create Policy defaultDomain** - creates an operational policy using policy/api component
 - **Delete Policy sampleDomain** - deletes the operational policy sampleDomain using policy/api component
 
 - **Create Policy defaultDomain** - creates an operational policy using policy/api component
 - **Delete Policy sampleDomain** - deletes the operational policy sampleDomain using policy/api component

-- **Commission Contorlloop definition** - commissions the acm definition in runtime
+- **Commission AC definition** - commissions the acm definition in runtime

 - **Instantiate acm** - Instantiate the acm towards participants
 - **Check acm state** - check the current state of acm
 - **Change State to PASSIVE** - change the state of the acm to PASSIVE
 - **Instantiate acm** - Instantiate the acm towards participants
 - **Check acm state** - check the current state of acm
 - **Change State to PASSIVE** - change the state of the acm to PASSIVE


@@ -42,7 +88,7 @@ The 72 hours stability test ran the following steps sequentially in a single thr
 - **Delete instantiated acm** - delete the instantiated acm from all participants
 - **Delete ACM Definition** - delete the acm definition on runtime
 
 - **Delete instantiated acm** - delete the instantiated acm from all participants
 - **Delete ACM Definition** - delete the acm definition on runtime
 

-The following steps can be used to configure the parameters of test plan.
+The following parameters can be configured on the JMX file for the test.

 
 - **HTTP Authorization Manager** - used to store user/password authentication details.
 - **HTTP Header Manager** - used to store headers which will be used for making HTTP requests.
 
 - **HTTP Authorization Manager** - used to store user/password authentication details.
 - **HTTP Header Manager** - used to store headers which will be used for making HTTP requests.


@@ -57,11 +103,19 @@ The following steps can be used to configure the parameters of test plan.
  POLICY_PARTICIPANT_HOST_PORT  Port number of policy participant
 =============================  ========================================================================
 
  POLICY_PARTICIPANT_HOST_PORT  Port number of policy participant
 =============================  ========================================================================
 

+Download the ACM stability.jmx and performance.jmx files from the Policy-Clamp repo.
+
+Stability jmx file
+
+.. code-block:: bash
+
+    ~/clamp/testsuites/stability/src/main/resources/testplans/stability.jmx
+

 The test was run in the background via "nohup", to prevent it from being interrupted:
 
 .. code-block:: bash
 
 The test was run in the background via "nohup", to prevent it from being interrupted:
 
 .. code-block:: bash
 

-    nohup ./jMeter/apache-jmeter-5.2.1/bin/jmeter -n -t stability.jmx -l testresults.jtl
+    nohup ./jmeter/apache-jmeter-5.5/bin/jmeter -n -t stability.jmx -l testresults.jtl

 
 Test Results
 ------------
 
 Test Results
 ------------


@@ -83,22 +137,24 @@ Stability test plan was triggered for 72 hours.
 =======================  =================  ==================  ==================================
 **Total # of requests**  **Success %**      **Error %**         **Average time taken per request**
 =======================  =================  ==================  ==================================
 =======================  =================  ==================  ==================================
 **Total # of requests**  **Success %**      **Error %**         **Average time taken per request**
 =======================  =================  ==================  ==================================

-99992                    100.00 %           0.00 %              192 ms
+97916                    100.00 %           0.00 %              246 ms

 =======================  =================  ==================  ==================================
 
 **ACM component Setup**
 
 =======================  =================  ==================  ==================================
 
 **ACM component Setup**
 

-================  =========================================================  ===========================================  =========================
-**CONTAINER ID**  **IMAGE**                                                  **PORTS**                                    **NAMES**
-================  =========================================================  ===========================================  =========================
- a9cb0cd103cf     onap/policy-clamp-cl-runtime:latest                        6969/tcp                                     policy-clamp-cl-runtime
- 886e572b8438     onap/policy-clamp-cl-pf-ppnt:latest                        6973/tcp                                     policy-clamp-cl-pf-ppnt
- 035707b1b95f     nexus3.onap.org:10001/onap/policy-api:latest               6969/tcp                                     policy-api
- d34204f95ff3     onap/policy-clamp-cl-http-ppnt:latest                      6971/tcp                                     policy-clamp-cl-http-ppnt
- 4470e608c9a8     onap/policy-clamp-cl-k8s-ppnt:latest                       6972/tcp, 8083/tcp                           policy-clamp-cl-k8s-ppnt
- 62229d46b79c     nexus3.onap.org:10001/onap/policy-models-simulator:latest  3905/tcp, 6666/tcp, 6668-6670/tcp, 6680/tcp  simulator
- efaf0ca5e1f0     nexus3.onap.org:10001/mariadb:10.5.8                       3306/tcp                                     mariadb
-================  =========================================================  ===========================================  =========================
+================  ============================================================    ===========================================  =========================
+**CONTAINER ID**  **IMAGE**                                                       **PORT**                                     **NAME**
+================  ============================================================    ===========================================  =========================
+ a9cb0cd103cf     nexus3.onap.org:10001/onap/policy-clamp-runtime-acm:latest      6969/tcp                                     policy-clamp-runtime-acm
+ 886e572b8438     nexus3.onap.org:10001/onap/policy-clamp-ac-pf-ppnt:latest       6969/tcp                                     policy-clamp-ac-pf-ppnt
+ 035707b1b95f     nexus3.onap.org:10001/onap/policy-api:latest                    6969/tcp                                     policy-api
+ d34204f95ff3     nexus3.onap.org:10001/onap/policy-clamp-ac-http-ppnt:latest     6969/tcp                                     policy-clamp-ac-http-ppnt
+ 4470e608c9a8     nexus3.onap.org:10001/onap/policy-clamp-ac-k8s-ppnt:latest      6969/tcp                                     policy-clamp-ac-k8s-ppnt
+ 62229d46b79c     nexus3.onap.org:10001/onap/policy-models-simulator:latest       3905/tcp, 6666/tcp, 6668-6670/tcp, 6680/tcp  simulator
+ efaf0ca5e1f0     nexus3.onap.org:10001/mariadb:10.5.8                            3306/tcp                                     mariadb
+ e84cf17db2a4     nexus3.onap.org:10001/onap/policy-pap:latest                    6969/tcp                                     policy-pap
+ 0a16eecd13c9     nexus3.onap.org:10001/onap/policy-apex-pdp:latest               6969/tcp                                     policy-apex-pdp
+================  ============================================================    ===========================================  =========================

 
 .. Note::
 
 
 .. Note::
 


@@ -116,11 +172,7 @@ Stability test plan was triggered for 72 hours.
 
 **Memory and CPU usage**
 
 
 **Memory and CPU usage**
 

-The memory and CPU usage can be monitored by running "docker stats" command. A snapshot is taken before and after test execution to monitor the changes in resource utilization.
-
-Memory and CPU usage before test execution:
-
-.. image:: clamp-s3p-results/Stability_before_stats.png
+The memory and CPU usage can be monitored by running "docker stats" command.

 
 Memory and CPU usage after test execution:
 
 
 Memory and CPU usage after test execution:
 


@@ -152,11 +204,17 @@ Performance test plan is the same as the stability test plan above except for th
 Run Test
 --------
 
 Run Test
 --------
 

+Performance jmx file
+
+.. code-block:: bash
+
+    ~/clamp/testsuites/performance/src/main/resources/testplans/performance.jmx
+

 Running/Triggering the performance test will be the same as the stability test. That is, launch JMeter pointing to corresponding *.jmx* test plan. The *RUNTIME_HOST*, *RUNTIME_PORT*, *POLICY_PARTICIPANT_HOST*, *POLICY_PARTICIPANT_HOST_PORT* are already set up in *.jmx*
 
 .. code-block:: bash
 
 Running/Triggering the performance test will be the same as the stability test. That is, launch JMeter pointing to corresponding *.jmx* test plan. The *RUNTIME_HOST*, *RUNTIME_PORT*, *POLICY_PARTICIPANT_HOST*, *POLICY_PARTICIPANT_HOST_PORT* are already set up in *.jmx*
 
 .. code-block:: bash
 

-    nohup ./jMeter/apache-jmeter-5.2.1/bin/jmeter -n -t performance.jmx -l testresults.jtl
+    nohup ./jmeter/apache-jmeter-5.5/bin/jmeter -n -t performance.jmx -l testresults.jtl

 
 Once the test execution is completed, execute the below script to get the statistics:
 
 
 Once the test execution is completed, execute the below script to get the statistics:
 


@@ -175,23 +233,25 @@ Test results are shown as below.
 =======================  =================  ==================  ==================================
 **Total # of requests**  **Success %**      **Error %**         **Average time taken per request**
 =======================  =================  ==================  ==================================
 =======================  =================  ==================  ==================================
 **Total # of requests**  **Success %**      **Error %**         **Average time taken per request**
 =======================  =================  ==================  ==================================

-13809                    100 %              0.00 %              206 ms
+13591                    100 %              0.00 %              249 ms

 =======================  =================  ==================  ==================================
 
 **ACM component Setup**
 
 =======================  =================  ==================  ==================================
 
 **ACM component Setup**
 

-================  =========================================================  ===========================================  =========================
-**CONTAINER ID**  **IMAGE**                                                  **PORTS**                                    **NAMES**
-================  =========================================================  ===========================================  =========================
- a9cb0cd103cf     onap/policy-clamp-cl-runtime:latest                        6969/tcp                                     policy-clamp-cl-runtime
- 886e572b8438     onap/policy-clamp-cl-pf-ppnt:latest                        6973/tcp                                     policy-clamp-cl-pf-ppnt
- 035707b1b95f     nexus3.onap.org:10001/onap/policy-api:latest               6969/tcp                                     policy-api
- d34204f95ff3     onap/policy-clamp-cl-http-ppnt:latest                      6971/tcp                                     policy-clamp-cl-http-ppnt
- 4470e608c9a8     onap/policy-clamp-cl-k8s-ppnt:latest                       6972/tcp, 8083/tcp                           policy-clamp-cl-k8s-ppnt
- 62229d46b79c     nexus3.onap.org:10001/onap/policy-models-simulator:latest  3905/tcp, 6666/tcp, 6668-6670/tcp, 6680/tcp  simulator
- efaf0ca5e1f0     nexus3.onap.org:10001/mariadb:10.5.8                       3306/tcp                                     mariadb
-================  =========================================================  ===========================================  =========================
+================  ============================================================    ===========================================  =========================
+**CONTAINER ID**  **IMAGE**                                                       **PORT**                                     **NAME**
+================  ============================================================    ===========================================  =========================
+ a9cb0cd103cf     nexus3.onap.org:10001/onap/policy-clamp-runtime-acm:latest      6969/tcp                                     policy-clamp-runtime-acm
+ 886e572b8438     nexus3.onap.org:10001/onap/policy-clamp-ac-pf-ppnt:latest       6969/tcp                                     policy-clamp-ac-pf-ppnt
+ 035707b1b95f     nexus3.onap.org:10001/onap/policy-api:latest                    6969/tcp                                     policy-api
+ d34204f95ff3     nexus3.onap.org:10001/onap/policy-clamp-ac-http-ppnt:latest     6969/tcp                                     policy-clamp-ac-http-ppnt
+ 4470e608c9a8     nexus3.onap.org:10001/onap/policy-clamp-ac-k8s-ppnt:latest      6969/tcp                                     policy-clamp-ac-k8s-ppnt
+ 62229d46b79c     nexus3.onap.org:10001/onap/policy-models-simulator:latest       3905/tcp, 6666/tcp, 6668-6670/tcp, 6680/tcp  simulator
+ efaf0ca5e1f0     nexus3.onap.org:10001/mariadb:10.5.8                            3306/tcp                                     mariadb
+ e84cf17db2a4     nexus3.onap.org:10001/onap/policy-pap:latest                    6969/tcp                                     policy-pap
+ 0a16eecd13c9     nexus3.onap.org:10001/onap/policy-apex-pdp:latest               6969/tcp                                     policy-apex-pdp
+================  ============================================================    ===========================================  =========================

 
 **JMeter Screenshot**
 
 
 **JMeter Screenshot**
 

-.. image:: clamp-s3p-results/cl-s3p-performance-result-jmeter.png
+.. image:: clamp-s3p-results/acm_performance_jmeter.png