Minor corrections and updates to docs
[armband.git] / docs / release / release-notes / release-notes.rst
index b4e8bc8..e27aeaf 100644 (file)
@@ -1,25 +1,23 @@
-.. This document is protected/licensed under the following conditions
-.. (c) Jonas Bjurel (Ericsson AB)
-.. Licensed under a Creative Commons Attribution 4.0 International License.
-.. You should have received a copy of the license along with this work.
-.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
 
 ========
 Abstract
 ========
 
-This document compiles the release notes for the Colorado 3.0 release of
-OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target
+This document compiles the release notes for the Danube release of
+OPNFV when using Fuel as a deployment tool with an AArch64 (only) target
 node pool.
 
 ===============
-Important notes
+Important Notes
 ===============
 
 These notes provides release information for the use of Fuel as deployment
-tool for the AArch64 Colorado 3.0 release of OPNFV.
+tool for the AArch64 Danube release of OPNFV.
 
-The goal of the AArch64 Colorado release and this Fuel-based deployment process
+The goal of the AArch64 Danube release and this Fuel-based deployment process
 is to establish a lab ready platform accelerating further development
 of the OPNFV on AArch64 infrastructure.
 
@@ -35,32 +33,27 @@ Carefully follow the installation-instructions provided in *Reference 13*.
 Summary
 =======
 
-For AArch64 Colorado, the typical use of Fuel as an OpenStack installer is
+For AArch64 Danube, the typical use of Fuel as an OpenStack installer is
 supplemented with OPNFV unique components such as:
 
-- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Boron" [1]_ - 'http://www.opendaylight.org/software'
-
-- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ 'https://wiki.opnfv.org/ovsnfv'
-
-- `BGPVPN <http://docs.openstack.org/developer/networking-bgpvpn>`_ 'http://docs.openstack.org/developer/networking-bgpvpn/'
-
--  Tacker <https://wiki.openstack.org/wiki/Tacker>`_ 'https://wiki.openstack.org/wiki/Tacker'
+- `OpenDaylight <http://www.opendaylight.org/software>`_
+- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
+- `BGPVPN <http://docs.openstack.org/developer/networking-bgpvpn>`_
+- `Tacker <https://wiki.openstack.org/wiki/Tacker>`_
+- `Service Function Chaining <https://wiki.opnfv.org/service_function_chaining>`_
+- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_
 
 The following OPNFV plugins are not yet ported for AArch64:
 
-- `ONOS <http://onosproject.org/>`_ version "Drake" - 'http://onosproject.org/'
-
-- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ 'https://wiki.opnfv.org/service_function_chaining'
-
-- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ 'https://wiki.opnfv.org/sdnvpn'
+- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
+- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_
+- `Promise <https://wiki.opnfv.org/display/promise>`_
+- `Parser <https://wiki.opnfv.org/display/parser>`_
+- `Doctor <https://wiki.opnfv.org/display/doctor>`_
 
-- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm'
+As well as OPNFV-unique configurations of the Hardware and Software stack.
 
-- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_ 'https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases'
-
-As well as OPNFV-unique configurations of the Hardware- and Software stack.
-
-This Colorado artifact provides Fuel as the deployment stage tool in the
+This Danube artifact provides Fuel as the deployment stage tool in the
 OPNFV CI pipeline including:
 
 - Documentation built by Jenkins
@@ -73,11 +66,11 @@ OPNFV CI pipeline including:
 
   - build-instructions
 
-- The Colorado Fuel installer image AArch64 (.iso) built by Jenkins
+- The Danube Fuel installer image AArch64 (.iso) built by Jenkins
 
-- Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM)
+- Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM)
 
-- Automated validation of the Colorado deployment
+- Automated validation of the Danube deployment
 
 ============
 Release Data
@@ -87,85 +80,83 @@ Release Data
 | **Project**                          | armband                              |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | colorado.3.0                         |
+| **Repo/tag**                         | danube.1.0                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Colorado 3.0 follow-up release       |
+| **Release designation**              | Danube 1.0                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | December 05 2016                     |
+| **Release date**                     | March 27 2017                        |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Colorado alignment to Released       |
-|                                      | Fuel 9.0 baseline + Bug-fixes for    |
-|                                      | the following feaures/scenarios:     |
+| **Purpose of the delivery**          | Danube alignment to Released         |
+|                                      | Fuel 10.0 baseline + features and    |
+|                                      | bug-fixes for the following          |
+|                                      | feaures:                             |
 |                                      | - Open vSwitch for NFV               |
 |                                      | - OpenDaylight                       |
 |                                      | - Tacker                             |
-|                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-Version change
+Version Change
 ==============
 
-Module version changes
+Module Version Changes
 ----------------------
-This is the Colorado 3.0 follow-up release.
+This is the Danube 1.0 release.
 It is based on following upstream versions:
 
-- Fuel 9.0 Base release
-
-- OpenStack Mitaka release
+- Fuel 10.0 Base Release
 
-- OpenDaylight Boron release [1]_
+- OpenStack Newton Release
 
+- OpenDaylight
 
-Document changes
+Document Changes
 ----------------
-This is the Colorado 3.0 follow-up release.
+This is the Danube 1.0 release.
 It comes with the following documentation:
 
-- Installation instructions - *Reference 13* - **Changed**
+- Installation instructions
 
-- Build instructions - *Reference 14* - **Changed**
+- Build instructions
 
-- Release notes - *Reference 15* - **Changed** (This document)
+- Release notes (This document)
 
-Reason for version
+Reason for Version
 ==================
 
-Feature additions
+Feature Additions
 -----------------
 
 **JIRA TICKETS:**
 
--
 
-Bug corrections
+Bug Corrections
 ---------------
 
 **JIRA TICKETS:**
 
-`Workarounds <https://jira.opnfv.org/issues/?filter=11404>`_ 'https://jira.opnfv.org/issues/?filter=11404'
+`Danube 1.0 bug fixes  <https://jira.opnfv.org/issues/?filter=11615>`_
 
 (Also See respective Integrated feature project's bug tracking)
 
 Deliverables
 ============
 
-Software deliverables
+Software Deliverables
 ---------------------
 
-AArch64 Fuel-based installer iso file found in *Reference 2*
+AArch64 Fuel-based installer iso file found in `OPNFV Downloads <https://www.opnfv.org/software/download>`.
 
-Documentation deliverables
+Documentation Deliverables
 --------------------------
 
-- Installation instructions - *Reference 13*
+- Installation instructions
 
-- Build instructions - *Reference 14*
+- Build instructions
 
-- Release notes - *Reference 15* (This document)
+- Release notes(This document)
 
 =========================================
 Known Limitations, Issues and Workarounds
@@ -186,12 +177,12 @@ System Limitations
 
 - **Target node arch:** aarch64
 
-Known issues
+Known Issues
 ============
 
 **JIRA TICKETS:**
 
-`Known issues <https://jira.opnfv.org/issues/?filter=11405>`_ 'https://jira.opnfv.org/issues/?filter=11405'
+`Known issues <https://jira.opnfv.org/issues/?filter=11614>`_
 
 (Also See respective Integrated feature project's bug tracking)
 
@@ -205,59 +196,45 @@ Workarounds
 (Also See respective Integrated feature project's bug tracking)
 
 ============
-Test results
+Test Results
 ============
-The Colorado 3.0 release with the Fuel deployment tool has undergone QA test
+The Danube 1.0 release with the Fuel deployment tool has undergone QA test
 runs, see separate test results.
 
 ==========
 References
 ==========
-For more information on the OPNFV Colorado 3.0 release, please see:
+For more information on the OPNFV Danube 1.0 release, please see:
 
 OPNFV
 =====
 
-1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org'
-
-2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download'
+1) `OPNFV Home Page <http://www.opnfv.org>`_
+2) `OPNFV Documentation - and Software Downloads <https://www.opnfv.org/software/download>`_
 
 OpenStack
 =========
 
-3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka'
+3) `OpenStack Newton Release Artifacts <http://www.openstack.org/software/newton>`_
 
-4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org'
+4) `OpenStack Documentation <http://docs.openstack.org>`_
 
 OpenDaylight
 ============
 
-5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads'
+5) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
 
 Fuel
 ====
 
-6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel
-
-7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs
-
-8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html
-
-9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html
-
-10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html
-
-11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html
-
-12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list
+6) `The Fuel OpenStack Project <https://wiki.openstack.org/wiki/Fuel>`_
+7) `Fuel Documentation <http://docs.openstack.org/developer/fuel-docs>`_
 
 Fuel in OPNFV
 =============
 
-13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html>`_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html'
-
-14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html>`_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html'
+13) `OPNFV Installation instruction for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release_installation/index.html>`_
 
-15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html>`_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html'
+14) `OPNFV Build instruction for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/development_overview_build/index.html>`_
 
-.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin.
+15) `OPNFV Release Note for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release_release-notes/index.html>`_