diff options
| author |   JingLu5 <lvjing5@huawei.com> | 2017-10-10 08:19:54 +0000 |
|---|---|---|
| committer | Jing Lu <lvjing5@huawei.com> | 2017-10-12 01:42:30 +0000 |
| commit | 1f9c4a5370bdaed3f495c3fd4b106dd788af4f28 (patch) | |
| tree | ef3381ed32c66e543e139dbfbeeca53cf4e3cd31 | |
| parent | d6b148980fb78d99ed99985bf578ce285ead51d6 (diff) | |
Doc amendment: env prepare command
JIRA: YARDSTICK-637
Change-Id: I7e5e1afb7b5a7e97aa070c03cded3be285d97cc2
Signed-off-by: JingLu5 <lvjing5@huawei.com>
(cherry picked from commit d91ddc83daa7ac112c764e74621b48455d038e7f)
| -rw-r--r-- | docs/testing/user/userguide/04-installation.rst | 30 |
1 files changed, 8 insertions, 22 deletions
diff --git a/docs/testing/user/userguide/04-installation.rst b/docs/testing/user/userguide/04-installation.rst index cb4f31434..b40e1143e 100644 --- a/docs/testing/user/userguide/04-installation.rst +++ b/docs/testing/user/userguide/04-installation.rst @@ -82,7 +82,7 @@ following docker command:: Run the Docker image to get a Yardstick container:: - docker run -itd --privileged -v /var/run/docker.sock:/var/run/docker.sock -p 8888:5000 -e INSTALLER_IP=192.168.200.2 -e INSTALLER_TYPE=compass --name yardstick opnfv/yardstick:stable + docker run -itd --privileged -v /var/run/docker.sock:/var/run/docker.sock -p 8888:5000 --name yardstick opnfv/yardstick:stable Note: @@ -101,21 +101,6 @@ Note: | | Yardstick container, this | | | parameter is needed. | +----------------------------------------------+------------------------------+ -| -e INSTALLER_IP=192.168.200.2 | If you want to use yardstick | -| | env prepare command(or | -| -e INSTALLER_TYPE=compass | related API) to load the | -| | images that Yardstick needs, | -| | these parameters should be | -| | provided. | -| | The INSTALLER_IP and | -| | INSTALLER_TYPE are depending | -| | on your OpenStack installer. | -| | Currently Apex, Compass, | -| | Fuel and Joid are supported. | -| | If you use other installers, | -| | such as devstack, these | -| | parameters can be ignores. | -+----------------------------------------------+------------------------------+ | -p 8888:5000 | If you want to call | | | Yardstick API out of | | | Yardstick container, this | @@ -149,11 +134,11 @@ In the Yardstick container, the Yardstick repository is located in the ``/home/o yardstick env prepare -**NOTE**: The above command works for four OPNFV installers -- **Apex**, **Compass**, **Fuel** and **Joid**. -For Non-OPNFV installer OpenStack environment, the above command can also be used to configure the environment. -But before running the above command in a Non-OPNFV installer environment, it is necessary to create the /etc/yardstick/openstack.creds file and -save OpenStack environment variables in it. For details of the required OpenStack environment variables please refer to -section **Export OpenStack environment variables** +**NOTE**: Since Euphrates release, the above command will not able to automatically configure the /etc/yardstick/openstack.creds file. +So before running the above command, it is necessary to create the /etc/yardstick/openstack.creds file and save OpenStack environment variables into it manually. +If you have the openstack credential file saved outside the Yardstcik Docker container, you can do this easily by mapping the credential file into Yardstick container + using '-v /path/to/credential_file:/etc/yardstick/openstack.creds' when running the Yardstick container. +For details of the required OpenStack environment variables please refer to section **Export OpenStack environment variables** The env prepare command may take up to 6-8 minutes to finish building yardstick-image and other environment preparation. Meanwhile if you wish to @@ -647,4 +632,5 @@ yaml file and add test cases, constraint or task arguments if necessary. Proxy Support (**Todo**) ----------------------------
\ No newline at end of file +--------------------------- + |