Updated documentation for Brahmaputra 3.0 follow-up release
[fuel.git] / docs / release-notes.rst
index 0ffa683..7d86edb 100644 (file)
@@ -1,39 +1,31 @@
 ============================================================================================
-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
 ============================================================================================
 
-.. contents:: Table of Contents
-   :backlinks: none
-
-Abstract
-========
-
-This document compiles the release notes for the Brahmaputra release of
-OPNFV when using Fuel as a deployment tool.
-
 License
 =======
 
-Brahmaputra release with the Fuel deployment tool Docs (c) by Jonas
-Bjurel (Ericsson AB)
+This work is licensed under a Creative Commons Attribution 4.0 International
+License. .. http://creativecommons.org/licenses/by/4.0 ..
+(c) Jonas Bjurel (Ericsson AB) and others
 
-This document is licensed under a Creative Commons Attribution 4.0
-International License.
+Abstract
+========
 
-You should have received a copy of the license along with this document.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
+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
 of the OPNFV infrastructure.
 
-Carefully follow the installation-instructions.
+Carefully follow the installation-instructions provided in *Reference 13*.
 
 Summary
 =======
@@ -41,7 +33,7 @@ Summary
 For Brahmaputra, the typical use of Fuel as an OpenStack installer is
 supplemented with OPNFV unique components such as:
 
-- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium RC1 as"
+- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium SR1"
 
 - `ONOS <http://onosproject.org/>`_ version "Drake"
 
@@ -76,7 +68,6 @@ OPNFV CI pipeline including:
 
 - Automated validation of the Brahmaputra deployment
 
-
 Release Data
 ============
 
@@ -84,16 +75,23 @@ Release Data
 | **Project**                          | fuel                                 |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | fuel/<TODO>                          |
+| **Repo/tag**                         | brahmaputra.3.0                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Brahmaputra base release             |
+| **Release designation**              | Brahmaputra 3.0 follow-up release    |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | <TODO>                               |
+| **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          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -102,43 +100,46 @@ 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 pre-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:
 
-- OPNFV Installation instructions for Brahmaputra with Fuel as deployment tool - **Changed**
+- Installation instructions - *Reference 13* - **Changed**
 
-- OPNFV Release Notes for Brahmaputra use of Fuel as deployment tool - **Changed**
+- Build instructions - *Reference 14* - **Changed**
 
-- OPNFV Build instructions for Brahmaputra with Fuel as deployment tool - **Changed**
+- Release notes - *Reference 15* - **Changed** (This document)
 
 Reason for version
 ------------------
+
 Feature additions
 ~~~~~~~~~~~~~~~~~
 
 **JIRA TICKETS:**
 
-`New features <https://jira.opnfv.org/browse/FUEL-81?jql=project%20%3D%20FUEL%20AND%20issuetype%20in%20%28Improvement%2C%20%22New%20Feature%22%2C%20Story%2C%20Sub-task%29%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_
+-
 
 Bug corrections
 ~~~~~~~~~~~~~~~
 
 **JIRA TICKETS:**
 
-`Bug-fixes <https://jira.opnfv.org/browse/FUEL-96?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_
+`Workarounds <https://jira.opnfv.org/issues/?filter=11121>`_ 'https://jira.opnfv.org/issues/?filter=11121'
+
+(Also See respective Integrated feature project's bug tracking)
 
 Deliverables
 ------------
@@ -146,17 +147,16 @@ Deliverables
 Software deliverables
 ~~~~~~~~~~~~~~~~~~~~~
 
-Fuel-based installer iso file <TODO>
+Fuel-based installer iso file found in *Reference 2*
 
 Documentation deliverables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- OPNFV Installation instructions for Brahmaputra release with the Fuel deployment tool
+- Installation instructions - *Reference 13*
 
-- OPNFV Build instructions for Brahmaputra release with the Fuel deployment
-  tool
+- Build instructions - *Reference 14*
 
-- OPNFV Release Note for Brahmaputra release with the Fuel deployment tool - (this document)
+- Release notes - *Reference 15* (This document)
 
 Known Limitations, Issues and Workarounds
 =========================================
@@ -168,7 +168,7 @@ System Limitations
 
 - **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
 
-- **Storage:** Ceph is the only supported storage configuration.
+- **Storage:** Ceph is the only supported storage configuration
 
 - **Max number of networks:** 65k
 
@@ -178,20 +178,69 @@ Known issues
 
 **JIRA TICKETS:**
 
-`Known issues <https://jira.opnfv.org/browse/FUEL-99?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29>`_
+`Known issues <https://jira.opnfv.org/issues/?filter=11119>`_ '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>`_ '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
-runs with the following results:
-<TODO>
+The Brahmaputra 3.0 release with the Fuel deployment tool has undergone QA test
+runs, see separate test results.
 
 References
 ==========
-For more information on the OPNFV Brahmaputra release, please see
-<TODO>
+For more information on the OPNFV Brahmaputra release, please see:
+
+OPNFV
+-----
+
+1) `OPNFV Home Page <www.opnfv.org>`_
+
+2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
+
+OpenStack
+---------
+
+3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+
+4) `OpenStack documentation <http://docs.openstack.org>`_
+
+OpenDaylight
+------------
+
+5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
+
+Fuel
+----
+
+6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
+
+7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_
+
+8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_
+
+9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_
+
+10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html>`_
+
+11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
+
+12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
+
+Fuel in OPNFV
+-------------
+
+13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/installation-instruction.html>`_
+
+14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/build-instruction.html>`_
+
+15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/release-notes.html>`_