Publish former wiki page as README.md

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

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

1 files changed, 209 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..fa4dac281
--- /dev/null
+++ b/README.md
@@ -0,0 +1,209 @@
+# 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 | OpenStack releases |
+|-------------------|--------------------|
+| Hunter	          | Rocky              |
+| Iruya             | Stein              |
+| Jerma	            | Train              |
+| **Kali**          | **Ussuri**         |
+| Leguer            | Victoria           |
+| Master    	      | next Wallaby       |
+
+## Prepare your environment
+
+cat env
+```
+DEPLOY_SCENARIO=XXX  # if not os-nosdn-nofeature-noha scenario
+NAMESERVER=XXX  # if not 8.8.8.8
+EXTERNAL_NETWORK=XXX  # if not first network with router:external=True
+DASHBOARD_URL=XXX  # else tempest_horizon will be skipped
+NEW_USER_ROLE=XXX  # if not member
+SDN_CONTROLLER_IP=XXX  # if odl scenario
+VOLUME_DEVICE_NAME=XXX  # if not vdb
+FLAVOR_EXTRA_SPECS=hw:mem_page_size:large  # if fdio scenarios
+```
+
+cat openstack.creds
+```
+export OS_AUTH_URL=XXX
+export OS_USER_DOMAIN_NAME=XXX
+export OS_PROJECT_DOMAIN_NAME=XXX
+export OS_USERNAME=XXX
+export OS_PROJECT_NAME=XXX
+export OS_PASSWORD=XXX
+export OS_IDENTITY_API_VERSION=3
+export OS_REGION_NAME=XXX
+```
+
+mkdir -p images && wget -q -O- https://git.opnfv.org/functest/plain/functest/ci/download_images.sh?h=stable/kali | bash -s -- images && ls -1 images/*
+```
+images/cirros-0.4.0-aarch64-disk.img
+images/cirros-0.4.0-x86_64-disk.img
+images/cloudify-docker-manager-community-19.01.24.tar
+images/Fedora-Cloud-Base-30-1.2.x86_64.qcow2
+images/shaker-image-1.3.0+stretch.qcow2
+images/ubuntu-14.04-server-cloudimg-amd64-disk1.img
+images/ubuntu-14.04-server-cloudimg-arm64-uefi1.img
+images/ubuntu-16.04-server-cloudimg-amd64-disk1.img
+images/vyos-1.1.8-amd64.qcow2
+```
+
+### Run healthcheck suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
+    -v $(pwd)/images:/home/opnfv/functest/images \
+    opnfv/functest-healthcheck:kali
+```
+
+```
++--------------------------+------------------+---------------------+------------------+----------------+
+|        TEST CASE         |     PROJECT      |         TIER        |     DURATION     |     RESULT     |
++--------------------------+------------------+---------------------+------------------+----------------+
+|     connection_check     |     functest     |     healthcheck     |      00:02       |      PASS      |
+|      tenantnetwork1      |     functest     |     healthcheck     |      00:06       |      PASS      |
+|      tenantnetwork2      |     functest     |     healthcheck     |      00:07       |      PASS      |
+|         vmready1         |     functest     |     healthcheck     |      00:08       |      PASS      |
+|         vmready2         |     functest     |     healthcheck     |      00:08       |      PASS      |
+|        singlevm1         |     functest     |     healthcheck     |      00:41       |      PASS      |
+|        singlevm2         |     functest     |     healthcheck     |      00:41       |      PASS      |
+|        vping_ssh         |     functest     |     healthcheck     |      01:03       |      PASS      |
+|      vping_userdata      |     functest     |     healthcheck     |      00:35       |      PASS      |
+|       cinder_test        |     functest     |     healthcheck     |      01:08       |      PASS      |
+|      tempest_smoke       |     functest     |     healthcheck     |      05:26       |      PASS      |
+|     tempest_horizon      |     functest     |     healthcheck     |      01:09       |      PASS      |
+|           odl            |     functest     |     healthcheck     |      00:00       |      SKIP      |
++--------------------------+------------------+---------------------+------------------+----------------+
+```
+
+## Run smoke suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
+    -v $(pwd)/images:/home/opnfv/functest/images \
+    opnfv/functest-smoke:kali
+```
+
+```
++---------------------------+------------------+---------------+------------------+----------------+
+|         TEST CASE         |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
++---------------------------+------------------+---------------+------------------+----------------+
+|      tempest_neutron      |     functest     |     smoke     |      14:27       |      PASS      |
+|       tempest_cinder      |     functest     |     smoke     |      01:53       |      PASS      |
+|      tempest_keystone     |     functest     |     smoke     |      01:19       |      PASS      |
+|        tempest_heat       |     functest     |     smoke     |      23:16       |      PASS      |
+|     tempest_telemetry     |     functest     |     smoke     |      05:03       |      PASS      |
+|        rally_sanity       |     functest     |     smoke     |      19:40       |      PASS      |
+|      refstack_compute     |     functest     |     smoke     |      08:07       |      PASS      |
+|      refstack_object      |     functest     |     smoke     |      02:23       |      PASS      |
+|     refstack_platform     |     functest     |     smoke     |      10:05       |      PASS      |
+|        tempest_full       |     functest     |     smoke     |      41:00       |      PASS      |
+|      tempest_scenario     |     functest     |     smoke     |      09:34       |      PASS      |
+|        tempest_slow       |     functest     |     smoke     |      45:05       |      PASS      |
+|          patrole          |     functest     |     smoke     |      02:30       |      PASS      |
+|      tempest_barbican     |     functest     |     smoke     |      02:16       |      PASS      |
+|      tempest_octavia      |     functest     |     smoke     |      14:01       |      PASS      |
++---------------------------+------------------+---------------+------------------+----------------+
+```
+
+## Run smoke CNTT suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
+    -v $(pwd)/images:/home/opnfv/functest/images \
+    opnfv/functest-smoke-cntt:kali
+```
+
+```
++-------------------------------+------------------+---------------+------------------+----------------+
+|           TEST CASE           |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
++-------------------------------+------------------+---------------+------------------+----------------+
+|      tempest_neutron_cntt     |     functest     |     smoke     |      12:53       |      PASS      |
+|      tempest_cinder_cntt      |     functest     |     smoke     |      01:57       |      PASS      |
+|     tempest_keystone_cntt     |     functest     |     smoke     |      01:15       |      PASS      |
+|       tempest_heat_cntt       |     functest     |     smoke     |      22:23       |      PASS      |
+|       rally_sanity_cntt       |     functest     |     smoke     |      16:11       |      PASS      |
+|       tempest_full_cntt       |     functest     |     smoke     |      34:57       |      PASS      |
+|     tempest_scenario_cntt     |     functest     |     smoke     |      08:51       |      PASS      |
+|       tempest_slow_cntt       |     functest     |     smoke     |      32:09       |      PASS      |
++-------------------------------+------------------+---------------+------------------+----------------+
+```
+
+## Run benchmarking suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
+    -v $(pwd)/images:/home/opnfv/functest/images \
+    opnfv/functest-benchmarking:kali
+```
+
+```
++--------------------+------------------+----------------------+------------------+----------------+
+|     TEST CASE      |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
++--------------------+------------------+----------------------+------------------+----------------+
+|     rally_full     |     functest     |     benchmarking     |      100:35      |      PASS      |
+|     rally_jobs     |     functest     |     benchmarking     |      30:18       |      PASS      |
+|        vmtp        |     functest     |     benchmarking     |      17:18       |      PASS      |
+|       shaker       |     functest     |     benchmarking     |      23:35       |      PASS      |
++--------------------+------------------+----------------------+------------------+----------------+
+```
+
+## Run benchmarking CNTT suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
+    -v $(pwd)/images:/home/opnfv/functest/images \
+    opnfv/functest-benchmarking-cntt:kali
+```
+
+```
++-------------------------+------------------+----------------------+------------------+----------------+
+|        TEST CASE        |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
++-------------------------+------------------+----------------------+------------------+----------------+
+|     rally_full_cntt     |     functest     |     benchmarking     |      85:26       |      PASS      |
+|     rally_jobs_cntt     |     functest     |     benchmarking     |      17:46       |      PASS      |
+|           vmtp          |     functest     |     benchmarking     |      17:11       |      PASS      |
+|          shaker         |     functest     |     benchmarking     |      23:59       |      PASS      |
++-------------------------+------------------+----------------------+------------------+----------------+
+```
+
+## Run vnf suite
+
+```bash
+sudo docker run --env-file env \
+    -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
+    -v $(pwd)/images:/home/opnfv/functest/images \
+    opnfv/functest-vnf:kali
+```
+
+```
++----------------------+------------------+--------------+------------------+----------------+
+|      TEST CASE       |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
++----------------------+------------------+--------------+------------------+----------------+
+|       cloudify       |     functest     |     vnf      |      06:04       |      PASS      |
+|     cloudify_ims     |     functest     |     vnf      |      24:53       |      PASS      |
+|       heat_ims       |     functest     |     vnf      |      29:29       |      PASS      |
+|     vyos_vrouter     |     functest     |     vnf      |      17:19       |      PASS      |
+|       juju_epc       |     functest     |     vnf      |      28:53       |      PASS      |
++----------------------+------------------+--------------+------------------+----------------+
+```