1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 ===========================
5 Functest Installation Guide
6 ===========================
15 This document describes how to install and configure Functest in OPNFV.
17 High level architecture
18 -----------------------
20 The high level architecture of Functest within OPNFV can be described as
23 CIMC/Lights+out management Admin Mgmt/API Public Storage Private
27 | +----------------------------+ | | | | |
29 +-----+ Jumphost | | | | | |
31 | | +--------------------+ | | | | | |
33 | | | Tools | +----------------+ | | |
34 | | | - Rally | | | | | | |
35 | | | - Robot | | | | | | |
36 | | | - RefStack | | | | | | |
37 | | | | |-------------------------+ | |
38 | | | Testcases | | | | | | |
39 | | | - VIM | | | | | | |
41 | | | - SDN Controller | | | | | | |
43 | | | - Features | | | | | | |
45 | | | - VNF | | | | | | |
47 | | +--------------------+ | | | | | |
48 | | Functest Docker + | | | | |
52 | +----------------------------+ | | | | |
54 | +----------------+ | | | | |
56 +----+ +--------------+-+ | | | | |
58 | | | +--------------+-+ | | | | |
60 | | | | +--------------+-+ | | | | |
61 | | | | | 4 | | | | | |
62 | +-+ | | +--------------+-+ | | | | |
63 | | | | | 5 +-------------+ | | | |
64 | +-+ | | nodes for | | | | | |
65 | | | | deploying +---------------------+ | | |
66 | +-+ | OPNFV | | | | | |
67 | | | +------------------------------+ | |
69 | | +--------------------------------------+ |
71 | | +----------------------------------------------+
72 | +----------------+ | | | | |
75 SUT = System Under Test
77 Note connectivity to management network is not needed for most of the testcases.
78 But it may be needed for some specific snaps tests.
80 All the libraries and dependencies needed by all of the Functest tools are
81 pre-installed into the Docker images. This allows running Functest on any
84 The automated mechanisms inside the Functest Docker containers will:
86 * Prepare the environment according to the System Under Test (SUT)
87 * Perform the appropriate functional tests
88 * Push the test results into the OPNFV test result database (optional)
90 The OpenStack credentials file must be provided to the container.
92 These Docker images can be integrated into CI or deployed independently.
94 Please note that the Functest Docker images have been designed for OPNFV,
95 however, it would be possible to adapt them to any OpenStack based VIM +
96 controller environment, since most of the test cases are integrated from
99 The functional test cases are described in the Functest User Guide `[2]`_
101 .. include:: ./prerequisites.rst
103 .. include:: ./configguide.rst
105 .. include:: ./ci.rst
111 `[1]`_ : Keystone and public end point constraint
113 `[2]`_ : Functest User guide
115 `[3]`_ : Functest Jenkins jobs
117 `[4]`_ : Functest Configuration guide
119 `[5]`_ : OPNFV main site
121 `[6]`_ : Functest wiki page
123 IRC support channel: #opnfv-functest
125 .. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
126 .. _`[2]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
127 .. _`[3]`: https://git.opnfv.org/releng/tree/jjb/functest/functest-daily-jobs.yml
128 .. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
129 .. _`[5]`: http://www.opnfv.org
130 .. _`[6]`: https://wiki.opnfv.org/functest