Code Review / fuel.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Final Colorado document review.
[fuel.git] / docs / releasenotes / release-notes.rst
diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst
index 427f0a9..fa9e98e 100644 (file)
--- a/docs/releasenotes/release-notes.rst
+++ b/docs/releasenotes/release-notes.rst
@@ -1,20 +1,17 @@
-============================================================================================
-OPNFV Release Note for the Colorado 1.0 release of OPNFV when using Fuel as a deployment tool
-============================================================================================
-
-License
-=======
-
-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 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/>.
 
+========
 Abstract
 ========
 
 This document compiles the release notes for the Colorado 1.0 release of
 OPNFV when using Fuel as a deployment tool.
 
+===============
 Important notes
 ===============
 
@@ -27,25 +24,26 @@ of the OPNFV infrastructure.
 
 Carefully follow the installation-instructions provided in *Reference 13*.
 
+=======
 Summary
 =======
 
 For Colorado, 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 SR3"
+- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Beryllium SR3" [1]_ - 'http://www.opendaylight.org/software'
 
-- `ONOS <http://onosproject.org/>`_ version "Drake"
+- `ONOS <http://onosproject.org/>`_ version "Drake" - 'http://onosproject.org/'
 
-- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_
+- `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>`_
+- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ 'https://wiki.opnfv.org/sdnvpn'
 
-- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
+- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm'
 
-- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
+- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ 'https://wiki.opnfv.org/ovsnfv'
 
-- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_
+- `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.
 
@@ -68,6 +66,7 @@ OPNFV CI pipeline including:
 
 - Automated validation of the Colorado deployment
 
+============
 Release Data
 ============
 
@@ -89,17 +88,17 @@ Release Data
 |                                      | the following feaures/scenarios:     |
 |                                      | - NFV Hypervisors-KVM                |
 |                                      | - Open vSwitch for NFV               |
-|                                      | - OpenDaylight SR3                   |
+|                                      | - OpenDaylight                       |
 |                                      | - SDN distributed routing and VPN    |
 |                                      | - Service function chaining          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
 Version change
---------------
+==============
 
 Module version changes
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
 This is a follow-up release to Colorado 1.0. It is based on
 following upstream versions:
 
@@ -107,12 +106,12 @@ following upstream versions:
 
 - OpenStack Mitaka release
 
-- OpenDaylight Beryllium SR3 release
+- OpenDaylight Beryllium SR3 release [1]_
 
 - ONOS Drake release
 
 Document changes
-~~~~~~~~~~~~~~~~
+----------------
 This is a follow-up release to Colorado 1.0. It
 comes with the following documentation:
 
@@ -123,17 +122,17 @@ comes with the following documentation:
 - Release notes - *Reference 15* - **Changed** (This document)
 
 Reason for version
-------------------
+==================
 
 Feature additions
-~~~~~~~~~~~~~~~~~
+-----------------
 
 **JIRA TICKETS:**
 
 -
 
 Bug corrections
-~~~~~~~~~~~~~~~
+---------------
 
 **JIRA TICKETS:**
 
@@ -142,15 +141,15 @@ Bug corrections
 (Also See respective Integrated feature project's bug tracking)
 
 Deliverables
-------------
+============
 
 Software deliverables
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
 
 Fuel-based installer iso file found in *Reference 2*
 
 Documentation deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------
 
 - Installation instructions - *Reference 13*
 
@@ -158,11 +157,12 @@ Documentation deliverables
 
 - Release notes - *Reference 15* (This document)
 
+=========================================
 Known Limitations, Issues and Workarounds
 =========================================
 
 System Limitations
-------------------
+==================
 
 - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
 
@@ -174,7 +174,7 @@ System Limitations
 
 
 Known issues
-------------
+============
 
 **JIRA TICKETS:**
 
@@ -183,7 +183,7 @@ Known issues
 (Also See respective Integrated feature project's bug tracking)
 
 Workarounds
------------
+===========
 
 **JIRA TICKETS:**
 
@@ -191,56 +191,60 @@ Workarounds
 
 (Also See respective Integrated feature project's bug tracking)
 
+============
 Test results
 ============
 The Colorado 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 release, please see:
 
 OPNFV
------
+=====
 
-1) `OPNFV Home Page <http://www.opnfv.org>`_
+1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org'
 
-2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
+2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download'
 
 OpenStack
----------
+=========
 
-3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
+3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka'
 
-4) `OpenStack documentation <http://docs.openstack.org>`_
+4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org'
 
 OpenDaylight
-------------
+============
 
-5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
+5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads'
 
 Fuel
-----
+====
 
-6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
+6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_ 'https://wiki.openstack.org/wiki/Fuel'
 
-7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_
+7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/'
 
-8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_
+8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html'
 
-9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_
+9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html'
 
-10) `Fuel reference architecture <https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html>`_
+10) `Fuel reference architecture <https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html'
 
-11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
+11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ '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) `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'
 
 Fuel in OPNFV
--------------
+=============
+
+13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html'
 
-13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html>`_
+14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html'
 
-14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html>`_
+15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html'
 
-15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html>`_
+.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin.