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 WARNING: Connectivity from Jumphost is essential and it is of paramount
  18 importance to make sure it is working before even considering to install
  19 and run Functest. Make also sure you understand how your networking is
  20 designed to work.
  21
  22 NOTE: **Jumphost** refers to any server which meets the previous
  23 requirements. Normally it is the same server from where the OPNFV
  24 deployment has been triggered previously, but it could be any server
  25 with proper connectivity to the SUT.
  26
  27 NOTE: If your Jumphost is operating behind a company http proxy and/or
  28 firewall, please consult first the section :ref:`Proxy support`, towards
  29 the end of this document. The section details some tips/tricks which
  30 *may* be of help in a proxified environment.
  31
  32 Docker installation
  33 -------------------
  34 Docker installation and configuration is only needed to be done once
  35 through the life cycle of Jumphost.
  36
  37 If your Jumphost is based on Ubuntu, SUSE, RHEL or CentOS linux, please
  38 consult the references below for more detailed instructions. The
  39 commands below are offered as a short reference.
  40
  41 *Tip:* For running docker containers behind the proxy, you need first
  42 some extra configuration which is described in section
  43 :ref:`Docker Installation on CentOS behind http proxy`. You should follow that
  44 section before installing the docker engine.
  45
  46 Docker installation needs to be done as root user. You may use other
  47 userid's to create and run the actual containers later if so desired.
  48 Log on to your Jumphost as root user and install the Docker Engine
  49 (e.g. for CentOS family)::
  50
  51  curl -sSL https://get.docker.com/ | sh
  52  systemctl start docker
  53
  54  *Tip:* If you are working through proxy, please set the https_proxy
  55  environment variable first before executing the curl command.
  56
  57 Add your user to docker group to be able to run commands without sudo::
  58
  59  sudo usermod -aG docker <your_user>
  60
  61 A reconnection is needed. There are 2 ways for this:
  62     #. Re-login to your account
  63     #. su - <username>
  64
  65 References - Installing Docker Engine on different Linux Operating Systems:
  66   * Ubuntu_
  67   * RHEL_
  68   * CentOS_
  69   * SUSE_
  70
  71 .. _Ubuntu: https://docs.docker.com/engine/installation/linux/ubuntulinux/
  72 .. _RHEL:   https://docs.docker.com/engine/installation/linux/rhel/
  73 .. _CentOS: https://docs.docker.com/engine/installation/linux/centos/
  74 .. _SUSE: https://docs.docker.com/engine/installation/linux/suse/
  75
  76 Public/External network on SUT
  77 ------------------------------
  78 Some of the tests against the VIM (Virtual Infrastructure Manager) need
  79 connectivity through an existing public/external network in order to
  80 succeed. This is needed, for example, to create floating IPs to access
  81 VM instances through the public/external network (i.e. from the Docker
  82 container).
  83
  84 By default, the five OPNFV installers provide a fresh installation with
  85 a public/external network created along with a router. Make sure that
  86 the public/external subnet is reachable from the Jumphost and an external
  87 router exists.
  88
  89 *Hint:* For the given OPNFV Installer in use, the IP sub-net address
  90 used for the public/external network is usually a planning item and
  91 should thus be known. Ensure you can reach each node in the SUT, from the
  92 Jumphost using the 'ping' command using the respective IP address on the
  93 public/external network for each node in the SUT. The details of how to
  94 determine the needed IP addresses for each node in the SUT may vary according
  95 to the used installer and are therefore ommitted here.