summaryrefslogtreecommitdiffstats
path: root/docs/release-notes.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release-notes.rst')
-rw-r--r--docs/release-notes.rst213
1 files changed, 88 insertions, 125 deletions
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index e7b52156c..0ffa683cb 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,100 +1,99 @@
-=========================================================================================
-OPNFV Release Note for the Arno SR1 release of OPNFV when using Fuel as a deployment tool
-=========================================================================================
-
+============================================================================================
+OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+============================================================================================
.. contents:: Table of Contents
:backlinks: none
-
Abstract
========
-This document compiles the release notes for the Arno SR1 release of
+This document compiles the release notes for the Brahmaputra release of
OPNFV when using Fuel as a deployment tool.
License
=======
-Arno SR1 release with the Fuel deployment tool Docs (c) by Jonas
+Brahmaputra release with the Fuel deployment tool Docs (c) by Jonas
Bjurel (Ericsson AB)
-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
-<http://creativecommons.org/licenses/by/4.0/>.
+This document is licensed under a Creative Commons Attribution 4.0
+International License.
-
-Version history
-===============
-
-+--------------------+--------------------+--------------------+--------------------+
-| **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 |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
+You should have received a copy of the license along with this document.
+If not, see <http://creativecommons.org/licenses/by/4.0/>.
Important notes
===============
-For the first OPNFV release (Arno), these notes introduce use of
-`OpenStack Fuel <https://wiki.openstack.org/wiki/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.
-
+These notes provides release information for the use of Fuel as deployment
+tool for the Brahmaputra release of OPNFV.
-Carefully follow the installation-instructions and pay special
-attention to the pre-deploy script that needs to be run before
-deployment is started.
+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.
Summary
=======
-For Arno SR1, the typical use of Fuel as an OpenStack installer is
-supplemented with OPNFV unique components such as `OpenDaylight
-<http://www.opendaylight.org/software>`_ version Helium as well as
-OPNFV-unique configurations.
+For 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 RC1 as"
-This Arno artefact provides Fuel as the deployment stage tool in the
-OPNFV CI pipeline including:
+- `ONOS <http://onosproject.org/>`_ version "Drake"
+
+- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_
+
+- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_
+
+- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
+
+- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
+
+- `VSPERF <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 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** | fuel/<TODO> |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Arno Base Service release 1 (SR1) |
+| **Release designation** | Brahmaputra base release |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 2015-10-01 |
+| **Release date** | <TODO> |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Arno Base SR1 release |
+| **Purpose of the delivery** | Brahmaputra base release |
| | |
+--------------------------------------+--------------------------------------+
@@ -106,73 +105,58 @@ Module version changes
This is the second tracked release of genesis/fuel. It is based on
following upstream versions:
-- Fuel 6.1.0
-- OpenStack Juno release
-- OpenDaylight Litium release
+- Fuel 8.0 pre-release
+
+- OpenStack Liberty release
+
+- OpenDaylight Beryllium pre-release
-Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~
-This is the second tracked version of the fuel installer for OPNFV. It
+- ONOS Drake release
+
+Document changes
+~~~~~~~~~~~~~~~~
+This is the third tracked version of the fuel installer for OPNFV. It
comes with the following documentation:
-- 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
+- OPNFV Installation instructions for Brahmaputra with Fuel as deployment tool - **Changed**
+
+- OPNFV Release Notes for Brahmaputra use of Fuel as deployment tool - **Changed**
+- OPNFV Build instructions for Brahmaputra with Fuel as deployment tool - **Changed**
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:**
+
+`New features <https://jira.opnfv.org/browse/FUEL-81?jql=project%20%3D%20FUEL%20AND%20issuetype%20in%20%28Improvement%2C%20%22New%20Feature%22%2C%20Story%2C%20Sub-task%29%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_
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. |
-| | |
-+--------------------------------------+--------------------------------------+
+`Bug-fixes <https://jira.opnfv.org/browse/FUEL-96?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_
Deliverables
------------
Software deliverables
~~~~~~~~~~~~~~~~~~~~~
-Fuel-based installer iso file <arno.2015.2.0.fuel.iso>
+
+Fuel-based installer iso file <TODO>
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)
+
+- OPNFV Installation instructions for Brahmaputra release with the Fuel deployment tool
+
+- OPNFV Build instructions for Brahmaputra release with the Fuel deployment
+ tool
+
+- OPNFV Release Note for Brahmaputra release with the Fuel deployment tool - (this document)
Known Limitations, Issues and Workarounds
=========================================
@@ -180,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
@@ -194,41 +178,20 @@ 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/browse/FUEL-99?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29>`_
Workarounds
-----------
-See JIRA: `FUEL-43 <https://jira.opnfv.org/browse/FUEL-43>`
+-
-Test Result
-===========
-Arno SR1 release with the Fuel deployment tool has undergone QA test
+Test results
+============
+The Brahmaputra 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
+<TODO>
References
==========
-For more information on the OPNFV Arno release, please see
-http://wiki.opnfv.org/releases/arno.
-
-:Authors: Jonas Bjurel (Ericsson)
-:Version: 1.1.3
-
-**Documentation tracking**
-
-Revision: _sha1_
-
-Build date: _date_
+For more information on the OPNFV Brahmaputra release, please see
+<TODO>