aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/release/release-notes/functest-release.rst23
-rw-r--r--docs/spelling_wordlist.txt3
-rw-r--r--docs/testing/user/configguide/configguide.rst61
-rw-r--r--docs/testing/user/userguide/test_results.rst29
4 files changed, 102 insertions, 14 deletions
diff --git a/docs/release/release-notes/functest-release.rst b/docs/release/release-notes/functest-release.rst
index dd7d22024..f47ce9518 100644
--- a/docs/release/release-notes/functest-release.rst
+++ b/docs/release/release-notes/functest-release.rst
@@ -1,16 +1,16 @@
.. SPDX-License-Identifier: CC-BY-4.0
-======================================
-OPNFV master release note for Functest
-======================================
+====================================
+OPNFV Kali release note for Functest
+====================================
Abstract
========
This document contains the release notes of the Functest project.
-OPNFV master Release
-====================
+OPNFV Kali Release
+==================
Functest deals with functional testing of the OPNFV solution.
It includes test cases developed within the project, test cases developed in
@@ -67,8 +67,12 @@ Kubernetes
The internal test cases are:
* k8s_smoke
- * xrally_kubernetes
* k8s_conformance
+ * xrally_kubernetes
+ * kube_hunter
+ * kube_bench
+ * xrally_kubernetes_full
+ * k8s_vims
Release Data
============
@@ -76,7 +80,7 @@ Release Data
+--------------------------------------+--------------------------------------+
| **Project** | functest |
+--------------------------------------+--------------------------------------+
-| **Repository branch** | master |
+| **Repository branch** | stable/kali |
+--------------------------------------+--------------------------------------+
Deliverables
@@ -98,8 +102,11 @@ Software
* https://hub.docker.com/r/opnfv/functest-kubernetes-healthcheck
* https://hub.docker.com/r/opnfv/functest-kubernetes-smoke
+ * https://hub.docker.com/r/opnfv/functest-kubernetes-security
+ * https://hub.docker.com/r/opnfv/functest-kubernetes-benchmarking
+ * https://hub.docker.com/r/opnfv/functest-kubernetes-cnf
-Docker tag for master: latest
+Docker tag for Kali: kali
Documents
---------
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index 94452dcf4..802f19e96 100644
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -14,6 +14,7 @@ ci
Clearwater
cloudify
Cloudify
+cnf
cntt
conf
config
@@ -52,6 +53,7 @@ juju
Juju
jumphost
Jumphost
+kali
kube
kubernetes
Kubernetes
@@ -128,6 +130,7 @@ vEPC
verifier
versioned
vIMS
+vims
Virtualised
Virtualized
vm
diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst
index 10476f923..df37d6227 100644
--- a/docs/testing/user/configguide/configguide.rst
+++ b/docs/testing/user/configguide/configguide.rst
@@ -13,7 +13,6 @@ Functest Dockers for OpenStack deployment
-----------------------------------------
Docker images are available on the dockerhub:
- * opnfv/functest-core
* opnfv/functest-healthcheck
* opnfv/functest-smoke
* opnfv/functest-smoke-cntt
@@ -228,9 +227,11 @@ Functest Dockers for Kubernetes deployment
------------------------------------------
Docker images are available on the dockerhub:
- * opnfv/functest-kubernetes-core
* opnfv/functest-kubernetes-healthcheck
* opnfv/functest-kubernetes-smoke
+ * opnfv/functest-kubernetes-security
+ * opnfv/functest-kubernetes-benchmarking
+ * opnfv/functest-kubernetes-cnf
Preparing your environment
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -273,10 +274,62 @@ Results shall be displayed as follows::
+---------------------------+------------------+---------------+------------------+----------------+
| TEST CASE | PROJECT | TIER | DURATION | RESULT |
+---------------------------+------------------+---------------+------------------+----------------+
- | xrally_kubernetes | functest | smoke | 22:04 | PASS |
- | k8s_conformance | functest | smoke | 173:48 | PASS |
+ | k8s_conformance | functest | smoke | 76:12 | PASS |
+ | xrally_kubernetes | functest | smoke | 12:22 | PASS |
+---------------------------+------------------+---------------+------------------+----------------+
+Testing security suite
+^^^^^^^^^^^^^^^^^^^^^^
+
+Run smoke suite::
+
+ sudo docker run -it --env-file env \
+ -v $(pwd)/config:/root/.kube/config \
+ opnfv/functest-kubernetes-security:kali
+
+Results shall be displayed as follows::
+
+ +---------------------+------------------+------------------+------------------+----------------+
+ | TEST CASE | PROJECT | TIER | DURATION | RESULT |
+ +---------------------+------------------+------------------+------------------+----------------+
+ | kube_hunter | functest | security | 00:18 | PASS |
+ | kube_bench | functest | security | 00:01 | PASS |
+ +---------------------+------------------+------------------+------------------+----------------+
+
+Testing benchmarking suite
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Run benchmarking suite::
+
+ sudo docker run -it --env-file env \
+ -v $(pwd)/config:/root/.kube/config \
+ opnfv/functest-kubernetes-benchmarking:kali
+
+Results shall be displayed as follows::
+
+ +--------------------------------+------------------+----------------------+------------------+----------------+
+ | TEST CASE | PROJECT | TIER | DURATION | RESULT |
+ +--------------------------------+------------------+----------------------+------------------+----------------+
+ | xrally_kubernetes_full | functest | benchmarking | 33:07 | PASS |
+ +--------------------------------+------------------+----------------------+------------------+----------------+
+
+Testing cnf suite
+^^^^^^^^^^^^^^^^^
+
+Run cnf suite::
+
+ sudo docker run -it --env-file env \
+ -v $(pwd)/config:/root/.kube/config \
+ opnfv/functest-kubernetes-cnf:kali
+
+Results shall be displayed as follows::
+
+ +-------------------+------------------+--------------+------------------+----------------+
+ | TEST CASE | PROJECT | TIER | DURATION | RESULT |
+ +-------------------+------------------+--------------+------------------+----------------+
+ | k8s_vims | functest | cnf | 20:28 | PASS |
+ +-------------------+------------------+--------------+------------------+----------------+
+
Environment variables
=====================
diff --git a/docs/testing/user/userguide/test_results.rst b/docs/testing/user/userguide/test_results.rst
index c17723868..85ea85d1a 100644
--- a/docs/testing/user/userguide/test_results.rst
+++ b/docs/testing/user/userguide/test_results.rst
@@ -123,10 +123,35 @@ Kubernetes smoke suite::
+---------------------------+------------------+---------------+------------------+----------------+
| TEST CASE | PROJECT | TIER | DURATION | RESULT |
+---------------------------+------------------+---------------+------------------+----------------+
- | xrally_kubernetes | functest | smoke | 22:04 | PASS |
- | k8s_conformance | functest | smoke | 173:48 | PASS |
+ | k8s_conformance | functest | smoke | 76:12 | PASS |
+ | xrally_kubernetes | functest | smoke | 12:22 | PASS |
+---------------------------+------------------+---------------+------------------+----------------+
+Kubernetes security suite::
+
+ +---------------------+------------------+------------------+------------------+----------------+
+ | TEST CASE | PROJECT | TIER | DURATION | RESULT |
+ +---------------------+------------------+------------------+------------------+----------------+
+ | kube_hunter | functest | security | 00:18 | PASS |
+ | kube_bench | functest | security | 00:01 | PASS |
+ +---------------------+------------------+------------------+------------------+----------------+
+
+Kubernetes benchmarking suite::
+
+ +--------------------------------+------------------+----------------------+------------------+----------------+
+ | TEST CASE | PROJECT | TIER | DURATION | RESULT |
+ +--------------------------------+------------------+----------------------+------------------+----------------+
+ | xrally_kubernetes_full | functest | benchmarking | 33:07 | PASS |
+ +--------------------------------+------------------+----------------------+------------------+----------------+
+
+Kubernetes cnf suite::
+
+ +-------------------+------------------+--------------+------------------+----------------+
+ | TEST CASE | PROJECT | TIER | DURATION | RESULT |
+ +-------------------+------------------+--------------+------------------+----------------+
+ | k8s_vims | functest | cnf | 20:28 | PASS |
+ +-------------------+------------------+--------------+------------------+----------------+
+
Results are automatically pushed to the test results database, some additional
result files are pushed to OPNFV artifact web sites.