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