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