9adf79e143fcf3e03f2ec5103b36de978e538692
[functest.git] / docs / testing / user / configguide / configguide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3
4 Installation and configuration
5 ==============================
6
7 Alpine containers have been introduced in Euphrates.
8 Alpine allows Functest testing in several very light containers and thanks to
9 the refactoring on dependency management should allow the creation of light and
10 fully customized docker images.
11
12
13 Functest Dockers
14 ----------------
15 Docker images are available on the dockerhub:
16
17   * opnfv/functest-core
18   * opnfv/functest-healthcheck
19   * opnfv/functest-smoke
20   * opnfv/functest-features
21   * opnfv/functest-components
22   * opnfv/functest-vnf
23   * opnfv/functest-parser
24   * opnfv/functest-restapi
25
26 The tag "opnfv-5.0.0" is the official release image in Euphrates, but you can also pull "euphrates"
27 tag as it is being maintained by Functest team and might include bugfixes.
28
29 The Functest docker container environment can -in principle- be also
30 used with non-OPNFV official installers (e.g. 'devstack'), with the
31 **disclaimer** that support for such environments is outside of the
32 scope and responsibility of the OPNFV project.
33
34
35 Preparing your environment
36 --------------------------
37
38 cat env::
39
40   INSTALLER_TYPE=XXX
41   INSTALLER_IP=XXX
42   EXTERNAL_NETWORK=XXX
43   DEPLOY_SCENARIO=XXX
44
45 See section on environment variables for details.
46
47 cat env_file::
48
49   export OS_AUTH_URL=XXX
50   export OS_USER_DOMAIN_NAME=XXX
51   export OS_PROJECT_DOMAIN_NAME=XXX
52   export OS_USERNAME=XXX
53   export OS_TENANT_NAME=XXX
54   export OS_PROJECT_NAME=XXX
55   export OS_PASSWORD=XXX
56   export OS_VOLUME_API_VERSION=XXX
57   export OS_IDENTITY_API_VERSION=XXX
58   export OS_IMAGE_API_VERSION=XXX
59
60 See section on OpenStack credentials for details.
61
62 Create a directory for the different images (attached as a Docker volume)::
63
64   mkdir -p images && wget -q -O- https://git.opnfv.org/functest/plain/functest/ci/download_images.sh?h=stable/euphrates | bash -s -- images && ls -1 images/*
65
66   images/CentOS-7-aarch64-GenericCloud.qcow2
67   images/CentOS-7-aarch64-GenericCloud.qcow2.xz
68   images/CentOS-7-x86_64-GenericCloud.qcow2
69   images/cirros-0.4.0-x86_64-disk.img
70   images/cirros-0.4.0-x86_64-lxc.tar.gz
71   images/cirros-d161201-aarch64-disk.img
72   images/cirros-d161201-aarch64-initramfs
73   images/cirros-d161201-aarch64-kernel
74   images/cloudify-manager-premium-4.0.1.qcow2
75   images/img
76   images/trusty-server-cloudimg-amd64-disk1.img
77   images/ubuntu-14.04-server-cloudimg-amd64-disk1.img
78   images/ubuntu-14.04-server-cloudimg-arm64-uefi1.img
79   images/ubuntu-16.04-server-cloudimg-amd64-disk1.img
80   images/vyos-1.1.7.img
81
82 Testing healthcheck suite
83 --------------------------
84
85 Run healthcheck suite::
86
87   sudo docker run --env-file env \
88       -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
89       -v $(pwd)/images:/home/opnfv/functest/images \
90       opnfv/functest-healthcheck
91
92 Results shall be displayed as follows::
93
94   +----------------------------+------------------+---------------------+------------------+----------------+
95   |         TEST CASE          |     PROJECT      |         TIER        |     DURATION     |     RESULT     |
96   +----------------------------+------------------+---------------------+------------------+----------------+
97   |      connection_check      |     functest     |     healthcheck     |      00:06       |      PASS      |
98   |         api_check          |     functest     |     healthcheck     |      06:52       |      PASS      |
99   |     snaps_health_check     |     functest     |     healthcheck     |      00:42       |      PASS      |
100   +----------------------------+------------------+---------------------+------------------+----------------+
101   NOTE: the duration is a reference and it might vary depending on your SUT.
102
103 Testing smoke suite
104 -------------------
105
106 Run smoke suite::
107
108   sudo docker run --env-file env \
109       -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
110       -v $(pwd)/images:/home/opnfv/functest/images \
111       opnfv/functest-smoke
112
113 Results shall be displayed as follows::
114
115   +------------------------------+------------------+---------------+------------------+----------------+
116   |          TEST CASE           |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
117   +------------------------------+------------------+---------------+------------------+----------------+
118   |          vping_ssh           |     functest     |     smoke     |      00:45       |      PASS      |
119   |        vping_userdata        |     functest     |     smoke     |      00:36       |      PASS      |
120   |     tempest_smoke_serial     |     functest     |     smoke     |      14:04       |      PASS      |
121   |         rally_sanity         |     functest     |     smoke     |      23:59       |      PASS      |
122   |       refstack_defcore       |     functest     |     smoke     |      14:37       |      FAIL      |
123   |         snaps_smoke          |     functest     |     smoke     |      42:09       |      PASS      |
124   |             odl              |     functest     |     smoke     |      00:00       |      SKIP      |
125   |         odl_netvirt          |     functest     |     smoke     |      00:00       |      SKIP      |
126   +------------------------------+------------------+---------------+------------------+----------------+
127   Note: if the scenario does not support some tests, they are indicated as SKIP.
128   See User guide for details.
129
130 Testing features suite
131 ----------------------
132
133 Run features suite::
134
135   sudo docker run --env-file env \
136       -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
137       -v $(pwd)/images:/home/opnfv/functest/images \
138       opnfv/functest-features
139
140 Results shall be displayed as follows::
141
142   +-----------------------------+------------------------+------------------+------------------+----------------+
143   |          TEST CASE          |        PROJECT         |       TIER       |     DURATION     |     RESULT     |
144   +-----------------------------+------------------------+------------------+------------------+----------------+
145   |     doctor-notification     |         doctor         |     features     |      00:00       |      SKIP      |
146   |            bgpvpn           |         sdnvpn         |     features     |      00:00       |      SKIP      |
147   |       functest-odl-sfc      |          sfc           |     features     |      00:00       |      SKIP      |
148   |      barometercollectd      |       barometer        |     features     |      00:00       |      SKIP      |
149   |             fds             |     fastdatastacks     |     features     |      00:00       |      SKIP      |
150   +-----------------------------+------------------------+------------------+------------------+----------------+
151   Note: if the scenario does not support some tests, they are indicated as SKIP.
152   See User guide for details.
153
154 Testing components suite
155 ------------------------
156
157 Run components suite::
158
159   sudo docker run --env-file env \
160       -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
161       -v $(pwd)/images:/home/opnfv/functest/images \
162       opnfv/functest-components
163
164 Results shall be displayed as follows::
165
166   +-------------------------------+------------------+--------------------+------------------+----------------+
167   |           TEST CASE           |     PROJECT      |        TIER        |     DURATION     |     RESULT     |
168   +-------------------------------+------------------+--------------------+------------------+----------------+
169   |     tempest_full_parallel     |     functest     |     components     |      52:42       |      PASS      |
170   |           rally_full          |     functest     |     components     |      114:22      |      PASS      |
171   +-------------------------------+------------------+--------------------+------------------+----------------+
172
173 Testing vnf suite
174 -----------------
175
176 Run vnf suite::
177
178 sudo docker run --env-file env \
179     -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
180     -v $(pwd)/images:/home/opnfv/functest/images \
181     opnfv/functest-vnf
182
183 Results shall be displayed as follows::
184
185   +---------------------------------+-------------------+--------------+------------------+----------------+
186   |            TEST CASE            |      PROJECT      |     TIER     |     DURATION     |     RESULT     |
187   +---------------------------------+-------------------+--------------+------------------+----------------+
188   |           cloudify_ims          |      functest     |     vnf      |      28:49       |      FAIL      |
189   |           vyos_vrouter          |      functest     |     vnf      |      27:57       |      FAIL      |
190   |             juju_epc            |      functest     |     vnf      |      55:03       |      PASS      |
191   |        orchestra_openims        |     orchestra     |     vnf      |      00:00       |      SKIP      |
192   |     orchestra_clearwaterims     |     orchestra     |     vnf      |      00:00       |      SKIP      |
193   +---------------------------------+-------------------+--------------+------------------+----------------+
194
195
196 Environment variables
197 =====================
198
199 Several environement variables may be specified:
200   * INSTALLER_TYPE=(apex|compass|daisy|fuel|joid)
201   * INSTALLER_IP=<Specific IP Address>
202   * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>
203
204
205 INSTALLER IP may be required by some test cases like SFC or Barometer in order
206 to access the installer node and the deployment.
207
208 The format for the DEPLOY_SCENARIO env variable can be described as follows:
209   * vim: (os|k8s) = OpenStack or Kubernetes
210   * controller is one of ( nosdn | odl )
211   * nfv_feature is one or more of ( ovs | kvm | sfc | bgpvpn | nofeature )
212   * ha_mode (high availability) is one of ( ha | noha )
213
214 If several features are pertinent then use the underscore character '_' to
215 separate each feature (e.g. ovs_kvm). 'nofeature' indicates that no OPNFV
216 feature is deployed.
217
218 The list of supported scenarios per release/installer is indicated in the
219 release note.
220
221 **NOTE:** The scenario name is mainly used to automatically detect
222 if a test suite is runnable or not (e.g. it will prevent ODL test suite to be
223 run on 'nosdn' scenarios). If not set, Functest will try to run the default test
224 cases that might not include SDN controller or a specific feature
225
226 **NOTE:** An HA scenario means that 3 OpenStack controller nodes are
227 deployed. It does not necessarily mean that the whole system is HA. See
228 installer release notes for details.
229
230 Finally, three additional environment variables can also be passed in
231 to the Functest Docker Container, using the -e
232 "<EnvironmentVariable>=<Value>" mechanism. The first two parameters are
233 only relevant to Jenkins CI invoked testing and **should not be used**
234 when performing manual test scenarios:
235
236   * NODE_NAME = <Test POD Name>
237   * BUILD_TAG = <Jenkins Build Tag>
238
239 where:
240
241   * <Test POD Name> = Symbolic name of the POD where the tests are run.
242                       Visible in test results files, which are stored
243                       to the database. This option is only used when
244                       tests are activated under Jenkins CI control.
245                       It indicates the POD/hardware where the test has
246                       been run. If not specified, then the POD name is
247                       defined as "Unknown" by default.
248                       DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
249   * <Jenkins Build tag> = Symbolic name of the Jenkins Build Job.
250                          Visible in test results files, which are stored
251                          to the database. This option is only set when
252                          tests are activated under Jenkins CI control.
253                          It enables the correlation of test results,
254                          which are independently pushed to the results database
255                          from different Jenkins jobs.
256                          DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
257
258
259 Openstack credentials
260 =====================
261 OpenStack credentials are mandatory and must be provided to Functest.
262 When running the command "functest env prepare", the framework  will
263 automatically look for the Openstack credentials file
264 "/home/opnfv/functest/conf/env_file" and will exit with
265 error if it is not present or is empty.
266
267 There are 2 ways to provide that file:
268
269   * by using a Docker volume with -v option when creating the Docker container.
270     This is referred to in docker documentation as "Bind Mounting".
271     See the usage of this parameter in the following chapter.
272   * or creating manually the file '/home/opnfv/functest/conf/env_file'
273     inside the running container and pasting the credentials in it. Consult
274     your installer guide for further details. This is however not
275     instructed in this document.
276
277 In proxified environment you may need to change the credentials file.
278 There are some tips in chapter: `Proxy support`_
279
280 SSL Support
281 -----------
282 If you need to connect to a server that is TLS-enabled (the auth URL
283 begins with "https") and it uses a certificate from a private CA or a
284 self-signed certificate, then you will need to specify the path to an
285 appropriate CA certificate to use, to validate the server certificate
286 with the environment variable OS_CACERT::
287
288   echo $OS_CACERT
289   /etc/ssl/certs/ca.crt
290
291 However, this certificate does not exist in the container by default.
292 It has to be copied manually from the OpenStack deployment. This can be
293 done in 2 ways:
294
295   #. Create manually that file and copy the contents from the OpenStack
296      controller.
297   #. (Recommended) Add the file using a Docker volume when starting the
298      container::
299
300        -v <path_to_your_cert_file>:/etc/ssl/certs/ca.cert
301
302 You might need to export OS_CACERT environment variable inside the
303 credentials file::
304
305   export OS_CACERT=/etc/ssl/certs/ca.crt
306
307 Certificate verification can be turned off using OS_INSECURE=true. For
308 example, Fuel uses self-signed cacerts by default, so an pre step would
309 be::
310
311   export OS_INSECURE=true
312
313 Functest docker container directory structure
314 =============================================
315 Inside the Functest docker container, the following directory structure
316 should now be in place::
317
318   `--
319     |- home
320     |   |-- opnfv
321     |   |     `- functest
322     |   |          |-- conf
323     |   |          `-- results
324     |    `-- repos
325     |       `-- vnfs
326     |- src
327     |   |-- tempest
328     |   |-- vims-test
329     |   |-- odl_test
330     |   `-- fds
331     `- usr
332         `- lib
333            `- python2.7
334               `- site-packages
335                  `- functest
336                       |-- ...
337
338 Underneath the '/home/opnfv/functest' directory, the Functest docker container
339 includes two main directories:
340
341   * The **conf** directory stores configuration files (e.g. the
342     OpenStack creds are stored in path '/home/opnfv/functest/conf/env_file'),
343   * the **results** directory stores some temporary result log files
344
345 src and repos directories are used to host third party code used for the tests.
346
347 The structure of functest repo can be described as follows::
348
349   |-- INFO
350   |-- LICENSE
351   |-- api
352   |  `-- apidoc
353   |-- build.sh
354   |-- commons
355   |-- docker
356   |  |-- components
357   |  |-- core
358   |  |-- features
359   |  |-- healthcheck
360   |  |-- smoke
361   |  |-- vnf
362   |  |-- parser
363   |  |-- restapi
364   |  |-- thirdparty-requirements.txt
365   |-- docs
366   |  |-- com
367   |  |-- images
368   |  |-- release
369   |  |  `-- release-notes
370   |  |-- results
371   |  | testing
372   |  |  |-- developer
373   |  |    `-- user
374   |  |      |-- configguide
375   |  |      `-- userguide
376   `-- functest
377     |-- api
378     |  |-- base.py
379     |  |-- server.py
380     |  |-- urls.py
381     |  |-- common
382     |  |  |-- api_utils.py
383     |  |  |-- thread.py
384     |  `-- resources
385     |     `-- v1
386     |        |-- creds.py
387     |        |-- envs.py
388     |        |-- testcases.py
389     |        |-- tiers.py
390     |        |-- tasks.py
391     |  `-- database
392     |     |-- db.py
393     |     `-- v1
394     |        |-- handlers.py
395     |        |-- models.py
396     |  `-- swagger
397     |-- ci
398     â”‚   |-- check_deployment.py
399     â”‚   |-- config_aarch64_patch.yaml
400     â”‚   |-- config_functest.yaml
401     â”‚   |-- config_patch.yaml
402     â”‚   |-- download_images.sh
403     â”‚   |-- logging.ini
404     â”‚   |-- rally_aarch64_patch.conf
405     â”‚   |-- run_tests.py
406     â”‚   |-- testcases.yaml
407     â”‚   |-- tier_builder.py
408     â”‚   |-- tier_handler.py
409     |-- cli
410     â”‚   |-- cli_base.py
411     â”‚   |-- commands
412     â”‚   â”‚   |-- cli_env.py
413     â”‚   â”‚   |-- cli_os.py
414     â”‚   â”‚   |-- cli_testcase.py
415     â”‚   â”‚   |-- cli_tier.py
416     â”‚   |-- functest-complete.sh
417     |-- core
418     â”‚   |-- feature.py
419     â”‚   |-- robotframework.py
420     â”‚   |-- testcase.py
421     â”‚   |-- unit.py
422     â”‚   |-- vnf.py
423     |-- energy
424     â”‚   |-- energy.py
425     |-- opnfv_tests
426     â”‚   `-- openstack
427     â”‚       |-- rally
428     â”‚       |-- refstack_client
429     â”‚       |-- snaps
430     â”‚       |-- tempest
431     â”‚       |-- vping
432     â”‚   `-- sdn
433     â”‚   â”‚    `-- odl
434     â”‚   `-- vnf
435     â”‚       |-- ims
436     â”‚       `-- router
437     |-- tests
438     â”‚   `-- unit
439     â”‚       |-- ci
440     â”‚       |-- cli
441     â”‚       |-- core
442     â”‚       |-- energy
443     â”‚       |-- features
444     â”‚       |-- odl
445     â”‚       |-- openstack
446     â”‚       |-- opnfv_tests
447     â”‚       |-- test_utils.py
448     â”‚       |-- utils
449     â”‚       `-- vnf
450     |-- utils
451     |    |-- config.py
452     |    |-- constants.py
453     |    |-- decorators.py
454     |    |-- env.py
455     |    |-- functest_utils.py
456     |    |-- functest_vacation.py
457     |    |-- openstack_clean.py
458     |    |-- openstack_tacker.py
459     |    `-- openstack_utils.py
460   |-- requirements.txt
461   |-- setup.cfg
462   |-- setup.py
463   |-- test-requirements.txt
464   |-- tox.ini
465   |-- upper-constraints.txt
466
467   (Note: All *.pyc files removed from above list for brevity...)
468
469 We may distinguish several directories, the first level has 5 directories:
470
471 * **api**: This directory is dedicated to the API (framework) documentations.
472 * **commons**: This directory is dedicated for storage of traffic profile or
473   any other test inputs that could be reused by any test project.
474 * **docker**: This directory includes the needed files and tools to
475   build the Functest Docker images.
476 * **docs**: This directory includes documentation: Release Notes,
477   User Guide, Configuration Guide and Developer Guide.
478 * **functest**: This directory contains all the code needed to run
479   functest internal cases and OPNFV onboarded feature or VNF test cases.
480
481 Functest directory has 7 sub-directories, which is located under
482 /usr/lib/python2.7/site-packages/functest:
483   * **api**: This directory is dedicated for the internal Functest API.
484   * **ci**: This directory contains test structure definition files
485     (e.g <filename>.yaml) and bash shell/python scripts used to
486     configure and execute Functional tests. The test execution script
487     can be executed under the control of Jenkins CI jobs.
488   * **cli**: This directory holds the python based Functest CLI utility
489     source code, which is based on the Python 'click' framework.
490   * **core**: This directory holds the python based Functest core
491       source code. Three abstraction classes have been created to ease
492       the integration of internal, feature or vnf cases.
493   * **opnfv_tests**: This directory includes the scripts required by
494     Functest internal test cases and other feature projects test cases.
495   * **tests**: This directory includes the functest unit tests.
496   * **utils**: this directory holds Python source code for some general
497     purpose helper utilities, which testers can also re-use in their
498     own test code. See for an example the Openstack helper utility:
499     'openstack_utils.py'.
500
501
502 Logs
503 ====
504 By default all the logs are put un /home/opnfv/functest/results/functest.log.
505 If you want to have more logs in console, you may edit the logging.ini file
506 manually.
507 Connect on the docker then edit the file located in
508 /usr/lib/python2.7/site-packages/functest/ci/logging.ini
509
510 Change wconsole to console in the desired module to get more traces.
511
512
513 Configuration
514 =============
515
516 You may also directly modify the python code or the configuration file (e.g.
517 testcases.yaml used to declare test constraints) under
518 /usr/lib/python2.7/site-packages/functest
519
520
521 Tips
522 ====
523
524 Docker
525 ------
526 When typing **exit** in the container prompt, this will cause exiting
527 the container and probably stopping it. When stopping a running Docker
528 container all the changes will be lost, there is a keyboard shortcut
529 to quit the container without stopping it: <CTRL>-P + <CTRL>-Q. To
530 reconnect to the running container **DO NOT** use the *run* command
531 again (since it will create a new container), use the *exec* or *attach*
532 command instead::
533
534   docker ps  # <check the container ID from the output>
535   docker exec -ti <CONTAINER_ID> /bin/bash
536
537 There are other useful Docker commands that might be needed to manage possible
538 issues with the containers.
539
540 List the running containers::
541
542   docker ps
543
544 List all the containers including the stopped ones::
545
546   docker ps -a
547
548 Start a stopped container named "FunTest"::
549
550   docker start FunTest
551
552 Attach to a running container named "StrikeTwo"::
553
554   docker attach StrikeTwo
555
556 It is useful sometimes to remove a container if there are some problems::
557
558   docker rm <CONTAINER_ID>
559
560 Use the *-f* option if the container is still running, it will force to
561 destroy it::
562
563   docker rm -f <CONTAINER_ID>
564
565 Check the Docker documentation [`dockerdocs`_] for more information.
566
567
568 Checking Openstack and credentials
569 ----------------------------------
570 It is recommended and fairly straightforward to check that Openstack
571 and credentials are working as expected.
572
573 Once the credentials are there inside the container, they should be
574 sourced before running any Openstack commands::
575
576   source /home/opnfv/functest/conf/env_file
577
578 After this, try to run any OpenStack command to see if you get any
579 output, for instance::
580
581   openstack user list
582
583 This will return a list of the actual users in the OpenStack
584 deployment. In any other case, check that the credentials are sourced::
585
586   env|grep OS_
587
588 This command must show a set of environment variables starting with
589 *OS_*, for example::
590
591   OS_REGION_NAME=RegionOne
592   OS_USER_DOMAIN_NAME=Default
593   OS_PROJECT_NAME=admin
594   OS_AUTH_VERSION=3
595   OS_IDENTITY_API_VERSION=3
596   OS_PASSWORD=da54c27ae0d10dfae5297e6f0d6be54ebdb9f58d0f9dfc
597   OS_AUTH_URL=http://10.1.0.9:5000/v3
598   OS_USERNAME=admin
599   OS_TENANT_NAME=admin
600   OS_ENDPOINT_TYPE=internalURL
601   OS_INTERFACE=internalURL
602   OS_NO_CACHE=1
603   OS_PROJECT_DOMAIN_NAME=Default
604
605
606 If the OpenStack command still does not show anything or complains
607 about connectivity issues, it could be due to an incorrect url given to
608 the OS_AUTH_URL environment variable. Check the deployment settings.
609
610 Proxy support
611 -------------
612 If your Jumphost node is operating behind a http proxy, then there are
613 2 places where some special actions may be needed to make operations
614 succeed:
615
616   #. Initial installation of docker engine First, try following the
617      official Docker documentation for Proxy settings. Some issues were
618      experienced on CentOS 7 based Jumphost. Some tips are documented
619      in section: `Docker Installation on CentOS behind http proxy`_
620      below.
621
622 If that is the case, make sure the resolv.conf and the needed
623 http_proxy and https_proxy environment variables, as well as the
624 'no_proxy' environment variable are set correctly::
625
626   # Make double sure that the 'no_proxy=...' line in the
627   # 'env_file' file is commented out first. Otherwise, the
628   # values set into the 'no_proxy' environment variable below will
629   # be ovewrwritten, each time the command
630   # 'source ~/functest/conf/env_file' is issued.
631
632   cd ~/functest/conf/
633   sed -i 's/export no_proxy/#export no_proxy/' env_file
634   source ./env_file
635
636   # Next calculate some IP addresses for which http_proxy
637   # usage should be excluded:
638
639   publicURL_IP=$(echo $OS_AUTH_URL | grep -Eo "([0-9]+\.){3}[0-9]+")
640
641   adminURL_IP=$(openstack catalog show identity | \
642   grep adminURL | grep -Eo "([0-9]+\.){3}[0-9]+")
643
644   export http_proxy="<your http proxy settings>"
645   export https_proxy="<your https proxy settings>"
646   export no_proxy="127.0.0.1,localhost,$publicURL_IP,$adminURL_IP"
647
648   # Ensure that "git" uses the http_proxy
649   # This may be needed if your firewall forbids SSL based git fetch
650   git config --global http.sslVerify True
651   git config --global http.proxy <Your http proxy settings>
652
653 For example, try to use the **nc** command from inside the functest
654 docker container::
655
656   nc -v opnfv.org 80
657   Connection to opnfv.org 80 port [tcp/http] succeeded!
658
659   nc -v opnfv.org 443
660   Connection to opnfv.org 443 port [tcp/https] succeeded!
661
662 Note: In a Jumphost node based on the CentOS family OS, the **nc**
663 commands might not work. You can use the **curl** command instead.
664
665   curl http://www.opnfv.org:80
666
667   <HTML><HEAD><meta http-equiv="content-type"
668   .
669   .
670   </BODY></HTML>
671
672   curl https://www.opnfv.org:443
673
674   <HTML><HEAD><meta http-equiv="content-type"
675   .
676   .
677   </BODY></HTML>
678
679   (Ignore the content. If command returns a valid HTML page, it proves
680   the connection.)
681
682 Docker Installation on CentOS behind http proxy
683 -----------------------------------------------
684 This section is applicable for CentOS family OS on Jumphost which
685 itself is behind a proxy server. In that case, the instructions below
686 should be followed **before** installing the docker engine::
687
688   1) # Make a directory '/etc/systemd/system/docker.service.d'
689      # if it does not exist
690      sudo mkdir /etc/systemd/system/docker.service.d
691
692   2) # Create a file called 'env.conf' in that directory with
693      # the following contents:
694      [Service]
695      EnvironmentFile=-/etc/sysconfig/docker
696
697   3) # Set up a file called 'docker' in directory '/etc/sysconfig'
698      # with the following contents:
699      HTTP_PROXY="<Your http proxy settings>"
700      HTTPS_PROXY="<Your https proxy settings>"
701      http_proxy="${HTTP_PROXY}"
702      https_proxy="${HTTPS_PROXY}"
703
704   4) # Reload the daemon
705      systemctl daemon-reload
706
707   5) # Sanity check - check the following docker settings:
708      systemctl show docker | grep -i env
709
710      Expected result:
711      ----------------
712      EnvironmentFile=/etc/sysconfig/docker (ignore_errors=yes)
713      DropInPaths=/etc/systemd/system/docker.service.d/env.conf
714
715 Now follow the instructions in [`Install Docker on CentOS`_] to download
716 and install the **docker-engine**. The instructions conclude with a
717 "test pull" of a sample "Hello World" docker container. This should now
718 work with the above pre-requisite actions.
719
720
721 .. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
722 .. _`dockerdocs`: https://docs.docker.com/
723 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
724 .. _`Install Docker on CentOS`: https://docs.docker.com/engine/installation/linux/centos/
725 .. _`Functest User Guide`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
726 .. _`images/CentOS-7-x86_64-GenericCloud.qcow2`: https://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
727 .. _`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
728 .. _`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