-:Authors: Jonas Bjurel (Ericsson)
-:Version: 0.1
+=====================================================================================
+OPNFV Release Note for the Arno release of OPNFV when using Fuel as a deployment tool
+=====================================================================================
+
+
+.. contents:: Table of Contents
+ :backlinks: none
-======================================================================
-OPNFV Release Note for "Arno-SRx release" - < Component denomination >
-======================================================================
Abstract
========
-This document provides the release notes for <RELEASE> of <COMPONENT>.
+This document compiles the release notes for the Arno release of OPNFV when using Fuel as a deployment tool.
License
=======
-<WORK'S NAME> (c) by <AUTHOR'S NAME>
-
-<WORK'S NAME> is licensed under a Creative Commons Attribution 4.0 Unported 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
+Arno release with the Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB)
-3 Summary
+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/>.
-4 Delivery Data
-
-5 Known Limitations, Issues and Workarounds
-
-6 Test Result
-
-7 References
-
-1 Version history
-===================
+Version history
+===============
+--------------------+--------------------+--------------------+--------------------+
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft |
+| 2015-06-03 | 1.0.0 | Jonas Bjurel | Arno SR0 release |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| | 0.1.1 | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | 1.0 | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-
-2 Important notes
-===================
-<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
+Important notes
+===============
-<EXAMPLE>:
+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.
-**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master – see the OPNFV@Fuel SW installation instructions
+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
+=======
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+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.
-<EXAMPLE>:
+This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including:
-Arno Fuel@OPNFV is based 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......
+- Documentation built by Jenkins
+ - 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
-================
-<STATE RELEVANT RELEASE DATA/RECORDS>
-<EXAMPLE>:
+Release Data
+============
+--------------------------------------+--------------------------------------+
-| **Project** | E.g. Arno/genesis/fuel@opnfv |
+| **Project** | genesis/bgs |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
+| **Repo/tag** | genesis/arno.2015.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | E.g. Arno RC2 |
+| **Release designation** | Arno Base Service release 0 (SR0) |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | E.g. 2015-04-16 |
+| **Release date** | 2015-06-04 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance|
+| **Purpose of the delivery** | OPNFV Arno Base SR0 release |
| | |
+--------------------------------------+--------------------------------------+
-4.1 Version change
-------------------
-
-4.1.1 Module version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>
-
-<EXAMPLE>:
+Version change
+--------------
-- Fuel have changed from 5.1 to 6.0.1
+Module version changes
+~~~~~~~~~~~~~~~~~~~~~~
+This is the first tracked release of genesis/fuel. It is based on following upstream versions:
-- OpenDaylight has changed from Helium-SR1 to Helium-SR2
+- Fuel 6.0.1
+- OpenStack Juno release
+- OpenDaylight Helium-SR3
-4.1.2 Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>
+Document version changes
+~~~~~~~~~~~~~~~~~~~~~~~~
+This is the first tracked version of the fuel installer for OPNFV. It comes with the following documentation:
-<EXAMPLE>:
+- 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
-- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2
-4.2 Reason for version
-----------------------
-4.2.1 Feature additions
-~~~~~~~~~~~~~~~~~~~~~~~
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
-
-**JIRA BACK-LOG:**
+Reason for version
+------------------
+Feature additions
+~~~~~~~~~~~~~~~~~
+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-123 | ADD OpenDaylight ml2 integration |
+| JIRA:- | Baselining Fuel 6.0.1 for OPNFV |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-456 | Add auto-deployment of Fuel@OPNFV |
+| JIRA:- | Integration of OpenDaylight |
| | |
+--------------------------------------+--------------------------------------+
-4.2.2 Bug corrections
-~~~~~~~~~~~~~~~~~~~~~
+Bug corrections
+~~~~~~~~~~~~~~~
**JIRA TICKETS:**
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-888 | Fuel doesn't deploy |
-| | |
-+--------------------------------------+--------------------------------------+
-| BGS-999 | Floating IP doesn't work |
| | |
+| - | - |
+--------------------------------------+--------------------------------------+
-4.3 Deliverables
-----------------
+Deliverables
+------------
-4.3.1 Software deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-<EXAMPLE>:
-
-4.3.2 Documentation deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-<EXAMPLE>:
+Software deliverables
+~~~~~~~~~~~~~~~~~~~~~
+Fuel-based installer iso file <arno.2015.1.0.fuel.iso>
-5 Known Limitations, Issues and Workarounds
-============================================
+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.1 System Limitations
--------------------------
-<STATE ALL RELEVANT SYSTEM LIMITATIONS>
+Known Limitations, Issues and Workarounds
+=========================================
-<EXAMPLE>:
+System Limitations
+------------------
**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
**Max number of networks:** 3800 (Needs special switch config.)
-**L3Agent:** L3 agent and floating IPs is not supported.
-5.2 Known issues
--------------------
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
-
-<EXAMPLE>:
+Known issues
+------------
**JIRA TICKETS:**
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-987 | Nova-compute process does |
-| | not re-spawn when killed |
-| | |
-+--------------------------------------+--------------------------------------+
-| BGS-654 | MOS 5.1 : neutron net-list returns |
-| | "400 Bad request" |
+| 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. |
| | |
+--------------------------------------+--------------------------------------+
-5.3 Workarounds
-------------------
-
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>
-
-<EXAMPLE>:
+Workarounds
+-----------
+Current workaround for the JIRA: BGS-57 is not to enable OpenDaylight networking - see installation instructions.
-- In case the contact with a compute is lost - restart the compute host
-- In case the disk is full on a controller - delete all files in /tmp
-6 Test Result
-==============
-<STATE THE QA COVERAGE AND RESULTS>
-
-<EXAMPLE>:
+Test Result
+===========
-Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
+Arno release with the Fuel deployment tool has undergone QA test runs with the following results:
+--------------------------------------+--------------------------------------+
| **TEST-SUITE** | **Results:** |
| | |
+--------------------------------------+--------------------------------------+
-| Tempest test suite 123 | Following tests failed: |
-| | |
-| | 1. Image resizing.... |
-| | |
-| | 2. Heat deploy.... |
+| Tempest test suite 1: | 27 out of 105 testcases fails |
+| | see note (1) and note (2) |
+--------------------------------------+--------------------------------------+
-| Robot test suite 456 | Following tests failed: |
-| | |
-| | 1....... |
-| | |
-| | 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) |
+--------------------------------------+--------------------------------------+
-7 References
-=============
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
+** - 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
-<EXAMPLE>:
+**Documentation tracking**
-For more information on the OPNFV Arno release, please see:
+Revision: _sha1_
-http://wiki.opnfv.org/release/arno
+Build date: _date_