summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/configguide/intro.rst
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2018-04-03 20:29:37 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2018-04-04 20:15:15 +0200
commit3cabf9dc69e8639db7bb72f05474dee4ece2ed97 (patch)
tree5822ad96861ec0e1d956b30193f9654a36580537 /docs/testing/user/configguide/intro.rst
parent452f3e459c7e466368c7624c6d9bf5be9ee825b1 (diff)
Fix Functest Config Guide
It allows building this documentation via tox. rst files are now checked via doc8. Intro is moved into a new file. Change-Id: Ic5c0108cf1cbb0fc69f7e2cc73cf2fb69e44baa1 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> (cherry picked from commit 87a9ed4c08b2c7781f97bf03c08f2d4788f4653d)
Diffstat (limited to 'docs/testing/user/configguide/intro.rst')
-rw-r--r--docs/testing/user/configguide/intro.rst91
1 files changed, 91 insertions, 0 deletions
diff --git a/docs/testing/user/configguide/intro.rst b/docs/testing/user/configguide/intro.rst
new file mode 100644
index 000000000..72730b253
--- /dev/null
+++ b/docs/testing/user/configguide/intro.rst
@@ -0,0 +1,91 @@
+.. SPDX-License-Identifier: CC-BY-4.0
+
+Introduction
+============
+This document describes how to install and configure Functest in OPNFV.
+
+High level architecture
+-----------------------
+
+The high level architecture of Functest within OPNFV can be described as
+follows::
+
+ CIMC/Lights+out management Admin Mgmt/API Public Storage Private
+ PXE
+ + + + + + +
+ | | | | | |
+ | +----------------------------+ | | | | |
+ | | | | | | | |
+ +-----+ Jumphost | | | | | |
+ | | | | | | | |
+ | | +--------------------+ | | | | | |
+ | | | | | | | | | |
+ | | | Tools | +----------------+ | | |
+ | | | - Rally | | | | | | |
+ | | | - Robot | | | | | | |
+ | | | - RefStack | | | | | | |
+ | | | | |-------------------------+ | |
+ | | | Testcases | | | | | | |
+ | | | - VIM | | | | | | |
+ | | | | | | | | | |
+ | | | - SDN Controller | | | | | | |
+ | | | | | | | | | |
+ | | | - Features | | | | | | |
+ | | | | | | | | | |
+ | | | - VNF | | | | | | |
+ | | | | | | | | | |
+ | | +--------------------+ | | | | | |
+ | | Functest Docker + | | | | |
+ | | | | | | | |
+ | | | | | | | |
+ | | | | | | | |
+ | +----------------------------+ | | | | |
+ | | | | | |
+ | +----------------+ | | | | |
+ | | 1 | | | | | |
+ +----+ +--------------+-+ | | | | |
+ | | | 2 | | | | | |
+ | | | +--------------+-+ | | | | |
+ | | | | 3 | | | | | |
+ | | | | +--------------+-+ | | | | |
+ | | | | | 4 | | | | | |
+ | +-+ | | +--------------+-+ | | | | |
+ | | | | | 5 +-------------+ | | | |
+ | +-+ | | nodes for | | | | | |
+ | | | | deploying +---------------------+ | | |
+ | +-+ | OPNFV | | | | | |
+ | | | +------------------------------+ | |
+ | +-+ SUT | | | | | |
+ | | +--------------------------------------+ |
+ | | | | | | | |
+ | | +----------------------------------------------+
+ | +----------------+ | | | | |
+ | | | | | |
+ + + + + + +
+ SUT = System Under Test
+
+Note connectivity to management network is not needed for most of the
+testcases. But it may be needed for some specific snaps tests.
+
+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:
+
+ * 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 (optional)
+
+The OpenStack credentials file must be provided to the container.
+
+These Docker images can be integrated into CI or deployed independently.
+
+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.
+
+The functional test cases are described in the Functest User `[2]`_
+
+.. _`[2]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html