Update xtesting READMEs

They can be used to run the xtesting dockers on any ONAP deployment
Note a section in the official doc shall also be created

Issue-ID: TEST-274

Signed-off-by: mrichomme <morgan.richomme@orange.com>
Change-Id: If1d98e51c1dd476f5b1da81e51e4b4d99f513aa5
Signed-off-by: mrichomme <morgan.richomme@orange.com>

1 files changed, 74 insertions, 20 deletions

diff --git a/healthcheck/README.md b/healthcheck/README.md
index 455bcdf..b1826c5 100644
--- a/healthcheck/README.md
+++ b/healthcheck/README.md
@@ -6,15 +6,11 @@ This healthcheck docker includes the test suites checking ONAP components.
 
 It includes 4 tests:
 
-* core: robot basic healthcheck of the components AAI, dmaap, portal, SDC, SDNC,
+- core: robot basic healthcheck of the components AAI, dmaap, portal, SDC, SDNC,
   SO
-* small: robot basic healthcheck of the components AAI, dmaap, portal, SDC, SDNC,
-  SO, AAF, APPC, CLI, LOG, MSB, Mulicloud, VID
-* medium: robot basic healthcheck of the components AAI, dmaap, portal, SDC, SDNC,
-  SO, AAF, APPC, CLI, LOG, MSB, Mulicloud, VID, CDS, CLAMP, Dcaegen2, OOF,
-  Policy, UUI
-* full: all the components
-* healthdist: test the onboarding and the distribution of the vFW
+- full: robot basic healthcheck covering all the components
+- healthdist: test the onboarding and the distribution of the vFW
+- postinstall: postinstallation tests including dmaap message router ACL update
 
 ## Usage
 
@@ -22,7 +18,7 @@ It includes 4 tests:
 
 Mandatory:
 
-* The Robot configuration file: this file is setup at ONAP installation in the
+- The Robot configuration file: this file is setup at ONAP installation in the
   configmap onap-robot-robot-eteshare-configmap. It includes lots of variables,
   end points, urls, passwords, logins, needed by the robot scripts.
   By default most of these data are set at ONAP installation.
@@ -34,7 +30,7 @@ Mandatory:
 
 Optional:
 
-* The local result directory path: to store the results in your local
+- The local result directory path: to store the results in your local
   environement. It shall corresponds to the internal result docker path
   /var/lib/xtesting/results
 
@@ -45,27 +41,85 @@ the image as a jobs within onap namespace.
 An example of job is provided in the job subdirectory. You need to setup the
 following variables:
 
-* Mandatory:
-  * run_type: the name of the use case: core, small, medium, full, healthdist
-  * onap_namespace: onap name space (usually set to onap)
-* Optional:
-  * deployment_name: parameter for the results pushed into the database (e.g.
+- Mandatory:
+  - run_type: the name of the use case: core, full, healthdist, postinstall
+  - onap_namespace: onap name space (usually set to onap)
+- Optional:
+  - deployment_name: parameter for the results pushed into the database (e.g.
     daily-master)
-  * deploy_scenario: parameter for the results pushed into the database (e.g.
+  - deploy_scenario: parameter for the results pushed into the database (e.g.
     rke_istio_baremetal)
-  * node_name: parameter for the results pushed into the database. This
+  - node_name: parameter for the results pushed into the database. This
     parameter must match the pod declaration in the database otherwise the
     results will not be accepted
-  * test_result_url: the url of the test database
-  * build_tag: parameter for the results pushed into the database. It is used to
+  - test_result_url: the url of the test database
+  - build_tag: parameter for the results pushed into the database. It is used to
     identify the CI run. It can be used indirectly to retrieve the version
-  * res_local_path: the path where you want to save the result logs on your
+  - res_local_path: the path where you want to save the result logs on your
     local machine
 
 By default (in scripts/cmd.sh), the -r option is enabled in the job template.
 It means that xtesting will try to push the results to the DB.
 If the parameters are not set, an error will be displayed (DB not reachable)
 
+### Example
+
+For the core test, the job description (test-core.yaml) shall look as follows:
+
+```
+apiVersion: batch/v1
+kind: Job
+metadata:
+    name: integration-onap-core
+    namespace: onap
+spec:
+    template:
+        spec:
+            containers:
+            -   env:
+                -   name: INSTALLER_TYPE
+                    value: oom
+                -   name: DEPLOY_SCENARIO
+                    value: onap-nofeature-noha
+                -   name: NODE_NAME
+                    value: onap_daily_pod4_master-ONAP-oom
+                -   name: TEST_DB_URL
+                    value: http://testresults.opnfv.org/onap/api/v1/results
+                -   name: BUILD_TAG
+                    value: gitlab_ci-functest-kubespray-baremetal-daily-master-209039216-onap
+                -   name: TAG
+                    value: core
+                image: nexus3.onap.org:10003/onap/xtesting-healthcheck:master
+                imagePullPolicy: Always
+                name: functest-onap
+                volumeMounts:
+                -   mountPath: /etc/localtime
+                    name: localtime
+                    readOnly: true
+                -   mountPath: /share/config
+                    name: robot-eteshare
+                -   mountPath: /var/lib/xtesting/results/
+                    name: robot-save-results
+            restartPolicy: Never
+            volumes:
+            -   hostPath:
+                    path: /etc/localtime
+                name: localtime
+            -   configMap:
+                    defaultMode: 493
+                    name: onap-robot-eteshare-configmap
+                name: robot-eteshare
+            -   hostPath:
+                    path: /dockerdata-nfs/onap/integration/xtesting-healthcheck/core
+                name: robot-save-results
+```
+
+This job can be simply run using the command:
+
+```
+kubectl apply -f test-core.yaml
+```
+
 ### Output
 
 ```