Improve Yardstick user-guide 01/36401/2
authorJingLu5 <lvjing5@huawei.com>
Fri, 23 Jun 2017 03:13:04 +0000 (03:13 +0000)
committerJingLu5 <lvjing5@huawei.com>
Fri, 23 Jun 2017 03:56:22 +0000 (03:56 +0000)
This patch adds a short description on how to use the "yardstick env prepare"
command in a Non-OPNFV installer environtment.

Change-Id: Idf54bf5318499d2b129a1445e0758e351945e755
Signed-off-by: JingLu5 <lvjing5@huawei.com>
docs/testing/user/userguide/04-installation.rst

index 0c2bb58..660f3b5 100644 (file)
@@ -149,7 +149,12 @@ In the Yardstick container, the Yardstick repository is located in the ``/home/o
 
   yardstick env prepare
 
 
   yardstick env prepare
 
-**NOTE**: The above command just works for four OPNFV installers -- **Apex**, **Compass**, **Fuel** and **Joid**.
+**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**
+
 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
 monitor the env prepare process, you can enter the Yardstick container in a new
 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
 monitor the env prepare process, you can enter the Yardstick container in a new
@@ -506,3 +511,4 @@ yaml file and add test cases, constraint or task arguments if necessary.
 
 Proxy Support (**Todo**)
 ---------------------------
 
 Proxy Support (**Todo**)
 ---------------------------
+