+.. SPDX-License-Identifier: CC-BY-4.0
+
Prerequisites
=============
The OPNFV deployment is out of the scope of this document but it can be
-found in http://docs.opnfv.org.
+found in https://docs.opnfv.org/en/stable-hunter/.
The OPNFV platform is considered as the SUT in this document.
Several prerequisites are needed for Functest:
#. An admin/management network created on the SUT
#. Connectivity from the Jumphost to the SUT public/external network
-Some specific SNAPS tests may require a connectivity from the Jumphost to the
-SUT admin/management network but most of the test cases do not. This requirement
-can be overridden by overriding the 'interface' attribute (OS_INTERFACE) value
-to 'public'. Another means to circumvent this issue would be to change the
-'snaps.use_keystone' value from True to False.
-
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
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.
+deployment has been triggered previously, but it could be any server
+with proper connectivity to the SUT.
NOTE: If your Jumphost is operating behind a company http proxy and/or
-firewall, please consult first the section `Proxy Support`_, towards
+firewall, please consult first the section :ref:`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.
+:ref:`Docker Installation on CentOS behind http proxy`. You should follow that
+section before installing the docker engine.
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.
VM instances through the public/external network (i.e. from the Docker
container).
-By default, the four OPNFV installers provide a fresh installation with
+By default, the five 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.
+the public/external subnet is reachable from the Jumphost and an external
+router exists.
*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
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.
-
-.. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
-.. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
+to the used installer and are therefore omitted here.