Conform with LFN doc rules

[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 d19939a..09fca19 100644 (file)
--- a/docs/testing/user/configguide/configguide.rst
+++ b/docs/testing/user/configguide/configguide.rst
@@ -1,502 +1,439 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.

 .. SPDX-License-Identifier: CC-BY-4.0
 
 .. SPDX-License-Identifier: CC-BY-4.0
 

-Installation and configuration (Ubuntu)
-=======================================
-
-The historical docker file is based on Ubuntu. It has been maintained for
-Euphrates.
-
-Pulling the Docker image
-------------------------
-Pull the Functest Docker image ('opnfv/functest') from the public
-dockerhub registry under the OPNFV account: [̀`dockerhub`_], with the
-following docker command::
-
-  docker pull opnfv/functest:<TagIdentifier>
-
-where <TagIdentifier> identifies a release of the Functest docker
-container image in the public Dockerhub registry. There are many tags
-created automatically by the CI mechanisms, and you must ensure you
-pull an image with the **correct tag** to match the OPNFV software
-release installed in your environment. All available tagged images can
-be seen from location [FunctestDockerTags_]. For example, when running
-on the first official release of the OPNFV Danube system platform,
-tag "danube.1.0" is needed. For the second and third releases, the tag
-"danube.2.0" and "danube.3.0" can be used respectively.
-Pulling other tags might cause some problems while running the tests.
-Docker images pulled without a tag specifier bear the implicitly
-assigned label "latest". If you need to specifically pull the latest
-Functest docker image, then omit the tag argument::
-
-  docker pull opnfv/functest
-
-After pulling the Docker image, check that it is available with the
-following docker command::
-
-  [functester@jumphost ~]$ docker images
-  REPOSITORY     TAG             IMAGE ID      CREATED       SIZE
-  opnfv/functest latest          8cd6683c32ae  2 weeks ago   1.321 GB
-  opnfv/functest danube.2.0      d2c174a91911  7 minutes ago 1.471 GB
-  opnfv/functest danube.1.0      13fa54a1b238  4 weeks ago   1.29 GB
-
-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.
-
-Please note that alpine dockers have been introduced in Euphrates. See alpine
-section for details.
-
-Accessing the Openstack credentials
------------------------------------
-OpenStack credentials are mandatory and must be provided to Functest.
-When running the command "functest env prepare", the framework  will
-automatically look for the Openstack credentials file
-"/home/opnfv/functest/conf/openstack.creds" and will exit with
-error if it is not present or it is empty.
+Installation and configuration
+==============================

 
 

-There are 2 ways to provide that file:
+Alpine containers have been introduced in Euphrates.
+Alpine allows Functest testing in several very light containers and thanks to
+the refactoring on dependency management should allow the creation of light and
+fully customized docker images.

 
 

-  * by using a Docker volume with -v option when creating the Docker container.
-    This is referred to in docker documentation as "Bind Mounting".
-    See the usage of this parameter in the following chapter.
-  * or creating manually the file '/home/opnfv/functest/conf/openstack.creds'
-    inside the running container and pasting the credentials in it. Consult
-    your installer guide for further details. This is however not
-    instructed in this document.

 
 

-There is a default environment variable in the Functest container **$creds**
-that points to the credentials absolute path to help the user with this task.
+Functest Dockers for OpenStack deployment
+-----------------------------------------
+Docker images are available on the dockerhub:

 
 

-In proxified environment you may need to change the credentials file.
-There are some tips in chapter: `Proxy support`_
+  * opnfv/functest-core
+  * opnfv/functest-healthcheck
+  * opnfv/functest-smoke
+  * opnfv/functest-benchmarking
+  * opnfv/functest-features
+  * opnfv/functest-components
+  * opnfv/functest-vnf

 
 

-Functest Docker parameters
---------------------------
-This chapter explains how to run a container for executing functest
-test suites. Numbered list below explains some details of the
-recommended parameters for invoking docker container

 
 

-  #. It is a good practice to assign a precise container name through
-     the **--name** option.
+Preparing your environment
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 
 

-  #. Assign parameter for installer type::
+cat env::

 
 

-       -e "INSTALLER_TYPE=<type>"
-       # Use one of following apex, compass, fuel or joid
+  EXTERNAL_NETWORK=XXX
+  DEPLOY_SCENARIO=XXX  # if not os-nosdn-nofeature-noha scenario
+  NAMESERVER=XXX  # if not 8.8.8.8

 
 

-  #. Functest needs to know the IP of some installers::
+See section on environment variables for details.

 
 

-       -e "INSTALLER_IP=<Specific IP Address>"
+cat env_file::

 
 

-       These two env variables are useful extract some information
-       from the deployment. However, for some test cases like
-       SFC or Barometer they are mandatory since the tests
-       need to access the installer node and the deployment.
+  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
+
+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/fraser | 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/cloudify-manager-premium-4.0.1.qcow2
+  images/shaker-image-arm64.qcow2
+  images/shaker-image.qcow
+  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
+
+Testing healthcheck suite
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Run healthcheck 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-healthcheck
+
+Results shall be displayed as follows::
+
+  +----------------------------+------------------+---------------------+------------------+----------------+
+  |         TEST CASE          |     PROJECT      |         TIER        |     DURATION     |     RESULT     |
+  +----------------------------+------------------+---------------------+------------------+----------------+
+  |      connection_check      |     functest     |     healthcheck     |      00:09       |      PASS      |
+  |       tenantnetwork1       |     functest     |     healthcheck     |      00:14       |      PASS      |
+  |       tenantnetwork2       |     functest     |     healthcheck     |      00:11       |      PASS      |
+  |          vmready1          |     functest     |     healthcheck     |      00:19       |      PASS      |
+  |          vmready2          |     functest     |     healthcheck     |      00:16       |      PASS      |
+  |         singlevm1          |     functest     |     healthcheck     |      00:41       |      PASS      |
+  |         singlevm2          |     functest     |     healthcheck     |      00:36       |      PASS      |
+  |         vping_ssh          |     functest     |     healthcheck     |      00:46       |      PASS      |
+  |       vping_userdata       |     functest     |     healthcheck     |      00:41       |      PASS      |
+  |        cinder_test         |     functest     |     healthcheck     |      01:18       |      PASS      |
+  |         api_check          |     functest     |     healthcheck     |      10:33       |      PASS      |
+  |     snaps_health_check     |     functest     |     healthcheck     |      00:44       |      PASS      |
+  |            odl             |     functest     |     healthcheck     |      00:00       |      SKIP      |
+  +----------------------------+------------------+---------------------+------------------+----------------+
+
+NOTE: the duration is a reference and it might vary depending on your SUT.
+
+Testing smoke suite
+^^^^^^^^^^^^^^^^^^^
+
+Run smoke 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
+
+Results shall be displayed as follows::
+
+  +------------------------------------+------------------+---------------+------------------+----------------+
+  |             TEST CASE              |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
+  +------------------------------------+------------------+---------------+------------------+----------------+
+  |           tempest_smoke            |     functest     |     smoke     |      06:13       |      PASS      |
+  |     neutron-tempest-plugin-api     |     functest     |     smoke     |      09:32       |      PASS      |
+  |            rally_sanity            |     functest     |     smoke     |      29:34       |      PASS      |
+  |             rally_jobs             |     functest     |     smoke     |      24:02       |      PASS      |
+  |          refstack_defcore          |     functest     |     smoke     |      13:07       |      PASS      |
+  |              patrole               |     functest     |     smoke     |      05:17       |      PASS      |
+  |            snaps_smoke             |     functest     |     smoke     |      90:13       |      PASS      |
+  |           neutron_trunk            |     functest     |     smoke     |      00:00       |      SKIP      |
+  |         networking-bgpvpn          |     functest     |     smoke     |      00:00       |      SKIP      |
+  |           networking-sfc           |     functest     |     smoke     |      00:00       |      SKIP      |
+  |              barbican              |     functest     |     smoke     |      05:01       |      PASS      |
+  +------------------------------------+------------------+---------------+------------------+----------------+
+
+Note: if the scenario does not support some tests, they are indicated as SKIP.
+See User guide for details.
+
+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 \
+      opnfv/functest-benchmarking
+
+Results shall be displayed as follows::
+
+  +-------------------+------------------+----------------------+------------------+----------------+
+  |     TEST CASE     |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
+  +-------------------+------------------+----------------------+------------------+----------------+
+  |        vmtp       |     functest     |     benchmarking     |      18:43       |      PASS      |
+  |       shaker      |     functest     |     benchmarking     |      29:45       |      PASS      |
+  +-------------------+------------------+----------------------+------------------+----------------+
+
+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::
+
+  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
+
+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      |
+  |             vgpu            |        functest        |     features     |      00:00       |      SKIP      |
+  |         stor4nfv_os         |        stor4nfv        |     features     |      00:00       |      SKIP      |
+  +-----------------------------+------------------------+------------------+------------------+----------------+
+
+Note: if the scenario does not support some tests, they are indicated as SKIP.
+See User guide for details.
+
+Testing components suite
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Run components 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-components
+
+Results shall be displayed as follows::
+
+  +--------------------------+------------------+--------------------+------------------+----------------+
+  |        TEST CASE         |     PROJECT      |        TIER        |     DURATION     |     RESULT     |
+  +--------------------------+------------------+--------------------+------------------+----------------+
+  |       tempest_full       |     functest     |     components     |      49:51       |      PASS      |
+  |     tempest_scenario     |     functest     |     components     |      18:50       |      PASS      |
+  |        rally_full        |     functest     |     components     |      167:13      |      PASS      |
+  +--------------------------+------------------+--------------------+------------------+----------------+
+
+Testing 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
+
+Results shall be displayed as follows::
+
+  +----------------------+------------------+--------------+------------------+----------------+
+  |      TEST CASE       |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
+  +----------------------+------------------+--------------+------------------+----------------+
+  |       cloudify       |     functest     |     vnf      |      04:05       |      PASS      |
+  |     cloudify_ims     |     functest     |     vnf      |      24:07       |      PASS      |
+  |       heat_ims       |     functest     |     vnf      |      18:15       |      PASS      |
+  |     vyos_vrouter     |     functest     |     vnf      |      15:48       |      PASS      |
+  |       juju_epc       |     functest     |     vnf      |      29:38       |      PASS      |
+  +----------------------+------------------+--------------+------------------+----------------+
+
+Functest Dockers for Kubernetes deployment
+------------------------------------------
+Docker images are available on the dockerhub:

 
 

-  #. Credentials for accessing the Openstack.
-     Most convenient way of passing them to container is by having a
-     local copy of the credentials file in Jumphost and then using the
-     **-v** option. In the example we have local file by the name of
-     "overcloudrc" and we are using that as an argument::
+  * opnfv/functest-kubernetes-core
+  * opnfv/functest-kubernetest-healthcheck
+  * opnfv/functest-kubernetest-smoke
+  * opnfv/functest-kubernetest-features

 
 

-       -v ~/overcloudrc:/home/opnfv/functest/conf/openstack.creds
+Preparing your environment
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+cat env::
+
+  DEPLOY_SCENARIO=k8s-XXX
+
+Testing healthcheck suite
+^^^^^^^^^^^^^^^^^^^^^^^^^

 
 

-       The credentials file needs to exist in the Docker container
-       under the path: '/home/opnfv/functest/conf/openstack.creds'.
+Run healthcheck suite::

 
 

-     **WARNING:** If you are using the Joid installer, you must pass the
-     credentials using the **-v** option:
-     -v /var/lib/jenkins/admin-openrc:/home/opnfv/functest/conf/openstack.creds.
-     See the section `Accessing the Openstack credentials`_ above.
+  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_smoke     |     functest     |     healthcheck     |      02:27       |      PASS      |
+  +-------------------+------------------+---------------------+------------------+----------------+
+
+Testing smoke suite
+^^^^^^^^^^^^^^^^^^^

 
 

-  #. Passing deployment scenario
-     When running Functest against any of the supported OPNFV scenarios,
-     it is recommended to include also the environment variable
-     **DEPLOY_SCENARIO**. The **DEPLOY_SCENARIO** environment variable
-     is passed with the format::
+Run smoke suite::

 
 

-       -e "DEPLOY_SCENARIO=os-<controller>-<nfv_feature>-<ha_mode>"
-       where:
-       os = OpenStack (No other VIM choices currently available)
-       controller is one of ( nosdn | odl_l2 | odl_l3 )
-       nfv_feature is one or more of ( ovs | kvm | sfc | bgpvpn | nofeature )
-                If several features are pertinent then use the underscore
-                character '_' to separate each feature (e.g. ovs_kvm)
-                'nofeature' indicates no NFV feature is deployed
-       ha_mode (high availability) is one of ( ha | noha )
+  sudo docker run -it --env-file env \
+      -v $(pwd)/config:/root/.kube/config \
+      opnfv/functest-kubernetes-smoke

 
 

-     **NOTE:** Not all possible combinations of "DEPLOY_SCENARIO" are
-     supported. The name passed in to the Functest Docker container
-     must match the scenario used when the actual OPNFV platform was
-     deployed. See release note to see the list of supported scenarios.
+Results shall be displayed as follows::

 
 

-     **NOTE:** The scenario name is mainly used to automatically detect
-     if a test suite is runnable or not (e.g. it will prevent ONOS test suite
-     to be run on ODL scenarios). If not set, Functest will try to run the
-     default test cases that might not include SDN controller or a specific
-     feature
+  +-------------------------+------------------+---------------+------------------+----------------+
+  |        TEST CASE        |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
+  +-------------------------+------------------+---------------+------------------+----------------+
+  |     k8s_conformance     |     functest     |     smoke     |      57:14       |      PASS      |
+  +-------------------------+------------------+---------------+------------------+----------------+

 
 

-     **NOTE:** A HA scenario means that 3 OpenStack controller nodes are
-     deployed. It does not necessarily mean that the whole system is HA. See
-     installer release notes for details.
+Testing features suite
+^^^^^^^^^^^^^^^^^^^^^^

 
 

+Run features suite::

 
 

-Putting all above together, when using installer 'fuel' and an invented
-INSTALLER_IP of '10.20.0.2', the recommended command to create the
-Functest Docker container is as follows::
+  sudo docker run -it --env-file env \
+      -v $(pwd)/config:/root/.kube/config \
+      opnfv/functest-kubernetes-features

 
 

-  docker run --name "FunctestContainer" -it \
-  -e "INSTALLER_IP=10.20.0.2" \
-  -e "INSTALLER_TYPE=fuel" \
-  -e "DEPLOY_SCENARIO=os-odl_l2-ovs_kvm-ha" \
-  -v ~/overcloudrc:/home/opnfv/functest/conf/openstack.creds \
-  opnfv/functest /bin/bash
+Results shall be displayed as follows::

 
 

-After the *run* command, a new prompt appears which means that we are inside
-the container and ready to move to the next step.
+  +----------------------+------------------+------------------+------------------+----------------+
+  |      TEST CASE       |     PROJECT      |       TIER       |     DURATION     |     RESULT     |
+  +----------------------+------------------+------------------+------------------+----------------+
+  |     stor4nfv_k8s     |     stor4nfv     |     stor4nfv     |      00:00       |      SKIP      |
+  |      clover_k8s      |      clover      |      clover      |      00:00       |      SKIP      |
+  +----------------------+------------------+------------------+------------------+----------------+

 
 

-For tips on how to set up container with installer Apex, see chapter
-`Apex Installer Tips`_.
+Environment variables
+=====================
+
+Several environement variables may be specified:
+
+  * INSTALLER_IP=<Specific IP Address>
+  * 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
+  * controller is one of ( nosdn | odl )
+  * nfv_feature is one or more of ( ovs | kvm | sfc | bgpvpn | nofeature )
+  * ha_mode (high availability) is one of ( ha | noha )
+
+If several features are pertinent then use the underscore character '_' to
+separate each feature (e.g. ovs_kvm). 'nofeature' indicates that no OPNFV
+feature is deployed.
+
+The list of supported scenarios per release/installer is indicated in the
+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
+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
+installer release notes for details.

 
 Finally, three additional environment variables can also be passed in
 to the Functest Docker Container, using the -e
 
 Finally, three additional environment variables can also be passed in
 to the Functest Docker Container, using the -e

-"<EnvironmentVariable>=<Value>" mechanism. The first two of these are
+"<EnvironmentVariable>=<Value>" mechanism. The first two parameters are

 only relevant to Jenkins CI invoked testing and **should not be used**
 only relevant to Jenkins CI invoked testing and **should not be used**

-when performing manual test scenarios::
-
-  -e "NODE_NAME=<Test POD Name>" \
-  -e "BUILD_TAG=<Jenkins Build Tag>" \
-  -e "CI_DEBUG=<DebugTraceValue>"
-  where:
-  <Test POD Name> = Symbolic name of the POD where the tests are run.
-                    Visible in test results files, which are stored
-                    to the database. This option is only used when
-                    tests are activated under Jenkins CI control.
-                    It indicates the POD/hardware where the test has
-                    been run. If not specified, then the POD name is
-                    defined as "Unknown" by default.
-                    DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
-  <Jenkins Build tag> = Symbolic name of the Jenkins Build Job.
-                        Visible in test results files, which are stored
-                        to the database. This option is only set when
-                        tests are activated under Jenkins CI control.
-                        It enables the correlation of test results,
-                        which
-                        are independently pushed to the results database
-                        from different Jenkins jobs.
-                        DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
-  <DebugTraceValue> = "true" or "false"
-                      Default = "false", if not specified
-                      If "true" is specified, then additional debug trace
-                      text can be sent to the test results file / log files
-                      and also to the standard console output.
-
-Installer Tips
---------------
-
-Apex Installer Tips
-^^^^^^^^^^^^^^^^^^^
-Some specific tips are useful for the Apex Installer case. If not using
-Apex Installer; ignore this section.
+when performing manual test scenarios:
+
+  * INSTALLER_TYPE=(apex|compass|daisy|fuel)
+  * NODE_NAME=<Test POD Name>
+  * BUILD_TAG=<Jenkins Build Tag>
+
+where:
+
+  * <Test POD Name> = Symbolic name of the POD where the tests are run.
+                      Visible in test results files, which are stored
+                      to the database. This option is only used when
+                      tests are activated under Jenkins CI control.
+                      It indicates the POD/hardware where the test has
+                      been run. If not specified, then the POD name is
+                      defined as "Unknown" by default.
+                      DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
+  * <Jenkins Build tag> = Symbolic name of the Jenkins Build Job.
+                         Visible in test results files, which are stored
+                         to the database. This option is only set when
+                         tests are activated under Jenkins CI control.
+                         It enables the correlation of test results,
+                         which are independently pushed to the results database
+                         from different Jenkins jobs.
+                         DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
+
+
+Openstack credentials
+=====================
+OpenStack credentials are mandatory and must be provided to Functest.
+When running the command "functest env prepare", the framework  will
+automatically look for the Openstack credentials file
+"/home/opnfv/functest/conf/env_file" and will exit with
+error if it is not present or is empty.
+
+There are 2 ways to provide that file:
+
+  * by using a Docker volume with -v option when creating the Docker container.
+    This is referred to in docker documentation as "Bind Mounting".
+    See the usage of this parameter in the following chapter.
+  * or creating manually the file '/home/opnfv/functest/conf/env_file'
+    inside the running container and pasting the credentials in it. Consult
+    your installer guide for further details. This is however not
+    instructed in this document.
+
+In proxified environment you may need to change the credentials file.
+There are some tips in chapter: `Proxy support`_
+
+SSL Support
+-----------
+If you need to connect to a server that is TLS-enabled (the auth URL
+begins with "https") and it uses a certificate from a private CA or a
+self-signed certificate, then you will need to specify the path to an
+appropriate CA certificate to use, to validate the server certificate
+with the environment variable OS_CACERT::
+
+  echo $OS_CACERT
+  /etc/ssl/certs/ca.crt
+
+However, this certificate does not exist in the container by default.
+It has to be copied manually from the OpenStack deployment. This can be
+done in 2 ways:
+
+  #. Create manually that file and copy the contents from the OpenStack
+     controller.
+  #. (Recommended) Add the file using a Docker volume when starting the
+     container::

 
 

-In case of Triple-O based installer (like Apex) the docker container
-needs to connect to the installer VM, so it is then required that some
-known SSH keys are present in docker container. Since the Jumphost root
-SSH keys are already known, easiest way is to use those using the
-'Bind mount' method. See below for sample parameter::
+       -v <path_to_your_cert_file>:/etc/ssl/certs/ca.cert

 
 

-  -v /root/.ssh/id_rsa:/root/.ssh/id_rsa
+You might need to export OS_CACERT environment variable inside the
+credentials file::

 
 

-  NOTE: You need the "sudo" when creating the container to access root
-  users ssh credentials even the docker command itself might not
-  require that.
+  export OS_CACERT=/etc/ssl/certs/ca.crt

 
 

-HINT! In case of Triple-O installers you can find value for the
-INSTALLER_IP parameter by executing command and note the returned IP
-address::
+Certificate verification can be turned off using OS_INSECURE=true. For
+example, Fuel uses self-signed cacerts by default, so an pre step would
+be::

 
 

-  inst=$(sudo virsh list | grep -iEo "undercloud|instack")
-  sudo virsh domifaddr ${inst}
+  export OS_INSECURE=true

 
 

-  NOTE: In releases prior to Colorado, the name 'instack' was
-  used. Currently the name 'undercloud' is used.

 
 

-You can copy the credentials file from the "stack" users home directory
-in installer VM to Jumphost. Please check the correct IP from the
-command above. In the example below we are using invented IP address
-"192.168.122.89"::
+Logs
+====
+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
+/usr/lib/python2.7/site-packages/xtesting/ci/logging.ini

 
 

-    scp stack@192.168.122.89:overcloudrc .
+Change wconsole to console in the desired module to get more traces.

 
 

-Here is an example of the full docker command invocation for an Apex
-installed system, using latest Functest docker container, for
-illustration purposes::
-
-  sudo docker run -it --name "ApexFuncTestODL" \
-  -e "INSTALLER_IP=192.168.122.89" \
-  -e "INSTALLER_TYPE=apex" \
-  -e "DEPLOY_SCENARIO=os-odl_l2-nofeature-ha" \
-  -v /root/.ssh/id_rsa:/root/.ssh/id_rsa \
-  -v ~/overcloudrc:/home/opnfv/functest/conf/openstack.creds \
-  opnfv/functest /bin/bash
-
-Compass installer local development env usage Tips
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-In the compass-functest local test case check and development environment,
-in order to get openstack service inside the functest container, some
-parameters should be configured during container creation, which are
-hard to guess for freshman. This section will provide the guideline, the
-parameters values are defaults here, which should be adjusted according
-to the settings, the complete steps are given here so as not to appear
-too abruptly.
-
-1, Pull Functest docker image from public dockerhub::
-
-    docker pull opnfv/functest:<Tag>
-
-<Tag> here can be "brahmaputra.1.0", "colorado.1.0", etc.
-Tag omitted means the latest docker image::
-
-    docker pull opnfv/functest
-
-2, Functest Docker container creation
-
-To make a file used for the environment, such as 'functest-docker-env'::
-
-    CINDER_ENDPOINT_TYPE=publicURL
-    NOVA_ENDPOINT_TYPE=publicURL
-    OS_ENDPOINT_TYPE=publicURL
-    OS_INTERFACE=publicURL
-    OS_USERNAME=admin
-    OS_PASSWORD='990232e0885da343ac805523322d'
-    OS_PROJECT_NAME=admin
-    OS_TENANT_NAME=admin
-    OS_AUTH_URL=https://192.16.1.222:5000/v3
-    OS_NO_CACHE=1
-    OS_USER_DOMAIN_NAME=Default
-    OS_PROJECT_DOMAIN_NAME=Default
-    OS_REGION_NAME=RegionOne
-    OS_IDENTITY_API_VERSION=3
-    OS_AUTH_VERSION=3
-
-
-Note: please adjust the content according to the environment, such as
-'TENANT_ID' maybe used for some special cases.
-
-Then to create the Functest docker::
-
-    docker run --privileged=true --rm -t \
-    --env-file functest-docker-env \
-    --name <Functest_Container_Name> \
-    opnfv/functest:<Tag> /bin/bash
-
-3, To attach Functest container
-
-Before trying to attach the Functest container, the status can be checked by::
-
-   docker ps -a
-
-to attach the 'Up' status Functest container and start bash mode::
-
-   docker exec -it <Functest_Container_Name> bash
-
-4, Functest environment preparation and check
-
-To see the Section below `Preparing the Functest environment`_.
-
-Functest docker container directory structure
----------------------------------------------
-Inside the Functest docker container, the following directory structure
-should now be in place::
-
-  `-- home
-    |  `-- opnfv
-    |   |-- functest
-    |   |   |-- conf
-    |   |   |-- data
-    |   |   |-- images
-    |   |   `-- results
-    |   `-- repos
-    |       |-- doctor
-    |       `-- vnfs
-   -- src
-       |-- tempest
-       |-- vims-test
-       |-- odl_test
-       `-- fds
-
-Underneath the '/home/opnfv/' directory, the Functest docker container
-includes two main directories:
-
-  * The **functest** directory stores configuration files (e.g. the
-    OpenStack creds are stored in path '/home/opnfv/functest/conf/openstack.creds'),
-    the **data** directory stores a 'cirros' test image used in some
-    functional tests and the **results** directory stores some temporary
-    result log files
-  * The **repos** directory holds various repositories. The directories
-    are used for the installation of the needed tooling (e.g. rally) or
-    for the retrieval of feature projects scenarios (e.g. promise)
-
-The structure under the **functest** repository can be described as
-follows::
-
-  |-- INFO
-  |-- LICENSE
-  |-- api
-  |  `-- apidoc
-  |-- build.sh
-  |-- commons
-  |  |-- docker
-  |  |-- Dockerfile
-  |  |-- Dockerfile.aarch64.patch
-  |  |-- components
-  |  |-- config_install_env.sh
-  |  |-- core
-  |  |-- docker_remote_api
-  |  |-- features
-  |  |-- healthcheck
-  |  |-- smoke
-  |  |-- vnf
-  |  `-- 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
-    |  |  `-- error.py
-    |  `-- resources
-    |     `-- v1
-    |        |-- creds.py
-    |        |-- envs.py
-    |        |-- testcases.py
-    |        `-- tiers.py
-    |-- ci
-    │   |-- check_deployment.py
-    │   |-- config_aarch64_patch.yaml
-    │   |-- config_functest.yaml
-    │   |-- config_patch.yaml
-    │   |-- download_images.sh
-    │   |-- installer_params.yaml
-    │   |-- logging.ini
-    │   |-- prepare_env.py
-    │   |-- 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
-    │   |-- testcase.py
-    │   |-- unit.py
-    │   `-- vnf.py
-    |-- energy
-    │   |-- energy.py
-    │   `-- energy.pyc
-    |-- opnfv_tests
-    │   |-- mano
-    │   │   |-- orchestra.py
-    │   |-- openstack
-    │   │   |-- rally
-    │   │   |-- refstack_client
-    │   │   |-- snaps
-    │   │   |-- tempest
-    │   │   `-- vping
-    │   |-- sdn
-    │   │    `-- odl
-    │   `-- vnf
-    │       |-- aaa
-    │       |-- 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_snapshot.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 for the internal Functest API and 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 image.
-* **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 6 directories:
-  * **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'.
-
-Useful Docker commands
-----------------------
+
+Configuration
+=============
+
+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/xtesting and
+/usr/lib/python2.7/site-packages/functest
+
+
+Tips
+====
+
+Docker
+------

 When typing **exit** in the container prompt, this will cause exiting
 the container and probably stopping it. When stopping a running Docker
 container all the changes will be lost, there is a keyboard shortcut
 When typing **exit** in the container prompt, this will cause exiting
 the container and probably stopping it. When stopping a running Docker
 container all the changes will be lost, there is a keyboard shortcut


@@ -538,116 +475,6 @@ destroy it::
 
 Check the Docker documentation [`dockerdocs`_] for more information.
 
 
 Check the Docker documentation [`dockerdocs`_] for more information.
 

-Preparing the Functest environment
-----------------------------------
-Once the Functest docker container is up and running, the required
-Functest environment needs to be prepared. A custom built **functest**
-CLI utility is available to perform the needed environment preparation
-action. Once the environment is prepared, the **functest** CLI utility
-can be used to run different functional tests. The usage of the
-**functest** CLI utility to run tests is described further in the
-`Functest User Guide`_
-
-Prior to commencing the Functest environment preparation, we can check
-the initial status of the environment. Issue the **functest env status**
-command at the prompt::
-
-  functest env status
-  Functest environment is not installed.
-
-  Note: When the Functest environment is prepared, the command will
-  return the status: "Functest environment ready to run tests."
-
-To prepare the Functest docker container for test case execution, issue
-the **functest env prepare** command at the prompt::
-
-  functest env prepare
-
-This script will make sure that the requirements to run the tests are
-met and will install the needed libraries and tools by all Functest
-test cases. It should be run only once every time the Functest docker
-container is started from scratch. If you try to run this command, on
-an already prepared environment, you will be prompted whether you really
-want to continue or not::
-
-  functest env prepare
-  It seems that the environment has been already prepared.
-  Do you want to do it again? [y|n]
-
-  (Type 'n' to abort the request, or 'y' to repeat the
-   environment preparation)
-
-
-To list some basic information about an already prepared Functest
-docker container environment, issue the **functest env show** at the
-prompt::
-
-  functest env show
-  +======================================================+
-  | Functest Environment info                            |
-  +======================================================+
-  |  INSTALLER: apex, 192.168.122.89                     |
-  |   SCENARIO: os-odl_l2-nofeature-ha                   |
-  |        POD: localhost                                |
-  | GIT BRANCH: master                                   |
-  |   GIT HASH: 5bf1647dec6860464eeb082b2875798f0759aa91 |
-  | DEBUG FLAG: false                                    |
-  +------------------------------------------------------+
-  |     STATUS: ready                                    |
-  +------------------------------------------------------+
-
-  Where:
-
-  INSTALLER:  Displays the INSTALLER_TYPE value
-              - here = "apex"
-              and the INSTALLER_IP value
-              - here = "192.168.122.89"
-  SCENARIO:   Displays the DEPLOY_SCENARIO value
-              - here = "os-odl_l2-nofeature-ha"
-  POD:        Displays the value passed in NODE_NAME
-              - here = "localhost"
-  GIT BRANCH: Displays the git branch of the OPNFV Functest
-              project repository included in the Functest
-              Docker Container.
-              - here = "master"
-                       (In first official colorado release
-                        would be "colorado.1.0")
-  GIT HASH:   Displays the git hash of the OPNFV Functest
-              project repository included in the Functest
-              Docker Container.
-              - here = "5bf1647dec6860464eeb082b2875798f0759aa91"
-  DEBUG FLAG: Displays the CI_DEBUG value
-              - here = "false"
-
-  NOTE: In Jenkins CI runs, an additional item "BUILD TAG"
-        would also be listed. The value is set by Jenkins CI.
-
-Finally, the **functest** CLI has a **--help** options:
-
-Some examples::
-
-  functest --help Usage: functest [OPTIONS] COMMAND [ARGS]...
-
-  Options:
-    --version  Show the version and exit.
-    -h, --help Show this message and exit.
-
-  Commands:
-    env
-    openstack
-    testcase
-    tier
-
-  functest env --help
-  Usage: functest env [OPTIONS] COMMAND [ARGS]...
-
-  Options:
-    -h, --help Show this message and exit.
-
-  Commands:
-    prepare  Prepares the Functest environment.
-    show     Shows information about the current...
-    status   Checks if the Functest environment is ready...

 
 Checking Openstack and credentials
 ----------------------------------
 
 Checking Openstack and credentials
 ----------------------------------


@@ -657,7 +484,7 @@ and credentials are working as expected.
 Once the credentials are there inside the container, they should be
 sourced before running any Openstack commands::
 
 Once the credentials are there inside the container, they should be
 sourced before running any Openstack commands::
 

-  source /home/opnfv/functest/conf/openstack.creds
+  source /home/opnfv/functest/conf/env_file

 
 After this, try to run any OpenStack command to see if you get any
 output, for instance::
 
 After this, try to run any OpenStack command to see if you get any
 output, for instance::


@@ -673,52 +500,25 @@ This command must show a set of environment variables starting with
 *OS_*, for example::
 
   OS_REGION_NAME=RegionOne
 *OS_*, for example::
 
   OS_REGION_NAME=RegionOne

-  OS_DEFAULT_DOMAIN=default
+  OS_USER_DOMAIN_NAME=Default

   OS_PROJECT_NAME=admin
   OS_PROJECT_NAME=admin

-  OS_PASSWORD=admin
-  OS_AUTH_STRATEGY=keystone
-  OS_AUTH_URL=http://172.30.10.3:5000/v2.0
+  OS_AUTH_VERSION=3
+  OS_IDENTITY_API_VERSION=3
+  OS_PASSWORD=da54c27ae0d10dfae5297e6f0d6be54ebdb9f58d0f9dfc
+  OS_AUTH_URL=http://10.1.0.9:5000/v3

   OS_USERNAME=admin
   OS_TENANT_NAME=admin
   OS_ENDPOINT_TYPE=internalURL
   OS_USERNAME=admin
   OS_TENANT_NAME=admin
   OS_ENDPOINT_TYPE=internalURL

-  OS_NO_CACHE=true
+  OS_INTERFACE=internalURL
+  OS_NO_CACHE=1
+  OS_PROJECT_DOMAIN_NAME=Default
+

 
 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.
 
 
 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.
 

-SSL Support
------------
-If you need to connect to a server that is TLS-enabled (the auth URL
-begins with "https") and it uses a certificate from a private CA or a
-self-signed certificate, then you will need to specify the path to an
-appropriate CA certificate to use, to validate the server certificate
-with the environment variable OS_CACERT::
-
-  echo $OS_CACERT
-  /etc/ssl/certs/ca.crt
-
-However, this certificate does not exist in the container by default.
-It has to be copied manually from the OpenStack deployment. This can be
-done in 2 ways:
-
-  #. Create manually that file and copy the contents from the OpenStack
-     controller.
-  #. (Recommended) Add the file using a Docker volume when starting the
-     container::
-
-       -v <path_to_your_cert_file>:/etc/ssl/certs/ca.cert
-
-You might need to export OS_CACERT environment variable inside the
-container::
-
-  export OS_CACERT=/etc/ssl/certs/ca.crt
-
-Certificate verification can be turned off using OS_INSECURE=true. For
-example, Fuel uses self-signed cacerts by default, so an pre step would
-be::
-
-  export OS_INSECURE=true
+.. _`Proxy support`:

 
 Proxy support
 -------------
 
 Proxy support
 -------------


@@ -729,28 +529,22 @@ 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.
 
      below.
 

-  #. Execution of the Functest environment preparation inside the
-     created docker container Functest needs internet access to
-     download some resources for some test cases. This might not
-     work properly if the Jumphost is connecting to internet
-     through a http Proxy.
-

 If that is the case, make sure the resolv.conf and the needed
 http_proxy and https_proxy environment variables, as well as the
 'no_proxy' environment variable are set correctly::
 
   # Make double sure that the 'no_proxy=...' line in the
 If that is the case, make sure the resolv.conf and the needed
 http_proxy and https_proxy environment variables, as well as the
 'no_proxy' environment variable are set correctly::
 
   # Make double sure that the 'no_proxy=...' line in the

-  # 'openstack.creds' file is commented out first. Otherwise, the
+  # 'env_file' file is commented out first. Otherwise, the

   # values set into the 'no_proxy' environment variable below will
   # be ovewrwritten, each time the command
   # values set into the 'no_proxy' environment variable below will
   # be ovewrwritten, each time the command

-  # 'source ~/functest/conf/openstack.creds' is issued.
+  # 'source ~/functest/conf/env_file' is issued.

 
   cd ~/functest/conf/
 
   cd ~/functest/conf/

-  sed -i 's/export no_proxy/#export no_proxy/' openstack.creds
-  source ./openstack.creds
+  sed -i 's/export no_proxy/#export no_proxy/' env_file
+  source ./env_file

 
   # Next calculate some IP addresses for which http_proxy
   # usage should be excluded:
 
   # Next calculate some IP addresses for which http_proxy
   # usage should be excluded:


@@ -769,10 +563,6 @@ http_proxy and https_proxy environment variables, as well as the
   git config --global http.sslVerify True
   git config --global http.proxy <Your http proxy settings>
 
   git config --global http.sslVerify True
   git config --global http.proxy <Your http proxy settings>
 

-Validation check: Before running **'functest env prepare'** CLI command,
-make sure you can reach http and https sites from inside the Functest
-docker container.
-

 For example, try to use the **nc** command from inside the functest
 docker container::
 
 For example, try to use the **nc** command from inside the functest
 docker container::
 


@@ -786,12 +576,14 @@ 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
 commands might not work. You can use the **curl** command instead.
 
   curl http://www.opnfv.org:80

+

   <HTML><HEAD><meta http-equiv="content-type"
   .
   .
   </BODY></HTML>
 
   curl https://www.opnfv.org:443
   <HTML><HEAD><meta http-equiv="content-type"
   .
   .
   </BODY></HTML>
 
   curl https://www.opnfv.org:443

+

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


@@ -800,6 +592,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


@@ -833,68 +627,17 @@ should be followed **before** installing the docker engine::
      EnvironmentFile=/etc/sysconfig/docker (ignore_errors=yes)
      DropInPaths=/etc/systemd/system/docker.service.d/env.conf
 
      EnvironmentFile=/etc/sysconfig/docker (ignore_errors=yes)
      DropInPaths=/etc/systemd/system/docker.service.d/env.conf
 

-Now follow the instructions in [`InstallDockerCentOS`_] to download
+Now follow the instructions in [`Install Docker on CentOS`_] to download

 and install the **docker-engine**. The instructions conclude with a
 "test pull" of a sample "Hello World" docker container. This should now
 work with the above pre-requisite actions.
 
 
 and install the **docker-engine**. The instructions conclude with a
 "test pull" of a sample "Hello World" docker container. This should now
 work with the above pre-requisite actions.
 
 

-Installation and Configuration (Alpine)
-=======================================
-
-Introduction to Alpine
-----------------------
-Alpine container have been introduced in Euphrates and released as experimental.
-Alpine allows Functest testing in several very light container and thanks to
-the refactoring on dependency management shoudl allow the creation of light and
-fully customized docker files
-
-Functest Alpine
----------------
-Docker files are available on the the dockerhub:
-
-  * opnfv/functest-core
-  * opnfv/functest-healthcheck
-  * opnfv/functest-smoke
-  * opnfv/functest-features
-  * opnfv/functest-components
-  * opnfv/functest-vnf
-
-
-Preparing your environment
---------------------------
-
-cat env::
-
-  INSTALLER_TYPE=XXX
-  INSTALLER_IP=XXX
-  EXTERNAL_NETWORK=XXX
-
-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_TENANT_NAME=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
-
-md5sum images/*md5sum images/*::
-
-  c03e55c22b6fb2127e7de391b488d8d6  `images/CentOS-7-x86_64-GenericCloud.qcow2`_
-  f8ab98ff5e73ebab884d80c9dc9c7290  `images/cirros-0.3.5-x86_64-disk.img`_
-  845c9b0221469f9e0f4d7ea0039ab5f2  `images/ubuntu-14.04-server-cloudimg-amd64-disk1.img`_
-
+.. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html

 .. _`dockerdocs`: https://docs.docker.com/
 .. _`dockerdocs`: https://docs.docker.com/

-.. _`dockerhub`: https://hub.docker.com/r/opnfv/functest/

 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy

-.. _`FunctestDockerTags`: https://hub.docker.com/r/opnfv/functest/tags/
-.. _`InstallDockerCentOS`: https://docs.docker.com/engine/installation/linux/centos/
+.. _`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
 .. _`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` http://download.cirros-cloud.net/0.3.5/cirros-0.3.5-x86_64-disk.img
-:: _`images/cirros-0.3.5-x86_64-disk.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.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
+.. _`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/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