diff options
| author |   Cédric Ollivier <cedric.ollivier@orange.com> | 2018-04-03 20:29:37 +0200 |
|---|---|---|
| committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-04-04 06:34:11 +0200 |
| commit | 87a9ed4c08b2c7781f97bf03c08f2d4788f4653d (patch) | |
| tree | 0b16b2ed1fd312acbf79999413f4652914099c57 /docs/testing/user/configguide/prerequisites.rst | |
| parent | 319c283565c4d7d38106487a12d3ce6a71cb4ba8 (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>
Diffstat (limited to 'docs/testing/user/configguide/prerequisites.rst')
| -rw-r--r-- | docs/testing/user/configguide/prerequisites.rst | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/docs/testing/user/configguide/prerequisites.rst b/docs/testing/user/configguide/prerequisites.rst index 8289803bb..60be1b93b 100644 --- a/docs/testing/user/configguide/prerequisites.rst +++ b/docs/testing/user/configguide/prerequisites.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + Prerequisites ============= The OPNFV deployment is out of the scope of this document but it can be @@ -13,10 +15,11 @@ Several prerequisites are needed for Functest: #. 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 changed by overriding the 'interface' attribute (OS_INTERFACE) value -to 'public' in the credentials file. Another means to circumvent this issue -would be to change the 'snaps.use_keystone' value from True to False. +SUT admin/management network but most of the test cases do not. This +requirement can be changed by overriding the 'interface' attribute +(OS_INTERFACE) value to 'public' in the credentials file. 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 @@ -29,7 +32,7 @@ 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. @@ -44,8 +47,8 @@ commands below are offered as a short reference. *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. |