docs/release-notes.rst: Armband refresh.
[armband.git] / docs / release-notes.rst
index e731af0..df29f9e 100644 (file)
@@ -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 AArch64 Brahmaputra 3.0 release of OPNFV when using Fuel as a deployment tool
 ============================================================================================
 
 License
@@ -12,28 +12,37 @@ License. .. http://creativecommons.org/licenses/by/4.0 ..
 Abstract
 ========
 
-This document compiles the release notes for the Brahmaputra release of
-OPNFV when using Fuel as a deployment tool.
+This document compiles the release notes for the Brahmaputra 3.0 release of
+OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target
+node pool.
 
 Important notes
 ===============
 
-These notes provides release information for the use of Fuel as deployment
-tool for the Brahmaputra release of OPNFV.
+These notes provide release information for the use of Fuel as deployment
+tool for the AArch64 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.
+of the OPNFV infrastructure on AArch64 architecture.
 
-Carefully follow the installation-instructions provided in *Reference 13*.
+Due to early docker and nodejs support on AArch64, we will still use an
+x86_64 Fuel Master to build and deploy an AArch64 target pool.
+
+Although not currently supported, mixing x86_64 and AArch64 architectures
+inside the target pool will be possible later.
+
+Carefully follow the installation-instructions provided in *Reference 16*.
 
 Summary
 =======
 
-For Brahmaputra, the typical use of Fuel as an OpenStack installer is
+For AArch64 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"
+
+The following OPNFV plugins are not yet ported for AArch64:
 
 - `ONOS <http://onosproject.org/>`_ version "Drake"
 
@@ -62,13 +71,12 @@ OPNFV CI pipeline including:
 
   - build-instructions
 
-- The Brahmaputra Fuel installer image (.iso) built by Jenkins
+- The Brahmaputra Fuel installer image for AArch64 (.iso) built by Jenkins
 
 - Automated deployment of Brahmaputra with running on bare metal or a nested hypervisor environment (KVM)
 
 - Automated validation of the Brahmaputra deployment
 
-
 Release Data
 ============
 
@@ -76,16 +84,20 @@ 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**                     | May 6 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:     |
+|                                      | - Added AArch64 target support       |
+|                                      | - OpenDaylight SR1                   |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -94,27 +106,28 @@ Version change
 
 Module version changes
 ~~~~~~~~~~~~~~~~~~~~~~
-This is the second tracked release of genesis/fuel. It is based on
+This is the first AArch64 release for Brahmaputra 3.0. It is based on
 following upstream versions:
 
-- Fuel 8.0 pre-release
+- Fuel 8.0 Base release
 
 - OpenStack Liberty release
 
-- OpenDaylight Beryllium release
+- OPNFV Fuel Brahmaputra 3.0 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 based upon a follow-up release to Brahmaputra 1.0. It
 comes with the following documentation:
 
-- Installation instructions - *Reference 13* - **Changed**
+- Installation instructions - *Reference 16* - **Changed**
 
-- Build instructions - *Reference 14* - **Changed**
+- Build instructions - *Reference 17* - **Changed**
 
-- Release notes - *Reference 15* - **Changed** (This document)
+- Release notes - *Reference 18* - **Changed** (This document)
 
 Reason for version
 ------------------
@@ -124,14 +137,18 @@ Feature additions
 
 **JIRA TICKETS:**
 
-`New features <https://jira.opnfv.org/issues/?filter=11002>`_ 'https://jira.opnfv.org/issues/?filter=11002'
+`AArch64 new features <https://jira.opnfv.org/issues/?filter=11129>`_ 'https://jira.opnfv.org/issues/?filter=11129'
+
+(Also See respective Integrated feature project's bug tracking)
 
 Bug corrections
 ~~~~~~~~~~~~~~~
 
 **JIRA TICKETS:**
 
-`Bug-fixes <https://jira.opnfv.org/browse/FUEL-99?filter=11001>`_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001'
+`AArch64 Workarounds <https://jira.opnfv.org/issues/?filter=11126>`_ 'https://jira.opnfv.org/issues/?filter=11126'
+
+(Also See respective Integrated feature project's bug tracking)
 
 Deliverables
 ------------
@@ -139,16 +156,16 @@ Deliverables
 Software deliverables
 ~~~~~~~~~~~~~~~~~~~~~
 
-Fuel-based installer iso file found in *Reference 2*
+Fuel-based installer iso file for AArch64 targets found in *Reference 2*
 
 Documentation deliverables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- Installation instructions - *Reference 13*
+- Installation instructions - *Reference 16*
 
-- Build instructions - *Reference 14*
+- Build instructions - *Reference 17*
 
-- Release notes - *Reference 15* (This document)
+- Release notes - *Reference 18* (This document)
 
 Known Limitations, Issues and Workarounds
 =========================================
@@ -164,22 +181,32 @@ System Limitations
 
 - **Max number of networks:** 65k
 
+- **Fuel master arch:** x86_64
+
+- **Target node arch:** aarch64
+
 
 Known issues
 ------------
 
 **JIRA TICKETS:**
 
-`Known issues <https://jira.opnfv.org/issues/?filter=11000>`_ 'https://jira.opnfv.org/issues/?filter=11000'
+`AArch64 Known issues <https://jira.opnfv.org/issues/?filter=11127>`_ 'https://jira.opnfv.org/issues/?filter=11127'
+
+(Also See respective Integrated feature project's bug tracking)
 
 Workarounds
 -----------
 
+**JIRA TICKETS:**
+
+`AArch64 Workarounds <https://jira.opnfv.org/issues/?filter=11128>`_ 'https://jira.opnfv.org/issues/?filter=11128'
 
+(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 +237,13 @@ 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>`_
+7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_
 
-8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_
+8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_
 
-9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
+9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_
 
-10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.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>`_
 
@@ -225,8 +252,14 @@ 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 <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>`_
+
+16) `OPNFV Installation instruction for the AArch64 Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/brahmaputra/docs/installation-instruction.html>`_
 
-14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+17) `OPNFV Build instruction for the AArch64 Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/brahmaputra/docs/build-instruction.html>`_
 
-15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+18) `OPNFV Release Note for the AArch64 Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/brahmaputra/docs/release-notes.html>`_