Updated armband
[armband.git] / docs / release-notes.rst
index 7d86edb..2600eca 100644 (file)
@@ -1,5 +1,5 @@
 ============================================================================================
-OPNFV Release Note for the Brahmaputra 3.0 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
@@ -13,28 +13,37 @@ Abstract
 ========
 
 This document compiles the release notes for the Brahmaputra 3.0 release of
-OPNFV when using Fuel as a deployment tool.
+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 3.0 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.
+
+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 13*.
 
 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 SR1"
 
+The following OPNFV plugins are not yet ported for AArch64:
+
 - `ONOS <http://onosproject.org/>`_ version "Drake"
 
 - `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_
@@ -62,7 +71,7 @@ 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)
 
@@ -81,17 +90,14 @@ Release Data
 | **Release designation**              | Brahmaputra 3.0 follow-up release    |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | April 28 2016                        |
+| **Release date**                     | May 6 2016                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **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               |
+|                                      | - Added AArch64 target support       |
 |                                      | - OpenDaylight SR1                   |
-|                                      | - SDN distributed routing and VPN    |
-|                                      | - Service function chaining          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -100,20 +106,21 @@ Version change
 
 Module version changes
 ~~~~~~~~~~~~~~~~~~~~~~
-This is a follow-up release to Brahmaputra 1.0. It is based on
+This is the first AArch64 release for Brahmaputra 3.0. It is based on
 following upstream versions:
 
 - Fuel 8.0 Base release
 
 - OpenStack Liberty release
 
+- OPNFV Fuel Brahmaputra 3.0 release
+
 - OpenDaylight Beryllium SR1 release
 
-- ONOS Drake release
 
 Document changes
 ~~~~~~~~~~~~~~~~
-This is a follow-up release to Brahmaputra 1.0. It
+This is based upon a follow-up release to Brahmaputra 1.0. It
 comes with the following documentation:
 
 - Installation instructions - *Reference 13* - **Changed**
@@ -130,14 +137,16 @@ Feature additions
 
 **JIRA TICKETS:**
 
--
+`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:**
 
-`Workarounds <https://jira.opnfv.org/issues/?filter=11121>`_ 'https://jira.opnfv.org/issues/?filter=11121'
+`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)
 
@@ -147,7 +156,7 @@ 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -172,13 +181,17 @@ 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=11119>`_ 'https://jira.opnfv.org/issues/?filter=11119'
+`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)
 
@@ -187,7 +200,7 @@ Workarounds
 
 **JIRA TICKETS:**
 
-`Workarounds <https://jira.opnfv.org/issues/?filter=11120>`_ 'https://jira.opnfv.org/issues/?filter=11120'
+`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)
 
@@ -203,7 +216,7 @@ For more information on the OPNFV Brahmaputra release, please see:
 OPNFV
 -----
 
-1) `OPNFV Home Page <www.opnfv.org>`_
+1) `OPNFV Home Page <http://www.opnfv.org>`_
 
 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
 
@@ -234,13 +247,13 @@ Fuel
 
 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>`_
+12) `(N/A on AArch64) 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>`_
+13) `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 <http://artifacts.opnfv.org/fuel/brahmaputra/docs/build-instruction.html>`_
+14) `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 <http://artifacts.opnfv.org/fuel/brahmaputra/docs/release-notes.html>`_
+15) `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>`_