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-benchmarking
20 * opnfv/functest-features
21 * opnfv/functest-components
25 Preparing your environment
26 ^^^^^^^^^^^^^^^^^^^^^^^^^^
31 DEPLOY_SCENARIO=XXX # if not os-nosdn-nofeature-noha scenario
32 NAMESERVER=XXX # if not 8.8.8.8
34 See section on environment variables for details.
38 export OS_AUTH_URL=XXX
39 export OS_USER_DOMAIN_NAME=XXX
40 export OS_PROJECT_DOMAIN_NAME=XXX
41 export OS_USERNAME=XXX
42 export OS_PROJECT_NAME=XXX
43 export OS_PASSWORD=XXX
44 export OS_IDENTITY_API_VERSION=3
46 See section on OpenStack credentials for details.
48 Create a directory for the different images (attached as a Docker volume)::
50 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/*
52 images/CentOS-7-aarch64-GenericCloud.qcow2
53 images/CentOS-7-aarch64-GenericCloud.qcow2.xz
54 images/CentOS-7-x86_64-GenericCloud.qcow2
55 images/cirros-0.4.0-x86_64-disk.img
56 images/cirros-0.4.0-x86_64-lxc.tar.gz
57 images/cloudify-manager-premium-4.0.1.qcow2
58 images/shaker-image-arm64.qcow2
59 images/shaker-image.qcow
60 images/ubuntu-14.04-server-cloudimg-amd64-disk1.img
61 images/ubuntu-14.04-server-cloudimg-arm64-uefi1.img
62 images/ubuntu-16.04-server-cloudimg-amd64-disk1.img
65 Testing healthcheck suite
66 ^^^^^^^^^^^^^^^^^^^^^^^^^
68 Run healthcheck suite::
70 sudo docker run --env-file env \
71 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
72 -v $(pwd)/images:/home/opnfv/functest/images \
73 opnfv/functest-healthcheck
75 Results shall be displayed as follows::
77 +----------------------------+------------------+---------------------+------------------+----------------+
78 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
79 +----------------------------+------------------+---------------------+------------------+----------------+
80 | connection_check | functest | healthcheck | 00:09 | PASS |
81 | tenantnetwork1 | functest | healthcheck | 00:14 | PASS |
82 | tenantnetwork2 | functest | healthcheck | 00:11 | PASS |
83 | vmready1 | functest | healthcheck | 00:19 | PASS |
84 | vmready2 | functest | healthcheck | 00:16 | PASS |
85 | singlevm1 | functest | healthcheck | 00:41 | PASS |
86 | singlevm2 | functest | healthcheck | 00:36 | PASS |
87 | vping_ssh | functest | healthcheck | 00:46 | PASS |
88 | vping_userdata | functest | healthcheck | 00:41 | PASS |
89 | cinder_test | functest | healthcheck | 01:18 | PASS |
90 | api_check | functest | healthcheck | 10:33 | PASS |
91 | snaps_health_check | functest | healthcheck | 00:44 | PASS |
92 | odl | functest | healthcheck | 00:00 | SKIP |
93 +----------------------------+------------------+---------------------+------------------+----------------+
95 NOTE: the duration is a reference and it might vary depending on your SUT.
102 sudo docker run --env-file env \
103 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
104 -v $(pwd)/images:/home/opnfv/functest/images \
107 Results shall be displayed as follows::
109 +------------------------------------+------------------+---------------+------------------+----------------+
110 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
111 +------------------------------------+------------------+---------------+------------------+----------------+
112 | tempest_smoke | functest | smoke | 06:13 | PASS |
113 | neutron-tempest-plugin-api | functest | smoke | 09:32 | PASS |
114 | rally_sanity | functest | smoke | 29:34 | PASS |
115 | rally_jobs | functest | smoke | 24:02 | PASS |
116 | refstack_defcore | functest | smoke | 13:07 | PASS |
117 | patrole | functest | smoke | 05:17 | PASS |
118 | snaps_smoke | functest | smoke | 90:13 | PASS |
119 | neutron_trunk | functest | smoke | 00:00 | SKIP |
120 | networking-bgpvpn | functest | smoke | 00:00 | SKIP |
121 | networking-sfc | functest | smoke | 00:00 | SKIP |
122 | barbican | functest | smoke | 05:01 | PASS |
123 +------------------------------------+------------------+---------------+------------------+----------------+
125 Note: if the scenario does not support some tests, they are indicated as SKIP.
126 See User guide for details.
128 Testing benchmarking suite
129 ^^^^^^^^^^^^^^^^^^^^^^^^^^
131 Run benchmarking suite::
133 sudo docker run --env-file env \
134 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
135 -v $(pwd)/images:/home/opnfv/functest/images \
136 opnfv/functest-benchmarking
138 Results shall be displayed as follows::
140 +-------------------+------------------+----------------------+------------------+----------------+
141 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
142 +-------------------+------------------+----------------------+------------------+----------------+
143 | vmtp | functest | benchmarking | 18:43 | PASS |
144 | shaker | functest | benchmarking | 29:45 | PASS |
145 +-------------------+------------------+----------------------+------------------+----------------+
147 Note: if the scenario does not support some tests, they are indicated as SKIP.
148 See User guide for details.
150 Testing features suite
151 ^^^^^^^^^^^^^^^^^^^^^^
155 sudo docker run --env-file env \
156 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
157 -v $(pwd)/images:/home/opnfv/functest/images \
158 opnfv/functest-features
160 Results shall be displayed as follows::
162 +-----------------------------+------------------------+------------------+------------------+----------------+
163 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
164 +-----------------------------+------------------------+------------------+------------------+----------------+
165 | doctor-notification | doctor | features | 00:00 | SKIP |
166 | bgpvpn | sdnvpn | features | 00:00 | SKIP |
167 | functest-odl-sfc | sfc | features | 00:00 | SKIP |
168 | barometercollectd | barometer | features | 00:00 | SKIP |
169 | fds | fastdatastacks | features | 00:00 | SKIP |
170 | vgpu | functest | features | 00:00 | SKIP |
171 | stor4nfv_os | stor4nfv | features | 00:00 | SKIP |
172 +-----------------------------+------------------------+------------------+------------------+----------------+
174 Note: if the scenario does not support some tests, they are indicated as SKIP.
175 See User guide for details.
177 Testing components suite
178 ^^^^^^^^^^^^^^^^^^^^^^^^
180 Run components suite::
182 sudo docker run --env-file env \
183 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
184 -v $(pwd)/images:/home/opnfv/functest/images \
185 opnfv/functest-components
187 Results shall be displayed as follows::
189 +--------------------------+------------------+--------------------+------------------+----------------+
190 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
191 +--------------------------+------------------+--------------------+------------------+----------------+
192 | tempest_full | functest | components | 49:51 | PASS |
193 | tempest_scenario | functest | components | 18:50 | PASS |
194 | rally_full | functest | components | 167:13 | PASS |
195 +--------------------------+------------------+--------------------+------------------+----------------+
202 sudo docker run --env-file env \
203 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
204 -v $(pwd)/images:/home/opnfv/functest/images \
207 Results shall be displayed as follows::
209 +----------------------+------------------+--------------+------------------+----------------+
210 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
211 +----------------------+------------------+--------------+------------------+----------------+
212 | cloudify | functest | vnf | 04:05 | PASS |
213 | cloudify_ims | functest | vnf | 24:07 | PASS |
214 | heat_ims | functest | vnf | 18:15 | PASS |
215 | vyos_vrouter | functest | vnf | 15:48 | PASS |
216 | juju_epc | functest | vnf | 29:38 | PASS |
217 +----------------------+------------------+--------------+------------------+----------------+
219 Functest Dockers for Kubernetes deployment
220 ------------------------------------------
221 Docker images are available on the dockerhub:
223 * opnfv/functest-kubernetes-core
224 * opnfv/functest-kubernetest-healthcheck
225 * opnfv/functest-kubernetest-smoke
226 * opnfv/functest-kubernetest-features
228 Preparing your environment
229 ^^^^^^^^^^^^^^^^^^^^^^^^^^
233 DEPLOY_SCENARIO=k8s-XXX
235 Testing healthcheck suite
236 ^^^^^^^^^^^^^^^^^^^^^^^^^
238 Run healthcheck suite::
240 sudo docker run -it --env-file env \
241 -v $(pwd)/config:/root/.kube/config \
242 opnfv/functest-kubernetes-healthcheck
244 A config file in the current dir 'config' is also required, which should be
245 volume mapped to ~/.kube/config inside kubernetes container.
247 Results shall be displayed as follows::
249 +-------------------+------------------+---------------------+------------------+----------------+
250 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
251 +-------------------+------------------+---------------------+------------------+----------------+
252 | k8s_smoke | functest | healthcheck | 02:27 | PASS |
253 +-------------------+------------------+---------------------+------------------+----------------+
260 sudo docker run -it --env-file env \
261 -v $(pwd)/config:/root/.kube/config \
262 opnfv/functest-kubernetes-smoke
264 Results shall be displayed as follows::
266 +-------------------------+------------------+---------------+------------------+----------------+
267 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
268 +-------------------------+------------------+---------------+------------------+----------------+
269 | k8s_conformance | functest | smoke | 57:14 | PASS |
270 +-------------------------+------------------+---------------+------------------+----------------+
272 Testing features suite
273 ^^^^^^^^^^^^^^^^^^^^^^
277 sudo docker run -it --env-file env \
278 -v $(pwd)/config:/root/.kube/config \
279 opnfv/functest-kubernetes-features
281 Results shall be displayed as follows::
283 +----------------------+------------------+------------------+------------------+----------------+
284 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
285 +----------------------+------------------+------------------+------------------+----------------+
286 | stor4nfv_k8s | stor4nfv | stor4nfv | 00:00 | SKIP |
287 | clover_k8s | clover | clover | 00:00 | SKIP |
288 +----------------------+------------------+------------------+------------------+----------------+
290 Environment variables
291 =====================
293 Several environement variables may be specified:
295 * INSTALLER_IP=<Specific IP Address>
296 * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>
297 * NAMESERVER=XXX # if not 8.8.8.8
298 * VOLUME_DEVICE_NAME=XXX # if not vdb
299 * EXTERNAL_NETWORK=XXX # if not first network with router:external=True
300 * NEW_USER_ROLE=XXX # if not member
302 INSTALLER_IP is required by Barometer in order to access the installer node and
305 The format for the DEPLOY_SCENARIO env variable can be described as follows:
306 * vim: (os|k8s) = OpenStack or Kubernetes
307 * controller is one of ( nosdn | odl )
308 * nfv_feature is one or more of ( ovs | kvm | sfc | bgpvpn | nofeature )
309 * ha_mode (high availability) is one of ( ha | noha )
311 If several features are pertinent then use the underscore character '_' to
312 separate each feature (e.g. ovs_kvm). 'nofeature' indicates that no OPNFV
315 The list of supported scenarios per release/installer is indicated in the
318 **NOTE:** The scenario name is mainly used to automatically detect
319 if a test suite is runnable or not (e.g. it will prevent ODL test suite to be
320 run on 'nosdn' scenarios). If not set, Functest will try to run the default
321 test cases that might not include SDN controller or a specific feature.
323 **NOTE:** An HA scenario means that 3 OpenStack controller nodes are
324 deployed. It does not necessarily mean that the whole system is HA. See
325 installer release notes for details.
327 Finally, three additional environment variables can also be passed in
328 to the Functest Docker Container, using the -e
329 "<EnvironmentVariable>=<Value>" mechanism. The first two parameters are
330 only relevant to Jenkins CI invoked testing and **should not be used**
331 when performing manual test scenarios:
333 * INSTALLER_TYPE=(apex|compass|daisy|fuel)
334 * NODE_NAME=<Test POD Name>
335 * BUILD_TAG=<Jenkins Build Tag>
339 * <Test POD Name> = Symbolic name of the POD where the tests are run.
340 Visible in test results files, which are stored
341 to the database. This option is only used when
342 tests are activated under Jenkins CI control.
343 It indicates the POD/hardware where the test has
344 been run. If not specified, then the POD name is
345 defined as "Unknown" by default.
346 DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
347 * <Jenkins Build tag> = Symbolic name of the Jenkins Build Job.
348 Visible in test results files, which are stored
349 to the database. This option is only set when
350 tests are activated under Jenkins CI control.
351 It enables the correlation of test results,
352 which are independently pushed to the results database
353 from different Jenkins jobs.
354 DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
357 Openstack credentials
358 =====================
359 OpenStack credentials are mandatory and must be provided to Functest.
360 When running the command "functest env prepare", the framework will
361 automatically look for the Openstack credentials file
362 "/home/opnfv/functest/conf/env_file" and will exit with
363 error if it is not present or is empty.
365 There are 2 ways to provide that file:
367 * by using a Docker volume with -v option when creating the Docker container.
368 This is referred to in docker documentation as "Bind Mounting".
369 See the usage of this parameter in the following chapter.
370 * or creating manually the file '/home/opnfv/functest/conf/env_file'
371 inside the running container and pasting the credentials in it. Consult
372 your installer guide for further details. This is however not
373 instructed in this document.
375 In proxified environment you may need to change the credentials file.
376 There are some tips in chapter: `Proxy support`_
380 If you need to connect to a server that is TLS-enabled (the auth URL
381 begins with "https") and it uses a certificate from a private CA or a
382 self-signed certificate, then you will need to specify the path to an
383 appropriate CA certificate to use, to validate the server certificate
384 with the environment variable OS_CACERT::
387 /etc/ssl/certs/ca.crt
389 However, this certificate does not exist in the container by default.
390 It has to be copied manually from the OpenStack deployment. This can be
393 #. Create manually that file and copy the contents from the OpenStack
395 #. (Recommended) Add the file using a Docker volume when starting the
398 -v <path_to_your_cert_file>:/etc/ssl/certs/ca.cert
400 You might need to export OS_CACERT environment variable inside the
403 export OS_CACERT=/etc/ssl/certs/ca.crt
405 Certificate verification can be turned off using OS_INSECURE=true. For
406 example, Fuel uses self-signed cacerts by default, so an pre step would
409 export OS_INSECURE=true
414 By default all the logs are put un /home/opnfv/functest/results/functest.log.
415 If you want to have more logs in console, you may edit the logging.ini file
417 Connect on the docker then edit the file located in
418 /usr/lib/python2.7/site-packages/xtesting/ci/logging.ini
420 Change wconsole to console in the desired module to get more traces.
426 You may also directly modify the python code or the configuration file (e.g.
427 testcases.yaml used to declare test constraints) under
428 /usr/lib/python2.7/site-packages/xtesting and
429 /usr/lib/python2.7/site-packages/functest
437 When typing **exit** in the container prompt, this will cause exiting
438 the container and probably stopping it. When stopping a running Docker
439 container all the changes will be lost, there is a keyboard shortcut
440 to quit the container without stopping it: <CTRL>-P + <CTRL>-Q. To
441 reconnect to the running container **DO NOT** use the *run* command
442 again (since it will create a new container), use the *exec* or *attach*
445 docker ps # <check the container ID from the output>
446 docker exec -ti <CONTAINER_ID> /bin/bash
448 There are other useful Docker commands that might be needed to manage possible
449 issues with the containers.
451 List the running containers::
455 List all the containers including the stopped ones::
459 Start a stopped container named "FunTest"::
463 Attach to a running container named "StrikeTwo"::
465 docker attach StrikeTwo
467 It is useful sometimes to remove a container if there are some problems::
469 docker rm <CONTAINER_ID>
471 Use the *-f* option if the container is still running, it will force to
474 docker rm -f <CONTAINER_ID>
476 Check the Docker documentation [`dockerdocs`_] for more information.
479 Checking Openstack and credentials
480 ----------------------------------
481 It is recommended and fairly straightforward to check that Openstack
482 and credentials are working as expected.
484 Once the credentials are there inside the container, they should be
485 sourced before running any Openstack commands::
487 source /home/opnfv/functest/conf/env_file
489 After this, try to run any OpenStack command to see if you get any
490 output, for instance::
494 This will return a list of the actual users in the OpenStack
495 deployment. In any other case, check that the credentials are sourced::
499 This command must show a set of environment variables starting with
502 OS_REGION_NAME=RegionOne
503 OS_USER_DOMAIN_NAME=Default
504 OS_PROJECT_NAME=admin
506 OS_IDENTITY_API_VERSION=3
507 OS_PASSWORD=da54c27ae0d10dfae5297e6f0d6be54ebdb9f58d0f9dfc
508 OS_AUTH_URL=http://10.1.0.9:5000/v3
511 OS_ENDPOINT_TYPE=internalURL
512 OS_INTERFACE=internalURL
514 OS_PROJECT_DOMAIN_NAME=Default
517 If the OpenStack command still does not show anything or complains
518 about connectivity issues, it could be due to an incorrect url given to
519 the OS_AUTH_URL environment variable. Check the deployment settings.
525 If your Jumphost node is operating behind a http proxy, then there are
526 2 places where some special actions may be needed to make operations
529 #. Initial installation of docker engine First, try following the
530 official Docker documentation for Proxy settings. Some issues were
531 experienced on CentOS 7 based Jumphost. Some tips are documented
532 in section: :ref:`Docker Installation on CentOS behind http proxy`
535 If that is the case, make sure the resolv.conf and the needed
536 http_proxy and https_proxy environment variables, as well as the
537 'no_proxy' environment variable are set correctly::
539 # Make double sure that the 'no_proxy=...' line in the
540 # 'env_file' file is commented out first. Otherwise, the
541 # values set into the 'no_proxy' environment variable below will
542 # be ovewrwritten, each time the command
543 # 'source ~/functest/conf/env_file' is issued.
546 sed -i 's/export no_proxy/#export no_proxy/' env_file
549 # Next calculate some IP addresses for which http_proxy
550 # usage should be excluded:
552 publicURL_IP=$(echo $OS_AUTH_URL | grep -Eo "([0-9]+\.){3}[0-9]+")
554 adminURL_IP=$(openstack catalog show identity | \
555 grep adminURL | grep -Eo "([0-9]+\.){3}[0-9]+")
557 export http_proxy="<your http proxy settings>"
558 export https_proxy="<your https proxy settings>"
559 export no_proxy="127.0.0.1,localhost,$publicURL_IP,$adminURL_IP"
561 # Ensure that "git" uses the http_proxy
562 # This may be needed if your firewall forbids SSL based git fetch
563 git config --global http.sslVerify True
564 git config --global http.proxy <Your http proxy settings>
566 For example, try to use the **nc** command from inside the functest
570 Connection to opnfv.org 80 port [tcp/http] succeeded!
573 Connection to opnfv.org 443 port [tcp/https] succeeded!
575 Note: In a Jumphost node based on the CentOS family OS, the **nc**
576 commands might not work. You can use the **curl** command instead.
578 curl http://www.opnfv.org:80
580 <HTML><HEAD><meta http-equiv="content-type"
585 curl https://www.opnfv.org:443
587 <HTML><HEAD><meta http-equiv="content-type"
592 (Ignore the content. If command returns a valid HTML page, it proves
595 .. _`Docker Installation on CentOS behind http proxy`:
597 Docker Installation on CentOS behind http proxy
598 -----------------------------------------------
599 This section is applicable for CentOS family OS on Jumphost which
600 itself is behind a proxy server. In that case, the instructions below
601 should be followed **before** installing the docker engine::
603 1) # Make a directory '/etc/systemd/system/docker.service.d'
604 # if it does not exist
605 sudo mkdir /etc/systemd/system/docker.service.d
607 2) # Create a file called 'env.conf' in that directory with
608 # the following contents:
610 EnvironmentFile=-/etc/sysconfig/docker
612 3) # Set up a file called 'docker' in directory '/etc/sysconfig'
613 # with the following contents:
614 HTTP_PROXY="<Your http proxy settings>"
615 HTTPS_PROXY="<Your https proxy settings>"
616 http_proxy="${HTTP_PROXY}"
617 https_proxy="${HTTPS_PROXY}"
619 4) # Reload the daemon
620 systemctl daemon-reload
622 5) # Sanity check - check the following docker settings:
623 systemctl show docker | grep -i env
627 EnvironmentFile=/etc/sysconfig/docker (ignore_errors=yes)
628 DropInPaths=/etc/systemd/system/docker.service.d/env.conf
630 Now follow the instructions in [`Install Docker on CentOS`_] to download
631 and install the **docker-engine**. The instructions conclude with a
632 "test pull" of a sample "Hello World" docker container. This should now
633 work with the above pre-requisite actions.
636 .. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
637 .. _`dockerdocs`: https://docs.docker.com/
638 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
639 .. _`Install Docker on CentOS`: https://docs.docker.com/engine/installation/linux/centos/
640 .. _`Functest User Guide`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
641 .. _`images/CentOS-7-x86_64-GenericCloud.qcow2`: https://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
642 .. _`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
643 .. _`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