aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrichomme <morgan.richomme@orange.com>2020-04-21 17:59:58 +0200
committermrichomme <morgan.richomme@orange.com>2020-06-04 15:51:39 +0200
commit242950666ad42f4e9523b0fc3cd7c6d71b707103 (patch)
tree3064732cac9c521cefc030d4ebd436677ac7c88a
parentaf53d49b308333dd0b388de539a4e2fb91bdccfa (diff)
Fix md linting errors
Issue-ID: INT-1533 Signed-off-by: mrichomme <morgan.richomme@orange.com> Change-Id: I9fad7a3920b0609338859f7a55c8a78d1f34a571 Signed-off-by: mrichomme <morgan.richomme@orange.com>
-rw-r--r--infra-healthcheck/README.md30
-rw-r--r--security/README.md36
2 files changed, 33 insertions, 33 deletions
diff --git a/infra-healthcheck/README.md b/infra-healthcheck/README.md
index 231ff88..9a27cfd 100644
--- a/infra-healthcheck/README.md
+++ b/infra-healthcheck/README.md
@@ -7,12 +7,12 @@ healm charts of an ONAP deployment.
It includes 2 tests:
-* onap-k8s: list pods, deployments, events, cm, ... For any faulty pod, it
+- 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
+- onap-helm: list the helm charts. The success criteria is all the helm charts
are completed.
-* nodeport_ingress: check that we have a 1:1 corresdpondance between nodeports
+- nodeport_ingress: check that we have a 1:1 corresdpondance between nodeports
and ingress (run only when the env variable DEPLOY_SCENARIO includes ingress)
## Usage
@@ -21,14 +21,14 @@ It includes 2 tests:
Mandatory:
-* The kubernetes configuration: usually hosted on the.kube/config of your
+- 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 /root/.kube/config in
the docker.
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
@@ -44,23 +44,23 @@ registry.gitlab.com/orange-opensource/lfn/onap/integration/xtesting/infra-health
Options:
-* -r: by default the reporting to the Database is not enabled. You need to
+- \-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.
environment variables:
-* Mandatory (if you want to report the results in the database):
- * 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
+- Mandatory (if you want to report the results in the database):
+ - 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
+- 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).
- * DEPLOY_SCENARIO: your scenario deployment. ingress test run only if the
+ - DEPLOY_SCENARIO: your scenario deployment. ingress test run only if the
scenario includes 'ingress'
The command becomes:
diff --git a/security/README.md b/security/README.md
index b350078..3365d55 100644
--- a/security/README.md
+++ b/security/README.md
@@ -7,15 +7,15 @@ of an ONAP deployment.
It includes 6 tests:
-* root_pods: check that pods are nor using root user or started as root
-* unlimitted_pods: check that limits are set for pods
-* cis_kubernetes: perform the k8s cis test suite (upstream src aquasecurity)
-* http_public_endpoints: check that there is no public http endpoints exposed in
+- root_pods: check that pods are nor using root user or started as root
+- unlimitted_pods: check that limits are set for pods
+- cis_kubernetes: perform the k8s cis test suite (upstream src aquasecurity)
+- http_public_endpoints: check that there is no public http endpoints exposed in
ONAP cluster
-* nonssl_endpoints: check that all public HTTP endpoints exposed in ONAP
+- nonssl_endpoints: check that all public HTTP endpoints exposed in ONAP
cluster use SSL tunnels
-* jdpw_ports: check that there are no internal java ports
-* kube_hunter: security suite to search k8s vulnerabilities (upstream src
+- jdpw_ports: check that there are no internal java ports
+- kube_hunter: security suite to search k8s vulnerabilities (upstream src
aquasecurity)
## Usage
@@ -24,14 +24,14 @@ It includes 6 tests:
Mandatory:
-* The kubernetes configuration: usually hosted on the.kube/config of your
+- 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 /root/.kube/config in
the docker.
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
@@ -47,21 +47,21 @@ registry.gitlab.com/orange-opensource/lfn/onap/integration/xtesting/security:lat
Options:
-* -r: by default the reporting to the Database is not enabled. You need to
+- \-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.
environment variables:
-* Mandatory (if you want to report the results in the database):
- * 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
+- Mandatory (if you want to report the results in the database):
+ - 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
+- 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: