diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/testing/user/configguide/configguide.rst | 28 | ||||
| -rw-r--r-- | docs/testing/user/userguide/runfunctest.rst | 6 | ||||
| -rw-r--r-- | docs/testing/user/userguide/troubleshooting.rst | 4 |
3 files changed, 19 insertions, 19 deletions
diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst index d63286475..e514165dc 100644 --- a/docs/testing/user/configguide/configguide.rst +++ b/docs/testing/user/configguide/configguide.rst @@ -44,7 +44,7 @@ cat env:: See section on environment variables for details. -cat openstack.creds:: +cat env_file:: export OS_AUTH_URL=XXX export OS_USER_DOMAIN_NAME=XXX @@ -86,7 +86,7 @@ Testing healthcheck suite Run healthcheck suite:: sudo docker run --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-healthcheck @@ -107,7 +107,7 @@ Testing smoke suite Run smoke suite:: sudo docker run --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-smoke @@ -135,7 +135,7 @@ Testing features suite Run features suite:: sudo docker run --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-features @@ -160,7 +160,7 @@ Testing components suite Run components suite:: sudo docker run --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-components @@ -179,7 +179,7 @@ Testing vnf suite Run vnf suite:: sudo docker run --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-vnf @@ -268,7 +268,7 @@ Openstack credentials OpenStack credentials are mandatory and must be provided to Functest. When running the command "functest env prepare", the framework will automatically look for the Openstack credentials file -"/home/opnfv/functest/conf/openstack.creds" and will exit with +"/home/opnfv/functest/conf/env_file" and will exit with error if it is not present or is empty. There are 2 ways to provide that file: @@ -276,7 +276,7 @@ There are 2 ways to provide that file: * by using a Docker volume with -v option when creating the Docker container. This is referred to in docker documentation as "Bind Mounting". See the usage of this parameter in the following chapter. - * or creating manually the file '/home/opnfv/functest/conf/openstack.creds' + * or creating manually the file '/home/opnfv/functest/conf/env_file' inside the running container and pasting the credentials in it. Consult your installer guide for further details. This is however not instructed in this document. @@ -346,7 +346,7 @@ Underneath the '/home/opnfv/functest' directory, the Functest docker container includes two main directories: * The **conf** directory stores configuration files (e.g. the - OpenStack creds are stored in path '/home/opnfv/functest/conf/openstack.creds'), + OpenStack creds are stored in path '/home/opnfv/functest/conf/env_file'), * the **results** directory stores some temporary result log files src and repos directories are used to host third party code used for the tests. @@ -580,7 +580,7 @@ and credentials are working as expected. Once the credentials are there inside the container, they should be sourced before running any Openstack commands:: - source /home/opnfv/functest/conf/openstack.creds + source /home/opnfv/functest/conf/env_file After this, try to run any OpenStack command to see if you get any output, for instance:: @@ -631,14 +631,14 @@ http_proxy and https_proxy environment variables, as well as the 'no_proxy' environment variable are set correctly:: # Make double sure that the 'no_proxy=...' line in the - # 'openstack.creds' file is commented out first. Otherwise, the + # 'env_file' file is commented out first. Otherwise, the # values set into the 'no_proxy' environment variable below will # be ovewrwritten, each time the command - # 'source ~/functest/conf/openstack.creds' is issued. + # 'source ~/functest/conf/env_file' is issued. cd ~/functest/conf/ - sed -i 's/export no_proxy/#export no_proxy/' openstack.creds - source ./openstack.creds + sed -i 's/export no_proxy/#export no_proxy/' env_file + source ./env_file # Next calculate some IP addresses for which http_proxy # usage should be excluded: diff --git a/docs/testing/user/userguide/runfunctest.rst b/docs/testing/user/userguide/runfunctest.rst index 89580e564..d5b95101a 100644 --- a/docs/testing/user/userguide/runfunctest.rst +++ b/docs/testing/user/userguide/runfunctest.rst @@ -12,7 +12,7 @@ Assuming that you pulled the container and your environement is ready, you can simply run the tiers by typing (e.g. with functest-healthcheck):: sudo docker run --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-healthcheck @@ -44,14 +44,14 @@ different commands within the docker. Considering the healthcheck example, running functest manaully means:: sudo docker run -ti --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-healthcheck /bin/bash The docker prompt shall be returned. Then within the docker run the following commands:: - $ source /home/opnfv/functest/conf/openstack.creds + $ source /home/opnfv/functest/conf/env_file Tier ---- diff --git a/docs/testing/user/userguide/troubleshooting.rst b/docs/testing/user/userguide/troubleshooting.rst index 1e342b653..1649ac140 100644 --- a/docs/testing/user/userguide/troubleshooting.rst +++ b/docs/testing/user/userguide/troubleshooting.rst @@ -15,7 +15,7 @@ credentials:: or:: - source /home/opnfv/functest/conf/openstack.creds + source /home/opnfv/functest/conf/env_file VIM --- @@ -280,7 +280,7 @@ Example of custom list of tests 'my-custom-tempest-tests.txt':: This is an example of running a customized list of Tempest tests in Functest:: sudo docker run --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ -v $(pwd)/my-custom-testcases.yaml:/usr/lib/python2.7/site-packages/functest/ci/testcases.yaml \ -v $(pwd)/my-custom-tempest-tests.txt:/usr/lib/python2.7/site-packages/functest/opnfv_tests/openstack/tempest/custom_tests/test_list.txt \ |