[docs] Fix docs {un,}indent warnings in Testcase definitions

Mostly, the issues were with un/indentation.
This has been fixed, and `tox -e docs` now issues less warnings.

JIRA: YARDSTICK-1416
Change-Id: Ie58a8dba42e9868357e1dce414cb1a01af8ad1f4
Signed-off-by: Emma Foley <emma.l.foley@intel.com>

diff --git a/docs/templates/test_results_template.rst b/docs/templates/test_results_template.rst
index 4523563..8885588 100644 (file)
--- a/docs/templates/test_results_template.rst
+++ b/docs/templates/test_results_template.rst
@@ -61,16 +61,16 @@ TCXXX
    on-demand test cases (HA, KVM, Parser)
 
 * Overview of test results
-.. general on metrics collected, number of iterations
+  .. general on metrics collected, number of iterations
 
 * Detailed test results
-.. info on lab, installer, scenario
+  .. info on lab, installer, scenario
 
 * Rationale for decisions
-.. pass/fail
+  .. pass/fail
 
 * Conclusions and recommendations
-.. did the expected behavior occured?
+  .. did the expected behavior occured?
 
 General
 =======

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc010.rst b/docs/testing/user/userguide/opnfv_yardstick_tc010.rst
index 202307d..19cc80e 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc010.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc010.rst
@@ -34,6 +34,7 @@ Yardstick Test Case Description TC010
 |              |                                                              |
 |              | Lmbench is a suite of operating system microbenchmarks. This |
 |              | test uses lat_mem_rd tool from that suite including:         |
+|              |                                                              |
 |              |  * Context switching                                         |
 |              |  * Networking: connection establishment, pipe, TCP, UDP, and |
 |              |    RPC hot potato                                            |
@@ -55,7 +56,7 @@ Yardstick Test Case Description TC010
 |              | The benchmark runs as two nested loops. The outer loop is    |
 |              | the stride size. The inner loop is the array size. For each  |
 |              | array size, the benchmark creates a ring of pointers that    |
-|              | point backward one stride.Traversing the array is done by:   |
+|              | point backward one stride. Traversing the array is done by:: |
 |              |                                                              |
 |              |         p = (char **)*p;                                     |
 |              |                                                              |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc011.rst b/docs/testing/user/userguide/opnfv_yardstick_tc011.rst
index 48bdef4..cbb1db9 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc011.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc011.rst
@@ -60,14 +60,14 @@ Yardstick Test Case Description TC011
 |              |                                                              |
 |              | * options:                                                   |
 |              |   protocol: udp # The protocol used by iperf3 tools          |
-|              |   bandwidth: 20m # It will send the given number of packets  |
-|              |                    without pausing                           |
+|              |   # Send the given number of packets without pausing:        |
+|              |   bandwidth: 20m                                             |
 |              | * runner:                                                    |
 |              |   duration: 30 # Total test duration 30 seconds.             |
 |              |                                                              |
 |              | * SLA (optional):                                            |
 |              |   jitter: 10 (ms) # The maximum amount of jitter that is     |
-|              |     accepted.                                                |
+|              |   accepted.                                                  |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |applicability | Test can be configured with different:                       |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc012.rst b/docs/testing/user/userguide/opnfv_yardstick_tc012.rst
index b56e829..2502f5d 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc012.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc012.rst
@@ -34,6 +34,7 @@ Yardstick Test Case Description TC012
 |              |                                                              |
 |              | LMbench is a suite of operating system microbenchmarks.      |
 |              | This test uses bw_mem tool from that suite including:        |
+|              |                                                              |
 |              |  * Cached file read                                          |
 |              |  * Memory copy (bcopy)                                       |
 |              |  * Memory read                                               |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc019.rst b/docs/testing/user/userguide/opnfv_yardstick_tc019.rst
index 8d79e01..d27b201 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc019.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc019.rst
@@ -43,20 +43,24 @@ Yardstick Test Case Description TC019
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |monitors      | In this test case, two kinds of monitor are needed:          |
+|              |                                                              |
 |              | 1. the "openstack-cmd" monitor constantly request a specific |
 |              |    Openstack command, which needs two parameters:            |
-|              | 1) monitor_type: which is used for finding the monitor class |
-|              | and related scritps. It should be always set to              |
-|              | "openstack-cmd" for this monitor.                            |
-|              | 2) command_name: which is the command name used for request  |
+|              |                                                              |
+|              |    1. monitor_type: which is used for finding the monitor    |
+|              |       class and related scritps. It should be always set to  |
+|              |       "openstack-cmd" for this monitor.                      |
+|              |    2. command_name: which is the command name used for       |
+|              |       request                                                |
 |              |                                                              |
 |              | 2. the "process" monitor check whether a process is running  |
 |              |    on a specific node, which needs three parameters:         |
-|              | 1) monitor_type: which used for finding the monitor class    |
-|              | and related scritps. It should be always set to "process"    |
-|              | for this monitor.                                            |
-|              | 2) process_name: which is the process name for monitor       |
-|              | 3) host: which is the name of the node runing the process    |
+|              |                                                              |
+|              |    1. monitor_type: which used for finding the monitor class |
+|              |       and related scritps. It should be always set to        |
+|              |       "process" for this monitor.                            |
+|              |    2. process_name: which is the process name for monitor    |
+|              |    3. host: which is the name of the node runing the process |
 |              |                                                              |
 |              | e.g.                                                         |
 |              | monitor1:                                                    |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc025.rst b/docs/testing/user/userguide/opnfv_yardstick_tc025.rst
index 0e2e9a5..f3f9ea6 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc025.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc025.rst
@@ -39,12 +39,15 @@ Yardstick Test Case Description TC025
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |monitors      | In this test case, one kind of monitor are needed:           |
+|              |                                                              |
 |              | 1. the "openstack-cmd" monitor constantly request a specific |
 |              |    Openstack command, which needs two parameters             |
-|              | 1) monitor_type: which is used for finding the monitor class |
-|              | and related scritps. It should be always set to              |
-|              | "openstack-cmd" for this monitor.                            |
-|              | 2) command_name: which is the command name used for request  |
+|              |                                                              |
+|              |    1) monitor_type: which is used for finding the monitor    |
+|              |       class and related scripts. It should be always set to  |
+|              |       "openstack-cmd" for this monitor.                      |
+|              |    2) command_name: which is the command name used for       |
+|              |       request                                                |
 |              |                                                              |
 |              | There are four instance of the "openstack-cmd" monitor:      |
 |              | monitor1:                                                    |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc050.rst b/docs/testing/user/userguide/opnfv_yardstick_tc050.rst
index 82a491b..7d01cb9 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc050.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc050.rst
@@ -35,18 +35,18 @@ Yardstick Test Case Description TC050
 |              | 3) interface: the network interface to be turned off.        |
 |              |                                                              |
 |              | The interface to be closed by the attacker can be set by the |
-|              | variable of "{{ interface_name }}"                           |
+|              | variable of "{{ interface_name }}"::                         |
 |              |                                                              |
-|              | attackers:                                                   |
-|              |   -                                                          |
-|              |     fault_type: "general-attacker"                           |
-|              |     host: {{ attack_host }}                                  |
-|              |     key: "close-br-public"                                   |
-|              |     attack_key: "close-interface"                            |
-|              |     action_parameter:                                        |
-|              |       interface: {{ interface_name }}                        |
-|              |     rollback_parameter:                                      |
-|              |       interface: {{ interface_name }}                        |
+|              |   attackers:                                                 |
+|              |     -                                                        |
+|              |       fault_type: "general-attacker"                         |
+|              |       host: {{ attack_host }}                                |
+|              |       key: "close-br-public"                                 |
+|              |       attack_key: "close-interface"                          |
+|              |       action_parameter:                                      |
+|              |         interface: {{ interface_name }}                      |
+|              |       rollback_parameter:                                    |
+|              |         interface: {{ interface_name }}                      |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |monitors      | In this test case, the monitor named "openstack-cmd" is      |
@@ -56,19 +56,20 @@ Yardstick Test Case Description TC050
 |              | "openstack-cmd" for this monitor.                            |
 |              | 2) command_name: which is the command name used for request  |
 |              |                                                              |
-|              | There are four instance of the "openstack-cmd" monitor:      |
-|              | monitor1:                                                    |
-|              |     - monitor_type: "openstack-cmd"                          |
-|              |     - command_name: "nova image-list"                        |
-|              | monitor2:                                                    |
-|              |     - monitor_type: "openstack-cmd"                          |
-|              |     - command_name: "neutron router-list"                    |
-|              | monitor3:                                                    |
-|              |     - monitor_type: "openstack-cmd"                          |
-|              |     - command_name: "heat stack-list"                        |
-|              | monitor4:                                                    |
-|              |     - monitor_type: "openstack-cmd"                          |
-|              |     - command_name: "cinder list"                            |
+|              | There are four instance of the "openstack-cmd" monitor::     |
+|              |                                                              |
+|              |   monitor1:                                                  |
+|              |       - monitor_type: "openstack-cmd"                        |
+|              |       - command_name: "nova image-list"                      |
+|              |   monitor2:                                                  |
+|              |       - monitor_type: "openstack-cmd"                        |
+|              |       - command_name: "neutron router-list"                  |
+|              |   monitor3:                                                  |
+|              |       - monitor_type: "openstack-cmd"                        |
+|              |       - command_name: "heat stack-list"                      |
+|              |   monitor4:                                                  |
+|              |       - monitor_type: "openstack-cmd"                        |
+|              |       - command_name: "cinder list"                          |
 +--------------+--------------------------------------------------------------+
 |metrics       | In this test case, there is one metric:                      |
 |              | 1)service_outage_time: which indicates the maximum outage    |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc052.rst b/docs/testing/user/userguide/opnfv_yardstick_tc052.rst
index 9514b68..7f2be6e 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc052.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc052.rst
@@ -65,15 +65,16 @@ Yardstick Test Case Description TC052
 |              |                                                              |
 |              | In this case, the "operation" adds a flavor and the "result  |
 |              | checker" checks whether ths flavor is created. Their         |
-|              | parameters show as follows:                                  |
-|              | operation:                                                   |
-|              | -operation_type: "nova-create-flavor"                        |
-|              | -action_parameter:                                           |
-|              |    flavorconfig: "test-001 test-001 100 1 1"                 |
-|              | result checker:                                              |
-|              | -checker_type: "check-flavor"                                |
-|              | -expectedValue: "test-001"                                   |
-|              | -condition: "in"                                             |
+|              | parameters show as follows::                                 |
+|              |                                                              |
+|              |   operation:                                                 |
+|              |   -operation_type: "nova-create-flavor"                      |
+|              |   -action_parameter:                                         |
+|              |      flavorconfig: "test-001 test-001 100 1 1"               |
+|              |   result checker:                                            |
+|              |   -checker_type: "check-flavor"                              |
+|              |   -expectedValue: "test-001"                                 |
+|              |   -condition: "in"                                           |
 +--------------+--------------------------------------------------------------+
 |metrics       | In this test case, there is one metric:                      |
 |              | 1)service_outage_time: which indicates the maximum outage    |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc055.rst b/docs/testing/user/userguide/opnfv_yardstick_tc055.rst
index c861ca9..25703d3 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc055.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc055.rst
@@ -7,7 +7,7 @@
 Yardstick Test Case Description TC055
 *************************************
 
-.. _/proc/cpuinfo: http://www.linfo.org/proc_cpuinfo.html
+.. _`/proc/cpuinfo`: http://www.linfo.org/proc_cpuinfo.html
 
 +-----------------------------------------------------------------------------+
 |Compute Capacity                                                             |
@@ -41,7 +41,7 @@ Yardstick Test Case Description TC055
 |              | capacity output.                                             |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
-|references    | /proc/cpuinfo_                                               |
+|references    | `/proc/cpuinfo`_                                             |
 |              |                                                              |
 |              | ETSI-NFV-TST001                                              |
 |              |                                                              |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc057.rst b/docs/testing/user/userguide/opnfv_yardstick_tc057.rst
index 1bb43c9..245a58e 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc057.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc057.rst
@@ -49,12 +49,15 @@ Yardstick Test Case Description TC057
 |              | -host: node1                                                 |
 +--------------+--------------------------------------------------------------+
 |monitors      | In this test case, a kind of monitor is needed:              |
+|              |                                                              |
 |              | 1. the "openstack-cmd" monitor constantly request a specific |
 |              |    Openstack command, which needs two parameters:            |
-|              | 1) monitor_type: which is used for finding the monitor class |
-|              | and related scripts. It should be always set to              |
-|              | "openstack-cmd" for this monitor.                            |
-|              | 2) command_name: which is the command name used for request  |
+|              |                                                              |
+|              |    1. monitor_type: which is used for finding the monitor    |
+|              |       class and related scripts. It should be always set to  |
+|              |       "openstack-cmd" for this monitor.                      |
+|              |    2. command_name: which is the command name used for       |
+|              |       request                                                |
 |              |                                                              |
 |              | In this case, the command_name of monitor1 should be         |
 |              | services that are managed by the cluster manager.            |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc063.rst b/docs/testing/user/userguide/opnfv_yardstick_tc063.rst
index a77653a..7b8ee06 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc063.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc063.rst
@@ -58,6 +58,7 @@ Yardstick Test Case Description TC063
 |              |  * count: 15 - how many times to stat disk utilization       |
 |              |     type: int                                                |
 |              |     unit: na                                                 |
+|              |                                                              |
 |              | There are default values for each above-mentioned option.    |
 |              | Run in background with other test cases.                     |
 |              |                                                              |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc069.rst b/docs/testing/user/userguide/opnfv_yardstick_tc069.rst
index af0e64f..2d61438 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc069.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc069.rst
@@ -41,7 +41,8 @@ Yardstick Test Case Description TC069
 |              | * SLA (optional): 7000 (MBps) min_bandwidth: The minimum     |
 |              |   amount of memory bandwidth that is accepted.               |
 |              | * type_id: 1 - runs a specified benchmark                    |
-|              |   (by an ID number):                                         |
+|              |   (by an ID number)::                                        |
+|              |                                                              |
 |              |     1 -- INTmark [writing]          4 -- FLOATmark [writing] |
 |              |     2 -- INTmark [reading]          5 -- FLOATmark [reading] |
 |              |     3 -- INTmem                     6 -- FLOATmem            |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc074.rst b/docs/testing/user/userguide/opnfv_yardstick_tc074.rst
index d6beeaf..8d025ee 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc074.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc074.rst
@@ -91,12 +91,15 @@ Yardstick Test Case Description TC074
 |              | * workload=[workload module]                                 |
 |              |   If not specified, the default is to run all workloads. The |
 |              |   workload types are:                                        |
+|              |                                                              |
 |              |      - rs: 100% Read, sequential data                        |
 |              |      - ws: 100% Write, sequential data                       |
 |              |      - rr: 100% Read, random access                          |
 |              |      - wr: 100% Write, random access                         |
 |              |      - rw: 70% Read / 30% write, random access               |
+|              |                                                              |
 |              |   measurements.                                              |
+|              |                                                              |
 |              | * workloads={json maps}                                      |
 |              |   This parameter supercedes the workload and calls the V2.0  |
 |              |   API in StorPerf. It allows for greater control of the      |
@@ -131,11 +134,13 @@ Yardstick Test Case Description TC074
 |              |                                                              |
 |              | Storperf is required to be installed in the environment.     |
 |              | There are two possible methods for Storperf installation:    |
-|              |     Run container on Jump Host                               |
-|              |     Run container in a VM                                    |
+|              |                                                              |
+|              |     - Run container on Jump Host                             |
+|              |     - Run container in a VM                                  |
 |              |                                                              |
 |              | Running StorPerf on Jump Host                                |
 |              | Requirements:                                                |
+|              |                                                              |
 |              |     - Docker must be installed                               |
 |              |     - Jump Host must have access to the OpenStack Controller |
 |              |       API                                                    |
@@ -146,6 +151,7 @@ Yardstick Test Case Description TC074
 |              |                                                              |
 |              | Running StorPerf in a VM                                     |
 |              | Requirements:                                                |
+|              |                                                              |
 |              |     - VM has docker installed                                |
 |              |     - VM has OpenStack Controller credentials and can        |
 |              |       communicate with the Controller API                    |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc084.rst b/docs/testing/user/userguide/opnfv_yardstick_tc084.rst
index 2e7b28e..b3d44c4 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc084.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc084.rst
@@ -92,18 +92,19 @@ Yardstick Test Case Description TC084
 +--------------+--------------------------------------------------------------+
 |pre-test      | To run and install SPEC CPU 2006, the following are          |
 |conditions    | required:                                                    |
-|              |  * For SPECint 2006: Both C99 and C++98 compilers are        |
-|              |    installed in VM images;                                   |
-|              |  * For SPECfp 2006: All three of C99, C++98 and Fortran-95   |
-|              |    compilers installed in VM images;                         |
-|              |  * At least 4GB of disk space availabile on VM.              |
-|              |                                                              |
-|              |  gcc 4.8.* and g++ 4.8.* version have been tested in Ubuntu  |
-|              |  14.04, Ubuntu 16.04 and Redhat Enterprise Linux 7.4 image.  |
-|              |  Higher gcc and g++ version may cause compiling error.       |
-|              |                                                              |
-|              |  For more SPEC CPU 2006 dependencies please visit            |
-|              |  (https://www.spec.org/cpu2006/Docs/techsupport.html)        |
+|              |                                                              |
+|              | * For SPECint 2006: Both C99 and C++98 compilers are         |
+|              |   installed in VM images;                                    |
+|              | * For SPECfp 2006: All three of C99, C++98 and Fortran-95    |
+|              |   compilers installed in VM images;                          |
+|              | * At least 4GB of disk space availabile on VM.               |
+|              |                                                              |
+|              | gcc 4.8.* and g++ 4.8.* version have been tested in Ubuntu   |
+|              | 14.04, Ubuntu 16.04 and Redhat Enterprise Linux 7.4 image.   |
+|              | Higher gcc and g++ version may cause compiling error.        |
+|              |                                                              |
+|              | For more SPEC CPU 2006 dependencies please visit             |
+|              | (https://www.spec.org/cpu2006/Docs/techsupport.html)         |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |test sequence | description and expected result                              |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc087.rst b/docs/testing/user/userguide/opnfv_yardstick_tc087.rst
index d3aed6b..c112526 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc087.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc087.rst
@@ -10,7 +10,7 @@ Yardstick Test Case Description TC087
 +-----------------------------------------------------------------------------+
 |SDN Controller resilience in non-HA configuration                            |
 |                                                                             |
-+==============+==============================================================+
++--------------+--------------------------------------------------------------+
 |test case id  | OPNFV_YARDSTICK_TC087: SDN controller resilience in          |
 |              | non-HA configuration                                         |
 |              |                                                              |
@@ -41,6 +41,7 @@ Yardstick Test Case Description TC087
 +--------------+--------------------------------------------------------------+
 |attackers     | In this test case, an attacker called “kill-process” is      |
 |              | needed. This attacker includes three parameters:             |
+|              |                                                              |
 |              |  1. fault_type: which is used for finding the attacker's     |
 |              |     scripts. It should be set to 'kill-process' in this test |
 |              |                                                              |
@@ -58,6 +59,7 @@ Yardstick Test Case Description TC087
 |monitors      | This test case utilizes two monitors of type "ip-status"     |
 |              | and one monitor of type "process" to track the following     |
 |              | conditions:                                                  |
+|              |                                                              |
 |              |  1. "ping_same_network_l2": monitor ICMP traffic between     |
 |              |     VMs in the same Neutron network                          |
 |              |                                                              |
@@ -74,11 +76,13 @@ Yardstick Test Case Description TC087
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |operations    | In this test case, the following operations are needed:      |
+|              |                                                              |
 |              |  1. "nova-create-instance-in_network": create a VM instance  |
 |              |     in one of the existing Neutron network.                  |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |metrics       | In this test case, there are two metrics:                    |
+|              |                                                              |
 |              |  1. process_recover_time: which indicates the maximun        |
 |              |     time (seconds) from the process being killed to          |
 |              |     recovered                                                |
@@ -95,7 +99,9 @@ Yardstick Test Case Description TC087
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |configuration | This test case needs two configuration files:                |
+|              |                                                              |
 |              |  1. test case file: opnfv_yardstick_tc087.yaml               |
+|              |                                                              |
 |              |     - Attackers: see above “attackers” discription           |
 |              |     - waiting_time: which is the time (seconds) from the     |
 |              |       process being killed to stoping monitors the monitors  |
@@ -126,7 +132,7 @@ Yardstick Test Case Description TC087
 |              |     Neutron network.                                         |
 |              |                                                              |
 |              |  2. Check connectivity from one VM to an external host on    |
-|              |     the Internet to verify SNAT functionality.
+|              |     the Internet to verify SNAT functionality.               |
 |              |                                                              |
 |              | Result: The monitor info will be collected.                  |
 |              |                                                              |
@@ -171,11 +177,14 @@ Yardstick Test Case Description TC087
 |test verdict  | This test fails if the SLAs are not met or if there is a     |
 |              | test case execution problem. The SLAs are define as follows  |
 |              | for this test:                                               |
+|              |                                                              |
 |              |  * SDN Controller recovery                                   |
+|              |                                                              |
 |              |    * process_recover_time <= 30 sec                          |
 |              |                                                              |
 |              |  * no impact on data plane connectivity during SDN           |
 |              |    controller failure and recovery.                          |
+|              |                                                              |
 |              |    * packet_drop == 0                                        |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc092.rst b/docs/testing/user/userguide/opnfv_yardstick_tc092.rst
index 895074a..9c833fa 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc092.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc092.rst
@@ -43,6 +43,7 @@ Yardstick Test Case Description TC092
 +--------------+--------------------------------------------------------------+
 |attackers     | In this test case, an attacker called “kill-process” is      |
 |              | needed. This attacker includes three parameters:             |
+|              |                                                              |
 |              |  1. ``fault_type``: which is used for finding the attacker's |
 |              |     scripts. It should be set to 'kill-process' in this test |
 |              |                                                              |
@@ -92,17 +93,20 @@ Yardstick Test Case Description TC092
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |configuration | This test case needs two configuration files:                |
-|              |  1. test case file: opnfv_yardstick_tc092.yaml               |
-|              |     - Attackers: see above “attackers” discription           |
-|              |     - Monitors: see above “monitors” discription             |
-|              |       - waiting_time: which is the time (seconds) from the   |
-|              |         process being killed to stoping monitors the         |
-|              |         monitors                                             |
-|              |     - SLA: see above “metrics” discription                   |
+|              | 1. test case file: opnfv_yardstick_tc092.yaml                |
+|              |                                                              |
+|              |    - Attackers: see above “attackers” discription            |
+|              |    - Monitors: see above “monitors” discription              |
+|              |                                                              |
+|              |      - waiting_time: which is the time (seconds) from the    |
+|              |        process being killed to stoping monitors the          |
+|              |        monitors                                              |
 |              |                                                              |
-|              |  2. POD file: pod.yaml The POD configuration should record   |
-|              |     on pod.yaml first. the “host” item in this test case     |
-|              |     will use the node name in the pod.yaml.                  |
+|              |    - SLA: see above “metrics” discription                    |
+|              |                                                              |
+|              | 2. POD file: pod.yaml The POD configuration should record    |
+|              |    on pod.yaml first. the “host” item in this test case      |
+|              |    will use the node name in the pod.yaml.                   |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |test sequence | Description and expected result                              |
@@ -168,11 +172,12 @@ Yardstick Test Case Description TC092
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
 |step 8        | Start IP connectivity monitors for the  new VM:              |
-|              |  1. Check the L2 connectivity from the existing VMs to the   |
-|              |     new VM in the Neutron network.                           |
 |              |                                                              |
-|              |  2. Check connectivity from one VM to an external host on    |
-|              |     the Internet to verify SNAT functionality.               |
+|              | 1. Check the L2 connectivity from the existing VMs to the    |
+|              |    new VM in the Neutron network.                            |
+|              |                                                              |
+|              | 2. Check connectivity from one VM to an external host on     |
+|              |    the Internet to verify SNAT functionality.                |
 |              |                                                              |
 |              | Result: The monitor info will be collected.                  |
 |              |                                                              |

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc093.rst b/docs/testing/user/userguide/opnfv_yardstick_tc093.rst
index 31fa5d3..4e22e8b 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc093.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc093.rst
@@ -43,14 +43,15 @@ Yardstick Test Case Description TC093
 +--------------+--------------------------------------------------------------+
 |attackers     | In this test case, two attackers called “kill-process” are   |
 |              | needed. These attackers include three parameters:            |
-|              |  1. fault_type: which is used for finding the attacker's     |
-|              |     scripts. It should be set to 'kill-process' in this test |
 |              |                                                              |
-|              |  2. process_name: should be set to the name of the Vswitch   |
-|              |     process                                                  |
+|              | 1. fault_type: which is used for finding the attacker's      |
+|              |    scripts. It should be set to 'kill-process' in this test  |
 |              |                                                              |
-|              |  3. host: which is the name of the compute node where the    |
-|              |     Vswitch process is running                               |
+|              | 2. process_name: should be set to the name of the Vswitch    |
+|              |    process                                                   |
+|              |                                                              |
+|              | 3. host: which is the name of the compute node where the     |
+|              |    Vswitch process is running                                |
 |              |                                                              |
 |              | e.g. -fault_type: "kill-process"                             |
 |              |      -process_name: "openvswitch"                            |
@@ -60,16 +61,17 @@ Yardstick Test Case Description TC093
 |monitors      | This test case utilizes two monitors of type "ip-status"     |
 |              | and one monitor of type "process" to track the following     |
 |              | conditions:                                                  |
-|              |  1. "ping_same_network_l2": monitor ICMP traffic between     |
-|              |     VMs in the same Neutron network                          |
 |              |                                                              |
-|              |  2. "ping_external_snat": monitor ICMP traffic from VMs to   |
-|              |     an external host on the Internet to verify SNAT          |
-|              |     functionality.                                           |
+|              | 1. "ping_same_network_l2": monitor ICMP traffic between      |
+|              |    VMs in the same Neutron network                           |
+|              |                                                              |
+|              | 2. "ping_external_snat": monitor ICMP traffic from VMs to    |
+|              |    an external host on the Internet to verify SNAT           |
+|              |    functionality.                                            |
 |              |                                                              |
-|              |  3. "Vswitch process monitor": a monitor checking the        |
-|              |     state of the specified Vswitch process. It measures      |
-|              |     the recovery time of the given process.                  |
+|              | 3. "Vswitch process monitor": a monitor checking the         |
+|              |    state of the specified Vswitch process. It measures       |
+|              |    the recovery time of the given process.                   |
 |              |                                                              |
 |              | Monitors of type "ip-status" use the "ping" utility to       |
 |              | verify reachability of a given target IP.                    |
@@ -99,6 +101,7 @@ Yardstick Test Case Description TC093
 +--------------+--------------------------------------------------------------+
 |configuration | This test case needs two configuration files:                |
 |              |  1. test case file: opnfv_yardstick_tc093.yaml               |
+|              |                                                              |
 |              |     - Attackers: see above “attackers” description           |
 |              |     - monitor_time: which is the time (seconds) from         |
 |              |       starting to stoping the monitors                       |
@@ -173,12 +176,14 @@ Yardstick Test Case Description TC093
 |test verdict  | This test fails if the SLAs are not met or if there is a     |
 |              | test case execution problem. The SLAs are define as follows  |
 |              | for this test:                                               |
-|              |  * SDN Vswitch recovery                                      |
-|              |    * process_recover_time <= 30 sec                          |
+|              | * SDN Vswitch recovery                                       |
+|              |                                                              |
+|              |   * process_recover_time <= 30 sec                           |
+|              |                                                              |
+|              | * no impact on data plane connectivity during SDN            |
+|              |   Vswitch failure and recovery.                              |
 |              |                                                              |
-|              |  * no impact on data plane connectivity during SDN           |
-|              |    Vswitch failure and recovery.                             |
-|              |    * packet_drop == 0                                        |
+|              |   * packet_drop == 0                                         |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+