diff options
Diffstat (limited to 'docs/configguide/configguide.rst')
| -rw-r--r-- | docs/configguide/configguide.rst | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst index 82ba1e373..bc66d3856 100644 --- a/docs/configguide/configguide.rst +++ b/docs/configguide/configguide.rst @@ -16,11 +16,11 @@ Check that the image is available:: Run the docker container giving the environment variables: - * INSTALLER_TYPE : possible values are "apex", "compass", "fuel" or "joid". - * INSTALLER_IP : IP of the installer node/VM. + * **INSTALLER_TYPE** : possible values are **apex**, **compass**, **fuel** or **joid**. + * **INSTALLER_IP** : IP of the installer node/VM. -Functest may need to know the IP of the installer to retrieve the credentials from -the installer node/VM or even from the actual controllers. +Functest may need to know the IP of the installer to retrieve automatically the +credentials from the installer node/VM or even from the actual controllers. The minimum command to create the Functest Docker container can be described as follows:: @@ -28,20 +28,20 @@ follows:: docker run -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:brahmaputra.1.0 /bin/bash Optionally, it is possible to precise the container name through the option ---name:: +**--name**:: docker run --name "CONTAINER_NAME" -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:brahmaputra.1.0 /bin/bash -It is also possible to to indicate the path of the OpenStack credentials using -v:: +It is also possible to to indicate the path of the OpenStack credentials using **-v**:: docker run -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" -v <path_to_your_local_creds_file>:/home/opnfv/functest/conf/openstack.creds opnfv/functest:brahmaputra.1.0 /bin/bash The local file will be mounted in the container under -/home/opnfv/functest/conf/openstack.creds +*/home/opnfv/functest/conf/openstack.creds* If the intention is to run Functest against any of the supported OPNFV scenarios, it is recommended to include also the environment variable **DEPLOY_SCENARIO**, -For instance:: +for example:: docker run -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" -e "DEPLOY_SCENARIO=os-odl_l2-nofeature-ha" opnfv/functest:brahmaputra.1.0 /bin/bash @@ -125,45 +125,45 @@ container and ready to move to the next step. Useful Docker commands ---------------------- -When typing **exit** in the container prompt, this will cause sometimes -exiting the container and stopping it. When stopping a running Docker container -all the changes will be lost when it is started again. There is a shortcut to -quit the container without stopping it. Type CTRL+P+Q to keep the changes. +When typing **exit** in the container prompt, this will cause +exiting the container and probably stopping it. When stopping a running Docker container +all the changes will be lost, there is a keyboard shortcut to +quit the container without stopping it: CTRL+P+Q. To reconnect to the running container **DO NOT** use the *run* command again -(since it will create a new container) use *exec* instead:: +(since it will create a new container), use *exec* instead:: docker ps <copy the container ID> - docker exec -ti <CONTAINER_ID> bash + docker exec -ti <CONTAINER_ID> /bin/bash or simply:: - docker exec -ti $(docker ps|grep functest|awk '{print $1}') bash + docker exec -ti $(docker ps|grep functest|awk '{print $1}') /bin/bash There are other useful Docker commands that might be needed to manage possible issues with the containers. - * List the running containers:: +List the running containers:: - docker ps + docker ps - * List all the containers including the stopped ones:: +List all the containers including the stopped ones:: docker ps -a - * It is useful sometimes to remove a container if there are some problems:: +It is useful sometimes to remove a container if there are some problems:: docker rm <CONTAINER_ID> - * Use the *-f* option if the container is still running, it will force to destroy it:: +Use the *-f* option if the container is still running, it will force to destroy it:: docker -f rm <CONTAINER_ID> -The Docker image is named **opnfv/functest** and it is stored in the public +The Docker image is called **opnfv/functest** and it is stored in the public Docker registry under the OPNFV account: dockerhub_. The are many different tags that have been created automatically by the CI mechanisms, but the one that this document refers to is **brahmaputra.1.0**. -Other tags might cause some problems while running the tests. +Pulling other tags might cause some problems while running the tests. Check the Docker documentation dockerdocs_ for more information. @@ -174,14 +174,14 @@ Preparing the Functest environment Once the docker container is up and running, execute the following command in the prompt:: - ${repos_dir}/functest/docker/prepare_env.sh + ${repos_dir}/functest/docker/prepare_env.sh NOTE: **${repos_dir}** is a default environment variable inside the docker container, which points to */home/opnfv/repos/* This script will make sure that the requirements to run the tests are met and will install the needed libraries and tools by all Functest test cases. It must be run -only once every time the docker is started. +only once every time the docker is started from sratch. Focus on the OpenStack credentials @@ -200,7 +200,7 @@ Once the credentials are there, they shall be sourced before running the tests:: source /home/opnfv/functest/conf/openstack.creds -or simply using the environment variable **$creds**:: +or simply using the environment variable **creds**:: . $creds @@ -235,8 +235,8 @@ Additional Options ------------------ In case you need to provide different configuration parameters to Functest (e.g. - commit IDs or branches for the repositories, ...) copy the config_functest.yaml - from the repository to your current directory and run docker with a volume:: +commit IDs or branches for the repositories, ...) copy the **config_functest.yaml** +from the repository to your current directory and run the container with a volume:: wget https://git.opnfv.org/cgit/functest/plain/testcases/config_functest.yaml |