aboutsummaryrefslogtreecommitdiffstats
path: root/infra-healthcheck/README.md
diff options
context:
space:
mode:
authormrichomme <morgan.richomme@orange.com>2019-12-10 08:47:28 +0100
committermrichomme <morgan.richomme@orange.com>2019-12-11 12:00:31 +0100
commit1f997a66f658ff11809f44f4630fc678eb091b83 (patch)
treed29e08adfc2a5d193310d9dfc640175b0cf76fc6 /infra-healthcheck/README.md
parent78b4cdd2c5aa084ee6b8cc0f768187be907ae68c (diff)
Move integration xtesting Dockerfile to ONAP
All the Dockerfiles and xtesting configurations were hosted in gitlab.com [1] The goal of this patch is to host these assets in ONAP A jenkins jjb shall be created to generated the docker and push them on the nexus (today the built-in registry of ONAP was used) These xtesting dockers are referencing integration categories [2] and integration use cases [3] These xtesting dockers shall also simplify the way to integrate new use cases in any CI chain (jenkins or gitlab-ci based) [1]: https://gitlab.com/Orange-OpenSource/lfn/onap/integration/xtesting [2]: https://wiki.onap.org/pages/viewpage.action?pageId=71835330 [3]: http://testresults.opnfv.org/onap/api/v1/projects/integration/cases Issue-ID: INT-1366 Signed-off-by: mrichomme <morgan.richomme@orange.com> Change-Id: Iba0fc0b0415731a7a81ba0225a70ae16391dd129 Signed-off-by: mrichomme <morgan.richomme@orange.com>
Diffstat (limited to 'infra-healthcheck/README.md')
-rw-r--r--infra-healthcheck/README.md79
1 files changed, 79 insertions, 0 deletions
diff --git a/infra-healthcheck/README.md b/infra-healthcheck/README.md
new file mode 100644
index 0000000..ba873af
--- /dev/null
+++ b/infra-healthcheck/README.md
@@ -0,0 +1,79 @@
+# infra-healthcheck
+
+## Goal
+
+This infra-healthcheck docker includes the test suites checking kubernetes and
+healm charts of an ONAP deployment.
+
+It includes 2 tests:
+
+* onap-k8s: list pods, deployments, events, cm, ... For any faulty pod, it
+ collects the logs and the describe. The success criteria is 100% of the pods
+ are up&running
+* onap-helm: list the helm charts. The success criteria is all the helm charts
+ are completed.
+
+## Usage
+
+### Configuration
+
+Mandatory:
+
+* The kubernetes configuration: usually hosted on the.kube/config of your
+ jumphost. It corresponds the kubernetes credentials and are needed to perform
+ the different operations. This file shall be copied in /config/.kube/config in
+ the docker.
+
+Optional:
+
+* 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
+
+### Command
+
+You can run this docker by typing:
+
+```
+docker run -v <the kube config>:/config/.kube/config -v
+<result directory>:/var/lib/xtesting/results
+registry.gitlab.com/orange-opensource/lfn/onap/integration/xtesting:latest
+```
+
+Options:
+
+* -r: by default the reporting to the Database is not enabled. You need to
+ specify the -r option in the command line. Please note that in this case, you
+ must precise some env variables.
+
+environement variables:
+
+* Mandatory:
+ * TEST_DB_URL: the url of the target Database with the env variable .
+ * NODE_NAME: the name of your test environement. It must be declared in the
+ test database (e.g. windriver-SB00)
+* Optionnal
+ * INSTALLER_TYPE: precise how your ONAP has been installed (e.g. kubespray-oom,
+ rke-oom)
+ * BUILD_TAG: a unique tag of your CI system. It can be usefull to get all the
+ tests of one CI run. It uses the regex (dai|week)ly-(.+?)-[0-9]* to find the
+ version (e.g. daily-elalto-123456789).
+
+The command becomes:
+
+```
+docker run -v <the kube config>:/config/.kube/config -v
+<result directory>:/var/lib/xtesting/results registry.gitlab.com/orange-opensour
+ce/lfn/onap/integration/xtesting:latest /bin/bash -c "run_tests -r -t all
+```
+
+### Output
+
+```
++------------+-------------+-------------------+----------+--------+
+| TEST CASE | PROJECT | TIER | DURATION | RESULT |
++------------+-------------+-------------------+----------+--------+
+| onap-k8s | integration | infra-healthcheck | 00:06 | PASS |
+| onap-helm | integration | infra-healthcheck | 00:01 | PASS |
++------------+-------------+-------------------+----------+--------+
+```