Fix minor format details in tc descriptions

This change fixes minor formating in TC025, remove one extra line in TC028
and update 03-list-of-tcs.

The formating caused the pdf to fail.

Change-Id: I304335277b1fbc33b10d9a07245ebeef0612fc80
Signed-off-by: Ana C <ana.cunha@ericsson.com>
(cherry picked from commit 5c4c8667e0c0a8e039d7682f235b022f39149d56)

diff --git a/docs/configguide/yardstick_testcases/03-list-of-tcs.rst b/docs/configguide/yardstick_testcases/03-list-of-tcs.rst
index ac01b3d..d8d9632 100644 (file)
--- a/docs/configguide/yardstick_testcases/03-list-of-tcs.rst
+++ b/docs/configguide/yardstick_testcases/03-list-of-tcs.rst
@@ -29,15 +29,21 @@ Generic NFVI Test Case Descriptions
    opnfv_yardstick_tc010.rst
    opnfv_yardstick_tc012.rst
    opnfv_yardstick_tc014.rst
-   opnfv_yardstick_tc019.rst
-   opnfv_yardstick_tc025.rst
-   opnfv_yardstick_tc028.rst
    opnfv_yardstick_tc037.rst
    opnfv_yardstick_tc038.rst
 
 OPNFV Feature Test Cases
 ========================
 
+H A
+---
+
+.. toctree::
+   :maxdepth: 1
+
+   opnfv_yardstick_tc019.rst
+   opnfv_yardstick_tc025.rst
+
 IPv6
 ----
 
@@ -46,6 +52,14 @@ IPv6
 
    opnfv_yardstick_tc027.rst
 
+KVM
+---
+
+.. toctree::
+   :maxdepth: 1
+
+   opnfv_yardstick_tc028.rst
+
 Parser
 ------
 

diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc025.rst b/docs/configguide/yardstick_testcases/opnfv_yardstick_tc025.rst
index f01bd3b..947bd64 100644 (file)
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc025.rst
+++ b/docs/configguide/yardstick_testcases/opnfv_yardstick_tc025.rst
@@ -1,26 +1,24 @@
-.. image:: ../../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
 *************************************
 Yardstick Test Case Description TC025
 *************************************
 
 +-----------------------------------------------------------------------------+
 |OpenStack Controll Node abnormally shutdown High Availability                |
-+==============+==============================================================+
+|                                                                             |
++--------------+--------------------------------------------------------------+
 |test case id  | OPNFV_YARDSTICK_TC025_HA: OpenStack Controll Node abnormally |
 |              | shutdown                                                     |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |test purpose  | This test case will verify the high availability of control  |
 |              | nodethe. When one of the control node abnormally shutdown,   |
 |              | the service provided by it should be OK.                     |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |test method   | This test case shutdowns a specified control node with some  |
 |              | fault injection tools, then checks whether all services      |
 |              | provided by the control node are OK with some monitor tools. |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |attackers     | In this test case, an attacker called "host-shutdown" is     |
 |              | needed. This attacker includes two parameters:               |
@@ -32,6 +30,7 @@ Yardstick Test Case Description TC025
 |              | e.g.                                                         |
 |              | -fault_type: "host-shutdown"                                 |
 |              | -host: node1                                                 |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |monitors      | In this test case, one kind of monitor are needed:           |
 |              | 1. the "openstack-cmd" monitor constantly request a specific |
@@ -54,14 +53,18 @@ Yardstick Test Case Description TC025
 |              | monitor4:                                                    |
 |              | -monitor_type: "openstack-cmd"                               |
 |              | -api_name: "cinder list"                                     |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |metrics       | In this test case, there is one metric:                      |
 |              | 1)service_outage_time: which indicates the maximum outage    |
 |              | time (seconds) of the specified Openstack command request.   |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |test tool     | None. Self-developed.                                        |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |references    | ETSI NFV REL001                                              |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |configuration | This test case needs two configuration files:                |
 |              | 1) test case file: opnfv_yardstick_tc019.yaml                |
@@ -75,25 +78,39 @@ Yardstick Test Case Description TC025
 |              | 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 | step | description                      | result             |
-|              +------+----------------------------------+--------------------+
-|              |  1   | start monitors: each monitor will| The monitor info   |
-|              |      | run with independently process   | will be collected. |
-|              +------+----------------------------------+--------------------+
-|              |  2   | do attacker: connect the host    | the host will be   |
-|              |      | through SSH, and then execute    | shutdown.          |
-|              |      | shutdown script on the host      |                    |
-|              +------+----------------------------------+--------------------+
-|              |  3   | stop monitors after a period of  | All monitor result |
-|              |      | time specified by "waiting_time" | will be aggregated.|
-|              +------+----------------------------------+--------------------+
-|              |  4   | verify the SLA                   | The test case is   |
-|              |      |                                  | passed or not.     |
-+--------------+------+----------------------------------+--------------------+
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test sequence | description and expected result                              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 1        | start monitors:                                              |
+|              | each monitor will run with independently process             |
+|              |                                                              |
+|              | Result: The monitor info will be collected.                  |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 2        | do attacker: connect the host through SSH, and then execute  |
+|              | shutdown script on the host                                  |
+|              |                                                              |
+|              | Result: The host will be shutdown.                           |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 3        | stop monitors after a period of time specified by            |
+|              | "waiting_time"                                               |
+|              |                                                              |
+|              | Result: All monitor result will be aggregated.               |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 4        | verify the SLA                                               |
+|              |                                                              |
+|              | Result: The test case is passed or not.                      |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
 |post-action   | It is the action when the test cases exist. It restarts the  |
 |              | specified control node if it is not restarted.               |
-+--------------+------+----------------------------------+--------------------+
+|              |                                                              |
++--------------+--------------------------------------------------------------+
 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
 |              | execution problem.                                           |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+

diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc028.rst b/docs/configguide/yardstick_testcases/opnfv_yardstick_tc028.rst
index 8b6db11..8ac5f49 100644 (file)
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc028.rst
+++ b/docs/configguide/yardstick_testcases/opnfv_yardstick_tc028.rst
@@ -63,4 +63,3 @@ Yardstick Test Case Description TC028
 |              | execution problem.                                           |
 |              |                                                              |
 +--------------+--------------------------------------------------------------+
-