Merge "Editorials"

1 files changed, 51 insertions, 44 deletions

diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 52bc6272f..f23b11d41 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -1,12 +1,11 @@
-***********************************************
+===============================================
 OPNFV FUNCTEST configuration/installation guide
-***********************************************
+===============================================
 
 .. toctree::
    :numbered:
    :maxdepth: 2
 
-============
 Introduction
 ============
 
@@ -14,7 +13,6 @@ Introduction
 
 This document describes how to install and configure Functest in OPNFV.
 
-=============
 Prerequisites
 =============
 
@@ -24,18 +22,18 @@ document.
 
 Several prerequisites are needed for functest:
 
-    1. A Jumphost to run Functest on
-    2. Docker daemon shall be installed on the Jumphost
-    3. A public/external network created on the SUT
-    4. Connectivity from the Jumphost to the SUT public/external network
-    5. Connectivity from the Jumphost to the SUT management network
+    #. A Jumphost to run Functest on
+    #. Docker daemon shall be installed on the Jumphost
+    #. A public/external network created on the SUT
+    #. Connectivity from the Jumphost to the SUT public/external network
+    #. Connectivity from the Jumphost to the SUT management network
 
 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.
 
 Docker installation
-===================
+-------------------
 
 .. _Ubuntu: https://docs.docker.com/installation/ubuntulinux/
 .. _RHEL: https://docs.docker.com/installation/rhel/
@@ -50,23 +48,24 @@ Add your user to docker group to be able to run commands without sudo::
 
 
 References:
+
   * Ubuntu_
   * RHEL_
 
-Connectivy to OPNFV management network
-======================================
+Connectivity to OPNFV management network
+----------------------------------------
 
 Some of the Functest tools need to have access to the OpenStack management
 network of the controllers `[1]`_.
 
 For this reason, an interface shall be configured in the Jumphost in the
-OpenStack management network range. 
+OpenStack management network range.
 
 Example::
 
  The OPNFV Fuel installation uses VLAN tagged 300 and subnet 192.168.1.0/24 as
  Openstack Management network.
- 
+ .
  Supposing that eth1 is the physical interface with access to that subnet:
  $ ip link add name eth1.300 link eth1 type vlan id 300
  $ ip link set eth1.300 up
@@ -74,18 +73,17 @@ Example::
 
 
 External network on SUT
-=======================
+-----------------------
 
 Some of the tests against the VIM (Virtual Infrastructure Manager) need an
 existing public network to succeed. This is needed, for example, to create
 floating IPs to access instances from the public network (i.e. Jumphost).
 
 By default, any of the four OPNFV installers provide a fresh installation with
-an external network created along with a router. 
+an external network created along with a router.
 
 
 
-=======================
 High level architecture
 =======================
 
@@ -152,16 +150,16 @@ The high level architecture of Functest within OPNFV can be described as follow:
 
 All the libraries and dependencies needed by all the Functest tools are
 pre-installed in the Docker image.
-This allows running Functest on any platform with any Operating System. 
+This allows running Functest on any platform with any Operating System.
 
 The Docker image will:
-  
+
   * retrieve OpenStack credentials
   * prepare the environment according to the SUT
   * perform the appropriate tests
   * push the results into the OPNFV test result database
 
- 
+
 
 This Docker image can be integrated into CI or deployed **independently** of the CI.
 A description of the Brahmaputra testcases can be retrieved in the Functest user
@@ -171,32 +169,32 @@ Please note that the Functest container has been designed for OPNFV, however, it
 would be possible to adapt it to any VIM+controller environment as most of the
 testcases are upstream testcases.
 
-===================
 Manual Installation
 ===================
 
 Pull the Functest Docker image from the Docker hub::
 
-  $ docker pull opnfv/functest:brahmaputra.1.0  
+  $ docker pull opnfv/functest:brahmaputra.1.0
 
 
 Check that the image is available::
 
  $ docker images
 
-Run the docker container giving the environment variables
+Run the docker container giving the environment variables::
+
  - INSTALLER_TYPE. Possible values are "apex", "compass", "fuel" or "joid".
  - INSTALLER_IP. each installer has its installation strategy.
- 
- Functest may need to know the IP of the installer to retrieve the credentials
-(e.g. usually "10.20.0.2" for fuel, not neede for joid...)
+
+Functest may need to know the IP of the installer to retrieve the credentials
+(e.g. usually "10.20.0.2" for fuel, not neede for joid...).
 
 The minimum command to create the Functest docker file can be described as
 follows::
 
   docker run -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:brahmaputra.1.0 /bin/bash
 
-Optionnaly, it is possible to precise the container name through the option
+Optionally, it is possible to precise the container name through the option
 --name::
 
   docker run --name "CONTAINER_NAME" -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:brahmaputra.1.0 /bin/bash
@@ -205,7 +203,8 @@ It is also possible to to indicate the path of the OpenStack creds using -v::
 
   docker run  -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" -v <path_to_your_local_creds_file>:/home/opnfv/functest/conf/openstack.creds opnfv/functest:brahmaputra.1.0 /bin/bash
 
-The local file will be mounted in the container under /home/opnfv/functest/conf/openstack.creds
+The local file will be mounted in the container under
+/home/opnfv/functest/conf/openstack.creds
 
 After the run command the prompt appears which means that we are inside the
 container and ready to run Functest.
@@ -229,8 +228,13 @@ Inside the container, you must have the following directory structure::
 
 Basically the container includes:
 
-  * Functest directory to store the configuration (the OpenStack creds are paste in /home/opngb/functest/conf), the data (images neede for test for offline testing), results (some temporary artifacts may be stored here)
-  * Repositories: the functest repository will be used to prepare the environement, run the tests. Other repositories are used for the installation of the tooling (e.g. rally) and/or the retrieval of feature projects scenarios (e.g. bgpvpn)
+  * Functest directory to store the configuration (the OpenStack creds are paste
+    in /home/opngb/functest/conf), the data (images neede for test for offline
+    testing), results (some temporary artifacts may be stored here)
+  * Repositories: the functest repository will be used to prepare the
+    environment, run the tests. Other repositories are used for the installation
+    of the tooling (e.g. rally) and/or the retrieval of feature projects
+    scenarios (e.g. bgpvpn)
 
 The arborescence under the functest repo can be described as follow::
 
@@ -265,17 +269,21 @@ The arborescence under the functest repo can be described as follow::
 
 We may distinguish 4 different folders:
 
-  * commons: it is a folder dedicated to store traffic profile or any test inputs that could be reused by any test project
-  * docker: this folder includes the scripts that will be used to setup the environment and run the tests
+  * commons: it is a folder dedicated to store traffic profile or any test
+    inputs that could be reused by any test project
+  * docker: this folder includes the scripts that will be used to setup the
+    environment and run the tests
   * docs: this folder includes the user and installation/configuration guide
-  * testcases: this folder includes the scripts required by Functest internal test cases
+  * testcases: this folder includes the scripts required by Functest internal
+    test cases
 
 
 Firstly run the script to install functest environment::
 
  $ ${repos_dir}/functest/docker/prepare_env.sh
 
-NOTE: ${repos_dir} is a default environment variable inside the docker container, which points to /home/opnfv/repos
+NOTE: ${repos_dir} is a default environment variable inside the docker
+container, which points to /home/opnfv/repos
 
 Run the script to start the tests::
 
@@ -284,13 +292,14 @@ Run the script to start the tests::
 NOTE: This will run ALL the tests by default, see `[2]`_ for details
 
 Focus on the OpenStack credentials
-==================================
+----------------------------------
 
 The OpenStack credentials are needed to test the VIM. There are 3 ways to
 provide them to Functest:
 
   * using the -v option when running the Docker container
-  * create an empty file in /home/opnfv/functest/conf/openstack.creds and paste the needed info in it.
+  * create an empty file in /home/opnfv/functest/conf/openstack.creds and paste
+    the needed info in it.
   * automatically retrieved using the following script::
          $repos_dir/releng/utils/fetch_os_creds.sh
 
@@ -299,10 +308,10 @@ Once the credentials are there, they shall be sourced before running the tests::
   source /home/opnfv/functest/conf/openstack.creds
 
 Additional Options
-==================
+------------------
 
 In case you need to provide different configuration parameters to Functest (e.g.
- commit IDs or branches for the repositories, …) copy the config_functest.yaml
+ commit IDs or branches for the repositories, ...) copy the config_functest.yaml
  from the repository to your current directory and run docker with a volume::
 
  $ wget https://git.opnfv.org/cgit/functest/plain/testcases/config_functest.yaml
@@ -312,9 +321,10 @@ In case you need to provide different configuration parameters to Functest (e.g.
    -v $(pwd)/config_functest.yaml:/home/opnfv/functest/conf/config_functest.yaml \
    "${cmd1} && ${cmd2}"
 
-=================
+
 Integration in CI
 =================
+
 In CI we use the docker file and execute commande within the container from
 Jenkins.
 
@@ -377,14 +387,12 @@ Docker clean in functest-cleanup builder `[3]`_::
     fi
 
 
-=============
 Configuration
 =============
 
-Everything is preconfigured in the docker file. 
+Everything is preconfigured in the docker file.
 It is however possible to customize the list of tests, see `[2]` for details.
 
-======
 Errors
 ======
 
@@ -392,7 +400,6 @@ Errors
 
 
 
-==========
 References
 ==========
 .. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
@@ -404,7 +411,7 @@ OPNFV main site: opnfvmain_.
 
 OPNFV functional test page: opnfvfunctest_.
 
-IRC support chan: #opnfv-testperf
+IRC support channel: #opnfv-testperf
 
 .. _opnfvmain: http://www.opnfv.org
 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing