Update of release notes towards SR1
[genesis.git] / fuel / docs / src / release-notes.rst
index 0b8187c..05b9780 100644 (file)
-:Authors: Jonas Bjurel (Ericsson)
-:Version: 0.3
-
 =====================================================================================
-OPNFV Release Note for the Arno release of OPNFV when using Fuel as a deployment tool
+OPNFV Release Note for the Arno SR1 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 release, when using Fuel as a deployment tool.
+This document compiles the release notes for the Arno SR1 release of OPNFV when using Fuel as a deployment tool.
 
 License
 =======
-Arno release with th Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB)
-
-Arno 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/>.
-
-
-**Contents**
-
-1  Version History
-
-2  Important notes
-
-3  Summary
-
-4  Delivery Data
-
-5 Known Limitations, Issues and Workarounds
 
-6 Test Result
+Arno release with the Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB)
 
-7 References
+Arno 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/>.
 
-1   Version history
-===================
+Version history
+===============
 
 +--------------------+--------------------+--------------------+--------------------+
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2015-04-16         | 0.1                | Jonas Bjurel       | First draft        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2015-04-23         | 0.2                | Jonas Bjurel       | Minor change       |
+| 2015-06-03         | 1.0.0              | Jonas Bjurel       | Arno SR0 release   |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2015-05-12         | 0.3                | Chris Price        | Minor edits       |
+| 2015-09-10         | 1.1.0              | Jonas Bjurel       | Arno SR1 release   |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
-2   Important notes
-===================
+Important notes
+===============
 
-This is the first OPNFV release of Arno using Fuel as the deploment stage of the OPNFV CI pipeline.  The intention of this release is to establish a foundation platform to accelerate the development of the OPNFV infrastructure.
+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.
 
-Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be run befor deployment is started.
+Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be run before deployment is started.
 
-3   Summary
-===========
+Summary
+=======
 
-Arno release with the Fuel deployment tool uses the OpenStack Fuel upstream project version 6.0.1, but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations.
+For Arno, 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.
 
-This Arno release artefact provides the Fuel deployment tool as the deploy stage of the OPNFV CI pipeline including:
+This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including:
 
 - Documentation built by Jenkins
-- The Arno .iso image built by Jenkins
-- Automated deployment of the Arno release with the Fuel deployment tool stack instance on bare metal or a nested hypervisor environment (KVM)
+  - 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
 
 
-4   Release Data
-================
+Release Data
+============
 
 +--------------------------------------+--------------------------------------+
-| **Project**                          | Arno/genesis/fuel                |
+| **Project**                          | genesis/bgs                          |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/tag**                         | genesis/arno.2015.2.0                |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | genesis/arno                     |
+| **Release designation**              | Arno Base Service release 1 (SR1)    |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Arno                             |
+| **Release date**                     | 2015-09-28                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | 2015-Spring                      |
+| **Purpose of the delivery**          | OPNFV Arno Base SR1 release          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-4.1 Version change
-------------------
+Version change
+--------------
 
-4.1.1   Module version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked release of genesis/fuel. It is based on following upstream versions:
+Module version changes
+~~~~~~~~~~~~~~~~~~~~~~
+This is the second tracked release of genesis/fuel. It is based on following upstream versions:
 
-- Fuel 6.0.1 (Juno release)
+- Fuel 6.1.0
+- OpenStack Juno release
+- OpenDaylight Litium-SR1
 
-- OpenDaylight Helium-SR2
+Document version changes
+~~~~~~~~~~~~~~~~~~~~~~~~
+This is the second tracked version of the fuel installer for OPNFV. It comes with the following documentation:
 
-4.1.2   Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of genesis/fuel. 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 the Arno release with the Fuel deployment tool - ver. 0.0.1
-- OPNFV Release Notes for Arno release with the Fuel deployment tool - ver. 0.1 (this document)
 
-4.2 Reason for version
-----------------------
-4.2.1 Feature additions
-~~~~~~~~~~~~~~~~~~~~~~~
+Reason for version
+------------------
+Feature additions
+~~~~~~~~~~~~~~~~~
 
 +--------------------------------------+--------------------------------------+
 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| JIRA:                                | Baselining Fuel 6.0.1 for OPNFV      |
+| JIRA:-                               | Baselining Fuel 6.0.1 for OPNFV      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| JIRA:                                | Integration of OpenDaylight          |
+| JIRA:-                               | Integration of OpenDaylight          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-4.2.2 Bug corrections
-~~~~~~~~~~~~~~~~~~~~~
+Bug corrections
+~~~~~~~~~~~~~~~
 
 **JIRA TICKETS:**
 
@@ -130,27 +121,64 @@ This is the first tracked version of genesis/fuel. It comes with the following d
 | **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.                             |
 |                                      |                                      |
++--------------------------------------+--------------------------------------+
 |                                      |                                      |
+| FUEL-4                               | Fuel 6.1 build rebasing              |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+| FUEL-5                               | Fuel 6.1 deploy rebasing             |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+| FUEL-7                               | Deploy clean-up script               |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+| FUEL-8                               | Virtualized deployment               |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+| FUEL-11                              | Updated installation instructions    |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+| FUEL-12                              | Updated build-system documentation   |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+| FUEL-13                              | Updated deploy-system documentation  |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+| FUEL-16                              | Deployment of ODL plugin             |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+| FUEL-17                              | ODL plugin for Fuel 6.1              |
 +--------------------------------------+--------------------------------------+
 
-4.3 Deliverables
-----------------
+Deliverables
+------------
 
-4.3.1   Software deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Fuel@OPNFV .iso file
+Software deliverables
+~~~~~~~~~~~~~~~~~~~~~
+Fuel-based installer iso file <arno.2015.1.0.fuel.iso>
 
-4.3.2   Documentation deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- OPNFV Installation instructions for Arno release with the Fuel deployment tool - ver. 0.0.1
-- OPNFV Release Note for Arno release with the Fuel deployment tool - ver. 0.1 (this document)
+Documentation deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+- OPNFV Installation instructions for Arno release with the Fuel deployment tool - ver. 1.0.0
+- OPNFV Build instructions for Arno release with the Fuel deployment tool - ver. 1.0.0
+- OPNFV Release Note for Arno release with the Fuel deployment tool - ver. 1.0.0 (this document)
 
-5  Known Limitations, Issues and Workarounds
-============================================
+Known Limitations, Issues and Workarounds
+=========================================
 
-5.1    System Limitations
--------------------------
+System Limitations
+------------------
 
 **Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
 
@@ -160,10 +188,9 @@ Fuel@OPNFV .iso file
 
 **Max number of networks:**   3800 (Needs special switch config.)
 
-**L3Agent:**   L3 agent and floating IPs is not supported.
 
-5.2    Known issues
--------------------
+Known issues
+------------
 
 **JIRA TICKETS:**
 
@@ -171,17 +198,14 @@ Fuel@OPNFV .iso file
 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| JIRA:                                | CentOS is not supported              |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
 
-5.3    Workarounds
-------------------
-**-**
+Workarounds
+-----------
+-
 
 
-6  Test Result
-==============
+Test Result
+===========
 
 Arno release with the Fuel deployment tool has undergone QA test runs with the following results:
 
@@ -189,13 +213,39 @@ Arno release with the Fuel deployment tool has undergone QA test runs with the f
 | **TEST-SUITE**                       | **Results:**                         |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **-**                                | **-**                                |
+| Tempest test suite 1:                | 27 out of 105 testcases fails        |
+|                                      | see note (1) and note (2)            |
++--------------------------------------+--------------------------------------+
+| Tempest test suite 2:                | 26 out of 100 testcases fails        |
+|                                      | see note (1) and note (2)            |
++--------------------------------------+--------------------------------------+
+| Tempest test suite 3:                | 14 out of 106 testcases fails        |
+|                                      | see note (1) and note (2)            |
++--------------------------------------+--------------------------------------+
+| Rally test suite suie 1:             | 10 out of 18 testcases fails         |
+|                                      | see note (1) and note (3)            |
++--------------------------------------+--------------------------------------+
+| ODL test suite suie                  | 7 out of 7 testcases fails           |
+|                                      | see note (1) and note (4)            |
++--------------------------------------+--------------------------------------+
+| vPING                                | OK                                   |
+|                                      | see note (1)                         |
 +--------------------------------------+--------------------------------------+
 
+** - Note (1): Have been run with ODL controller active but not with integrated ODL networking VXLAN segmentation activated **
+** - Note (2): see https://wiki.opnfv.org/r1_tempest **
+** - Note (3): see https://wiki.opnfv.org/r1_rally_bench **
+** - Note (4): see https://wiki.opnfv.org/r1_odl_suite **
+
+References
+==========
+For more information on the OPNFV Arno release, please see http://wiki.opnfv.org/releases/arno.
+
+:Authors: Jonas Bjurel (Ericsson)
+:Version: 1.0.0
 
-7  References
-=============
+**Documentation tracking**
 
-For more information on the OPNFV Arno release, please see:
+Revision: _sha1_
 
-http://wiki.opnfv.org/release/arno
+Build date:  _date_