diff options
Diffstat (limited to 'docs/yardstick')
| -rw-r--r-- | docs/yardstick/index.rst | 21 | ||||
| -rw-r--r-- | docs/yardstick/opnfv_yardstick_tc001.rst | 8 | ||||
| -rw-r--r-- | docs/yardstick/opnfv_yardstick_tc002.rst | 6 | ||||
| -rw-r--r-- | docs/yardstick/opnfv_yardstick_tc012.rst | 8 |
4 files changed, 26 insertions, 17 deletions
diff --git a/docs/yardstick/index.rst b/docs/yardstick/index.rst new file mode 100644 index 000000000..b14670bdd --- /dev/null +++ b/docs/yardstick/index.rst @@ -0,0 +1,21 @@ +====================== +Yardstick Config Guide +====================== + +Test Case Descriptions +====================== + +.. toctree:: + :maxdepth: 1 + + opnfv_yardstick_tc001.rst + opnfv_yardstick_tc002.rst + +Templates +========= + +.. toctree:: + :maxdepth: 1 + + ../templates/Yardstick_task_templates + ../templates/testcase_description_v2_template diff --git a/docs/yardstick/opnfv_yardstick_tc001.rst b/docs/yardstick/opnfv_yardstick_tc001.rst index 72ba68e9f..16c9d2c60 100644 --- a/docs/yardstick/opnfv_yardstick_tc001.rst +++ b/docs/yardstick/opnfv_yardstick_tc001.rst @@ -1,9 +1,3 @@ -.. image:: ../../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - ************************************* Yardstick Test Case Description TC001 ************************************* @@ -68,4 +62,4 @@ Yardstick Test Case Description TC001 +--------------+------+----------------------------------+--------------------+ |test verdict | Fails only if SLA is not passed, or if there is a test case | | | execution problem. | -+--------------+--------------------------------------------------------------+
\ No newline at end of file ++--------------+--------------------------------------------------------------+ diff --git a/docs/yardstick/opnfv_yardstick_tc002.rst b/docs/yardstick/opnfv_yardstick_tc002.rst index fb1b4694f..bc795bf38 100644 --- a/docs/yardstick/opnfv_yardstick_tc002.rst +++ b/docs/yardstick/opnfv_yardstick_tc002.rst @@ -1,9 +1,3 @@ -.. image:: ../../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - ************************************* Yardstick Test Case Description TC002 ************************************* diff --git a/docs/yardstick/opnfv_yardstick_tc012.rst b/docs/yardstick/opnfv_yardstick_tc012.rst index 0c8e9c02a..b5768c0c5 100644 --- a/docs/yardstick/opnfv_yardstick_tc012.rst +++ b/docs/yardstick/opnfv_yardstick_tc012.rst @@ -1,4 +1,3 @@ - ************************************* Yardstick Test Case Description TC012 ************************************* @@ -15,7 +14,7 @@ Yardstick Test Case Description TC012 +--------------+--------------------------------------------------------------+ |configuration | File: opnfv_yardstick_tc012.yaml | | | | -| | * SLA (optional): 15000 (MBps) | +| | * SLA (optional): 15000 (MBps) | | | min_bw: The minimum amount of memory bandwidth that is | | | accepted. | | | * Size: 10 240 kB - test allocates twice that size (20 480kB)| @@ -41,8 +40,8 @@ Yardstick Test Case Description TC012 |references | * http://manpages.ubuntu.com/manpages/trusty/bw_mem.8.html | | | | | | * McVoy, Larry W., and Carl Staelin. "lmbench: Portable Tools| -| | for Performance Analysis." *USENIX annual technical | -| | conference*. 1996. | +| | for Performance Analysis." | +| | * USENIX annual technical conference. 1996. | +--------------+--------------------------------------------------------------+ |applicability | Test can be configured with different | | | * memory sizes; | @@ -50,6 +49,7 @@ Yardstick Test Case Description TC012 | | fcp, bzero, bcopy); | | | * number of warmup iterations; | | | * iterations and intervals. | +| | | | | There are default values for each above-mentioned option. | +--------------+--------------------------------------------------------------+ |pre-test | The test case image needs to be installed into Glance | |