docs/configguide/index.rst

   1 ===============================================
   2 OPNFV FUNCTEST configuration/installation guide
   3 ===============================================
   4
   5 .. contents::
   6
   7 ------------
   8 Introduction
   9 ------------
  10
  11 ** DOCUMENT IS IN PROGRESS FOR BRAHMAPUTRA **
  12
  13 .. _prereqs:
  14
  15 -------------
  16 Prerequisites
  17 -------------
  18
  19 The installation of the OPNFV solution is out of scope of this document but can be found XXX.
  20 In the rest of the document the OPNFV solution would be considered as the System Under Test (SUT).
  21
  22 The installation and configuration of the tools needed to perform the tests will be described in the following sections.
  23
  24 Since Arno SR1, the tools are automatically installed. Manual sourcing of OpenStack credentials is no more required if you are fully integrated in the continuous integration.
  25 A script has been added to automatically retrieve the credentials.
  26 However, if you still install manually functest, you will need to source the rc file on the machine you are running the tests.
  27 More details will be provided in the configuration section.
  28
  29 .. _pharos: https://wiki.opnfv.org/pharos
  30
  31 It is recommended to install the different tools on the jump host server as defined in the pharos_ project.
  32
  33 For functest, the following libraries are needed. You can install them either with yum install or apt-get install, depending on your operating system:
  34  * python-pip
  35  * python-dev
  36  * libffi-dev
  37  * libxml2-dev
  38  * libxslt1-dev
  39
  40 You will also need some Python modules:
  41  * sudo pip install GitPython
  42  * sudo pip install python-novaclient
  43  * sudo pip install python-neutronclient
  44  * sudo pip install python-glanceclient
  45  * sudo pip install python-keystoneclient
  46
  47
  48 The high level architecture can be described as follow::
  49
  50  CIMC/Lights+out management                  Admin     Private   Public   Storage
  51                                               PXE
  52                                                                    +
  53  +                                             +     IP_PRIV/24    |        |
  54  |                                             |         +         +        |
  55  |                                             |         |    IP_PUB/24     |
  56  |     +-----------------+                     |         |         +        |
  57  |     |                 |                     |         |         |        |
  58  +-----+  Jumpserver     |                     |         |         |        |
  59  |     |                 +---------------------+         |         |        |
  60  |     |                 |                     |         |         |        |
  61  |     |  +----------+   |                     |         |         |        |
  62  |     |  |  Rally   |   +---- --------------------------+         |        |
  63  |     |  |          |   |                     |         |         |        |
  64  |     |  |  Robot   |   |                     |         |         |        |
  65  |     |  |          |   |                     |         |         |        |
  66  |     |  |  vPing   |   |                     |         |         |        |
  67  |     |  |          |   |                     |         |         |        |
  68  |     |  | Tempest  |   |                     |         |         |        |
  69  |     |  +----------+   |                     |         |         |        |
  70  |     |   FuncTest      +-----------------------------------------+        |
  71  |     |                 |                     |         |         |        |
  72  |     |                 +--------------------------------------------------+
  73  |     |                 |                     |         |         |        |
  74  |     +-----------------+                     |         |         |        |
  75  |                                             |         |         |        |
  76  |    +----------------+                       |         |         |        |
  77  |    |             1  |                       |         |         |        |
  78  +----+ +--------------+-+                     |         |         |        |
  79  |    | |             2  |                     |         |         |        |
  80  |    | | +--------------+-+                   |         |         |        |
  81  |    | | |             3  |                   |         |         |        |
  82  |    | | | +--------------+-+                 |         |         |        |
  83  |    | | | |             4  |                 |         |         |        |
  84  |    +-+ | | +--------------+-+               |         |         |        |
  85  |      | | | |             5  +---------------+         |         |        |
  86  |      +-+ | |  nodes for     |               |         |         |        |
  87  |        | | |  deploying     +-------------------------+         |        |
  88  |        +-+ |  opnfv         |               |         |         |        |
  89  |          | |     SUT        +-----------------------------------+        |
  90  |          +-+                |               |         |         |        |
  91  |            |                +--------------------------------------------+
  92  |            +----------------+               |         |         |        |
  93  |                                             |         |         |        |
  94  |                                             +         +         +        +
  95
  96
  97 .. _tooling_installation:
  98
  99 ------------
 100 Installation
 101 ------------
 102
 103 -------------
 104 Configuration
 105 -------------
 106
 107 -----------------
 108 Integration in CI
 109 -----------------
 110
 111
 112
 113 ----------
 114 References
 115 ----------
 116
 117 OPNFV main site: opnfvmain_.
 118
 119 OPNFV functional test page: opnfvfunctest_.
 120
 121 IRC support chan: #opnfv-testperf
 122
 123 .. _opnfvmain: http://www.opnfv.org
 124 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
 125 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
 126 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
 127 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
 128 .. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml