docs/testing/user/configguide/prerequisites.rst

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