diff options
author | yuyang <Gabriel.yuyang@huawei.com> | 2017-02-16 20:44:47 +0800 |
---|---|---|
committer | yuyang <Gabriel.yuyang@huawei.com> | 2017-02-23 13:00:27 +0800 |
commit | 81fba061911595953782299d2eb06c3014b8a890 (patch) | |
tree | 08d13ccef97b4ccceb0511c4668dcfd43ec2de59 /docs/release_notes | |
parent | be6453bb485c720278c5f6a45a5194391e454ce4 (diff) |
Add Danube Document Framework
JIRA: BOTTLENECK-137
Bottlenecks document framwork meeting Danube document requirement.
Changes:
1. Add POSCA testsuite document
2. Combine configuration and installation directory
2.1 https://wiki.opnfv.org/display/DEV/Documentation+Toolchain
3. Change file names in /user_guide
4. Add requirements notes to release notes
5. Add stress test configuartion details
Change-Id: I8d9055097ddae280d985120d4501819d20ad1dcb
Signed-off-by: yuyang <Gabriel.yuyang@huawei.com>
Diffstat (limited to 'docs/release_notes')
-rw-r--r-- | docs/release_notes/index.rst | 13 | ||||
-rw-r--r-- | docs/release_notes/release_notes.rst | 217 | ||||
-rw-r--r-- | docs/release_notes/requirements_notes.rst | 105 |
3 files changed, 335 insertions, 0 deletions
diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst new file mode 100644 index 00000000..622671cd --- /dev/null +++ b/docs/release_notes/index.rst @@ -0,0 +1,13 @@ +.. 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 - Release Notes +*************************** + +.. toctree:: + :maxdepth: 2 + + ./release_notes.rst + ./requirements_notes.rst diff --git a/docs/release_notes/release_notes.rst b/docs/release_notes/release_notes.rst new file mode 100644 index 00000000..76b5c1cf --- /dev/null +++ b/docs/release_notes/release_notes.rst @@ -0,0 +1,217 @@ +.. 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 Release Notes for OPNFV Danube Release +================================================== + +.. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks + + +Abstract +======== + +This document describes the release notes of Bottlenecks project. + + +License +======= + +OPNFV release notes for Bottlenecks Docs +are licensed under a Creative Commons Attribution 4.0 International License. +You should have received a copy of the license along with this. +If not, see <http://creativecommons.org/licenses/by/4.0/>. + +The *Bottlenecks software* is opensource software, licensed under the terms of the +Apache License, Version 2.0. + + +Version History +=============== + ++----------------+--------------------+---------------------------------+ +| *Date* | *Version* | *Comment* | +| | | | ++----------------+--------------------+---------------------------------+ +| Sept 22nd, 2016| 1.0 | Bottlenecks Colorado release 1.0| +| | | | ++----------------+--------------------+---------------------------------+ +| Feb 17nd, 2016 | 1.1 | Bottlenecks Danube release 1.0 | +| | | | ++----------------+--------------------+---------------------------------+ + + +Summary +======= + +* Documentation generated with Sphinx + + * User guide + + * Installation Procedure + + * Release Notes (this document) + + * Platform Overview + + * Configuration Guide + +* Bottlenecks test suite + + * Jenkins Jobs for OPNFV community labs + +* Bottlenecks framework + +* Bottlenecks test cases + +The *Bottlenecks software* is developed in the OPNFV community, by the +Bottlenecks_ team. + +Release Data +============ + +Bramaputra Release Data +----------------------- + ++--------------------------------------+--------------------------------------+ +| **Project** | Bottlenecks | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | Bottlenecks/brahmaputra.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Bottlenecks Docker image tag** | brahmaputra.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Brahmaputra base release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | February 25 2016 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Brahmaputra base release | +| | | ++--------------------------------------+--------------------------------------+ + +Colorado Release Data +----------------------- + ++--------------------------------------+--------------------------------------+ +| **Project** | Bottlenecks | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | Bottlenecks/colorado.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Bottlenecks Docker image tag** | colorado.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Colorado base release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | September 22 2016 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Colorado base release | +| | | ++--------------------------------------+--------------------------------------+ + +Colorado Release Data +----------------------- +* TODO + +Danube Deliverables +=================== + +Software Deliverables +--------------------- + +**Bottlenecks source code <danube.1.0>** + +* https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary + + +Documentatiion Deliverables +--------------------------- + +**Bottlenecks documentation <danube.1.0>** + +* Platformation Overview: http://artifacts.opnfv.org/bottlenecks/danube/1.0/docs/platformoverview/index.html +* Configuration Guide: http://artifacts.opnfv.org/bottlenecks/danube/1.0/configurationguide/index.html +* Installation Guide: http://artifacts.opnfv.org/bottlenecks/danube/docs/installationprocedure/index.html +* http://artifacts.opnfv.org/bottlenecks/danube/1.0/releasenotes/index.html +* User Guide: http://artifacts.opnfv.org/bottlenecks/danube/1.0/docs/userguide/index.html + +Colorado Deliverables +===================== + +Software Deliverables +--------------------- + +**Bottlenecks source code <colorado.1.0>** + +* https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary + + +Documentatiion Deliverables +--------------------------- + +**Bottlenecks documentation <colorado.1.0>** + +* Platformation Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html +* Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html +* Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html +* http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html +* User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html + +Reason for Version +================== + +* In Danube, POSCA testsuite is introduced and two stress tests are implemented. +* In Colorado, rubbos is refactored by using puppet, which makes it quite flexible to configure with different number of load generator(Client), worker(tomcat). +* In Colorado, vstf is refactored by extracting the test case's configuration information. + + +Known restrictions/issues +========================= + +* TODO + + +Test results +============ + +Test results are available in: + + - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/ + + +Open JIRA tickets +================= + ++------------------+-----------------------------------------------+ +| JIRA | Description | ++==================+===============================================+ ++------------------+-----------------------------------------------+ ++------------------+-----------------------------------------------+ ++------------------+-----------------------------------------------+ ++------------------+-----------------------------------------------+ ++------------------+-----------------------------------------------+ + + +Useful links +============ + + - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks + + - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/ + + - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/ + + - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks + + - Bottlenecks IRC chanel: #opnfv-bottlenecks + + diff --git a/docs/release_notes/requirements_notes.rst b/docs/release_notes/requirements_notes.rst new file mode 100644 index 00000000..2660bb01 --- /dev/null +++ b/docs/release_notes/requirements_notes.rst @@ -0,0 +1,105 @@ +.. 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 Requirements Notes for OPNFV Danube Release +******************************************************* + +====================== +Installer Requirements +====================== + +* TODO + +===================== +Hardware Requirements +===================== + +* TODO + +===================== +Software Requirements +===================== + +Operation System +---------------- + +* TODO + +Depending Package +----------------- + +- appdirs==1.4.0 +- Babel==2.2.0 +- backport-ipaddress==0.1 +- cliff==2.0.0 +- cmd2==0.6.8 +- coverage==4.1b2 +- debtcollector==1.3.0 +- ecdsa==0.13 +- extras==0.0.3 +- fixtures==1.4.0 +- flake8==2.5.4 +- funcsigs==0.4 +- functools32==3.2.3.post2 +- futures==3.0.5 +- iso8601==0.1.11 +- Jinja2==2.8 +- jsonpatch==1.13 +- jsonpointer==1.10 +- jsonschema==2.5.1 +- keystoneauth1==2.3.0 +- linecache2==1.0.0 +- lxml==3.5.0 +- MarkupSafe==0.23 +- mccabe==0.4.0 +- mock==1.3.0 +- monotonic==1.0 +- msgpack-python==0.4.7 +- netaddr==0.7.18 +- netifaces==0.10.4 +- nose==1.3.7 +- openstacksdk==0.8.1 +- os-client-config==1.16.0 +- oslo.config==3.9.0 +- oslo.i18n==3.4.0 +- oslo.serialization==2.4.0 +- oslo.utils==3.7.0 +- paramiko==1.16.0 +- pbr==1.8.1 +- pep8==1.7.0 +- positional==1.0.1 +- prettytable==0.7.2 +- pycrypto==2.6.1 +- pyflakes==1.0.0 +- pyparsing==2.1.0 +- pyrsistent==0.11.12 +- python-cinderclient==1.6.0 +- python-glanceclient==2.0.0 +- python-heatclient==1.0.0 +- python-keystoneclient==2.3.1 +- python-mimeparse==1.5.1 +- python-neutronclient==4.1.1 +- python-novaclient==3.3.0 +- python-openstackclient==2.2.0 +- python-subunit==1.2.0 +- python-swiftclient==3.0.0 +- pytz==2015.7 +- PyYAML==3.11 +- requests==2.9.1 +- requestsexceptions==1.1.3 +- scp==0.10.2 +- simplejson==3.8.2 +- six==1.10.0 +- stevedore==1.12.0 +- testrepository==0.0.20 +- testtools==2.0.0 +- traceback2==1.4.0 +- unicodecsv==0.14.1 +- unittest2==1.1.0 +- warlock==1.2.0 +- wrapt==1.10.6 +- pyroute2==0.4.10 +- elasticsearch==5.0.1 |