Amended documents with further alignment of structure and some editorials. Prepared...
[genesis.git] / fuel / docs / src / release-notes.rst
index 467de6e..69560e1 100644 (file)
-: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-RC2 release candidate" - Fuel@OPNFV
-================================================================
 
 Abstract
 ========
 
-This document provides the release notes for ARNO-RC2 release candidate of Fuel@OPNFV.
+This document compiles the release notes for the Arno release of OPNFV when using Fuel as a deployment tool.
 
 License
 =======
-Fuel@OPNFV DOCs (c) by Jonas Bjurel (Ericsson AB)
-
-Fuel@OPNFV DOCs are 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
-
-3  Summary
 
-4  Delivery Data
+Arno release with the Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB)
 
-5 Known Limitations, Issues and Workarounds
+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/>.
 
-6 Test Result
-
-7 References
-
-1   Version history
-===================
+Version history
+===============
 
 +--------------------+--------------------+--------------------+--------------------+
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2015-04-16         | 0.1.0              | Jonas Bjurel       | First draft        |
+| 2015-04-16         | 0.1                | Jonas Bjurel       | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2015-04-23         | 0.2                | Jonas Bjurel       | Minor change       |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2015-05-12         | 0.3                | Chris Price        | Minor edits        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2015-06-02         | 0.4                | Chris Price        | Minor edits        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
-2   Important notes
-===================
+Important notes
+===============
 
-This is the first OPNFV Arno pre-release that implements the deploy stage of the OPNFV CI pipeline.
+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 ran 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 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.
+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 pre-release of Fuel@OPNFV adds the deploy stage of the OPNFV CI pipeline
+This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including:
 
-- Documentation is built by Jenkins
-- .iso image is built by Jenkins
-- Jenkins deploy an Fuel@OPNFV stack instance on a nested hypervisor environment (KVM)
+- 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
 
-Automatic test of the deployed system is not part of this pre-release.
 
-4   Release Data
-================
+Release Data
+============
 
 +--------------------------------------+--------------------------------------+
-| **Project**                          | Arno/genesis/fuel                    |
+| **Project**                          | genesis/bgs                          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | genesis/arno-rc2                     |
+| **Repo/tag**                         | genesis/arno_1.0.0                   |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Arno RC2                             |
+| **Release designation**              | Arno 1.0.0                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | 2015-04-16                           |
+| **Release date**                     | 2015-06-04                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | OPNFV Internal quality assurance     |
-|                                      | and CI Pipline dry-run               |
+| **Purpose of the delivery**          | OPNFV Arno release                   |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-4.1 Version change
-------------------
+Version change
+--------------
 
-4.1.1   Module version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of genesis/fuel. It is based on following upstream versions:
-
-- Fuel 6.0.1 (Juno release)
+Module version changes
+~~~~~~~~~~~~~~~~~~~~~~
+This is the first tracked release of genesis/fuel. It is based on following upstream versions:
 
+- Fuel 6.0.1
+- OpenStack Juno release
 - OpenDaylight Helium-SR2
 
-- Ubuntu 12.04.5
-
-4.1.2   Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Document version changes
+~~~~~~~~~~~~~~~~~~~~~~~~
 This is the first tracked version of genesis/fuel. It comes with the following documentation:
 
-- OPNFV Installation instructions for - Fuel@OPNFV - ver. 0.0.1
-- OPNFV Release Note for "Arno-RC2 release candidate" - Fuel@OPNFV - ver. 0.1 (this document)
+- 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
 
-4.2 Reason for version
-----------------------
-4.2.1 Feature additions
-~~~~~~~~~~~~~~~~~~~~~~~
+
+Reason for version
+------------------
+Feature additions
+~~~~~~~~~~~~~~~~~
 
 +--------------------------------------+--------------------------------------+
 | **JIRA REFERENCE**                   | **SLOGAN**                           |
@@ -121,8 +118,8 @@ This is the first tracked version of genesis/fuel. It comes with the following d
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-4.2.2 Bug corrections
-~~~~~~~~~~~~~~~~~~~~~
+Bug corrections
+~~~~~~~~~~~~~~~
 
 **JIRA TICKETS:**
 
@@ -134,23 +131,23 @@ This is the first tracked version of genesis/fuel. It comes with the following d
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-4.3 Deliverables
-----------------
+Deliverables
+------------
 
-4.3.1   Software deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Fuel@OPNFV .iso file
+Software deliverables
+~~~~~~~~~~~~~~~~~~~~~
+Fuel-based installer iso (opnfv.iso) file
 
-4.3.2   Documentation deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- OPNFV Installation instructions for - Fuel@OPNFV - ver. 0.0.1
-- OPNFV Release Note for "Arno-RC2 release candidate" - Fuel@OPNFV - ver. 0.1 (this document)
+Documentation deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+- OPNFV Installation 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
 
@@ -162,8 +159,8 @@ Fuel@OPNFV .iso file
 
 **L3Agent:**   L3 agent and floating IPs is not supported.
 
-5.2    Known issues
--------------------
+Known issues
+------------
 
 **JIRA TICKETS:**
 
@@ -175,15 +172,15 @@ Fuel@OPNFV .iso file
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-5.3    Workarounds
-------------------
+Workarounds
+-----------
 **-**
 
 
-6  Test Result
-==============
+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:**                         |
@@ -193,9 +190,17 @@ Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
 +--------------------------------------+--------------------------------------+
 
 
-7  References
-=============
+References
+==========
+
+For more information on the OPNFV Arno release, please see http://wiki.opnfv.org/releases/arno.
+
+:Authors: Jonas Bjurel (Ericsson)
+:Version: 0.4
+
+**Documentation tracking**
+
+Revision: _sha1_
 
-For more information on the OPNFV Arno release, please see:
+Build date:  _date_
 
-http://wiki.opnfv.org/release/arno