Merge "Update Config Guide"

3 files changed, 32 insertions, 51 deletions

diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst
index 0a260ad0a..9d0179c80 100644
--- a/docs/testing/user/configguide/configguide.rst
+++ b/docs/testing/user/configguide/configguide.rst
@@ -7,14 +7,14 @@ Installation and configuration
 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 files.
+fully customized docker images.
 
-It is still possible to use the monolithic functest opnfv/functest especially
+It is still possible to use the monolithic Ubuntu image opnfv/functest especially
 for tests on Aarch64 architecture.
 
 Functest Dockers
 ----------------
-Docker files are available on the dockerhub:
+Docker images are available on the dockerhub:
 
   * opnfv/functest-core
   * opnfv/functest-healthcheck
@@ -25,8 +25,8 @@ Docker files are available on the dockerhub:
   * opnfv/functest-parser
   * opnfv/functest-restapi
 
-By default, we use the docker tag latest, but you may pull a tagged docker
-image.
+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
@@ -61,9 +61,9 @@ cat openstack.creds::
 
 See section on OpenStack credentials for details.
 
-Create a directory for the different images (included as volume)::
+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 | bash -s -- images && ls -1 images/*
+  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
@@ -101,6 +101,7 @@ Results shall be displayed as follows::
   |         api_check          |     functest     |     healthcheck     |      04:57       |      PASS      |
   |     snaps_health_check     |     functest     |     healthcheck     |      00:51       |      PASS      |
   +----------------------------+------------------+---------------------+------------------+----------------+
+  NOTE: the duration is a reference and it might vary depending on your SUT.
 
 Testing smoke suite
 -------------------
@@ -172,7 +173,6 @@ Results shall be displayed as follows::
   +-------------------------------+------------------+--------------------+------------------+----------------+
   |     tempest_full_parallel     |     functest     |     components     |      102:48      |      PASS      |
   |           rally_full          |     functest     |     components     |      160:58      |      PASS      |
-  |         tempest_custom        |     functest     |     components     |      00:00       |      SKIP      |
   +-------------------------------+------------------+--------------------+------------------+----------------+
 
 Testing vnf suite
@@ -193,7 +193,6 @@ Results shall be displayed as follows::
   |           cloudify_ims          |     functest     |     vnf      |      21:25       |      PASS      |
   |        orchestra_openims        |     functest     |     vnf      |      11:02       |      FAIL      |
   |     orchestra_clearwaterims     |     functest     |     vnf      |      09:13       |      FAIL      |
-  |           vyos_vrouter          |     functest     |     vnf      |      00:00       |      SKIP      |
   +---------------------------------+------------------+--------------+------------------+----------------+
 
 
@@ -201,7 +200,7 @@ Environment variables
 =====================
 
 Several environement variables may be specified:
-  * INSTALLER_TYPE=(apex|compass|daisy|fuel|joid|osa)
+  * INSTALLER_TYPE=(apex|compass|daisy|fuel|joid)
   * INSTALLER_IP=<Specific IP Address>
   * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>
 
@@ -216,19 +215,18 @@ The format for the DEPLOY_SCENARIO env variable can be described as follows:
   * 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 no OPNFV feature is
-deployed
+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 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
+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:** A HA scenario means that 3 OpenStack controller nodes are
+**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.
 
@@ -257,8 +255,7 @@ where:
                          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
+                         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"
@@ -286,9 +283,6 @@ There are 2 ways to provide that file:
     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.
-
 In proxified environment you may need to change the credentials file.
 There are some tips in chapter: `Proxy support`_
 
@@ -315,7 +309,7 @@ done in 2 ways:
        -v <path_to_your_cert_file>:/etc/ssl/certs/ca.cert
 
 You might need to export OS_CACERT environment variable inside the
-container::
+credentials file::
 
   export OS_CACERT=/etc/ssl/certs/ca.crt
 
diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst
index 98d798e25..4b605cd23 100644
--- a/docs/testing/user/configguide/index.rst
+++ b/docs/testing/user/configguide/index.rst
@@ -9,22 +9,6 @@ Functest Installation Guide
    :numbered:
    :maxdepth: 2
 
-Version history
-===============
-
-+------------+----------+------------------+----------------------------------+
-| **Date**   | **Ver.** | **Author**       | **Comment**                      |
-|            |          |                  |                                  |
-+------------+----------+------------------+----------------------------------+
-| 2016-08-17 | 1.0.0    | Juha Haapavirta  | Colorado release                 |
-|            |          | Column Gaynor    |                                  |
-+------------+----------+------------------+----------------------------------+
-| 2017-01-19 | 1.0.1    | Morgan Richomme  | Adaptations for Danube           |
-|            |          |                  | * update testcase list           |
-|            |          |                  | * update docker command          |
-+------------+----------+------------------+----------------------------------+
-| 2017-08-16 | 1.0.2    | Morgan Richomme  | Adaptations for Euphrates        |
-+------------+----------+------------------+----------------------------------+
 
 Introduction
 ============
@@ -97,17 +81,18 @@ All the libraries and dependencies needed by all of the Functest tools are
 pre-installed into the Docker images. This allows running Functest on any
 platform.
 
-The automated mechanisms inside the Functest Docker container will:
+The automated mechanisms inside the Functest Docker containers will:
 
-  * Retrieve OpenStack credentials
   * Prepare the environment according to the System Under Test (SUT)
   * Perform the appropriate functional tests
-  * Push the test results into the OPNFV test result database
+  * Push the test results into the OPNFV test result database (optional)
 
-This Docker image can be integrated into CI or deployed independently.
+The OpenStack credentials file must be provided to the container.
 
-Please note that the Functest Docker container has been designed for OPNFV,
-however, it would be possible to adapt it to any OpenStack based VIM +
+These Docker images can be integrated into CI or deployed independently.
+
+Please note that the Functest Docker images have been designed for OPNFV,
+however, it would be possible to adapt them to any OpenStack based VIM +
 controller environment, since most of the test cases are integrated from
 upstream communities.
 
diff --git a/docs/testing/user/configguide/prerequisites.rst b/docs/testing/user/configguide/prerequisites.rst
index 418cd1a73..8289803bb 100644
--- a/docs/testing/user/configguide/prerequisites.rst
+++ b/docs/testing/user/configguide/prerequisites.rst
@@ -14,9 +14,9 @@ Several prerequisites are needed for Functest:
 
 Some specific SNAPS tests may require a connectivity from the Jumphost to the
 SUT admin/management network but most of the test cases do not. This requirement
-can be overridden by overriding the 'interface' attribute (OS_INTERFACE) value
-to 'public'. Another means to circumvent this issue would be to change the
-'snaps.use_keystone' value from True to False.
+can be changed by overriding the 'interface' attribute (OS_INTERFACE) value
+to 'public' in the credentials file. Another means to circumvent this issue
+would be to change the 'snaps.use_keystone' value from True to False.
 
 WARNING: Connectivity from Jumphost is essential and it is of paramount
 importance to make sure it is working before even considering to install
@@ -25,7 +25,8 @@ designed to work.
 
 NOTE: **Jumphost** refers to any server which meets the previous
 requirements. Normally it is the same server from where the OPNFV
-deployment has been triggered previously.
+deployment has been triggered previously, but it could be any server
+with proper connectivity to the SUT.
 
 NOTE: If your Jumphost is operating behind a company http proxy and/or
 firewall, please consult first the section `Proxy Support`_, towards
@@ -84,9 +85,10 @@ succeed. This is needed, for example, to create floating IPs to access
 VM instances through the public/external network (i.e. from the Docker
 container).
 
-By default, the four OPNFV installers provide a fresh installation with
+By default, the five OPNFV installers provide a fresh installation with
 a public/external network created along with a router. Make sure that
-the public/external subnet is reachable from the Jumphost.
+the public/external subnet is reachable from the Jumphost and an external
+router exists.
 
 *Hint:* For the given OPNFV Installer in use, the IP sub-net address
 used for the public/external network is usually a planning item and