Code Review / fuel.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Final release notes for Fuel Brahmaputra SR0
[fuel.git] / docs / release-notes.rst
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 0ffa683..8e590c0 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -5,23 +5,18 @@ OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a dep
 .. 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 release of
+OPNFV when using Fuel as a deployment tool.
 
 Important notes
 ===============
@@ -33,7 +28,7 @@ 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
 =======
@@ -84,13 +79,13 @@ Release Data
 | **Project**                          | fuel                                 |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | fuel/<TODO>                          |
+| **Repo/tag**                         | brahmaputra.1.0                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Release designation**              | Brahmaputra base release             |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | <TODO>                               |
+| **Release date**                     | February 25 2016                     |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Purpose of the delivery**          | Brahmaputra base release             |
@@ -109,7 +104,7 @@ following upstream versions:
 
 - OpenStack Liberty release
 
-- OpenDaylight Beryllium pre-release
+- OpenDaylight Beryllium release
 
 - ONOS Drake release
 
@@ -118,11 +113,11 @@ Document changes
 This is the third tracked version of the fuel installer for OPNFV. 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
 ------------------
@@ -131,14 +126,14 @@ 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>`_
+`New features <https://jira.opnfv.org/issues/?filter=11002>`_ 'https://jira.opnfv.org/issues/?filter=11002'
 
 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>`_
+`Bug-fixes <https://jira.opnfv.org/browse/FUEL-99?filter=11001>`_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001'
 
 Deliverables
 ------------
@@ -146,17 +141,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 +162,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 +172,63 @@ 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=11000>`_ 'https://jira.opnfv.org/issues/?filter=11000'
 
 Workarounds
 -----------
 
--
+
 
 Test results
 ============
 The Brahmaputra release with the Fuel deployment tool has undergone QA test
-runs with the following results:
-<TODO>
+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-7.0/#guides>`_
+
+8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_
+
+9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
+
+10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.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
+
+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