docs/testing/user/configguide/prerequisites.rst

   1 .. SPDX-License-Identifier: CC-BY-4.0
   2
   3 Prerequisites
   4 =============
   5 The OPNFV deployment is out of the scope of this document but it can be
   6 found in http://docs.opnfv.org.
   7 The OPNFV platform is considered as the SUT in this document.
   8
   9 Several prerequisites are needed for Functest:
  10
  11     #. A Jumphost to run Functest on
  12     #. A Docker daemon shall be installed on the Jumphost
  13     #. A public/external network created on the SUT
  14     #. An admin/management network created on the SUT
  15     #. Connectivity from the Jumphost to the SUT public/external network
  16
  17 Some specific SNAPS tests may require a connectivity from the Jumphost to the
  18 SUT admin/management network but most of the test cases do not. This
  19 requirement can be changed by overriding the 'interface' attribute
  20 (OS_INTERFACE) value to 'public' in the credentials file. Another means to
  21 circumvent this issue would be to change the 'snaps.use_keystone' value from
  22 True to False.
  23
  24 WARNING: Connectivity from Jumphost is essential and it is of paramount
  25 importance to make sure it is working before even considering to install
  26 and run Functest. Make also sure you understand how your networking is
  27 designed to work.
  28
  29 NOTE: **Jumphost** refers to any server which meets the previous
  30 requirements. Normally it is the same server from where the OPNFV
  31 deployment has been triggered previously, but it could be any server
  32 with proper connectivity to the SUT.
  33
  34 NOTE: If your Jumphost is operating behind a company http proxy and/or
  35 firewall, please consult first the section :ref:`Proxy support`, towards
  36 the end of this document. The section details some tips/tricks which
  37 *may* be of help in a proxified environment.
  38
  39 Docker installation
  40 -------------------
  41 Docker installation and configuration is only needed to be done once
  42 through the life cycle of Jumphost.
  43
  44 If your Jumphost is based on Ubuntu, SUSE, RHEL or CentOS linux, please
  45 consult the references below for more detailed instructions. The
  46 commands below are offered as a short reference.
  47
  48 *Tip:* For running docker containers behind the proxy, you need first
  49 some extra configuration which is described in section
  50 :ref:`Docker Installation on CentOS behind http proxy`. You should follow that
  51 section before installing the docker engine.
  52
  53 Docker installation needs to be done as root user. You may use other
  54 userid's to create and run the actual containers later if so desired.
  55 Log on to your Jumphost as root user and install the Docker Engine
  56 (e.g. for CentOS family)::
  57
  58  curl -sSL https://get.docker.com/ | sh
  59  systemctl start docker
  60
  61  *Tip:* If you are working through proxy, please set the https_proxy
  62  environment variable first before executing the curl command.
  63
  64 Add your user to docker group to be able to run commands without sudo::
  65
  66  sudo usermod -aG docker <your_user>
  67
  68 A reconnection is needed. There are 2 ways for this:
  69     #. Re-login to your account
  70     #. su - <username>
  71
  72 References - Installing Docker Engine on different Linux Operating Systems:
  73   * Ubuntu_
  74   * RHEL_
  75   * CentOS_
  76   * SUSE_
  77
  78 .. _Ubuntu: https://docs.docker.com/engine/installation/linux/ubuntulinux/
  79 .. _RHEL:   https://docs.docker.com/engine/installation/linux/rhel/
  80 .. _CentOS: https://docs.docker.com/engine/installation/linux/centos/
  81 .. _SUSE: https://docs.docker.com/engine/installation/linux/suse/
  82
  83 Public/External network on SUT
  84 ------------------------------
  85 Some of the tests against the VIM (Virtual Infrastructure Manager) need
  86 connectivity through an existing public/external network in order to
  87 succeed. This is needed, for example, to create floating IPs to access
  88 VM instances through the public/external network (i.e. from the Docker
  89 container).
  90
  91 By default, the five OPNFV installers provide a fresh installation with
  92 a public/external network created along with a router. Make sure that
  93 the public/external subnet is reachable from the Jumphost and an external
  94 router exists.
  95
  96 *Hint:* For the given OPNFV Installer in use, the IP sub-net address
  97 used for the public/external network is usually a planning item and
  98 should thus be known. Ensure you can reach each node in the SUT, from the
  99 Jumphost using the 'ping' command using the respective IP address on the
 100 public/external network for each node in the SUT. The details of how to
 101 determine the needed IP addresses for each node in the SUT may vary according
 102 to the used installer and are therefore ommitted here.
 103
 104 .. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
 105 .. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html