diff options
Diffstat (limited to 'docs/releasenotes')
| -rw-r--r-- | docs/releasenotes/index.rst | 6 | ||||
| -rw-r--r-- | docs/releasenotes/release-notes.rst | 138 |
2 files changed, 79 insertions, 65 deletions
diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst index 8fb1fef78..db97a7492 100644 --- a/docs/releasenotes/index.rst +++ b/docs/releasenotes/index.rst @@ -4,9 +4,9 @@ .. You should have received a copy of the license along with this work. .. If not, see <http://creativecommons.org/licenses/by/4.0/>. -************************* -Fuel\@OPNFV release notes -************************* +***************************** +Release notes for Fuel\@OPNFV +***************************** .. toctree:: :numbered: diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst index 427f0a9db..a748e41f9 100644 --- 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,32 @@ 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" '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' -- `ONOS <http://onosproject.org/>`_ version "Drake" +- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm' -- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ +- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ 'https://wiki.opnfv.org/ovsnfv' -- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ +- `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' -- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ +- `Promise <https://wiki.opnfv.org/display/promise>`_ 'https://wiki.opnfv.org/display/promise' -- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ +- `Parser <https://wiki.opnfv.org/display/parser>`_ 'https://wiki.opnfv.org/display/parser' -- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_ +- `Doctor <https://wiki.opnfv.org/display/doctor>`_ 'https://wiki.opnfv.org/display/doctor' As well as OPNFV-unique configurations of the Hardware- and Software stack. @@ -68,6 +72,7 @@ OPNFV CI pipeline including: - Automated validation of the Colorado deployment +============ Release Data ============ @@ -78,43 +83,48 @@ Release Data | **Repo/tag** | colorado.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado 1.0 follow-up release | +| **Release designation** | Colorado 1.0 main release | | | | +--------------------------------------+--------------------------------------+ | **Release date** | September 22 2016 | | | | +--------------------------------------+--------------------------------------+ | **Purpose of the delivery** | Colorado alignment to Released | -| | Fuel 9.0 baseline + Bug-fixes for | -| | the following feaures/scenarios: | +| | Fuel 9.0 baseline + features and | +| | bug-fixes for the following | +| | feaures: | | | - NFV Hypervisors-KVM | | | - Open vSwitch for NFV | -| | - OpenDaylight SR3 | +| | - OpenDaylight | +| | - ONOS | | | - SDN distributed routing and VPN | | | - Service function chaining | +| | - Promise | +| | - Parser | +| | - Doctor | | | | +--------------------------------------+--------------------------------------+ Version change --------------- +============== Module version changes -~~~~~~~~~~~~~~~~~~~~~~ -This is a follow-up release to Colorado 1.0. It is based on -following upstream versions: +---------------------- +This is the Colorado 1.0 main release. +It is based on following upstream versions: - Fuel 9.0 Base release - 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: +---------------- +This is the Colorado 1.0 main release. +It comes with the following documentation: - Installation instructions - *Reference 13* - **Changed** @@ -123,34 +133,33 @@ comes with the following documentation: - Release notes - *Reference 15* - **Changed** (This document) Reason for version ------------------- +================== Feature additions -~~~~~~~~~~~~~~~~~ +----------------- **JIRA TICKETS:** -- Bug corrections -~~~~~~~~~~~~~~~ +--------------- **JIRA TICKETS:** -`Workarounds <https://jira.opnfv.org/issues/?filter=11121>`_ 'https://jira.opnfv.org/issues/?filter=11121' +`Colorado 1.0 bug fixes <https://jira.opnfv.org/issues/?filter=11180>`_ 'https://jira.opnfv.org/issues/?filter=11180' (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 +167,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,73 +184,77 @@ System Limitations Known issues ------------- +============ **JIRA TICKETS:** -`Known issues <https://jira.opnfv.org/issues/?filter=11119>`_ 'https://jira.opnfv.org/issues/?filter=11119' +`Known issues <https://jira.opnfv.org/issues/?filter=11183>`_ 'https://jira.opnfv.org/issues/?filter=11183' (Also See respective Integrated feature project's bug tracking) Workarounds ------------ +=========== **JIRA TICKETS:** -`Workarounds <https://jira.opnfv.org/issues/?filter=11120>`_ 'https://jira.opnfv.org/issues/?filter=11120' +`Workarounds <https://jira.opnfv.org/issues/?filter=11181>`_ 'https://jira.opnfv.org/issues/?filter=11181' (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 RC3.5 is used when Service Function Chaining is enabled in Fuel plugin. |