Merge "[Docs] Remove subsection numberings in the Rally tutorial"

doc/source/tutorial/step_1_setting_up_env_and_running_benchmark_from_samples.rst

@@ -23,8 +23,8 @@ In this demo, we will show how to perform some basic operations in Rally, such a
 We assume that you have a :ref:`Rally installation <tutorial_step_0_installation>` and an already existing OpenStack deployment with Keystone available at *<KEYSTONE_AUTH_URL>*.
 
 
-1. Registering an OpenStack deployment in Rally
------------------------------------------------
+Registering an OpenStack deployment in Rally
+--------------------------------------------
 
 First, you have to provide Rally with an Openstack deployment it is going to benchmark. This should be done either through `OpenRC files <http://docs.openstack.org/user-guide/content/cli_openrc.html>`_ or through deployment `configuration files <https://github.com/stackforge/rally/tree/master/samples/deployments>`_. In case you already have an *OpenRC*, it is extremely simple to register a deployment with the *deployment create* command:
 
@@ -78,8 +78,8 @@ Finally, the *deployment check* command enables you to verify that your current
    +----------+----------------+-----------+
 
 
-2. Benchmarking
----------------
+Benchmarking
+------------
 
 Now that we have a working and registered deployment, we can start benchmarking it. The sequence of benchmarks to be launched by Rally should be specified in a *benchmark task configuration file* (either in *JSON* or in *YAML* format). Let's try one of the sample benchmark tasks available in `samples/tasks/scenarios <https://github.com/stackforge/rally/tree/master/samples/tasks/scenarios>`_, say, the one that boots and deletes multiple servers (*samples/tasks/scenarios/nova/boot-and-delete.json*):
 
@@ -199,8 +199,8 @@ Note that the Rally input task above uses *regular expressions* to specify the i
    +---------------------+-----------+-------+----------+-----------+-----------+
 
 
-3. Report generation
---------------------
+Report generation
+-----------------
 
 One of the most beautiful things in Rally is its task report generation mechanism. It enables you to create illustrative and comprehensive HTML reports based on the benchmarking data. To create and open at once such a report for the last task you have launched, call:
 

doc/source/tutorial/step_2_running_multple_benchmarks_in_a_single_task.rst

@@ -18,8 +18,8 @@
 Step 2. Running multiple benchmarks in a single task
 ====================================================
 
-1. Rally input task syntax
---------------------------
+Rally input task syntax
+-----------------------
 
 Rally comes with a really great collection of :ref:`benchmark scenarios <tutorial_step_6_discovering_more_benchmark_scenarios>` and in most real-world scenarios you will use multiple scenarios to test your OpenStack cloud. Rally makes it very easy to run **different benchmarks defined in a single benchmark task**. To do so, use the following syntax:
 
@@ -27,7 +27,7 @@ Rally comes with a really great collection of :ref:`benchmark scenarios <tutoria
 
     {
         "<ScenarioName1>": [<benchmark_config>, <benchmark_config2>, ...]
-        "<ScnearioName2>": [<benchmark_config>, ...]
+        "<ScenarioName2>": [<benchmark_config>, ...]
     }
 
 where *<benchmark_config>*, as before, is a dictionary:
@@ -40,8 +40,8 @@ where *<benchmark_config>*, as before, is a dictionary:
         ...
     }
 
-2. Multiple benchmarks in a single task
----------------------------------------
+Multiple benchmarks in a single task
+------------------------------------
 
 As an example, let's edit our configuration file from :ref:`step 1 <tutorial_step_1_setting_up_env_and_running_benchmark_from_samples>` so that it prescribes Rally to launch not only the **NovaServers.boot_and_delete_server** scenario, but also the **KeystoneBasic.create_delete_user** scenario. All we have to do is to append the configuration of the second scenario as yet another top-level key of our json file:
 
@@ -129,8 +129,8 @@ Note that the HTML reports you can generate by typing **rally task report --out=
    :align: center
 
 
-3. Multiple configurations of the same scenario
------------------------------------------------
+Multiple configurations of the same scenario
+--------------------------------------------
 
 Yet another thing you can do in Rally is to launch **the same benchmark scenario multiple times with different configurations**. That's why our configuration file stores a list for the key *"NovaServers.boot_and_delete_server"*: you can just append a different configuration of this benchmark scenario to this list to get it. Let's say, you want to run the **boot_and_delete_server** scenario twice: first using the *"m1.nano"* flavor and then using the *"m1.tiny"* flavor:
 

doc/source/tutorial/step_3_adding_success_criteria_for_benchmarks.rst

@@ -18,8 +18,8 @@
 Step 3. Adding success criteria (SLA) for benchmarks
 ====================================================
 
-1. SLA - Service-Level Agreement (Success Criteria)
----------------------------------------------------
+SLA - Service-Level Agreement (Success Criteria)
+------------------------------------------------
 
 Rally allows you to set success criteria (also called *SLA - Service-Level Agreement*) for every benchmark. Rally will automatically check them for you.
 
@@ -52,8 +52,8 @@ To configure the SLA, add the *"sla"* section to the configuration of the corres
 Such configuration will mark the **NovaServers.boot_and_delete_server** benchmark scenario as not successful if either some iteration took more than 10 seconds or more than 25% iterations failed.
 
 
-2. Checking SLA
----------------
+Checking SLA
+------------
 Let us show you how Rally SLA work using a simple example based on **Dummy benchmark scenarios**. These scenarios actually do not perform any OpenStack-related stuff but are very useful for testing the behavious of Rally. Let us put in a new task, *test-sla.json*, 2 scenarios -- one that does nothing and another that just throws an exception:
 
 .. code-block:: none
@@ -122,8 +122,8 @@ After the task completes, run *rally task sla_check* to check the results again
 Exactly as expected.
 
 
-3. SLA in task report
----------------------
+SLA in task report
+------------------
 
 SLA checks are nicely visualized in task reports. Generate one:
 
@@ -131,7 +131,6 @@ SLA checks are nicely visualized in task reports. Generate one:
 
    $ rally task report --out=report_sla.html --open
 
-
 Benchmark scenarios that have passed SLA have a green check on the overview page:
 
 .. image:: ../images/Report-SLA-Overview.png

doc/source/tutorial/step_6_discovering_more_benchmark_scenarios.rst

@@ -18,15 +18,15 @@
 Step 6. Discovering more benchmark scenarios in Rally
 =====================================================
 
-1. Scenarios in the Rally repository
-------------------------------------
+Scenarios in the Rally repository
+---------------------------------
 
 Rally currently comes with a great collection of benchmark scenarios that use the API of different OpenStack projects like **Keystone**, **Nova**, **Cinder**, **Glance** and so on. The good news is that you can combine multiple benchmark scenarios in one task to benchmark your cloud in a comprehensive way.
 
 First, let's see what scenarios are available in Rally. One of the ways to discover these scenario is just to inspect their `source code <https://github.com/stackforge/rally/tree/master/rally/benchmark/scenarios>`_.
 
-2. Rally built-in search engine
--------------------------------
+Rally built-in search engine
+----------------------------
 
 A much more convenient way to learn about different benchmark scenarios in Rally, however, is to use a special **search engine** embedded into its Command-Line Interface, which, for a given **search query**, prints documentation for the corresponding benchmark scenario (and also supports other Rally entities like SLA).
 

doc/source/tutorial/step_8_task_templates.rst

@@ -18,8 +18,8 @@
 Step 8. Rally task templates
 ============================
 
-1. Basic template syntax
-------------------------
+Basic template syntax
+---------------------
 
 A nice feature of the input task format used in Rally is that it supports the **template syntax** based on `Jinja2 <https://pypi.python.org/pypi/Jinja2>`_. This turns out to be extremely useful when, say, you have a fixed structure of your task but you want to parameterize this task in some way. For example, imagine your input task file (*task.yaml*) runs a set of Nova scenarios:
 
@@ -189,8 +189,9 @@ Passed in either way, these parameter values will be substituted by Rally when s
     Benchmarking... This can take a while...
 
 
-1. Using the default values
----------------------------
+Using the default values
+------------------------
+
 Note that the Jinja2 template syntax allows you to set the default values for your parameters. With default values set, your task file will work even if you don't parameterize it explicitly while starting a task. The default values should be set using the *{% set ... %}* clause (*task.yaml*):
 
 .. code-block:: none
@@ -247,8 +248,8 @@ If you don't pass the value for *{{image_name}}* while starting a task, the defa
         ...
 
 
-3. Advanced templates
--------------------------------
+Advanced templates
+------------------
 
 Rally makes it possible to use all the power of Jinja2 template syntax, including the mechanism of **built-in functions**. This enables you to construct elegant task files capable of generating complex load on your cloud.