From 356b48fe5c6fa77a4cb77f483a0c0e95a708a67c Mon Sep 17 00:00:00 2001 From: JingLu5 Date: Wed, 10 Aug 2016 09:52:13 +0800 Subject: BugFix: fix userguide format bugs Change-Id: Ib8709a2f233333af7a75cbbf42e0507e0713ac72 Signed-off-by: JingLu5 --- docs/userguide/opnfv_yardstick_tc001.rst | 17 +++++++++-------- docs/userguide/opnfv_yardstick_tc011.rst | 6 +++--- docs/userguide/opnfv_yardstick_tc043.rst | 5 +++-- docs/userguide/opnfv_yardstick_tc069.rst | 25 +++++++++++++++---------- 4 files changed, 30 insertions(+), 23 deletions(-) diff --git a/docs/userguide/opnfv_yardstick_tc001.rst b/docs/userguide/opnfv_yardstick_tc001.rst index 4cf4b94a4..fac375d50 100644 --- a/docs/userguide/opnfv_yardstick_tc001.rst +++ b/docs/userguide/opnfv_yardstick_tc001.rst @@ -21,14 +21,14 @@ Yardstick Test Case Description TC001 +--------------+--------------------------------------------------------------+ |test purpose | To evaluate the IaaS network performance with regards to | | | flows and throughput, such as if and how different amounts | -| | of flows matter for the throughput between hosts on different| -| | compute blades. Typically e.g. the performance of a vSwitch | -| | depends on the number of flows running through it. Also | -| | performance of other equipment or entities can depend | +| | of flows matter for the throughput between hosts on | +| | different compute blades. Typically e.g. the performance of | +| | a vSwitch depends on the number of flows running through it. | +| | Also performance of other equipment or entities can depend | | | on the number of flows or the packet sizes used. | | | The purpose is also to be able to spot trends. Test results, | -| | graphs ans similar shall be stored for comparison reasons and| -| | product evolution understanding between different OPNFV | +| | graphs ans similar shall be stored for comparison reasons | +| | and product evolution understanding between different OPNFV | | | versions and/or configurations. | | | | +--------------+--------------------------------------------------------------+ @@ -37,7 +37,8 @@ Yardstick Test Case Description TC001 | | Packet size: 60 bytes | | | Number of ports: 10, 50, 100, 500 and 1000, where each | | | runs for 20 seconds. The whole sequence is run | -| | twice. The client and server are distributed on different HW.| +| | twice. The client and server are distributed on different | +| | HW. | | | For SLA max_ppm is set to 1000. The amount of configured | | | ports map to between 110 up to 1001000 flows, respectively. | | | | @@ -60,7 +61,7 @@ Yardstick Test Case Description TC001 | | of flows and test duration. Default values exist. | | | | | | SLA (optional): max_ppm: The number of packets per million | -| | packets sent that are acceptable to loose, not received. | +| | packets sent that are acceptable to loose, not received. | | | | +--------------+--------------------------------------------------------------+ |pre-test | The test case image needs to be installed into Glance | diff --git a/docs/userguide/opnfv_yardstick_tc011.rst b/docs/userguide/opnfv_yardstick_tc011.rst index 1c643cd72..cf2fd5055 100644 --- a/docs/userguide/opnfv_yardstick_tc011.rst +++ b/docs/userguide/opnfv_yardstick_tc011.rst @@ -56,12 +56,12 @@ Yardstick Test Case Description TC011 | | ETSI-NFV-TST001 | | | | +--------------+--------------------------------------------------------------+ -|applicability | Test can be configured with different | +|applicability | Test can be configured with different: | | | | | | * bandwidth: Test case can be configured with different | -| | bandwidth | +| | bandwidth. | | | | -| | * duration: The test duration can be configured | +| | * duration: The test duration can be configured. | | | | | | * jitter: SLA is optional. The SLA in this test case | | | serves as an example. | diff --git a/docs/userguide/opnfv_yardstick_tc043.rst b/docs/userguide/opnfv_yardstick_tc043.rst index 2f907e9ef..b6e557d86 100644 --- a/docs/userguide/opnfv_yardstick_tc043.rst +++ b/docs/userguide/opnfv_yardstick_tc043.rst @@ -13,8 +13,9 @@ Yardstick Test Case Description TC043 |Network Latency Between NFVI Nodes | | | +--------------+--------------------------------------------------------------+ -|test case id | OPNFV_YARDSTICK_TC043_Latency_between_ | -| | NFVI_nodes_measurements | +|test case id | OPNFV_YARDSTICK_TC043_Latency_between_NFVI_nodes_ | +| | measurements | +| | | +--------------+--------------------------------------------------------------+ |metric | RTT, Round Trip Time | | | | diff --git a/docs/userguide/opnfv_yardstick_tc069.rst b/docs/userguide/opnfv_yardstick_tc069.rst index 51807e246..af0e64fbf 100644 --- a/docs/userguide/opnfv_yardstick_tc069.rst +++ b/docs/userguide/opnfv_yardstick_tc069.rst @@ -9,6 +9,9 @@ Yardstick Test Case Description TC069 .. _RAMspeed: http://alasir.com/software/ramspeed/ +.. table:: + :class: longtable + +-----------------------------------------------------------------------------+ |Memory Bandwidth | | | @@ -25,9 +28,9 @@ Yardstick Test Case Description TC069 | | while reading and writing certain blocks of data (starting | | | from 1Kb and further in power of 2) continuously through ALU | | | and FPU respectively. | -| | Measure different aspects of memory performance via synthetic| -| | simulations. Each simulation consists of four performances | -| | (Copy, Scale, Add, Triad). | +| | Measure different aspects of memory performance via | +| | synthetic simulations. Each simulation consists of four | +| | performances (Copy, Scale, Add, Triad). | | | Test results, graphs and similar shall be stored for | | | comparison reasons and product evolution understanding | | | between different OPNFV versions and/or configurations. | @@ -37,12 +40,14 @@ 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): | +| | * type_id: 1 - runs a specified benchmark | +| | (by an ID number): | | | 1 -- INTmark [writing] 4 -- FLOATmark [writing] | | | 2 -- INTmark [reading] 5 -- FLOATmark [reading] | | | 3 -- INTmem 6 -- FLOATmem | -| | * block_size: 64 Megabytes - the maximum block size per array| -| | * load: 32 Gigabytes - the amount of data load per pass | +| | * block_size: 64 Megabytes - the maximum block | +| | size per array. | +| | * load: 32 Gigabytes - the amount of data load per pass. | | | * iterations: 5 - test is run 5 times iteratively. | | | * interval: 1 - there is 1 second delay between each | | | iteration. | @@ -52,8 +57,8 @@ Yardstick Test Case Description TC069 | | | | | RAMspeed is a free open source command line utility to | | | measure cache and memory performance of computer systems. | -| | RAMspeed is not always part of a Linux distribution, hence it| -| | needs to be installed in the test image. | +| | RAMspeed is not always part of a Linux distribution, hence | +| | it needs to be installed in the test image. | | | | +--------------+--------------------------------------------------------------+ |references | RAMspeed_ | @@ -83,8 +88,8 @@ Yardstick Test Case Description TC069 |test sequence | description and expected result | | | | +--------------+--------------------------------------------------------------+ -|step 1 | The host is installed as client. RAMspeed is invoked and logs| -| | are produced and stored. | +|step 1 | The host is installed as client. RAMspeed is invoked and | +| | logs are produced and stored. | | | | | | Result: logs are stored. | | | | -- cgit 1.2.3-korg