X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=7d86edbf7e30fd261e0c9616ba16ebae46d42440;hb=ba890bd75af60844252afd3fd4f1f9c8684b7918;hp=435789767078336ed8ceb52d5017a80f462eba0a;hpb=ce32b60906075b9471e9ebdb035998fd20afacc6;p=fuel.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 435789767..7d86edbf7 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,78 +1,97 @@ -========================================================================================= -OPNFV Release Note for the Arno SR1 release of OPNFV when using Fuel as a deployment tool -========================================================================================= +============================================================================================ +OPNFV Release Note for the Brahmaputra 3.0 release of OPNFV when using Fuel as a deployment tool +============================================================================================ +License +======= -.. contents:: Table of Contents - :backlinks: none - +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 Abstract ======== -This document compiles the release notes for the Arno SR1 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. -License +Important notes +=============== + +These notes provides release information for the use of Fuel as deployment +tool for the 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. + +Carefully follow the installation-instructions provided in *Reference 13*. + +Summary ======= -Arno SR1 release with the Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB) +For Brahmaputra, the typical use of Fuel as an OpenStack installer is +supplemented with OPNFV unique components such as: -Arno SR1 release with the Fuel deployment tool Docs are licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see . +- `OpenDaylight `_ version "Berylium SR1" -Version history -=============== +- `ONOS `_ version "Drake" -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-06-03 | 1.0.0 | Jonas Bjurel | Arno SR0 release | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-09-28 | 1.1.3 | Jonas Bjurel | Arno SR1 release | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ +- `Service function chaining `_ -Important notes -=============== +- `SDN distributed routing and VPN `_ -For the first OPNFV release (Arno), these notes introduce use of `OpenStack Fuel ` for the deployment stage of the OPNFV continuous integration (CI) pipeline. The goal of the Arno release and this Fuel-based deployment process is to establish a foundational platform accelerating further development of the OPNFV infrastructure. +- `NFV Hypervisors-KVM `_ -Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be run before deployment is started. +- `Open vSwitch for NFV `_ -Summary -======= +- `VSPERF `_ -For Arno SR1, the typical use of Fuel as an OpenStack installer is supplemented with OPNFV unique components such as `OpenDaylight `_ version Helium as well as OPNFV-unique configurations. +As well as OPNFV-unique configurations of the Hardware- and Software stack. -This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including: +This Brahmaputra artifact provides Fuel as the deployment stage tool in the +OPNFV CI pipeline including: - Documentation built by Jenkins + + - overall OPNFV documentation + - this document (release notes) + - installation instructions + - build-instructions -- The Arno Fuel installer image (.iso) built by Jenkins -- Automated deployment of Arno with running on bare metal or a nested hypervisor environment (KVM) -- Automated validation of the Arno deployment +- The Brahmaputra Fuel installer image (.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 ============ +--------------------------------------+--------------------------------------+ -| **Project** | genesis/bgs | +| **Project** | fuel | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | genesis/arno.2015.2.0 | +| **Repo/tag** | brahmaputra.3.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Arno Base Service release 1 (SR1) | +| **Release designation** | Brahmaputra 3.0 follow-up release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2015-10-01 | +| **Release date** | April 28 2016 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Arno Base SR1 release | +| **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 | +| | - OpenDaylight SR1 | +| | - SDN distributed routing and VPN | +| | - Service function chaining | | | | +--------------------------------------+--------------------------------------+ @@ -81,71 +100,63 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~ -This is the second tracked release of genesis/fuel. It is based on following upstream versions: +This is a follow-up release to Brahmaputra 1.0. It is based on +following upstream versions: + +- Fuel 8.0 Base release -- Fuel 6.1.0 -- OpenStack Juno release -- OpenDaylight Litium release +- OpenStack Liberty release -Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~ -This is the second tracked version of the fuel installer for OPNFV. It comes with the following documentation: +- OpenDaylight Beryllium SR1 release -- OPNFV Installation instructions for Arno with Fuel as deployment tool -- OPNFV Release Notes for Arno use of Fuel as deployment tool -- OPNFV Build instructions for Arno with Fuel as deployment tool +- ONOS Drake release +Document changes +~~~~~~~~~~~~~~~~ +This is a follow-up release to Brahmaputra 1.0. It +comes with the following documentation: + +- Installation instructions - *Reference 13* - **Changed** + +- Build instructions - *Reference 14* - **Changed** + +- Release notes - *Reference 15* - **Changed** (This document) Reason for version ------------------ + Feature additions ~~~~~~~~~~~~~~~~~ -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: FUEL-4 | Baselining Fuel 6.0.1 for OPNFV | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: FUEL-17 | Integration of OpenDaylight | -| | | -+--------------------------------------+--------------------------------------+ +**JIRA TICKETS:** + +- Bug corrections ~~~~~~~~~~~~~~~ **JIRA TICKETS:** -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: BGS-57 | The OpenDaylight Helium release is | -| | not fully functional and the | -| | resulting Fuel integration is not | -| | able to cope with the deficiancies. | -| | It is therefore not recommended to | -| | to enable this option. | -| | A functional integration of ODL | -| | version: Lithium is expected to be | -| | available in an upcomming service | -| | release. | -| | | -+--------------------------------------+--------------------------------------+ +`Workarounds `_ 'https://jira.opnfv.org/issues/?filter=11121' + +(Also See respective Integrated feature project's bug tracking) Deliverables ------------ Software deliverables ~~~~~~~~~~~~~~~~~~~~~ -Fuel-based installer iso file + +Fuel-based installer iso file found in *Reference 2* Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for Arno release with the Fuel deployment tool - ver. 1.1.0 -- OPNFV Build instructions for Arno release with the Fuel deployment tool - ver. 1.1.0 -- OPNFV Release Note for Arno release with the Fuel deployment tool - ver. 1.1.3 (this document) + +- Installation instructions - *Reference 13* + +- Build instructions - *Reference 14* + +- Release notes - *Reference 15* (This document) Known Limitations, Issues and Workarounds ========================================= @@ -153,13 +164,13 @@ Known Limitations, Issues and Workarounds System Limitations ------------------ -**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades +- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades -**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade +- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade -**Storage:** Ceph is the only supported storage configuration. +- **Storage:** Ceph is the only supported storage configuration -**Max number of networks:** 3800 (Needs special switch config.) +- **Max number of networks:** 65k Known issues @@ -167,39 +178,69 @@ Known issues **JIRA TICKETS:** -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: FUEL-43 | VMs not accessible through SSH due | -| | to VXLAN 50 Byte overhead and lack | -| | of proper MTU value setting on | -| | virtual ethernet devices | -+--------------------------------------+--------------------------------------+ -| JIRA: FUEL-44 | Centos 6.5 option has not been | -| | enough verified | -+--------------------------------------+--------------------------------------+ +`Known issues `_ 'https://jira.opnfv.org/issues/?filter=11119' +(Also See respective Integrated feature project's bug tracking) Workarounds ----------- -See JIRA: `FUEL-43 ` +**JIRA TICKETS:** + +`Workarounds `_ 'https://jira.opnfv.org/issues/?filter=11120' + +(Also See respective Integrated feature project's bug tracking) -Test Result -=========== -Arno SR1 release with the Fuel deployment tool has undergone QA test runs with the following results: -https://wiki.opnfv.org/arno_sr1_result_page?rev=1443626728 +Test results +============ +The Brahmaputra 3.0 release with the Fuel deployment tool has undergone QA test +runs, see separate test results. References ========== -For more information on the OPNFV Arno release, please see http://wiki.opnfv.org/releases/arno. +For more information on the OPNFV Brahmaputra release, please see: + +OPNFV +----- + +1) `OPNFV Home Page `_ + +2) `OPNFV documentation- and software downloads `_ + +OpenStack +--------- + +3) `OpenStack Liberty Release artifacts `_ + +4) `OpenStack documentation `_ + +OpenDaylight +------------ + +5) `OpenDaylight artifacts `_ + +Fuel +---- + +6) `The Fuel OpenStack project `_ + +7) `Fuel documentation overview `_ + +8) `Fuel planning guide `_ + +9) `Fuel quick start guide `_ + +10) `Fuel operations guide `_ + +11) `Fuel Plugin Developers Guide `_ + +12) `Fuel OpenStack Hardware Compatibility List `_ -:Authors: Jonas Bjurel (Ericsson) -:Version: 1.1.3 +Fuel in OPNFV +------------- -**Documentation tracking** +13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -Revision: _sha1_ +14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -Build date: _date_ +15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_