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