1 .. SPDX-License-Identifier: CC-BY-4.0
3 Installation and configuration
4 ==============================
6 Alpine containers have been introduced in Euphrates.
7 Alpine allows Functest testing in several very light containers and thanks to
8 the refactoring on dependency management should allow the creation of light and
9 fully customized docker images.
12 Functest Dockers for OpenStack deployment
13 -----------------------------------------
14 Docker images are available on the dockerhub:
17 * opnfv/functest-healthcheck
18 * opnfv/functest-smoke
19 * opnfv/functest-features
20 * opnfv/functest-components
23 The tag "opnfv-6.0.0" is the official release image in Fraser, but you can
24 also pull "fraser" tag as it is being maintained by Functest team and might
27 The Functest docker container environment can -in principle- be also
28 used with non-OPNFV official installers (e.g. 'devstack'), with the
29 **disclaimer** that support for such environments is outside of the
30 scope and responsibility of the OPNFV project.
33 Preparing your environment
34 ^^^^^^^^^^^^^^^^^^^^^^^^^^
39 DEPLOY_SCENARIO=XXX # if not os-nosdn-nofeature-noha scenario
40 NAMESERVER=XXX # if not 8.8.8.8
42 See section on environment variables for details.
46 export OS_AUTH_URL=XXX
47 export OS_USER_DOMAIN_NAME=XXX
48 export OS_PROJECT_DOMAIN_NAME=XXX
49 export OS_USERNAME=XXX
50 export OS_PROJECT_NAME=XXX
51 export OS_PASSWORD=XXX
52 export OS_IDENTITY_API_VERSION=3
54 See section on OpenStack credentials for details.
56 Create a directory for the different images (attached as a Docker volume)::
58 mkdir -p images && wget -q -O- https://git.opnfv.org/functest/plain/functest/ci/download_images.sh?h=stable/fraser | bash -s -- images && ls -1 images/*
60 images/CentOS-7-aarch64-GenericCloud.qcow2
61 images/CentOS-7-aarch64-GenericCloud.qcow2.xz
62 images/CentOS-7-x86_64-GenericCloud.qcow2
63 images/cirros-0.4.0-x86_64-disk.img
64 images/cirros-0.4.0-x86_64-lxc.tar.gz
65 images/cirros-d161201-aarch64-disk.img
66 images/cirros-d161201-aarch64-initramfs
67 images/cirros-d161201-aarch64-kernel
68 images/cloudify-manager-premium-4.0.1.qcow2
69 images/ubuntu-14.04-server-cloudimg-amd64-disk1.img
70 images/ubuntu-14.04-server-cloudimg-arm64-uefi1.img
71 images/ubuntu-16.04-server-cloudimg-amd64-disk1.img
74 Testing healthcheck suite
75 ^^^^^^^^^^^^^^^^^^^^^^^^^
77 Run healthcheck suite::
79 sudo docker run --env-file env \
80 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
81 -v $(pwd)/images:/home/opnfv/functest/images \
82 opnfv/functest-healthcheck
84 Results shall be displayed as follows::
86 +----------------------------+------------------+---------------------+------------------+----------------+
87 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
88 +----------------------------+------------------+---------------------+------------------+----------------+
89 | connection_check | functest | healthcheck | 00:07 | PASS |
90 | api_check | functest | healthcheck | 07:46 | PASS |
91 | snaps_health_check | functest | healthcheck | 00:36 | PASS |
92 +----------------------------+------------------+---------------------+------------------+----------------+
93 NOTE: the duration is a reference and it might vary depending on your SUT.
100 sudo docker run --env-file env \
101 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
102 -v $(pwd)/images:/home/opnfv/functest/images \
105 Results shall be displayed as follows::
107 +------------------------------+------------------+---------------+------------------+----------------+
108 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
109 +------------------------------+------------------+---------------+------------------+----------------+
110 | vping_ssh | functest | smoke | 00:57 | PASS |
111 | vping_userdata | functest | smoke | 00:33 | PASS |
112 | tempest_smoke_serial | functest | smoke | 13:22 | PASS |
113 | rally_sanity | functest | smoke | 24:07 | PASS |
114 | refstack_defcore | functest | smoke | 05:21 | PASS |
115 | patrole | functest | smoke | 04:29 | PASS |
116 | snaps_smoke | functest | smoke | 46:54 | PASS |
117 | odl | functest | smoke | 00:00 | SKIP |
118 | neutron_trunk | functest | smoke | 00:00 | SKIP |
119 +------------------------------+------------------+---------------+------------------+----------------+
120 Note: if the scenario does not support some tests, they are indicated as SKIP.
121 See User guide for details.
123 Testing features suite
124 ^^^^^^^^^^^^^^^^^^^^^^
128 sudo docker run --env-file env \
129 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
130 -v $(pwd)/images:/home/opnfv/functest/images \
131 opnfv/functest-features
133 Results shall be displayed as follows::
135 +-----------------------------+------------------------+------------------+------------------+----------------+
136 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
137 +-----------------------------+------------------------+------------------+------------------+----------------+
138 | doctor-notification | doctor | features | 00:00 | SKIP |
139 | bgpvpn | sdnvpn | features | 00:00 | SKIP |
140 | functest-odl-sfc | sfc | features | 00:00 | SKIP |
141 | barometercollectd | barometer | features | 00:00 | SKIP |
142 | fds | fastdatastacks | features | 00:00 | SKIP |
143 +-----------------------------+------------------------+------------------+------------------+----------------+
144 Note: if the scenario does not support some tests, they are indicated as SKIP.
145 See User guide for details.
147 Testing components suite
148 ^^^^^^^^^^^^^^^^^^^^^^^^
150 Run components suite::
152 sudo docker run --env-file env \
153 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
154 -v $(pwd)/images:/home/opnfv/functest/images \
155 opnfv/functest-components
157 Results shall be displayed as follows::
159 +-------------------------------+------------------+--------------------+------------------+----------------+
160 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
161 +-------------------------------+------------------+--------------------+------------------+----------------+
162 | tempest_full_parallel | functest | components | 48:28 | PASS |
163 | rally_full | functest | components | 126:02 | PASS |
164 +-------------------------------+------------------+--------------------+------------------+----------------+
171 sudo docker run --env-file env \
172 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
173 -v $(pwd)/images:/home/opnfv/functest/images \
176 Results shall be displayed as follows::
178 +----------------------+------------------+--------------+------------------+----------------+
179 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
180 +----------------------+------------------+--------------+------------------+----------------+
181 | cloudify_ims | functest | vnf | 28:15 | PASS |
182 | vyos_vrouter | functest | vnf | 17:59 | PASS |
183 | juju_epc | functest | vnf | 46:44 | PASS |
184 +----------------------+------------------+--------------+------------------+----------------+
187 Functest Dockers for Kubernetes deployment
188 ------------------------------------------
189 Docker images are available on the dockerhub:
191 * opnfv/functest-kubernetes-core
192 * opnfv/functest-kubernetest-healthcheck
193 * opnfv/functest-kubernetest-smoke
194 * opnfv/functest-kubernetest-features
196 Preparing your environment
197 ^^^^^^^^^^^^^^^^^^^^^^^^^^
206 export KUBERNETES_PROVIDER=local
207 export KUBE_MASTER_URL=XXX
208 export KUBE_MASTER_IP=XXX
210 Testing healthcheck suite
211 ^^^^^^^^^^^^^^^^^^^^^^^^^
213 Run healthcheck suite::
215 sudo docker run -it --env-file env \
216 -v $(pwd)/k8s.creds:/home/opnfv/functest/conf/env_file \
217 -v $(pwd)/config:/root/.kube/config \
218 opnfv/functest-kubernetes-healthcheck
220 A config file in the current dir 'config' is also required, which should be
221 volume mapped to ~/.kube/config inside kubernetes container.
223 Results shall be displayed as follows::
225 +-------------------------+------------------+-----------------+------------------+----------------+
226 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
227 +-------------------------+------------------+-----------------+------------------+----------------+
228 | k8s_smoke | functest | healthcheck | 01:54 | PASS |
229 +-------------------------+------------------+-----------------+------------------+----------------+
236 sudo docker run -it --env-file env \
237 -v $(pwd)/k8s.creds:/home/opnfv/functest/conf/env_file \
238 -v $(pwd)/config:/root/.kube/config \
239 opnfv/functest-kubernetes-smoke
241 Results shall be displayed as follows::
243 +-------------------------+------------------+---------------+------------------+----------------+
244 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
245 +-------------------------+------------------+---------------+------------------+----------------+
246 | k8s_conformance | functest | smoke | 57:47 | PASS |
247 +-------------------------+------------------+---------------+------------------+----------------+
249 Testing features suite
250 ^^^^^^^^^^^^^^^^^^^^^^
254 sudo docker run -it --env-file env \
255 -v $(pwd)/k8s.creds:/home/opnfv/functest/conf/env_file \
256 -v $(pwd)/config:/root/.kube/config \
257 opnfv/functest-kubernetes-features
259 Results shall be displayed as follows::
261 +----------------------+------------------+------------------+------------------+----------------+
262 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
263 +----------------------+------------------+------------------+------------------+----------------+
264 | stor4nfv_k8s | stor4nfv | stor4nfv | 00:00 | SKIP |
265 | clover_k8s | clover | clover | 00:00 | SKIP |
266 +----------------------+------------------+------------------+------------------+----------------+
268 Environment variables
269 =====================
271 Several environement variables may be specified:
272 * INSTALLER_TYPE=(apex|compass|daisy|fuel|joid)
273 * INSTALLER_IP=<Specific IP Address>
274 * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>
277 INSTALLER_IP is required by Barometer in order to access the installer node and
280 The format for the DEPLOY_SCENARIO env variable can be described as follows:
281 * vim: (os|k8s) = OpenStack or Kubernetes
282 * controller is one of ( nosdn | odl )
283 * nfv_feature is one or more of ( ovs | kvm | sfc | bgpvpn | nofeature )
284 * ha_mode (high availability) is one of ( ha | noha )
286 If several features are pertinent then use the underscore character '_' to
287 separate each feature (e.g. ovs_kvm). 'nofeature' indicates that no OPNFV
290 The list of supported scenarios per release/installer is indicated in the
293 **NOTE:** The scenario name is mainly used to automatically detect
294 if a test suite is runnable or not (e.g. it will prevent ODL test suite to be
295 run on 'nosdn' scenarios). If not set, Functest will try to run the default
296 test cases that might not include SDN controller or a specific feature.
298 **NOTE:** An HA scenario means that 3 OpenStack controller nodes are
299 deployed. It does not necessarily mean that the whole system is HA. See
300 installer release notes for details.
302 Finally, three additional environment variables can also be passed in
303 to the Functest Docker Container, using the -e
304 "<EnvironmentVariable>=<Value>" mechanism. The first two parameters are
305 only relevant to Jenkins CI invoked testing and **should not be used**
306 when performing manual test scenarios:
308 * NODE_NAME = <Test POD Name>
309 * BUILD_TAG = <Jenkins Build Tag>
313 * <Test POD Name> = Symbolic name of the POD where the tests are run.
314 Visible in test results files, which are stored
315 to the database. This option is only used when
316 tests are activated under Jenkins CI control.
317 It indicates the POD/hardware where the test has
318 been run. If not specified, then the POD name is
319 defined as "Unknown" by default.
320 DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
321 * <Jenkins Build tag> = Symbolic name of the Jenkins Build Job.
322 Visible in test results files, which are stored
323 to the database. This option is only set when
324 tests are activated under Jenkins CI control.
325 It enables the correlation of test results,
326 which are independently pushed to the results database
327 from different Jenkins jobs.
328 DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
331 Openstack credentials
332 =====================
333 OpenStack credentials are mandatory and must be provided to Functest.
334 When running the command "functest env prepare", the framework will
335 automatically look for the Openstack credentials file
336 "/home/opnfv/functest/conf/env_file" and will exit with
337 error if it is not present or is empty.
339 There are 2 ways to provide that file:
341 * by using a Docker volume with -v option when creating the Docker container.
342 This is referred to in docker documentation as "Bind Mounting".
343 See the usage of this parameter in the following chapter.
344 * or creating manually the file '/home/opnfv/functest/conf/env_file'
345 inside the running container and pasting the credentials in it. Consult
346 your installer guide for further details. This is however not
347 instructed in this document.
349 In proxified environment you may need to change the credentials file.
350 There are some tips in chapter: `Proxy support`_
354 If you need to connect to a server that is TLS-enabled (the auth URL
355 begins with "https") and it uses a certificate from a private CA or a
356 self-signed certificate, then you will need to specify the path to an
357 appropriate CA certificate to use, to validate the server certificate
358 with the environment variable OS_CACERT::
361 /etc/ssl/certs/ca.crt
363 However, this certificate does not exist in the container by default.
364 It has to be copied manually from the OpenStack deployment. This can be
367 #. Create manually that file and copy the contents from the OpenStack
369 #. (Recommended) Add the file using a Docker volume when starting the
372 -v <path_to_your_cert_file>:/etc/ssl/certs/ca.cert
374 You might need to export OS_CACERT environment variable inside the
377 export OS_CACERT=/etc/ssl/certs/ca.crt
379 Certificate verification can be turned off using OS_INSECURE=true. For
380 example, Fuel uses self-signed cacerts by default, so an pre step would
383 export OS_INSECURE=true
388 By default all the logs are put un /home/opnfv/functest/results/functest.log.
389 If you want to have more logs in console, you may edit the logging.ini file
391 Connect on the docker then edit the file located in
392 /usr/lib/python2.7/site-packages/xtesting/ci/logging.ini
394 Change wconsole to console in the desired module to get more traces.
400 You may also directly modify the python code or the configuration file (e.g.
401 testcases.yaml used to declare test constraints) under
402 /usr/lib/python2.7/site-packages/xtesting and
403 /usr/lib/python2.7/site-packages/functest
411 When typing **exit** in the container prompt, this will cause exiting
412 the container and probably stopping it. When stopping a running Docker
413 container all the changes will be lost, there is a keyboard shortcut
414 to quit the container without stopping it: <CTRL>-P + <CTRL>-Q. To
415 reconnect to the running container **DO NOT** use the *run* command
416 again (since it will create a new container), use the *exec* or *attach*
419 docker ps # <check the container ID from the output>
420 docker exec -ti <CONTAINER_ID> /bin/bash
422 There are other useful Docker commands that might be needed to manage possible
423 issues with the containers.
425 List the running containers::
429 List all the containers including the stopped ones::
433 Start a stopped container named "FunTest"::
437 Attach to a running container named "StrikeTwo"::
439 docker attach StrikeTwo
441 It is useful sometimes to remove a container if there are some problems::
443 docker rm <CONTAINER_ID>
445 Use the *-f* option if the container is still running, it will force to
448 docker rm -f <CONTAINER_ID>
450 Check the Docker documentation [`dockerdocs`_] for more information.
453 Checking Openstack and credentials
454 ----------------------------------
455 It is recommended and fairly straightforward to check that Openstack
456 and credentials are working as expected.
458 Once the credentials are there inside the container, they should be
459 sourced before running any Openstack commands::
461 source /home/opnfv/functest/conf/env_file
463 After this, try to run any OpenStack command to see if you get any
464 output, for instance::
468 This will return a list of the actual users in the OpenStack
469 deployment. In any other case, check that the credentials are sourced::
473 This command must show a set of environment variables starting with
476 OS_REGION_NAME=RegionOne
477 OS_USER_DOMAIN_NAME=Default
478 OS_PROJECT_NAME=admin
480 OS_IDENTITY_API_VERSION=3
481 OS_PASSWORD=da54c27ae0d10dfae5297e6f0d6be54ebdb9f58d0f9dfc
482 OS_AUTH_URL=http://10.1.0.9:5000/v3
485 OS_ENDPOINT_TYPE=internalURL
486 OS_INTERFACE=internalURL
488 OS_PROJECT_DOMAIN_NAME=Default
491 If the OpenStack command still does not show anything or complains
492 about connectivity issues, it could be due to an incorrect url given to
493 the OS_AUTH_URL environment variable. Check the deployment settings.
499 If your Jumphost node is operating behind a http proxy, then there are
500 2 places where some special actions may be needed to make operations
503 #. Initial installation of docker engine First, try following the
504 official Docker documentation for Proxy settings. Some issues were
505 experienced on CentOS 7 based Jumphost. Some tips are documented
506 in section: :ref:`Docker Installation on CentOS behind http proxy`
509 If that is the case, make sure the resolv.conf and the needed
510 http_proxy and https_proxy environment variables, as well as the
511 'no_proxy' environment variable are set correctly::
513 # Make double sure that the 'no_proxy=...' line in the
514 # 'env_file' file is commented out first. Otherwise, the
515 # values set into the 'no_proxy' environment variable below will
516 # be ovewrwritten, each time the command
517 # 'source ~/functest/conf/env_file' is issued.
520 sed -i 's/export no_proxy/#export no_proxy/' env_file
523 # Next calculate some IP addresses for which http_proxy
524 # usage should be excluded:
526 publicURL_IP=$(echo $OS_AUTH_URL | grep -Eo "([0-9]+\.){3}[0-9]+")
528 adminURL_IP=$(openstack catalog show identity | \
529 grep adminURL | grep -Eo "([0-9]+\.){3}[0-9]+")
531 export http_proxy="<your http proxy settings>"
532 export https_proxy="<your https proxy settings>"
533 export no_proxy="127.0.0.1,localhost,$publicURL_IP,$adminURL_IP"
535 # Ensure that "git" uses the http_proxy
536 # This may be needed if your firewall forbids SSL based git fetch
537 git config --global http.sslVerify True
538 git config --global http.proxy <Your http proxy settings>
540 For example, try to use the **nc** command from inside the functest
544 Connection to opnfv.org 80 port [tcp/http] succeeded!
547 Connection to opnfv.org 443 port [tcp/https] succeeded!
549 Note: In a Jumphost node based on the CentOS family OS, the **nc**
550 commands might not work. You can use the **curl** command instead.
552 curl http://www.opnfv.org:80
554 <HTML><HEAD><meta http-equiv="content-type"
559 curl https://www.opnfv.org:443
561 <HTML><HEAD><meta http-equiv="content-type"
566 (Ignore the content. If command returns a valid HTML page, it proves
569 .. _`Docker Installation on CentOS behind http proxy`:
571 Docker Installation on CentOS behind http proxy
572 -----------------------------------------------
573 This section is applicable for CentOS family OS on Jumphost which
574 itself is behind a proxy server. In that case, the instructions below
575 should be followed **before** installing the docker engine::
577 1) # Make a directory '/etc/systemd/system/docker.service.d'
578 # if it does not exist
579 sudo mkdir /etc/systemd/system/docker.service.d
581 2) # Create a file called 'env.conf' in that directory with
582 # the following contents:
584 EnvironmentFile=-/etc/sysconfig/docker
586 3) # Set up a file called 'docker' in directory '/etc/sysconfig'
587 # with the following contents:
588 HTTP_PROXY="<Your http proxy settings>"
589 HTTPS_PROXY="<Your https proxy settings>"
590 http_proxy="${HTTP_PROXY}"
591 https_proxy="${HTTPS_PROXY}"
593 4) # Reload the daemon
594 systemctl daemon-reload
596 5) # Sanity check - check the following docker settings:
597 systemctl show docker | grep -i env
601 EnvironmentFile=/etc/sysconfig/docker (ignore_errors=yes)
602 DropInPaths=/etc/systemd/system/docker.service.d/env.conf
604 Now follow the instructions in [`Install Docker on CentOS`_] to download
605 and install the **docker-engine**. The instructions conclude with a
606 "test pull" of a sample "Hello World" docker container. This should now
607 work with the above pre-requisite actions.
610 .. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
611 .. _`dockerdocs`: https://docs.docker.com/
612 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
613 .. _`Install Docker on CentOS`: https://docs.docker.com/engine/installation/linux/centos/
614 .. _`Functest User Guide`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
615 .. _`images/CentOS-7-x86_64-GenericCloud.qcow2`: https://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
616 .. _`images/cirros-0.4.0-x86_64-disk.img`: http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img
617 .. _`images/ubuntu-14.04-server-cloudimg-amd64-disk1.img`: https://cloud-images.ubuntu.com/releases/14.04/release/ubuntu-14.04-server-cloudimg-amd64-disk1.img