From 604d2fcb028ad5c02d1b3fbd9524a51090cdf853 Mon Sep 17 00:00:00 2001 From: MatthewLi Date: Tue, 16 Aug 2016 22:33:14 -0400 Subject: functest compass usage document JIRA: FUNCTEST-333 add some information in configuration file Change-Id: I6ec91d15c859b9739904d602aef3a0927f6561b6 Signed-off-by: MatthewLi --- docs/configguide/configguide.rst | 58 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) (limited to 'docs') diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst index c1c717b13..6448d2c99 100644 --- a/docs/configguide/configguide.rst +++ b/docs/configguide/configguide.rst @@ -241,6 +241,64 @@ illustration purposes:: -v ~/overcloudrc:/home/opnfv/functest/conf/openstack.creds \ opnfv/functest /bin/bash +Compass installer local development env usage Tips +-------------------------------------------------- +In the compass-functest local test case check and development environment, in order +to get openstack service inside the functest container, some parameters should be +configured during container creation, which are hard to guess for freshman. This +section will provide the guideline, the parameters values are defaults here, which should +be adjusted according to the settings, the complete steps are given here so as +not to appear too abruptly. + +1, Pull Functest docker image from public dockerhub:: + + docker pull opnfv/functest: + + here can be "brahmaputra.1.0", "colorado.1.0", etc. Tag omitted means the +latest docker image:: + + docker pull opnfv/functest + +2, Functest Docker container creation + +To make a file used for the environment, such as 'functest-docker-env':: + + OS_AUTH_URL=http://172.16.1.222:35357/v2.0 + OS_USERNAME=admin + OS_PASSWORD=console + OS_TENANT_NAME=admin + OS_VOLUME_API_VERSION=2 + OS_PROJECT_NAME=admin + INSTALLER_TYPE=compass + INSTALLER_IP=192.168.200.2 + EXTERNAL_NETWORK=ext-net + +Note: please adjust the content according to the environment, such as 'TENANT_ID' +maybe used for some special cases. + +Then to create the Functest docker:: + + docker run --privileged=true --rm -t \ + --env-file functest-docker-env \ + --name \ + opnfv/functest: /bin/bash + +Note: it is recommended to be run on jumpserver. + +3, To attach Functest container + +Before trying to attach the Functest container, the status can be checked by:: + + docker ps -a + +to attach the 'Up' status Functest container and start bash mode:: + + docker exec -it bash + +4, Functest environemnt preparation and check + +To see the Section below `Preparing the Functest environment`_. + Functest docker container directory structure --------------------------------------------- Inside the Functest docker container, the following directory structure -- cgit 1.2.3-korg