docs/testing/user/configguide/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ===========================
   5 Functest Installation Guide
   6 ===========================
   7
   8 .. toctree::
   9    :numbered:
  10    :maxdepth: 2
  11
  12 Version history
  13 ===============
  14
  15 +------------+----------+------------------+----------------------------------+
  16 | **Date**   | **Ver.** | **Author**       | **Comment**                      |
  17 |            |          |                  |                                  |
  18 +------------+----------+------------------+----------------------------------+
  19 | 2016-08-17 | 1.0.0    | Juha Haapavirta  | Colorado release                 |
  20 |            |          | Column Gaynor    |                                  |
  21 +------------+----------+------------------+----------------------------------+
  22 | 2017-01-19 | 1.0.1    | Morgan Richomme  | Adaptations for Danube           |
  23 |            |          |                  | * update testcase list           |
  24 |            |          |                  | * update docker command          |
  25 +------------+----------+------------------+----------------------------------+
  26 | 2017-08-16 | 1.0.2    | Morgan Richomme  | Adaptations for Euphrates        |
  27 +------------+----------+------------------+----------------------------------+
  28
  29 Introduction
  30 ============
  31 This document describes how to install and configure Functest in OPNFV.
  32
  33 High level architecture
  34 -----------------------
  35
  36 The high level architecture of Functest within OPNFV can be described as
  37 follows::
  38
  39  CIMC/Lights+out management               Admin  Mgmt/API  Public  Storage Private
  40                                            PXE
  41  +                                           +       +        +       +       +
  42  |                                           |       |        |       |       |
  43  |     +----------------------------+        |       |        |       |       |
  44  |     |                            |        |       |        |       |       |
  45  +-----+       Jumphost             |        |       |        |       |       |
  46  |     |                            |        |       |        |       |       |
  47  |     |   +--------------------+   |        |       |        |       |       |
  48  |     |   |                    |   |        |       |        |       |       |
  49  |     |   | Tools              |   +----------------+        |       |       |
  50  |     |   | - Rally            |   |        |       |        |       |       |
  51  |     |   | - Robot            |   |        |       |        |       |       |
  52  |     |   | - RefStack         |   |        |       |        |       |       |
  53  |     |   |                    |   |-------------------------+       |       |
  54  |     |   | Testcases          |   |        |       |        |       |       |
  55  |     |   | - VIM              |   |        |       |        |       |       |
  56  |     |   |                    |   |        |       |        |       |       |
  57  |     |   | - SDN Controller   |   |        |       |        |       |       |
  58  |     |   |                    |   |        |       |        |       |       |
  59  |     |   | - Features         |   |        |       |        |       |       |
  60  |     |   |                    |   |        |       |        |       |       |
  61  |     |   | - VNF              |   |        |       |        |       |       |
  62  |     |   |                    |   |        |       |        |       |       |
  63  |     |   +--------------------+   |        |       |        |       |       |
  64  |     |     Functest Docker        +        |       |        |       |       |
  65  |     |                            |        |       |        |       |       |
  66  |     |                            |        |       |        |       |       |
  67  |     |                            |        |       |        |       |       |
  68  |     +----------------------------+        |       |        |       |       |
  69  |                                           |       |        |       |       |
  70  |    +----------------+                     |       |        |       |       |
  71  |    |             1  |                     |       |        |       |       |
  72  +----+ +--------------+-+                   |       |        |       |       |
  73  |    | |             2  |                   |       |        |       |       |
  74  |    | | +--------------+-+                 |       |        |       |       |
  75  |    | | |             3  |                 |       |        |       |       |
  76  |    | | | +--------------+-+               |       |        |       |       |
  77  |    | | | |             4  |               |       |        |       |       |
  78  |    +-+ | | +--------------+-+             |       |        |       |       |
  79  |      | | | |             5  +-------------+       |        |       |       |
  80  |      +-+ | |  nodes for     |             |       |        |       |       |
  81  |        | | |  deploying     +---------------------+        |       |       |
  82  |        +-+ |  OPNFV         |             |       |        |       |       |
  83  |          | |                +------------------------------+       |       |
  84  |          +-+     SUT        |             |       |        |       |       |
  85  |            |                +--------------------------------------+       |
  86  |            |                |             |       |        |       |       |
  87  |            |                +----------------------------------------------+
  88  |            +----------------+             |       |        |       |       |
  89  |                                           |       |        |       |       |
  90  +                                           +       +        +       +       +
  91               SUT = System Under Test
  92
  93 Note connectivity to management network is not needed for most of the testcases.
  94 But it may be needed for some specific snaps tests.
  95
  96 All the libraries and dependencies needed by all of the Functest tools are
  97 pre-installed into the Docker images. This allows running Functest on any
  98 platform.
  99
 100 The automated mechanisms inside the Functest Docker container will:
 101
 102   * Retrieve OpenStack credentials
 103   * Prepare the environment according to the System Under Test (SUT)
 104   * Perform the appropriate functional tests
 105   * Push the test results into the OPNFV test result database
 106
 107 This Docker image can be integrated into CI or deployed independently.
 108
 109 Please note that the Functest Docker container has been designed for OPNFV,
 110 however, it would be possible to adapt it to any OpenStack based VIM +
 111 controller environment, since most of the test cases are integrated from
 112 upstream communities.
 113
 114 The functional test cases are described in the Functest User Guide `[2]`_
 115
 116 .. include:: ./prerequisites.rst
 117
 118 .. include:: ./configguide.rst
 119
 120 .. include:: ./ci.rst
 121
 122
 123 References
 124 ==========
 125
 126 `[1]`_ : Keystone and public end point constraint
 127
 128 `[2]`_ : Functest User guide
 129
 130 `[3]`_ : Functest Jenkins jobs
 131
 132 `[4]`_ : Functest Configuration guide
 133
 134 `[5]`_ : OPNFV main site
 135
 136 `[6]`_ : Functest wiki page
 137
 138 IRC support channel: #opnfv-functest
 139
 140 .. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
 141 .. _`[2]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
 142 .. _`[3]`: https://git.opnfv.org/releng/tree/jjb/functest/functest-daily-jobs.yml
 143 .. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
 144 .. _`[5]`: http://www.opnfv.org
 145 .. _`[6]`: https://wiki.opnfv.org/functest