diff options
| author |   yuyang <Gabriel.yuyang@huawei.com> | 2017-03-22 18:24:46 +0800 |
|---|---|---|
| committer | yuyang <Gabriel.yuyang@huawei.com> | 2017-03-22 18:24:46 +0800 |
| commit | 3bc1b97e2a594959a9966c6f967e50fa33d2893b (patch) | |
| tree | 9803e0c05baeafdd1e372e181f5818dfaf481ef9 /docs/testing/user/userguide | |
| parent | 0300c5099b234fe02330c16ea06856dadf72fc8f (diff) | |
Update docs structure according to Danube agreement
JIRA: BOTTLENECK-141
docs.opnfv.org has trouble indexing all the testing docs.
So testing projects have to adjust the docs structure.
Change-Id: I586b2c1626ca4fb8e1980130e132e6079a0977a7
Signed-off-by: yuyang <Gabriel.yuyang@huawei.com>
Diffstat (limited to 'docs/testing/user/userguide')
17 files changed, 534 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst new file mode 100644 index 00000000..8afd57ab --- /dev/null +++ b/docs/testing/user/userguide/index.rst @@ -0,0 +1,29 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +************************** +Bottlenecks - User Guide +************************** + +.. This index.rst file is used to structure and organise the content in these directories. +.. The documentation toolchain will create web and pdf versions of the content of this file. + +.. toctree:: + :maxdepth: 2 + + ./rubbos/rubbos_basic.rst + ./rubbos/rubbos_tc1101.rst + ./rubbos/rubbos_tc1201.rst + ./rubbos/rubbos_tc1301.rst + ./rubbos/rubbos_tc1401.rst + ./rubbos/rubbos_heavy_tc1101.rst + ./vstf/vstf_Ti1.rst + ./vstf/vstf_Ti2.rst + ./vstf/vstf_Ti3.rst + ./vstf/vstf_Tn1.rst + ./vstf/vstf_Tn2.rst + ./vstf/vstf_Tu1.rst + ./vstf/vstf_Tu2.rst + ./vstf/vstf_Tu3.rst + ./posca/posca_stress_ping.rst + ./posca/posca_stress_traffic.rst diff --git a/docs/testing/user/userguide/posca/posca_stress_ping.rst b/docs/testing/user/userguide/posca/posca_stress_ping.rst new file mode 100644 index 00000000..846b4686 --- /dev/null +++ b/docs/testing/user/userguide/posca/posca_stress_ping.rst @@ -0,0 +1,52 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +*************************************************** +POSCA Stress (Factor) Test of Perfomance Life-Cycle +*************************************************** + +Test Case +======== + ++-----------------------------------------------------------------------------+ +|Bottlenecks POSCA Stress Test Ping | +| | ++--------------+--------------------------------------------------------------+ +|test case name| posca_stress_ping | +| | | ++--------------+--------------------------------------------------------------+ +|description | Stress test regarding perfomance life-cycle while using ping | +| | to validate the VM pairs constructions | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/posca/testcase_cfg/posca_stress_ping | +| | | +| | stack number: 5, 10, 20, 50 ... | +| | | ++--------------+--------------------------------------------------------------+ +|test result | PKT loss rate, success rate, test time, latency | +| | | ++--------------+--------------------------------------------------------------+ + +Configuration +============ +load_manager: + scenarios: + tool: ping + test_times: 100 + package_size: + num_stack: 2, 5, 10 + package_loss: 10% + + contexts: + stack_create: yardstick + flavor: + yardstick_test_ip: + yardstick_test_dir: "samples" + yardstick_testcase: "ping_bottlenecks" + +dashboard: + dashboard: "y" + dashboard_ip: diff --git a/docs/testing/user/userguide/posca/posca_stress_traffic.rst b/docs/testing/user/userguide/posca/posca_stress_traffic.rst new file mode 100644 index 00000000..a995996e --- /dev/null +++ b/docs/testing/user/userguide/posca/posca_stress_traffic.rst @@ -0,0 +1,49 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +********************************************** +POSCA Stress (Factor) Test of System bandwidth +********************************************** + + +Test Case +======== ++-----------------------------------------------------------------------------+ +|Bottlenecks POSCA Stress Test Traffic | +| | ++--------------+--------------------------------------------------------------+ +|test case name| posca_stress_ping | +| | | ++--------------+--------------------------------------------------------------+ +|description | Stress test regarding baseline of the system for a single | +| | user, i.e., a VM pair while increasing the package size | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/posca/testcase_cfg/posca_factor_system_bandwith | +| | | +| | stack number: 1 | +| | | ++--------------+--------------------------------------------------------------+ +|test result | PKT loss rate, latency, throupht, cpu usage | +| | | ++--------------+--------------------------------------------------------------+ + +Configration +=========== +test_config: + tool: netperf + protocol: tcp + test_time: 20 + tx_pkt_sizes: 64, 256, 1024, 4096, 8192, 16384, 32768, 65536 + rx_pkt_sizes: 64, 256, 1024, 4096, 8192, 16384, 32768, 65536 + cpu_load: 0.9 + latency: 100000 +runner_config: + dashboard: "y" + dashboard_ip: + stack_create: yardstick + yardstick_test_ip: + yardstick_test_dir: "samples" + yardstick_testcase: "netperf_bottlenecks" diff --git a/docs/testing/user/userguide/rubbos/rubbos_basic.rst b/docs/testing/user/userguide/rubbos/rubbos_basic.rst new file mode 100644 index 00000000..ffef6c48 --- /dev/null +++ b/docs/testing/user/userguide/rubbos/rubbos_basic.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +************************************************ +Bottlenecks Rubbos Test Case Description Basic +************************************************ + + ++-----------------------------------------------------------------------------+ +|Bottlenecks Rubbos Basic | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_rubbos_Basic | +| | | ++--------------+--------------------------------------------------------------+ +|description | Rubbos platform for 1 tomcat, 1 Apache and 1 mysql. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/rubbos/testcase_cfg/rubbos_basic.yaml | +| | | +| | client number: 1 | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/rubbos/rubbos_heavy_tc1101.rst b/docs/testing/user/userguide/rubbos/rubbos_heavy_tc1101.rst new file mode 100644 index 00000000..08251c7b --- /dev/null +++ b/docs/testing/user/userguide/rubbos/rubbos_heavy_tc1101.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +****************************************************** +Bottlenecks Rubbos Test Case Description Heavy TC1101 +****************************************************** + + ++-----------------------------------------------------------------------------+ +|Bottlenecks Rubbos TC Heavy1101 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_rubbos_heavy_tc1101 | +| | | ++--------------+--------------------------------------------------------------+ +|description | Rubbos platform for 1 tomcat, 1 Apache and 1 mysql. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/rubbos/testcase_cfg/rubbos-heavy_1-1-0-1.yaml | +| | | +| | client number: 10 | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/rubbos/rubbos_tc1101.rst b/docs/testing/user/userguide/rubbos/rubbos_tc1101.rst new file mode 100644 index 00000000..2a261313 --- /dev/null +++ b/docs/testing/user/userguide/rubbos/rubbos_tc1101.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +************************************************ +Bottlenecks Rubbos Test Case Description TC1101 +************************************************ + + ++-----------------------------------------------------------------------------+ +|Bottlenecks Rubbos TC1101 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_rubbos_tc1101 | +| | | ++--------------+--------------------------------------------------------------+ +|description | Rubbos platform for 1 tomcat, 1 Apache and 1 mysql. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/rubbos/testcase_cfg/rubbos_1-1-0-1.yaml | +| | | +| | client number: 5 | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/rubbos/rubbos_tc1201.rst b/docs/testing/user/userguide/rubbos/rubbos_tc1201.rst new file mode 100644 index 00000000..9b6a5f99 --- /dev/null +++ b/docs/testing/user/userguide/rubbos/rubbos_tc1201.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +************************************************ +Bottlenecks Rubbos Test Case Description TC1201 +************************************************ + + ++-----------------------------------------------------------------------------+ +|Bottlenecks Rubbos TC1201 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_rubbos_tc1201 | +| | | ++--------------+--------------------------------------------------------------+ +|description | Rubbos platform for 1 Apache, 2 tomcat and 1 mysql. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/rubbos/testcase_cfg/rubbos_1-2-0-1.yaml | +| | | +| | client number: 5 | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/rubbos/rubbos_tc1301.rst b/docs/testing/user/userguide/rubbos/rubbos_tc1301.rst new file mode 100644 index 00000000..db4e0b63 --- /dev/null +++ b/docs/testing/user/userguide/rubbos/rubbos_tc1301.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +************************************************ +Bottlenecks Rubbos Test Case Description TC1301 +************************************************ + + ++-----------------------------------------------------------------------------+ +|Bottlenecks Rubbos TC1301 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_rubbos_tc1301 | +| | | ++--------------+--------------------------------------------------------------+ +|description | Rubbos platform for 1 Apache, 3 tomcat and 1 mysql. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/rubbos/testcase_cfg/rubbos_1-3-0-1.yaml | +| | | +| | client number: 5 | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/rubbos/rubbos_tc1401.rst b/docs/testing/user/userguide/rubbos/rubbos_tc1401.rst new file mode 100644 index 00000000..f195d237 --- /dev/null +++ b/docs/testing/user/userguide/rubbos/rubbos_tc1401.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +************************************************ +Bottlenecks Rubbos Test Case Description TC1401 +************************************************ + + ++-----------------------------------------------------------------------------+ +|Bottlenecks Rubbos TC1401 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_rubbos_tc1401 | +| | | ++--------------+--------------------------------------------------------------+ +|description | Rubbos platform for 1 Apache, 4 tomcat and 1 mysql. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/rubbos/testcase_cfg/rubbos_1-4-0-1.yaml | +| | | +| | client number: 5 | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/vstf/vstf_Ti1.rst b/docs/testing/user/userguide/vstf/vstf_Ti1.rst new file mode 100644 index 00000000..ce1690b4 --- /dev/null +++ b/docs/testing/user/userguide/vstf/vstf_Ti1.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +******************************************************************* +Bottlenecks vSwitch Test Framework(VSTF) Test Case Description Ti1 +******************************************************************* + + ++-----------------------------------------------------------------------------+ +|Bottlenecks VSTF Ti1 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_vstf_Ti1 | +| | | ++--------------+--------------------------------------------------------------+ +|description | vSwitch test Ti1. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/vstf/testcase_cfg/vstf_Ti1.yaml | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput & latency | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/vstf/vstf_Ti2.rst b/docs/testing/user/userguide/vstf/vstf_Ti2.rst new file mode 100644 index 00000000..58cb40f7 --- /dev/null +++ b/docs/testing/user/userguide/vstf/vstf_Ti2.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +******************************************************************* +Bottlenecks vSwitch Test Framework(VSTF) Test Case Description Ti2 +******************************************************************* + + ++-----------------------------------------------------------------------------+ +|Bottlenecks VSTF Ti2 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_vstf_Ti2 | +| | | ++--------------+--------------------------------------------------------------+ +|description | vSwitch test Ti2. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/vstf/testcase_cfg/vstf_Ti2.yaml | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput & latency | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/vstf/vstf_Ti3.rst b/docs/testing/user/userguide/vstf/vstf_Ti3.rst new file mode 100644 index 00000000..3bb9dfce --- /dev/null +++ b/docs/testing/user/userguide/vstf/vstf_Ti3.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +******************************************************************* +Bottlenecks vSwitch Test Framework(VSTF) Test Case Description Ti3 +******************************************************************* + + ++-----------------------------------------------------------------------------+ +|Bottlenecks VSTF Ti3 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_vstf_Ti3 | +| | | ++--------------+--------------------------------------------------------------+ +|description | vSwitch test Ti3. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/vstf/testcase_cfg/vstf_Ti3.yaml | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput & latency | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/vstf/vstf_Tn1.rst b/docs/testing/user/userguide/vstf/vstf_Tn1.rst new file mode 100644 index 00000000..5c591a9b --- /dev/null +++ b/docs/testing/user/userguide/vstf/vstf_Tn1.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +******************************************************************* +Bottlenecks vSwitch Test Framework(VSTF) Test Case Description Tn1 +******************************************************************* + + ++-----------------------------------------------------------------------------+ +|Bottlenecks VSTF Tn1 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_vstf_Tn1 | +| | | ++--------------+--------------------------------------------------------------+ +|description | vSwitch test Tn1. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/vstf/testcase_cfg/vstf_Tn1.yaml | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput & latency | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/vstf/vstf_Tn2.rst b/docs/testing/user/userguide/vstf/vstf_Tn2.rst new file mode 100644 index 00000000..4b6d0c45 --- /dev/null +++ b/docs/testing/user/userguide/vstf/vstf_Tn2.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +******************************************************************* +Bottlenecks vSwitch Test Framework(VSTF) Test Case Description Tn2 +******************************************************************* + + ++-----------------------------------------------------------------------------+ +|Bottlenecks VSTF Tn2 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_vstf_Tn2 | +| | | ++--------------+--------------------------------------------------------------+ +|description | vSwitch test Tn2. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/vstf/testcase_cfg/vstf_Tn2.yaml | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput & latency | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/vstf/vstf_Tu1.rst b/docs/testing/user/userguide/vstf/vstf_Tu1.rst new file mode 100644 index 00000000..cf27bb25 --- /dev/null +++ b/docs/testing/user/userguide/vstf/vstf_Tu1.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +******************************************************************* +Bottlenecks vSwitch Test Framework(VSTF) Test Case Description Tu1 +******************************************************************* + + ++-----------------------------------------------------------------------------+ +|Bottlenecks VSTF Tu1 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_vstf_Tu1 | +| | | ++--------------+--------------------------------------------------------------+ +|description | vSwitch test Tu1. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/vstf/testcase_cfg/vstf_Tu1.yaml | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput & latency | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/vstf/vstf_Tu2.rst b/docs/testing/user/userguide/vstf/vstf_Tu2.rst new file mode 100644 index 00000000..2ae84467 --- /dev/null +++ b/docs/testing/user/userguide/vstf/vstf_Tu2.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +******************************************************************* +Bottlenecks vSwitch Test Framework(VSTF) Test Case Description Tu2 +******************************************************************* + + ++-----------------------------------------------------------------------------+ +|Bottlenecks VSTF Tu2 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_vstf_Tu2 | +| | | ++--------------+--------------------------------------------------------------+ +|description | vSwitch test Tu2. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/vstf/testcase_cfg/vstf_Tu2.yaml | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput & latency | +| | | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/testing/user/userguide/vstf/vstf_Tu3.rst b/docs/testing/user/userguide/vstf/vstf_Tu3.rst new file mode 100644 index 00000000..4e090f17 --- /dev/null +++ b/docs/testing/user/userguide/vstf/vstf_Tu3.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei Tech and others. + +******************************************************************* +Bottlenecks vSwitch Test Framework(VSTF) Test Case Description Tu3 +******************************************************************* + + ++-----------------------------------------------------------------------------+ +|Bottlenecks VSTF Tu3 | +| | ++--------------+--------------------------------------------------------------+ +|test case name| opnfv_bottlenecks_vstf_Tu3 | +| | | ++--------------+--------------------------------------------------------------+ +|description | vSwitch test Tu3. | +| | | ++--------------+--------------------------------------------------------------+ +|configuration | config file: | +| | /testsuite/vstf/testcase_cfg/vstf_Tu3.yaml | +| | | ++--------------+--------------------------------------------------------------+ +|test result | throughput & latency | +| | | ++--------------+--------------------------------------------------------------+ + |