Update kube_bench split in doc

[functest.git] / docs / testing / user / configguide / configguide.rst

diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst
index c4d9a6d..ae3c79a 100644 (file)
--- a/docs/testing/user/configguide/configguide.rst
+++ b/docs/testing/user/configguide/configguide.rst
@@ -1,4 +1,3 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.

 .. SPDX-License-Identifier: CC-BY-4.0
 
 Installation and configuration
 .. SPDX-License-Identifier: CC-BY-4.0
 
 Installation and configuration


@@ -10,36 +9,31 @@ the refactoring on dependency management should allow the creation of light and
 fully customized docker images.
 
 
 fully customized docker images.
 
 

-Functest Dockers
-----------------
+Functest Dockers for OpenStack deployment
+-----------------------------------------

 Docker images are available on the dockerhub:
 
 Docker images are available on the dockerhub:
 

-  * opnfv/functest-core

   * opnfv/functest-healthcheck
   * opnfv/functest-smoke
   * opnfv/functest-healthcheck
   * opnfv/functest-smoke

-  * opnfv/functest-features
-  * opnfv/functest-components
+  * opnfv/functest-smoke-cntt
+  * opnfv/functest-benchmarking
+  * opnfv/functest-benchmarking-cntt

   * opnfv/functest-vnf
   * opnfv/functest-vnf

-  * opnfv/functest-parser
-  * opnfv/functest-restapi
-
-The tag "opnfv-5.0.0" is the official release image in Euphrates, but you can also pull "euphrates"
-tag as it is being maintained by Functest team and might include bugfixes.
-
-The Functest docker container environment can -in principle- be also
-used with non-OPNFV official installers (e.g. 'devstack'), with the
-**disclaimer** that support for such environments is outside of the
-scope and responsibility of the OPNFV project.

 
 
 Preparing your environment
 
 
 Preparing your environment

---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 
 cat env::
 
 
 cat env::
 

-  INSTALLER_TYPE=XXX
-  EXTERNAL_NETWORK=XXX
-  DEPLOY_SCENARIO=XXX
+  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

 
 See section on environment variables for details.
 
 
 See section on environment variables for details.
 


@@ -49,37 +43,29 @@ cat env_file::
   export OS_USER_DOMAIN_NAME=XXX
   export OS_PROJECT_DOMAIN_NAME=XXX
   export OS_USERNAME=XXX
   export OS_USER_DOMAIN_NAME=XXX
   export OS_PROJECT_DOMAIN_NAME=XXX
   export OS_USERNAME=XXX

-  export OS_TENANT_NAME=XXX

   export OS_PROJECT_NAME=XXX
   export OS_PASSWORD=XXX
   export OS_PROJECT_NAME=XXX
   export OS_PASSWORD=XXX

-  export OS_VOLUME_API_VERSION=XXX
-  export OS_IDENTITY_API_VERSION=XXX
-  export OS_IMAGE_API_VERSION=XXX
+  export OS_IDENTITY_API_VERSION=3
+  export OS_REGION_NAME=XXX

 
 See section on OpenStack credentials for details.
 
 Create a directory for the different images (attached as a Docker volume)::
 
 
 See section on OpenStack credentials for details.
 
 Create a directory for the different images (attached as a Docker volume)::
 

-  mkdir -p images && wget -q -O- https://git.opnfv.org/functest/plain/functest/ci/download_images.sh?h=stable/euphrates | bash -s -- images && ls -1 images/*
-
-  images/CentOS-7-aarch64-GenericCloud.qcow2
-  images/CentOS-7-aarch64-GenericCloud.qcow2.xz
-  images/CentOS-7-x86_64-GenericCloud.qcow2
-  images/cirros-0.4.0-x86_64-disk.img
-  images/cirros-0.4.0-x86_64-lxc.tar.gz
-  images/cirros-d161201-aarch64-disk.img
-  images/cirros-d161201-aarch64-initramfs
-  images/cirros-d161201-aarch64-kernel
-  images/cloudify-manager-premium-4.0.1.qcow2
-  images/img
-  images/trusty-server-cloudimg-amd64-disk1.img
+  mkdir -p images && wget -q -O- https://git.opnfv.org/functest/plain/functest/ci/download_images.sh | bash -s -- images && ls -1 images/*
+
+  images/cirros-0.5.1-aarch64-disk.img
+  images/cirros-0.5.1-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/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.7.img
+  images/vyos-1.1.8-amd64.qcow2

 
 Testing healthcheck suite
 
 Testing healthcheck suite

---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^

 
 Run healthcheck suite::
 
 
 Run healthcheck suite::
 


@@ -90,17 +76,28 @@ Run healthcheck suite::
 
 Results shall be displayed as follows::
 
 
 Results shall be displayed as follows::
 

-  +----------------------------+------------------+---------------------+------------------+----------------+
-  |         TEST CASE          |     PROJECT      |         TIER        |     DURATION     |     RESULT     |
-  +----------------------------+------------------+---------------------+------------------+----------------+
-  |      connection_check      |     functest     |     healthcheck     |      00:06       |      PASS      |
-  |         api_check          |     functest     |     healthcheck     |      06:52       |      PASS      |
-  |     snaps_health_check     |     functest     |     healthcheck     |      00:42       |      PASS      |
-  +----------------------------+------------------+---------------------+------------------+----------------+
-  NOTE: the duration is a reference and it might vary depending on your SUT.
+  +--------------------------+------------------+---------------------+------------------+----------------+
+  |        TEST CASE         |     PROJECT      |         TIER        |     DURATION     |     RESULT     |
+  +--------------------------+------------------+---------------------+------------------+----------------+
+  |     connection_check     |     functest     |     healthcheck     |      00:03       |      PASS      |
+  |      tenantnetwork1      |     functest     |     healthcheck     |      00:05       |      PASS      |
+  |      tenantnetwork2      |     functest     |     healthcheck     |      00:06       |      PASS      |
+  |         vmready1         |     functest     |     healthcheck     |      00:06       |      PASS      |
+  |         vmready2         |     functest     |     healthcheck     |      00:08       |      PASS      |
+  |        singlevm1         |     functest     |     healthcheck     |      00:32       |      PASS      |
+  |        singlevm2         |     functest     |     healthcheck     |      00:37       |      PASS      |
+  |        vping_ssh         |     functest     |     healthcheck     |      00:46       |      PASS      |
+  |      vping_userdata      |     functest     |     healthcheck     |      00:39       |      PASS      |
+  |       cinder_test        |     functest     |     healthcheck     |      01:05       |      PASS      |
+  |      tempest_smoke       |     functest     |     healthcheck     |      05:39       |      PASS      |
+  |     tempest_horizon      |     functest     |     healthcheck     |      01:05       |      PASS      |
+  |           odl            |     functest     |     healthcheck     |      00:00       |      SKIP      |
+  +--------------------------+------------------+---------------------+------------------+----------------+
+
+NOTE: the duration is a reference and it might vary depending on your SUT.

 
 Testing smoke suite
 
 Testing smoke suite

--------------------
+^^^^^^^^^^^^^^^^^^^

 
 Run smoke suite::
 
 
 Run smoke suite::
 


@@ -111,94 +108,245 @@ Run smoke suite::
 
 Results shall be displayed as follows::
 
 
 Results shall be displayed as follows::
 

-  +------------------------------+------------------+---------------+------------------+----------------+
-  |          TEST CASE           |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
-  +------------------------------+------------------+---------------+------------------+----------------+
-  |          vping_ssh           |     functest     |     smoke     |      00:45       |      PASS      |
-  |        vping_userdata        |     functest     |     smoke     |      00:36       |      PASS      |
-  |     tempest_smoke_serial     |     functest     |     smoke     |      14:04       |      PASS      |
-  |         rally_sanity         |     functest     |     smoke     |      23:59       |      PASS      |
-  |       refstack_defcore       |     functest     |     smoke     |      14:37       |      FAIL      |
-  |         snaps_smoke          |     functest     |     smoke     |      42:09       |      PASS      |
-  |             odl              |     functest     |     smoke     |      00:00       |      SKIP      |
-  |         odl_netvirt          |     functest     |     smoke     |      00:00       |      SKIP      |
-  +------------------------------+------------------+---------------+------------------+----------------+
-  Note: if the scenario does not support some tests, they are indicated as SKIP.
-  See User guide for details.
-
-Testing features suite
-----------------------
-
-Run features suite::
+  +---------------------------+------------------+---------------+------------------+----------------+
+  |         TEST CASE         |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
+  +---------------------------+------------------+---------------+------------------+----------------+
+  |      tempest_neutron      |     functest     |     smoke     |      15:30       |      PASS      |
+  |       tempest_cinder      |     functest     |     smoke     |      02:01       |      PASS      |
+  |      tempest_keystone     |     functest     |     smoke     |      01:17       |      PASS      |
+  |        tempest_heat       |     functest     |     smoke     |      22:14       |      PASS      |
+  |     tempest_telemetry     |     functest     |     smoke     |      00:00       |      SKIP      |
+  |        rally_sanity       |     functest     |     smoke     |      17:24       |      PASS      |
+  |      refstack_compute     |     functest     |     smoke     |      07:03       |      PASS      |
+  |      refstack_object      |     functest     |     smoke     |      02:09       |      PASS      |
+  |     refstack_platform     |     functest     |     smoke     |      07:31       |      PASS      |
+  |        tempest_full       |     functest     |     smoke     |      41:52       |      PASS      |
+  |      tempest_scenario     |     functest     |     smoke     |      08:42       |      PASS      |
+  |        tempest_slow       |     functest     |     smoke     |      43:42       |      PASS      |
+  |          patrole          |     functest     |     smoke     |      02:42       |      PASS      |
+  |      tempest_barbican     |     functest     |     smoke     |      02:30       |      PASS      |
+  |      tempest_octavia      |     functest     |     smoke     |      00:00       |      SKIP      |
+  +---------------------------+------------------+---------------+------------------+----------------+
+
+Note: if the scenario does not support some tests, they are indicated as SKIP.
+See User guide for details.
+
+Testing smoke CNTT suite
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Run smoke-cntt suite::
+
+  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
+
+Results shall be displayed as follows::
+
+  +-------------------------------+------------------+---------------+------------------+----------------+
+  |           TEST CASE           |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
+  +-------------------------------+------------------+---------------+------------------+----------------+
+  |      tempest_neutron_cntt     |     functest     |     smoke     |      11:35       |      PASS      |
+  |      tempest_cinder_cntt      |     functest     |     smoke     |      01:58       |      PASS      |
+  |     tempest_keystone_cntt     |     functest     |     smoke     |      01:13       |      PASS      |
+  |       tempest_heat_cntt       |     functest     |     smoke     |      22:32       |      PASS      |
+  |       rally_sanity_cntt       |     functest     |     smoke     |      17:16       |      PASS      |
+  |       tempest_full_cntt       |     functest     |     smoke     |      41:13       |      PASS      |
+  |     tempest_scenario_cntt     |     functest     |     smoke     |      08:57       |      PASS      |
+  |       tempest_slow_cntt       |     functest     |     smoke     |      35:58       |      PASS      |
+  +-------------------------------+------------------+---------------+------------------+----------------+
+
+Testing benchmarking suite
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Run benchmarking suite::

 
   sudo docker run --env-file env \
       -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
       -v $(pwd)/images:/home/opnfv/functest/images \
 
   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-features
+      opnfv/functest-benchmarking

 
 Results shall be displayed as follows::
 
 
 Results shall be displayed as follows::
 

-  +-----------------------------+------------------------+------------------+------------------+----------------+
-  |          TEST CASE          |        PROJECT         |       TIER       |     DURATION     |     RESULT     |
-  +-----------------------------+------------------------+------------------+------------------+----------------+
-  |     doctor-notification     |         doctor         |     features     |      00:00       |      SKIP      |
-  |            bgpvpn           |         sdnvpn         |     features     |      00:00       |      SKIP      |
-  |       functest-odl-sfc      |          sfc           |     features     |      00:00       |      SKIP      |
-  |      barometercollectd      |       barometer        |     features     |      00:00       |      SKIP      |
-  |             fds             |     fastdatastacks     |     features     |      00:00       |      SKIP      |
-  +-----------------------------+------------------------+------------------+------------------+----------------+
-  Note: if the scenario does not support some tests, they are indicated as SKIP.
-  See User guide for details.
+  +--------------------+------------------+----------------------+------------------+----------------+
+  |     TEST CASE      |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
+  +--------------------+------------------+----------------------+------------------+----------------+
+  |     rally_full     |     functest     |     benchmarking     |      93:03       |      PASS      |
+  |     rally_jobs     |     functest     |     benchmarking     |      27:05       |      PASS      |
+  |        vmtp        |     functest     |     benchmarking     |      17:56       |      PASS      |
+  |       shaker       |     functest     |     benchmarking     |      24:02       |      PASS      |
+  +--------------------+------------------+----------------------+------------------+----------------+

 
 

-Testing components suite
-------------------------
+Note: if the scenario does not support some tests, they are indicated as SKIP.
+See User guide for details.

 
 

-Run components suite::
+Testing benchmarking CNTT suite
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Run benchmarking-cntt suite::

 
   sudo docker run --env-file env \
       -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
       -v $(pwd)/images:/home/opnfv/functest/images \
 
   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-components
+      opnfv/functest-benchmarking-cntt

 
 Results shall be displayed as follows::
 
 
 Results shall be displayed as follows::
 

-  +-------------------------------+------------------+--------------------+------------------+----------------+
-  |           TEST CASE           |     PROJECT      |        TIER        |     DURATION     |     RESULT     |
-  +-------------------------------+------------------+--------------------+------------------+----------------+
-  |     tempest_full_parallel     |     functest     |     components     |      52:42       |      PASS      |
-  |           rally_full          |     functest     |     components     |      114:22      |      PASS      |
-  +-------------------------------+------------------+--------------------+------------------+----------------+
+  +-------------------------+------------------+----------------------+------------------+----------------+
+  |        TEST CASE        |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
+  +-------------------------+------------------+----------------------+------------------+----------------+
+  |     rally_full_cntt     |     functest     |     benchmarking     |      89:52       |      PASS      |
+  |     rally_jobs_cntt     |     functest     |     benchmarking     |      19:39       |      PASS      |
+  |           vmtp          |     functest     |     benchmarking     |      16:59       |      PASS      |
+  |          shaker         |     functest     |     benchmarking     |      23:43       |      PASS      |
+  +-------------------------+------------------+----------------------+------------------+----------------+

 
 Testing vnf suite
 
 Testing vnf suite

------------------
+^^^^^^^^^^^^^^^^^

 
 Run vnf suite::
 
 
 Run vnf suite::
 

-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
+  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
+
+Results shall be displayed as follows::
+
+  +----------------------+------------------+--------------+------------------+----------------+
+  |      TEST CASE       |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
+  +----------------------+------------------+--------------+------------------+----------------+
+  |       cloudify       |     functest     |     vnf      |      05:08       |      PASS      |
+  |     cloudify_ims     |     functest     |     vnf      |      24:46       |      PASS      |
+  |       heat_ims       |     functest     |     vnf      |      33:12       |      PASS      |
+  |     vyos_vrouter     |     functest     |     vnf      |      15:53       |      PASS      |
+  |       juju_epc       |     functest     |     vnf      |      27:52       |      PASS      |
+  +----------------------+------------------+--------------+------------------+----------------+
+
+Functest Dockers for Kubernetes deployment
+------------------------------------------
+Docker images are available on the dockerhub:
+
+  * opnfv/functest-kubernetes-healthcheck
+  * opnfv/functest-kubernetes-smoke
+  * opnfv/functest-kubernetes-security
+  * opnfv/functest-kubernetes-benchmarking
+  * opnfv/functest-kubernetes-cnf
+
+Preparing your environment
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+cat env::
+
+  DEPLOY_SCENARIO=k8s-XXX
+
+Testing healthcheck suite
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Run healthcheck suite::
+
+  sudo docker run -it --env-file env \
+      -v $(pwd)/config:/root/.kube/config \
+      opnfv/functest-kubernetes-healthcheck
+
+A config file in the current dir 'config' is also required, which should be
+volume mapped to ~/.kube/config inside kubernetes container.
+
+Results shall be displayed as follows::
+
+  +-------------------+------------------+---------------------+------------------+----------------+
+  |     TEST CASE     |     PROJECT      |         TIER        |     DURATION     |     RESULT     |
+  +-------------------+------------------+---------------------+------------------+----------------+
+  |     k8s_quick     |     functest     |     healthcheck     |      00:18       |      PASS      |
+  |     k8s_smoke     |     functest     |     healthcheck     |      01:14       |      PASS      |
+  +-------------------+------------------+---------------------+------------------+----------------+
+
+Testing smoke suite
+^^^^^^^^^^^^^^^^^^^
+
+Run smoke suite::
+
+  sudo docker run -it --env-file env \
+      -v $(pwd)/config:/root/.kube/config \
+      opnfv/functest-kubernetes-smoke
+
+Results shall be displayed as follows::
+
+  +---------------------------+------------------+---------------+------------------+----------------+
+  |         TEST CASE         |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
+  +---------------------------+------------------+---------------+------------------+----------------+
+  |      k8s_conformance      |     functest     |     smoke     |      94:26       |      PASS      |
+  |     xrally_kubernetes     |     functest     |     smoke     |      13:05       |      PASS      |
+  +---------------------------+------------------+---------------+------------------+----------------+
+
+Testing security suite
+^^^^^^^^^^^^^^^^^^^^^^
+
+Run smoke suite::
+
+  sudo docker run -it --env-file env \
+      -v $(pwd)/config:/root/.kube/config \
+      opnfv/functest-kubernetes-security

 
 Results shall be displayed as follows::
 
 
 Results shall be displayed as follows::
 

-  +---------------------------------+-------------------+--------------+------------------+----------------+
-  |            TEST CASE            |      PROJECT      |     TIER     |     DURATION     |     RESULT     |
-  +---------------------------------+-------------------+--------------+------------------+----------------+
-  |           cloudify_ims          |      functest     |     vnf      |      28:49       |      FAIL      |
-  |           vyos_vrouter          |      functest     |     vnf      |      27:57       |      FAIL      |
-  |             juju_epc            |      functest     |     vnf      |      55:03       |      PASS      |
-  |        orchestra_openims        |     orchestra     |     vnf      |      00:00       |      SKIP      |
-  |     orchestra_clearwaterims     |     orchestra     |     vnf      |      00:00       |      SKIP      |
-  +---------------------------------+-------------------+--------------+------------------+----------------+
+  +---------------------------+------------------+------------------+------------------+----------------+
+  |         TEST CASE         |     PROJECT      |       TIER       |     DURATION     |     RESULT     |
+  +---------------------------+------------------+------------------+------------------+----------------+
+  |        kube_hunter        |     functest     |     security     |      00:19       |      PASS      |
+  |     kube_bench_master     |     functest     |     security     |      00:02       |      PASS      |
+  |      kube_bench_node      |     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
+
+Results shall be displayed as follows::
+
+  +--------------------------------+------------------+----------------------+------------------+----------------+
+  |           TEST CASE            |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
+  +--------------------------------+------------------+----------------------+------------------+----------------+
+  |     xrally_kubernetes_full     |     functest     |     benchmarking     |      34:16       |      PASS      |
+  +--------------------------------+------------------+----------------------+------------------+----------------+
+
+Testing cnf suite
+^^^^^^^^^^^^^^^^^
+
+Run cnf suite::
+
+  sudo docker run -it --env-file env \
+      -v $(pwd)/config:/root/.kube/config \
+      opnfv/functest-kubernetes-cnf
+
+Results shall be displayed as follows::
+
+  +-------------------------+------------------+--------------+------------------+----------------+
+  |        TEST CASE        |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
+  +-------------------------+------------------+--------------+------------------+----------------+
+  |     cnf_conformance     |     functest     |     cnf      |      05:30       |      PASS      |
+  |         k8s_vims        |     functest     |     cnf      |      20:28       |      PASS      |
+  +-------------------------+------------------+--------------+------------------+----------------+

 
 Environment variables
 =====================
 
 
 Environment variables
 =====================
 

-Several environement variables may be specified:
-  * INSTALLER_TYPE=(apex|compass|daisy|fuel|joid)
+Several environment variables may be specified:
+
+  * INSTALLER_IP=<Specific IP Address>

   * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>
   * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>

+  * NAMESERVER=XXX  # if not 8.8.8.8
+  * VOLUME_DEVICE_NAME=XXX  # if not vdb
+  * EXTERNAL_NETWORK=XXX # if not first network with router:external=True
+  * NEW_USER_ROLE=XXX # if not member

 
 

+INSTALLER_IP is required by Barometer in order to access the installer node and
+the deployment.

 
 The format for the DEPLOY_SCENARIO env variable can be described as follows:
   * vim: (os|k8s) = OpenStack or Kubernetes
 
 The format for the DEPLOY_SCENARIO env variable can be described as follows:
   * vim: (os|k8s) = OpenStack or Kubernetes


@@ -215,8 +363,8 @@ release note.
 
 **NOTE:** The scenario name is mainly used to automatically detect
 if a test suite is runnable or not (e.g. it will prevent ODL test suite to be
 
 **NOTE:** The scenario name is mainly used to automatically detect
 if a test suite is runnable or not (e.g. it will prevent ODL test suite to be

-run on 'nosdn' scenarios). If not set, Functest will try to run the default test
-cases that might not include SDN controller or a specific feature
+run on 'nosdn' scenarios). If not set, Functest will try to run the default
+test cases that might not include SDN controller or a specific feature.

 
 **NOTE:** An HA scenario means that 3 OpenStack controller nodes are
 deployed. It does not necessarily mean that the whole system is HA. See
 
 **NOTE:** An HA scenario means that 3 OpenStack controller nodes are
 deployed. It does not necessarily mean that the whole system is HA. See


@@ -228,8 +376,9 @@ to the Functest Docker Container, using the -e
 only relevant to Jenkins CI invoked testing and **should not be used**
 when performing manual test scenarios:
 
 only relevant to Jenkins CI invoked testing and **should not be used**
 when performing manual test scenarios:
 

-  * NODE_NAME = <Test POD Name>
-  * BUILD_TAG = <Jenkins Build Tag>
+  * INSTALLER_TYPE=(apex|compass|daisy|fuel)
+  * NODE_NAME=<Test POD Name>
+  * BUILD_TAG=<Jenkins Build Tag>

 
 where:
 
 
 where:
 


@@ -305,194 +454,6 @@ be::
 
   export OS_INSECURE=true
 
 
   export OS_INSECURE=true
 

-Functest docker container directory structure
-=============================================
-Inside the Functest docker container, the following directory structure
-should now be in place::
-
-  `--
-    |- home
-    |   |-- opnfv
-    |   |     `- functest
-    |   |          |-- conf
-    |   |          `-- results
-    |    `-- repos
-    |       `-- vnfs
-    |- src
-    |   |-- tempest
-    |   |-- vims-test
-    |   |-- odl_test
-    |   `-- fds
-    `- usr
-        `- lib
-           `- python2.7
-              `- site-packages
-                 `- functest
-                      |-- ...
-
-Underneath the '/home/opnfv/functest' directory, the Functest docker container
-includes two main directories:
-
-  * The **conf** directory stores configuration files (e.g. the
-    OpenStack creds are stored in path '/home/opnfv/functest/conf/env_file'),
-  * the **results** directory stores some temporary result log files
-
-src and repos directories are used to host third party code used for the tests.
-
-The structure of functest repo can be described as follows::
-
-  |-- INFO
-  |-- LICENSE
-  |-- api
-  |  `-- apidoc
-  |-- build.sh
-  |-- commons
-  |-- docker
-  |  |-- components
-  |  |-- core
-  |  |-- features
-  |  |-- healthcheck
-  |  |-- smoke
-  |  |-- vnf
-  |  |-- parser
-  |  |-- restapi
-  |  |-- thirdparty-requirements.txt
-  |-- docs
-  |  |-- com
-  |  |-- images
-  |  |-- release
-  |  |  `-- release-notes
-  |  |-- results
-  |  | testing
-  |  |  |-- developer
-  |  |    `-- user
-  |  |      |-- configguide
-  |  |      `-- userguide
-  `-- functest
-    |-- api
-    |  |-- base.py
-    |  |-- server.py
-    |  |-- urls.py
-    |  |-- common
-    |  |  |-- api_utils.py
-    |  |  |-- thread.py
-    |  `-- resources
-    |     `-- v1
-    |        |-- creds.py
-    |        |-- envs.py
-    |        |-- testcases.py
-    |        |-- tiers.py
-    |        |-- tasks.py
-    |  `-- database
-    |     |-- db.py
-    |     `-- v1
-    |        |-- handlers.py
-    |        |-- models.py
-    |  `-- swagger
-    |-- ci
-    │   |-- check_deployment.py
-    │   |-- config_aarch64_patch.yaml
-    │   |-- config_functest.yaml
-    │   |-- config_patch.yaml
-    │   |-- download_images.sh
-    │   |-- logging.ini
-    │   |-- rally_aarch64_patch.conf
-    │   |-- run_tests.py
-    │   |-- testcases.yaml
-    │   |-- tier_builder.py
-    │   |-- tier_handler.py
-    |-- cli
-    │   |-- cli_base.py
-    │   |-- commands
-    │   │   |-- cli_env.py
-    │   │   |-- cli_os.py
-    │   │   |-- cli_testcase.py
-    │   │   |-- cli_tier.py
-    │   |-- functest-complete.sh
-    |-- core
-    │   |-- feature.py
-    │   |-- robotframework.py
-    │   |-- testcase.py
-    │   |-- unit.py
-    │   |-- vnf.py
-    |-- energy
-    │   |-- energy.py
-    |-- opnfv_tests
-    │   `-- openstack
-    │       |-- rally
-    │       |-- refstack_client
-    │       |-- snaps
-    │       |-- tempest
-    │       |-- vping
-    │   `-- sdn
-    │   │    `-- odl
-    │   `-- vnf
-    │       |-- ims
-    │       `-- router
-    |-- tests
-    │   `-- unit
-    │       |-- ci
-    │       |-- cli
-    │       |-- core
-    │       |-- energy
-    │       |-- features
-    │       |-- odl
-    │       |-- openstack
-    │       |-- opnfv_tests
-    │       |-- test_utils.py
-    │       |-- utils
-    │       `-- vnf
-    |-- utils
-    |    |-- config.py
-    |    |-- constants.py
-    |    |-- decorators.py
-    |    |-- env.py
-    |    |-- functest_utils.py
-    |    |-- functest_vacation.py
-    |    |-- openstack_clean.py
-    |    |-- openstack_tacker.py
-    |    `-- openstack_utils.py
-  |-- requirements.txt
-  |-- setup.cfg
-  |-- setup.py
-  |-- test-requirements.txt
-  |-- tox.ini
-  |-- upper-constraints.txt
-
-  (Note: All *.pyc files removed from above list for brevity...)
-
-We may distinguish several directories, the first level has 5 directories:
-
-* **api**: This directory is dedicated to the API (framework) documentations.
-* **commons**: This directory is dedicated for storage of traffic profile or
-  any other test inputs that could be reused by any test project.
-* **docker**: This directory includes the needed files and tools to
-  build the Functest Docker images.
-* **docs**: This directory includes documentation: Release Notes,
-  User Guide, Configuration Guide and Developer Guide.
-* **functest**: This directory contains all the code needed to run
-  functest internal cases and OPNFV onboarded feature or VNF test cases.
-
-Functest directory has 7 sub-directories, which is located under
-/usr/lib/python2.7/site-packages/functest:
-  * **api**: This directory is dedicated for the internal Functest API.
-  * **ci**: This directory contains test structure definition files
-    (e.g <filename>.yaml) and bash shell/python scripts used to
-    configure and execute Functional tests. The test execution script
-    can be executed under the control of Jenkins CI jobs.
-  * **cli**: This directory holds the python based Functest CLI utility
-    source code, which is based on the Python 'click' framework.
-  * **core**: This directory holds the python based Functest core
-      source code. Three abstraction classes have been created to ease
-      the integration of internal, feature or vnf cases.
-  * **opnfv_tests**: This directory includes the scripts required by
-    Functest internal test cases and other feature projects test cases.
-  * **tests**: This directory includes the functest unit tests.
-  * **utils**: this directory holds Python source code for some general
-    purpose helper utilities, which testers can also re-use in their
-    own test code. See for an example the Openstack helper utility:
-    'openstack_utils.py'.
-

 
 Logs
 ====
 
 Logs
 ====


@@ -500,7 +461,7 @@ By default all the logs are put un /home/opnfv/functest/results/functest.log.
 If you want to have more logs in console, you may edit the logging.ini file
 manually.
 Connect on the docker then edit the file located in
 If you want to have more logs in console, you may edit the logging.ini file
 manually.
 Connect on the docker then edit the file located in

-/usr/lib/python2.7/site-packages/functest/ci/logging.ini
+/usr/lib/python3.8/site-packages/xtesting/ci/logging.ini

 
 Change wconsole to console in the desired module to get more traces.
 
 
 Change wconsole to console in the desired module to get more traces.
 


@@ -510,7 +471,8 @@ Configuration
 
 You may also directly modify the python code or the configuration file (e.g.
 testcases.yaml used to declare test constraints) under
 
 You may also directly modify the python code or the configuration file (e.g.
 testcases.yaml used to declare test constraints) under

-/usr/lib/python2.7/site-packages/functest
+/usr/lib/python3.8/site-packages/xtesting and
+/usr/lib/python3.8/site-packages/functest

 
 
 Tips
 
 
 Tips


@@ -602,6 +564,8 @@ If the OpenStack command still does not show anything or complains
 about connectivity issues, it could be due to an incorrect url given to
 the OS_AUTH_URL environment variable. Check the deployment settings.
 
 about connectivity issues, it could be due to an incorrect url given to
 the OS_AUTH_URL environment variable. Check the deployment settings.
 

+.. _`Proxy support`:
+

 Proxy support
 -------------
 If your Jumphost node is operating behind a http proxy, then there are
 Proxy support
 -------------
 If your Jumphost node is operating behind a http proxy, then there are


@@ -611,7 +575,7 @@ succeed:
   #. Initial installation of docker engine First, try following the
      official Docker documentation for Proxy settings. Some issues were
      experienced on CentOS 7 based Jumphost. Some tips are documented
   #. Initial installation of docker engine First, try following the
      official Docker documentation for Proxy settings. Some issues were
      experienced on CentOS 7 based Jumphost. Some tips are documented

-     in section: `Docker Installation on CentOS behind http proxy`_
+     in section: :ref:`Docker Installation on CentOS behind http proxy`

      below.
 
 If that is the case, make sure the resolv.conf and the needed
      below.
 
 If that is the case, make sure the resolv.conf and the needed


@@ -657,7 +621,7 @@ docker container::
 Note: In a Jumphost node based on the CentOS family OS, the **nc**
 commands might not work. You can use the **curl** command instead.
 
 Note: In a Jumphost node based on the CentOS family OS, the **nc**
 commands might not work. You can use the **curl** command instead.
 

-  curl http://www.opnfv.org:80
+  curl https://www.opnfv.org/

 
   <HTML><HEAD><meta http-equiv="content-type"
   .
 
   <HTML><HEAD><meta http-equiv="content-type"
   .


@@ -674,6 +638,8 @@ commands might not work. You can use the **curl** command instead.
   (Ignore the content. If command returns a valid HTML page, it proves
   the connection.)
 
   (Ignore the content. If command returns a valid HTML page, it proves
   the connection.)
 

+.. _`Docker Installation on CentOS behind http proxy`:
+

 Docker Installation on CentOS behind http proxy
 -----------------------------------------------
 This section is applicable for CentOS family OS on Jumphost which
 Docker Installation on CentOS behind http proxy
 -----------------------------------------------
 This section is applicable for CentOS family OS on Jumphost which


@@ -713,11 +679,10 @@ and install the **docker-engine**. The instructions conclude with a
 work with the above pre-requisite actions.
 
 
 work with the above pre-requisite actions.
 
 

-.. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html

 .. _`dockerdocs`: https://docs.docker.com/
 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
 .. _`Install Docker on CentOS`: https://docs.docker.com/engine/installation/linux/centos/
 .. _`Functest User Guide`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
 .. _`images/CentOS-7-x86_64-GenericCloud.qcow2`: https://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
 .. _`dockerdocs`: https://docs.docker.com/
 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
 .. _`Install Docker on CentOS`: https://docs.docker.com/engine/installation/linux/centos/
 .. _`Functest User Guide`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
 .. _`images/CentOS-7-x86_64-GenericCloud.qcow2`: https://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2

-.. _`images/cirros-0.4.0-x86_64-disk.img`: http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img
+.. _`images/cirros-0.5.1-x86_64-disk.img`: http://download.cirros-cloud.net/0.5.1/cirros-0.5.1-x86_64-disk.img

 .. _`images/ubuntu-14.04-server-cloudimg-amd64-disk1.img`: https://cloud-images.ubuntu.com/releases/14.04/release/ubuntu-14.04-server-cloudimg-amd64-disk1.img
 .. _`images/ubuntu-14.04-server-cloudimg-amd64-disk1.img`: https://cloud-images.ubuntu.com/releases/14.04/release/ubuntu-14.04-server-cloudimg-amd64-disk1.img