summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatthewLi <matthew.lijun@huawei.com>2016-07-29 04:37:01 -0400
committerMatthewLi <matthew.lijun@huawei.com>2016-07-29 04:37:01 -0400
commitabe93d77218222796a2d4b40a08dddd8273299c6 (patch)
treef1fdac0dc68e79d1eafdf95488736b0d37f86966 /docs
parent21086bde5d6a83cfd9271687c65f52dd53b6b95b (diff)
project document improvement
JIRA: BOTTLENECK-88 Change-Id: I963502bb494bfb8773b312f038e9a1ea9902e56e Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/configurationguide/README.rst63
-rw-r--r--docs/configurationguide/index.rst (renamed from docs/configguide/index.rst)6
-rw-r--r--docs/installationprocedure/bottlenecks_test_result.rst (renamed from docs/templates/bottlenecks_test_result.rst)8
-rw-r--r--docs/installationprocedure/index.rst14
-rw-r--r--docs/installationprocedure/rubbos_installation.rst (renamed from docs/userguide/rubbos/rubbos_installation.rst)8
-rw-r--r--docs/installationprocedure/vstf_installation.rst (renamed from docs/userguide/vstf/vstf_installation.rst)9
-rw-r--r--docs/platformoverview/index.rst12
-rw-r--r--docs/platformoverview/introduction.rst (renamed from docs/configguide/introduction.rst)10
-rw-r--r--docs/userguide/index.rst2
9 files changed, 117 insertions, 15 deletions
diff --git a/docs/configurationguide/README.rst b/docs/configurationguide/README.rst
new file mode 100644
index 0000000..51a476a
--- /dev/null
+++ b/docs/configurationguide/README.rst
@@ -0,0 +1,63 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+****************************
+Project General Test Methods
+****************************
+
+For each *test suite*, you can setup *test story* by including several *test cases*
+only with one configuration parameter different, by comparing the test results,
+you can see the influence of the configuration parameter.
+
+Brahmaputra: rubbos is introduced, which is an end2end NFVI perforamnce tool.
+Virtual switch test framework(VSTF) is also introduced,
+which is an test framework used for vswitch performance test.
+
+Colorado: rubbos is refactored by using puppet, which makes it quite flexible
+to configure with different number of load generator(Client), worker(tomcat).
+vstf is refactored by extracting the test case's configuration information.
+
+***********************************
+Test suite & Test case Description
+***********************************
++--------+-----------------------------+
+|Rubbos | rubbos_basic |
+| +-----------------------------+
+| | rubbos_TC1101 |
+| +-----------------------------+
+| | rubbos_TC1201 |
+| +-----------------------------+
+| | rubbos_TC1301 |
+| +-----------------------------+
+| | rubbos_TC1401 |
+| +-----------------------------+
+| | rubbos_heavy_TC1101 |
++--------+-----------------------------+
+|vstf | vstf_Ti1 |
+| +-----------------------------+
+| | vstf_Ti2 |
+| +-----------------------------+
+| | vstf_Ti3 |
+| +-----------------------------+
+| | vstf_Tn1 |
+| +-----------------------------+
+| | vstf_Tn2 |
+| +-----------------------------+
+| | vstf_Tu1 |
+| +-----------------------------+
+| | vstf_Tu2 |
+| +-----------------------------+
+| | vstf_Tu3 |
++--------+-----------------------------+
+
+***********************
+Integration Description
+***********************
++-------------+----------------------+
+| Release | integrated installer |
++-------------+----------------------+
+| Brahmaputra | Fuel |
++-------------+----------------------+
+| Colorado | Compass |
++-------------+----------------------+
diff --git a/docs/configguide/index.rst b/docs/configurationguide/index.rst
index 86c4764..be5a48f 100644
--- a/docs/configguide/index.rst
+++ b/docs/configurationguide/index.rst
@@ -1,6 +1,6 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International
-.. License.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
*****************************
Bottlenecks - configureguide
@@ -9,4 +9,4 @@ Bottlenecks - configureguide
.. toctree::
:maxdepth: 2
- ./introduction.rst
+ ./README.rst
diff --git a/docs/templates/bottlenecks_test_result.rst b/docs/installationprocedure/bottlenecks_test_result.rst
index c566cdd..f1a1773 100644
--- a/docs/templates/bottlenecks_test_result.rst
+++ b/docs/installationprocedure/bottlenecks_test_result.rst
@@ -1,6 +1,10 @@
-========================
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+*************************
Bottlenecks Test Report
-========================
+*************************
Scope
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
new file mode 100644
index 0000000..9e22af2
--- /dev/null
+++ b/docs/installationprocedure/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+*************************************
+Bottlenecks - installation prodedure
+*************************************
+
+.. toctree::
+ :maxdepth: 2
+
+ ./rubbos_installation.rst
+ ./vstf_installation.rst
+ ./bottlenecks_test_result.rst
diff --git a/docs/userguide/rubbos/rubbos_installation.rst b/docs/installationprocedure/rubbos_installation.rst
index 5b3583d..b93cd6e 100644
--- a/docs/userguide/rubbos/rubbos_installation.rst
+++ b/docs/installationprocedure/rubbos_installation.rst
@@ -1,6 +1,10 @@
-=====================================
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+**************************************
Bottlenecks Rubbos Installation Guide
-=====================================
+**************************************
Rubbos Introduction
diff --git a/docs/userguide/vstf/vstf_installation.rst b/docs/installationprocedure/vstf_installation.rst
index ad3ae39..7808065 100644
--- a/docs/userguide/vstf/vstf_installation.rst
+++ b/docs/installationprocedure/vstf_installation.rst
@@ -1,7 +1,10 @@
-===================================
-Bottlenecks VSTF Installation Guide
-===================================
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+************************************
+Bottlenecks VSTF Installation Guide
+************************************
VSTF Introduction
====================
diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
new file mode 100644
index 0000000..f46ec15
--- /dev/null
+++ b/docs/platformoverview/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+******************************
+Bottlenecks - platformoverview
+******************************
+
+.. toctree::
+ :maxdepth: 2
+
+ ./introduction.rst
diff --git a/docs/configguide/introduction.rst b/docs/platformoverview/introduction.rst
index cf00286..5850fa5 100644
--- a/docs/configguide/introduction.rst
+++ b/docs/platformoverview/introduction.rst
@@ -1,6 +1,10 @@
-============
-Introduction
-============
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+**************************
+Bottlenecks Introduction
+**************************
**Welcome to bottlenecks' documentation !**
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index ae5909c..6966571 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -11,14 +11,12 @@ Bottlenecks - user guide
.. toctree::
:maxdepth: 2
- ./rubbos/rubbos_installation.rst
./rubbos/opnfv_bottlenecks_rubbos_basic.rst
./rubbos/opnfv_bottlenecks_rubbos_tc1101.rst
./rubbos/opnfv_bottlenecks_rubbos_tc1201.rst
./rubbos/opnfv_bottlenecks_rubbos_tc1301.rst
./rubbos/opnfv_bottlenecks_rubbos_tc1401.rst
./rubbos/opnfv_bottlenecks_rubbos_heavy_tc1101.rst
- ./vstf/vstf_installation.rst
./vstf/opnfv_bottlenecks_vstf_Ti1.rst
./vstf/opnfv_bottlenecks_vstf_Ti2.rst
./vstf/opnfv_bottlenecks_vstf_Ti3.rst