Move former wiki to README.md

https://wiki.opnfv.org/pages/viewpage.action?pageId=20742412

Change-Id: I75a9303b2ee5b2df66e0169b37408bb9ad881d5a
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
(cherry picked from commit 15f754678e4c8734c4600fea94fcbe66f2584515)

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e5d881e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,118 @@
+# Functest
+
+Network virtualization has dramatically modified our architectures which asks
+for more automation and powerful testing tools like Functest, a collection of
+state-of-the-art virtual infrastructure test suites, including automatic VNF
+testing (cf.
+[[1]](https://www.linuxfoundation.org/press-release/2019/05/opnfv-hunter-delivers-test-tools-ci-cd-framework-to-enable-common-nfvi-for-verifying-vnfs/)).
+
+In context of OPNFV, Functest verifies any kind of OpenStack and Kubernetes
+deployments including production environments. It conforms to upstream rules
+and integrates smoothly lots of the test cases available in the opensource
+market. It includes about 3000+ functional tests and 3 hours upstream API and
+dataplane benchmarks. It’s completed by Virtual Network Function deployments
+and testing (vIMS, vRouter and vEPC) to ensure that the platforms meet Network
+Functions Virtualization requirements. Raspberry PI is also supported to verify
+datacenters as the lowest cost (50 euros hardware and software included).
+
+| Functest releases | Kubernetes releases       |
+|-------------------|---------------------------|
+| Hunter            | v1.13                     |
+| Iruya             | v1.15                     |
+| Jerma             | v1.17                     |
+| Kali              | v1.19                     |
+| **Leguer**        | **v1.20**                 |
+| Master            | v1.21.0-alpha.3 (rolling) |
+
+## Prepare your environment
+
+cat env
+```
+DEPLOY_SCENARIO=k8s-XXX
+```
+
+## Run healthcheck suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/config:/root/.kube/config \
+    opnfv/functest-kubernetes-healthcheck:leguer
+```
+
+```
++-------------------+------------------+---------------------+------------------+----------------+
+|     TEST CASE     |     PROJECT      |         TIER        |     DURATION     |     RESULT     |
++-------------------+------------------+---------------------+------------------+----------------+
+|     k8s_quick     |     functest     |     healthcheck     |      00:13       |      PASS      |
+|     k8s_smoke     |     functest     |     healthcheck     |      00:26       |      PASS      |
++-------------------+------------------+---------------------+------------------+----------------+
+```
+
+## Run smoke suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/config:/root/.kube/config \
+    opnfv/functest-kubernetes-smoke:leguer
+```
+
+```
++---------------------------+------------------+---------------+------------------+----------------+
+|         TEST CASE         |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
++---------------------------+------------------+---------------+------------------+----------------+
+|      k8s_conformance      |     functest     |     smoke     |      103:05      |      PASS      |
+|     xrally_kubernetes     |     functest     |     smoke     |      14:17       |      PASS      |
++---------------------------+------------------+---------------+------------------+----------------+
+```
+
+## Run security suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/config:/root/.kube/config \
+    opnfv/functest-kubernetes-security:leguer
+```
+
+```
++---------------------------+------------------+------------------+------------------+----------------+
+|         TEST CASE         |     PROJECT      |       TIER       |     DURATION     |     RESULT     |
++---------------------------+------------------+------------------+------------------+----------------+
+|        kube_hunter        |     functest     |     security     |      00:18       |      PASS      |
+|     kube_bench_master     |     functest     |     security     |      00:07       |      PASS      |
+|      kube_bench_node      |     functest     |     security     |      00:06       |      PASS      |
++---------------------------+------------------+------------------+------------------+----------------+
+```
+
+## Run benchmarking suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/config:/root/.kube/config \
+    opnfv/functest-kubernetes-benchmarking:leguer
+```
+
+```
++--------------------------------+------------------+----------------------+------------------+----------------+
+|           TEST CASE            |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
++--------------------------------+------------------+----------------------+------------------+----------------+
+|     xrally_kubernetes_full     |     functest     |     benchmarking     |      39:15       |      PASS      |
++--------------------------------+------------------+----------------------+------------------+----------------+
+```
+
+## Run cnf suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/config:/root/.kube/config \
+    opnfv/functest-kubernetes-cnf:leguer
+```
+
+```
++-------------------------+------------------+--------------+------------------+----------------+
+|        TEST CASE        |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
++-------------------------+------------------+--------------+------------------+----------------+
+|         k8s_vims        |     functest     |     cnf      |      09:27       |      PASS      |
+|        helm_vims        |     functest     |     cnf      |      09:12       |      PASS      |
+|     cnf_conformance     |     functest     |     cnf      |      02:55       |      PASS      |
++-------------------------+------------------+--------------+------------------+----------------+
+```