[docs] Move user guide chapters to make room for new chapter.

[yardstick.git] / docs / testing / user / userguide / 06-yardstick-plugin.rst

diff --git a/docs/testing/user/userguide/05-yardstick_plugin.rst b/docs/testing/user/userguide/06-yardstick-plugin.rst
similarity index 75%
rename from docs/testing/user/userguide/05-yardstick_plugin.rst
rename to docs/testing/user/userguide/06-yardstick-plugin.rst
index 679ce79..bc35e23 100644 (file)
--- a/docs/testing/user/userguide/05-yardstick_plugin.rst
+++ b/docs/testing/user/userguide/06-yardstick-plugin.rst
@@ -31,7 +31,7 @@ In this introduction we will install Storperf on Jump Host.
 
 
 Step 0: Environment preparation
->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+-------------------------------
 
 Running Storperf on Jump Host
 Requirements:
@@ -47,24 +47,26 @@ environment and other dependencies:
 1. Make sure docker is installed.
 2. Make sure Keystone, Nova, Neutron, Glance, Heat are installed correctly.
 3. Make sure Jump Host have access to the OpenStack Controller API.
-4. Make sure Jump Host must have internet connectivity for downloading docker image.
-5. You need to know where to get basic openstack Keystone authorization info, such as
-   OS_PASSWORD, OS_PROJECT_NAME, OS_AUTH_URL, OS_USERNAME.
-6. To run a Storperf container, you need to have OpenStack Controller environment
-   variables defined and passed to Storperf container. The best way to do this is to
-   put environment variables in a "storperf_admin-rc" file. The storperf_admin-rc
-   should include credential environment variables at least:
-
-* OS_AUTH_URL
-* OS_USERNAME
-* OS_PASSWORD
-* OS_PROJECT_NAME
-* OS_PROJECT_ID
-* OS_USER_DOMAIN_ID
-
-*Yardstick* has a "prepare_storperf_admin-rc.sh" script which can be used to
-generate the "storperf_admin-rc" file, this script is located at
-test/ci/prepare_storperf_admin-rc.sh
+4. Make sure Jump Host must have internet connectivity for downloading docker
+   image.
+5. You need to know where to get basic openstack Keystone authorization info,
+   such as OS_PASSWORD, OS_PROJECT_NAME, OS_AUTH_URL, OS_USERNAME.
+6. To run a Storperf container, you need to have OpenStack Controller
+   environment variables defined and passed to Storperf container. The best way
+   to do this is to put environment variables in a "storperf_admin-rc" file.
+   The storperf_admin-rc should include credential environment variables at
+   least:
+
+   * OS_AUTH_URL
+   * OS_USERNAME
+   * OS_PASSWORD
+   * OS_PROJECT_NAME
+   * OS_PROJECT_ID
+   * OS_USER_DOMAIN_ID
+
+*Yardstick* has a ``prepare_storperf_admin-rc.sh`` script which can be used to
+generate the ``storperf_admin-rc`` file, this script is located at
+``test/ci/prepare_storperf_admin-rc.sh``
 
 ::
 
@@ -92,18 +94,18 @@ test/ci/prepare_storperf_admin-rc.sh
   echo "OS_USER_DOMAIN_ID="$USER_DOMAIN_ID >> ~/storperf_admin-rc
 
 
-The generated "storperf_admin-rc" file will be stored in the root directory. If
-you installed *Yardstick* using Docker, this file will be located in the
+The generated ``storperf_admin-rc`` file will be stored in the root directory.
+If you installed *Yardstick* using Docker, this file will be located in the
 container. You may need to copy it to the root directory of the Storperf
 deployed host.
 
 Step 1: Plug-in configuration file preparation
->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+----------------------------------------------
 
 To install a plug-in, first you need to prepare a plug-in configuration file in
-YAML format and store it in the "plugin" directory. The plugin configration file
-work as the input of yardstick "plugin" command. Below is the Storperf plug-in
-configuration file sample:
+YAML format and store it in the "plugin" directory. The plugin configration
+file work as the input of yardstick "plugin" command. Below is the Storperf
+plug-in configuration file sample:
 ::
 
   ---
@@ -123,28 +125,28 @@ Here the Storperf will be installed on IP 192.168.23.2 which is the Jump Host
 in my local environment.
 
 Step 2: Plug-in install/remove scripts preparation
->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+--------------------------------------------------
 
-In "yardstick/resource/scripts" directory, there are two folders: a "install"
-folder and a "remove" folder. You need to store the plug-in install/remove
-scripts in these two folders respectively.
+In ``yardstick/resource/scripts`` directory, there are two folders: an
+``install`` folder and a ``remove`` folder. You need to store the plug-in
+install/remove scripts in these two folders respectively.
 
 The detailed installation or remove operation should de defined in these two
 scripts. The name of both install and remove scripts should match the plugin-in
 name that you specified in the plug-in configuration file.
 
-For example, the install and remove scripts for Storperf are both named to
-"storperf.bash".
+For example, the install and remove scripts for Storperf are both named
+``storperf.bash``.
 
 Step 3: Install and remove Storperf
->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+-----------------------------------
 
 To install Storperf, simply execute the following command::
 
   # Install Storperf
   yardstick plugin install plugin/storperf.yaml
 
-removing Storperf from yardstick
+Removing Storperf from yardstick
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To remove Storperf, simply execute the following command::