Merge "Switch from BashFeature to Feature of bgpvpn testcase"

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

diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst
index 69c4166..fd99734 100644 (file)
--- a/docs/testing/user/configguide/index.rst
+++ b/docs/testing/user/configguide/index.rst
@@ -1,35 +1,18 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-==================================
-OPNFV FUNCTEST Configuration Guide
-==================================
+***************************
+Functest Installation Guide
+***************************
 
 .. toctree::
    :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          |
-+------------+----------+------------------+----------------------------------+
 
 Introduction
 ============
 This document describes how to install and configure Functest in OPNFV.
-The Functest CLI is used during the Functest environment preparation
-phase. The given example commands should work in both virtual and bare
-metal cases alike.
 
 High level architecture
 -----------------------
@@ -44,14 +27,12 @@ follows::
  |     +----------------------------+        |       |        |       |       |
  |     |                            |        |       |        |       |       |
  +-----+       Jumphost             |        |       |        |       |       |
- |     |                            +--------+       |        |       |       |
  |     |                            |        |       |        |       |       |
  |     |   +--------------------+   |        |       |        |       |       |
  |     |   |                    |   |        |       |        |       |       |
  |     |   | Tools              |   +----------------+        |       |       |
  |     |   | - Rally            |   |        |       |        |       |       |
  |     |   | - Robot            |   |        |       |        |       |       |
- |     |   | - TestON           |   |        |       |        |       |       |
  |     |   | - RefStack         |   |        |       |        |       |       |
  |     |   |                    |   |-------------------------+       |       |
  |     |   | Testcases          |   |        |       |        |       |       |
@@ -93,21 +74,25 @@ follows::
  +                                           +       +        +       +       +
               SUT = System Under Test
 
-All the libraries and dependencies needed by all of the Functest tools
-are pre-installed into the Docker image. This allows running Functest
-on any platform on any Operating System.
+Note connectivity to management network is not needed for most of the testcases.
+But it may be needed for some specific snaps tests.
 
-The automated mechanisms inside the Functest Docker container will:
+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 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)
+
+The OpenStack credentials file must be provided to the container.
 
-This Docker image can be integrated into CI or deployed independently.
+These Docker images can be integrated into CI or deployed independently.
 
-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 +
+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.
 
@@ -131,15 +116,15 @@ References
 
 `[4]`_ : Functest Configuration guide
 
-`OPNFV main site`_
+`[5]`_ : OPNFV main site
 
-`Functest page`_
+`[6]`_ : Functest wiki page
 
 IRC support channel: #opnfv-functest
 
 .. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
-.. _`[2]`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
-.. _`[3]`: https://git.opnfv.org/cgit/releng/tree/jjb/functest/functest-ci-jobs.yml
-.. _`[4]`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/configguide/index.html
-.. _`OPNFV main site`: http://www.opnfv.org
-.. _`Functest page`: https://wiki.opnfv.org/functest
+.. _`[2]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
+.. _`[3]`: https://git.opnfv.org/releng/tree/jjb/functest/functest-daily-jobs.yml
+.. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
+.. _`[5]`: http://www.opnfv.org
+.. _`[6]`: https://wiki.opnfv.org/functest