aboutsummaryrefslogtreecommitdiffstats
path: root/docs/configguide/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configguide/index.rst')
-rw-r--r--docs/configguide/index.rst249
1 files changed, 130 insertions, 119 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 7c8113e16..6b6c62a1b 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -12,7 +12,9 @@ OPNFV FUNCTEST Configuration Guide
Introduction
============
This document describes how to install and configure Functest in OPNFV.
-The Functest CLI is utilized during the Functest environment preparation step.
+The Functest CLI is utilized during the Functest environment preparation
+step. The given example commands should work in both virtual and bare
+metal cases alike.
High level architecture
-----------------------
@@ -20,69 +22,66 @@ High level architecture
The high level architecture of Functest within OPNFV can be described as
follows::
- CIMC/Lights+out management Admin Private Public Storage
- PXE
- +
- + + IP_PRIV/24 | |
- | | + + |
- | | | IP_PUB/24 |
- | +----------------------------+ | | + |
- | | | | | | |
- +-----+ Jumphost | | | | |
- | | +----------+ | | |
- | | | | | | |
- | | +--------------------+ | | | | |
- | | | | | | | | |
- | | | Tools | +--------------------+ | |
- | | | - Rally | | | | | |
- | | | - Robot | | | | | |
- | | | - TestON | | | | | |
- | | | | | | | | |
- | | | Testcases | | | | | |
- | | | - VIM | | | | | |
- | | | -- vPing | | | | | |
- | | | -- vPing_userdata | | | | | |
- | | | -- Tempest | | | | | |
- | | | -- Rally | | | | | |
- | | | - Controller | | | | | |
- | | | -- odl | | | | | |
- | | | -- onos | | | | | |
- | | | -- opencontrail | | | | | |
- | | | | | | | | |
- | | | Features | | | | | |
- | | | - vIMS | | | | | |
- | | | | | | | | |
- | | +--------------------+ | | | | |
- | | +------------------------------+ |
- | | Functest Docker | | | | |
- | | +---------------------------------------+
- | | | | | | |
- | +----------------------------+ | | | |
- | | | | |
- | +----------------+ | | | |
- | | 1 | | | | |
- +----+ +--------------+-+ | | | |
- | | | 2 | | | | |
- | | | +--------------+-+ | | | |
- | | | | 3 | | | | |
- | | | | +--------------+-+ | | | |
- | | | | | 4 | | | | |
- | +-+ | | +--------------+-+ | | | |
- | | | | | 5 +---------------+ | | |
- | +-+ | | nodes for | | | | |
- | | | | deploying +-------------------------+ | |
- | +-+ | OPNFV | | | | |
- | | | +-----------------------------------+ |
- | +-+ SUT | | | | |
- | | +--------------------------------------------+
- | +----------------+ | | | |
- | | | | |
- + + + + +
+ CIMC/Lights+out management Admin Private Public Storage
+ PXE
+ + + + + +
+ | | | | |
+ | +----------------------------+ | | | |
+ | | | | | | |
+ +-----+ Jumphost | | | | |
+ | | +--------+ | | |
+ | | | | | | |
+ | | +--------------------+ | | | | |
+ | | | | | | | | |
+ | | | Tools | +----------------+ | |
+ | | | - Rally | | | | | |
+ | | | - Robot | | | | | |
+ | | | - TestON | | | | | |
+ | | | | | | | | |
+ | | | Testcases | | | | | |
+ | | | - VIM | | | | | |
+ | | | -- vPing | | | | | |
+ | | | -- vPing_userdata | | | | | |
+ | | | -- Tempest | | | | | |
+ | | | -- Rally | | | | | |
+ | | | - Controller | | | | | |
+ | | | -- odl | | | | | |
+ | | | -- onos | | | | | |
+ | | | | | | | | |
+ | | | Features | | | | | |
+ | | | - vIMS | | | | | |
+ | | | | | | | | |
+ | | +--------------------+ | | | | |
+ | | +-------------------------+ |
+ | | Functest Docker | | | | |
+ | | +---------------------------------+
+ | | | | | | |
+ | +----------------------------+ | | | |
+ | | | | |
+ | +----------------+ | | | |
+ | | 1 | | | | |
+ +----+ +--------------+-+ | | | |
+ | | | 2 | | | | |
+ | | | +--------------+-+ | | | |
+ | | | | 3 | | | | |
+ | | | | +--------------+-+ | | | |
+ | | | | | 4 | | | | |
+ | +-+ | | +--------------+-+ | | | |
+ | | | | | 5 +-------------+ | | |
+ | +-+ | | nodes for | | | | |
+ | | | | deploying +---------------------+ | |
+ | +-+ | OPNFV | | | | |
+ | | | +------------------------------+ |
+ | +-+ SUT | | | | |
+ | | +--------------------------------------+
+ | +----------------+ | | | |
+ | | | | |
+ + + + + +
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.
+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.
The automated mechanisms inside the Functest Docker container will:
@@ -93,18 +92,18 @@ The automated mechanisms inside the Functest Docker container will:
This Docker image 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 VIM+controller environment,
-since most of the test cases are integrated from upstream communities.
-
-The test cases are described in the Functest User Guide `[2]`_
+Please note that the Functest Docker container has been designed for
+OPNFV, however, it would be possible to adapt it to any VIM + controller
+environment, since most of the test cases are integrated from upstream
+communities.
+The functional test cases are described in the Functest User Guide `[2]`_
Prerequisites
=============
-The OPNFV deployment is out of the scope of this document but it can be found
-in `[4]`_. The OPNFV platform is considered as the System Under Test (SUT) in
-this document.
+The OPNFV deployment is out of the scope of this document but it can be
+found in `[4]`_. The OPNFV platform is considered as the System Under
+Test (SUT) in this document.
Several prerequisites are needed for Functest:
@@ -115,24 +114,44 @@ Several prerequisites are needed for Functest:
#. Connectivity from the Jumphost to the SUT public/external network
#. Connectivity from the Jumphost to the SUT admin/management network
-NOTE: **Jumphost** refers to any server which meets the previous requirements.
-Normally it is the same server from where the OPNFV deployment has been
-triggered previously.
+WARNING: Connectivity from Jumphost is essential and it is of paramount
+importance to make sure it is working before even considering to install
+and run Functest. Make also sure you understand how your networking is
+designed to work.
+
+NOTE: **Jumphost** refers to any server which meets the previous
+requirements. Normally it is the same server from where the OPNFV
+deployment has been triggered previously.
+
+NOTE: If your Jumphost is operating behind a company http proxy and/or
+Firewall, please consult first the section `Proxy Support`_, towards
+the end of this document. The section details some tips/tricks which
+*may* be of help in a proxified environment.
Docker installation
-------------------
-.. _Ubuntu: https://docs.docker.com/installation/ubuntulinux/
-.. _RHEL: https://docs.docker.com/installation/rhel/
-.. _CentOS: https://docs.docker.com/engine/installation/linux/centos/
+Docker installation and configuration is only needed to be done once
+through the life cycle of Jumphost.
+
+If your Jumphost is based on Ubuntu, RHEL or CentOS linux, please
+consult the references below for more detailed instructions. The
+commands below are offered as a short reference.
-*Tip:* If your Jumphost is operating behind a company http proxy and/or
-Firewall, please consult first the section `Proxy Support`_, towards the end
-of this document. The section details some tips/tricks which *may* be of help
-in a proxified environment.
+*Tip:* For running docker containers behind the proxy, you need first
+some extra configuration which is described in section
+`Docker Installation on CentOS behind http proxy`_. You should follow
+that section before installing the docker engine.
-Log on to your Jumphost and install the Docker Engine (e.g. for Ubuntu)::
+Docker installation needs to be done as root user. You may use other
+userid's to create and run the actual containers later if so desired.
+Log on to your Jumphost as root user and install the Docker Engine
+(e.g. for CentOS family)::
curl -sSL https://get.docker.com/ | sh
+ systemctl start docker
+
+ *Tip:* If you are working through proxy, please set the https_proxy
+ environment variable first before executing the curl command.
Add your user to docker group to be able to run commands without sudo::
@@ -142,51 +161,43 @@ A reconnect is needed. There are 2 ways for this:
#. Re-login to your account
#. su - <username>
-If your Jumphost is based on Red Hat Enterprise Linux, or CentOS 7 linux,
-please consult the references below.
-
References - Installing Docker Engine on different Linux Operating Systems:
-
* Ubuntu_
* RHEL_
* CentOS_
+.. _Ubuntu: https://docs.docker.com/engine/installation/linux/ubuntulinux/
+.. _RHEL: https://docs.docker.com/engine/installation/linux/rhel/
+.. _CentOS: https://docs.docker.com/engine/installation/linux/centos/
+
Public/External network on SUT
------------------------------
Some of the tests against the VIM (Virtual Infrastructure Manager) need
-connectivity through an existing public/external network in order to succeed.
-This is needed, for example, to create floating IPs to access VM instances
-through the public/external network (i.e. from the Docker container).
-
-By default, the four OPNFV installers provide a fresh installation with a
-public/external network created along with a router. Make sure that the
-public/external subnet is reachable from the Jumphost.
-
-*Hint:* For the given OPNFV Installer in use, the IP sub-net address used for
-the public/external network is usually a planning item and should thus be known.
-Consult the OPNFV Configuration guide `[4]`_, and ensure you can reach each
-node in the SUT, from the Jumphost using the 'ping' command using the
-respective IP address on the public/external network for each node in the SUT.
-(The details of how to determine the needed IP addresses for each node in the
-SUT may vary according to the used installer and are therefore ommitted here.)
-
-Connectivity to OPNFV admin/management network
-----------------------------------------------
-Some of the Functest tools need to have access to the OpenStack admin/management
-network of the controllers `[1]`_.
-
-For this reason, an interface shall be configured in the Jumphost in the OpenStack admin/management network range.
-
-For example, if the admin/management network is using VLAN 300 and subnet 192.168.1.0/24 and assuming that eth1 is the
-physical interface with access to that subnet::
-
- ip link add name eth1.300 link eth1 type vlan id 300
- ip link set eth1.300 up
- ip addr add 192.168.1.66/24 dev eth1.300
-
-This is just an example about how to configure an interface with vlan, but it might differ depending on the deployment
-settings on each installer. Check the corresponding installer instructions for more precise instructions.
-
+connectivity through an existing public/external network in order to
+succeed. This is needed, for example, to create floating IPs to access
+VM instances through the public/external network (i.e. from the Docker
+container).
+
+By default, the four OPNFV installers provide a fresh installation with
+a public/external network created along with a router. Make sure that
+the public/external subnet is reachable from the Jumphost.
+
+*Hint:* For the given OPNFV Installer in use, the IP sub-net address
+used for the public/external network is usually a planning item and
+should thus be known. Consult the OPNFV Configuration guide `[4]`_, and
+ensure you can reach each node in the SUT, from the Jumphost using the
+'ping' command using the respective IP address on the public/external
+network for each node in the SUT. The details of how to determine the
+needed IP addresses for each node in the SUT may vary according to the
+used installer and are therefore ommitted here.
+
+Connectivity to Admin/Management network on SUT
+-----------------------------------------------
+Some of the Functest tools need to have access to the OpenStack
+admin/management network of the controllers `[1]`_.
+
+For this reason, check the connectivity from the Jumphost to all the
+controllers in cluster in the OpenStack admin/management network range.
Installation and configuration
==============================
@@ -269,7 +280,7 @@ OPNFV main site: opnfvmain_.
OPNFV functional test page: opnfvfunctest_.
-IRC support channel: #opnfv-testperf
+IRC support channel: #opnfv-functest
.. _opnfvmain: http://www.opnfv.org
.. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing