configuration guide review

JIRA: FUNCTEST-435

Change-Id: I5b18f1223a5892d084c761f174ac5f713ceed476
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>

2 files changed, 48 insertions, 42 deletions

diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst
index 6448d2c99..4d0d35b77 100644
--- a/docs/configguide/configguide.rst
+++ b/docs/configguide/configguide.rst
@@ -18,8 +18,10 @@ 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 Colorado system platform,
 tag "colorado.1.0" is needed. Pulling other tags might cause some
-problems while running the tests. If you need to specifically pull the
-latest Functest docker image, then omit the tag argument::
+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
 
@@ -32,9 +34,6 @@ following docker command::
   opnfv/functest brahmaputra.3.0 94b78faa94f7  4 weeks ago  874.9 MB
   hello-world    latest          94df4f0ce8a4  7 weeks ago    967 B
 
-Docker images pulled without a tag specifier bear the implicitly
-assigned label "latest", as seen above.
-
 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
@@ -121,8 +120,9 @@ recommended parameters for invoking docker container
        under the path: '/home/opnfv/functest/conf/openstack.creds'.
 
      WARNING: If you are using the Joid installer, you must pass the
-     credentials using the **-v** option. See the section
-     `Accessing the Openstack credentials`_ above.
+     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.
 
   #. Passing deployment scenario
      When running Functest against any of the supported OPNFV scenarios,
@@ -133,7 +133,7 @@ recommended parameters for invoking docker container
        -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 | onos )
+       controller is one of ( nosdn | odl_l2 | odl_l3 | onos | ocl)
        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)
@@ -143,7 +143,7 @@ recommended parameters for invoking docker container
      **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.
+     deployed. See release note to see the list of supported scenarios.
 
 Putting all above together, when using installer 'fuel' and an invented
 INSTALLER_IP of '10.20.0.2', the recommended command to create the
@@ -243,19 +243,20 @@ illustration purposes::
 
 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.
+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::
+<Tag> here can be "brahmaputra.1.0", "colorado.1.0", etc.
+Tag omitted means the latest docker image::
 
     docker pull opnfv/functest
 
@@ -273,8 +274,8 @@ To make a file used for the environment, such as 'functest-docker-env'::
     INSTALLER_IP=192.168.200.2
     EXTERNAL_NETWORK=ext-net
 
-Note: please adjust the content according to the environment, such as 'TENANT_ID'
-maybe used for some special cases.
+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::
 
@@ -283,8 +284,6 @@ Then to create the Functest docker::
     --name <Functest_Container_Name> \
     opnfv/functest:<Tag> /bin/bash
 
-Note: it is recommended to be run on jumpserver.
-
 3, To attach Functest container
 
 Before trying to attach the Functest container, the status can be checked by::
@@ -345,6 +344,7 @@ follows::
     |   |-- __init__.py
     |   |-- check_os.sh
     |   |-- config_functest.yaml
+    |   |-- generate_report.py
     |   |-- exec_test.sh
     |   |-- prepare_env.py
     |   |-- run_tests.py
@@ -374,12 +374,12 @@ follows::
     |   |-- results
     |   `--userguide
     |-- testcases
+    |   |-- __init__.py
     |   |-- Controllers
     |   |-- OpenStack
-    |   |-- __init__.py
     |   |-- features
     |   |-- security_scan
-    |   `-- vIMS
+    |   `-- vnf
     `-- utils
         |-- __init__.py
         |-- functest_logger.py
@@ -694,22 +694,22 @@ docker container.
 For example, try to use the **nc** command from inside the functest
 docker container::
 
-  nc -v google.com 80
-  Connection to google.com 80 port [tcp/http] succeeded!
+  nc -v opnfv.org 80
+  Connection to opnfv.org 80 port [tcp/http] succeeded!
 
-  nc -v google.com 443
-  Connection to google.com 443 port [tcp/https] succeeded!
+  nc -v opnfv.org 443
+  Connection to opnfv.org 443 port [tcp/https] succeeded!
 
 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.google.com:80
+  curl http://www.opnfv.org:80
   <HTML><HEAD><meta http-equiv="content-type"
   .
   .
   </BODY></HTML>
 
-  curl https://www.google.com:443
+  curl https://www.opnfv.org:443
   <HTML><HEAD><meta http-equiv="content-type"
   .
   .
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 6b6c62a1b..b61bf8ff5 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -40,16 +40,20 @@ follows::
  |     |   |                    |   |        |       |        |       |
  |     |   | Testcases          |   |        |       |        |       |
  |     |   | - VIM              |   |        |       |        |       |
- |     |   |  -- vPing          |   |        |       |        |       |
+ |     |   |  -- healthcheck    |   |        |       |        |       |
+ |     |   |  -- vPing_ssh      |   |        |       |        |       |
  |     |   |  -- vPing_userdata |   |        |       |        |       |
- |     |   |  -- Tempest        |   |        |       |        |       |
- |     |   |  -- Rally          |   |        |       |        |       |
- |     |   | - Controller       |   |        |       |        |       |
+ |     |   |  -- Tempest_smoke  |   |        |       |        |       |
+ |     |   |  -- Rally_sanity   |   |        |       |        |       |
+ |     |   |  -- Tempest_full   |   |        |       |        |       |
+ |     |   |  -- Rally_full     |   |        |       |        |       |
+ |     |   |                    |   |        |       |        |       |
+ |     |   | - SDN Controller   |   |        |       |        |       |
  |     |   |  -- odl            |   |        |       |        |       |
  |     |   |  -- onos           |   |        |       |        |       |
  |     |   |                    |   |        |       |        |       |
- |     |   | Features           |   |        |       |        |       |
- |     |   | - vIMS             |   |        |       |        |       |
+ |     |   | - VNF              |   |        |       |        |       |
+ |     |   |  -- vIMS           |   |        |       |        |       |
  |     |   |                    |   |        |       |        |       |
  |     |   +--------------------+   |        |       |        |       |
  |     |                            +-------------------------+       |
@@ -85,10 +89,10 @@ on any platform on any Operating System.
 
 The automated mechanisms inside the Functest Docker container will:
 
-  * retrieve OpenStack credentials
-  * prepare the environment according to the SUT
-  * perform the appropriate functional tests
-  * push the test results into the OPNFV test result database
+  * Retrieve OpenStack credentials
+  * Prepare the environment according to the SUT
+  * Perform the appropriate functional tests
+  * Push the test results into the OPNFV test result database
 
 This Docker image can be integrated into CI or deployed independently.
 
@@ -99,11 +103,13 @@ communities.
 
 The functional test cases are described in the Functest User Guide `[2]`_
 
+
 Prerequisites
 =============
 The OPNFV deployment is out of the scope of this document but it can be
-found in `[4]`_. The OPNFV platform is considered as the System Under
-Test (SUT) in this document.
+found in http://artifacts.opnfv.org/opnfvdocs/colorado/docs/configguide/index.html.
+The OPNFV platform is considered as the System Under Test (SUT) in this
+document.
 
 Several prerequisites are needed for Functest:
 
@@ -273,7 +279,7 @@ References
 .. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
 .. _`[2]`: http://artifacts.opnfv.org/functest/docs/userguide/index.html
 .. _`[3]`: https://git.opnfv.org/cgit/releng/tree/jjb/functest/functest-ci-jobs.yml
-.. _`[4]`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/index.html
+.. _`[4]`: http://artifacts.opnfv.org/opnfvdocs/colorado/docs/configguide/index.html
 
 
 OPNFV main site: opnfvmain_.