From b85bf7d3e726af6027e51244de3c5c68fde79754 Mon Sep 17 00:00:00 2001 From: Jonas Bjurel Date: Tue, 26 Apr 2016 21:06:02 +0200 Subject: Updated documentation for Brahmaputra 3.0 follow-up release READY TO MERGE Change-Id: Ic481f02375af9be1642791fa6d96856a453c4f29 Signed-off-by: Jonas Bjurel (cherry picked from commit f50747c9ec79b9f89df6a6ba6d680a89bd6a3de3) (cherry picked from commit 633f05d11bae8ef429288ad105d9a15aabc10c3b) --- docs/build-instruction.rst | 6 ++-- docs/configguide/installerconfig.rst | 16 +++++----- docs/configguide/postinstall.rst | 3 +- docs/installation-instruction.rst | 15 ++++----- docs/release-notes.rst | 62 ++++++++++++++++++++++-------------- 5 files changed, 58 insertions(+), 44 deletions(-) diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst index 254c0d3f..2d66b7c0 100644 --- a/docs/build-instruction.rst +++ b/docs/build-instruction.rst @@ -284,8 +284,8 @@ The artifacts produced are: References ========== -1) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +1) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -2) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +2) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -3) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +3) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst index 60ffadf1..07a50d94 100644 --- a/docs/configguide/installerconfig.rst +++ b/docs/configguide/installerconfig.rst @@ -28,7 +28,7 @@ following documents: - Fuel planning guide, please see *Reference: 8* in section *"Fuel associated references"* below. -- Fuel user guide, please see *Reference: 9* in section *"Fuel associated references"* below. +- Fuel quick start guide, please see *Reference: 9* in section *"Fuel associated references"* below. - Fuel operations guide, please see *Reference: 10* in section *"Fuel associated references"* below. @@ -310,13 +310,13 @@ Fuel 6) `The Fuel OpenStack project `_ -7) `Fuel documentation overview `_ +7) `Fuel documentation overview `_ -8) `Fuel planning guide `_ +8) `Fuel planning guide `_ -9) `Fuel user guide `_ +9) `Fuel quick start guide `_ -10) `Fuel operations guide `_ +10) `Fuel operations guide `_ 11) `Fuel Plugin Developers Guide `_ @@ -325,8 +325,8 @@ Fuel Fuel in OPNFV ~~~~~~~~~~~~~ -13) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst index e80d72aa..5064e4a2 100644 --- a/docs/configguide/postinstall.rst +++ b/docs/configguide/postinstall.rst @@ -14,7 +14,8 @@ These validate the installation in terms of configuration, services, networking, storage, policies, etc. The execution of the full range of health checks takes less than 30 minutes. -For instructions on how to run health-checks, please refer to the Fuel installation instructions. +For instructions on how to run health-checks, please read the Fuel installation +instructions. Platform components validation ------------------------------ diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst index f7125816..787287a9 100644 --- a/docs/installation-instruction.rst +++ b/docs/installation-instruction.rst @@ -601,16 +601,15 @@ OpenDaylight Fuel ---- - 6) `The Fuel OpenStack project `_ -7) `Fuel documentation overview `_ +7) `Fuel documentation overview `_ -8) `Fuel planning guide `_ +8) `Fuel planning guide `_ -9) `Fuel user guide `_ +9) `Fuel quick start guide `_ -10) `Fuel operations guide `_ +10) `Fuel operations guide `_ 11) `Fuel Plugin Developers Guide `_ @@ -619,8 +618,8 @@ Fuel Fuel in OPNFV ------------- -13) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index e731af02..7d86edbf 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,5 +1,5 @@ ============================================================================================ -OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +OPNFV Release Note for the Brahmaputra 3.0 release of OPNFV when using Fuel as a deployment tool ============================================================================================ License @@ -12,14 +12,14 @@ License. .. http://creativecommons.org/licenses/by/4.0 .. Abstract ======== -This document compiles the release notes for the Brahmaputra release of +This document compiles the release notes for the Brahmaputra 3.0 release of OPNFV when using Fuel as a deployment tool. Important notes =============== These notes provides release information for the use of Fuel as deployment -tool for the Brahmaputra release of OPNFV. +tool for the Brahmaputra 3.0 release of OPNFV. The goal of the Brahmaputra release and this Fuel-based deployment process is to establish a lab ready platform accelerating further development @@ -33,7 +33,7 @@ Summary For Brahmaputra, the typical use of Fuel as an OpenStack installer is supplemented with OPNFV unique components such as: -- `OpenDaylight `_ version "Berylium RC1 as" +- `OpenDaylight `_ version "Berylium SR1" - `ONOS `_ version "Drake" @@ -68,7 +68,6 @@ OPNFV CI pipeline including: - Automated validation of the Brahmaputra deployment - Release Data ============ @@ -76,16 +75,23 @@ Release Data | **Project** | fuel | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | brahmaputra.1.0 | +| **Repo/tag** | brahmaputra.3.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Brahmaputra base release | +| **Release designation** | Brahmaputra 3.0 follow-up release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | February 25 2016 | +| **Release date** | April 28 2016 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Brahmaputra base release | +| **Purpose of the delivery** | Brahmaputra alignment to Released | +| | Fuel 8.0 baseline + Bug-fixes for | +| | the following feaures/scenarios: | +| | - NFV Hypervisors-KVM | +| | - Open vSwitch for NFV | +| | - OpenDaylight SR1 | +| | - SDN distributed routing and VPN | +| | - Service function chaining | | | | +--------------------------------------+--------------------------------------+ @@ -94,20 +100,20 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~ -This is the second tracked release of genesis/fuel. It is based on +This is a follow-up release to Brahmaputra 1.0. It is based on following upstream versions: -- Fuel 8.0 pre-release +- Fuel 8.0 Base release - OpenStack Liberty release -- OpenDaylight Beryllium release +- OpenDaylight Beryllium SR1 release - ONOS Drake release Document changes ~~~~~~~~~~~~~~~~ -This is the third tracked version of the fuel installer for OPNFV. It +This is a follow-up release to Brahmaputra 1.0. It comes with the following documentation: - Installation instructions - *Reference 13* - **Changed** @@ -124,14 +130,16 @@ Feature additions **JIRA TICKETS:** -`New features `_ 'https://jira.opnfv.org/issues/?filter=11002' +- Bug corrections ~~~~~~~~~~~~~~~ **JIRA TICKETS:** -`Bug-fixes `_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001' +`Workarounds `_ 'https://jira.opnfv.org/issues/?filter=11121' + +(Also See respective Integrated feature project's bug tracking) Deliverables ------------ @@ -170,16 +178,22 @@ Known issues **JIRA TICKETS:** -`Known issues `_ 'https://jira.opnfv.org/issues/?filter=11000' +`Known issues `_ 'https://jira.opnfv.org/issues/?filter=11119' + +(Also See respective Integrated feature project's bug tracking) Workarounds ----------- +**JIRA TICKETS:** + +`Workarounds `_ 'https://jira.opnfv.org/issues/?filter=11120' +(Also See respective Integrated feature project's bug tracking) Test results ============ -The Brahmaputra release with the Fuel deployment tool has undergone QA test +The Brahmaputra 3.0 release with the Fuel deployment tool has undergone QA test runs, see separate test results. References @@ -210,13 +224,13 @@ Fuel 6) `The Fuel OpenStack project `_ -7) `Fuel documentation overview `_ +7) `Fuel documentation overview `_ -8) `Fuel planning guide `_ +8) `Fuel planning guide `_ -9) `Fuel user guide `_ +9) `Fuel quick start guide `_ -10) `Fuel operations guide `_ +10) `Fuel operations guide `_ 11) `Fuel Plugin Developers Guide `_ @@ -225,8 +239,8 @@ Fuel Fuel in OPNFV ------------- -13) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -- cgit 1.2.3-korg