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