From 81fba061911595953782299d2eb06c3014b8a890 Mon Sep 17 00:00:00 2001 From: yuyang Date: Thu, 16 Feb 2017 20:44:47 +0800 Subject: 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 --- docs/release_notes/release_notes.rst | 217 +++++++++++++++++++++++++++++++++++ 1 file changed, 217 insertions(+) create mode 100644 docs/release_notes/release_notes.rst (limited to 'docs/release_notes/release_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 . + +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 ** + +* https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary + + +Documentatiion Deliverables +--------------------------- + +**Bottlenecks documentation ** + +* 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 ** + +* https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary + + +Documentatiion Deliverables +--------------------------- + +**Bottlenecks documentation ** + +* 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 + + -- cgit 1.2.3-korg