From c3643b857be79ebdfd2340118ccd8288bb80cb23 Mon Sep 17 00:00:00 2001 From: Dan Radez Date: Wed, 10 Aug 2016 15:53:36 -0400 Subject: Initial pass through the docs for Colorado Release - doc8 compatibility - wraped lines at 79 chars - updated basic information - have not added any new feature information JIRA: DOCS-114 Change-Id: I6fad44315ce9211305399d2d220d0fe80365454a Signed-off-by: Dan Radez --- docs/release-notes/release-notes.rst | 95 +++++++++++++++++++++--------------- 1 file changed, 55 insertions(+), 40 deletions(-) (limited to 'docs/release-notes/release-notes.rst') diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst index a066e075..080d2043 100644 --- a/docs/release-notes/release-notes.rst +++ b/docs/release-notes/release-notes.rst @@ -1,6 +1,6 @@ -============================================================================================ -OPNFV Release Notes for the Brahmaputra release of OPNFV when using Apex as a deployment tool -============================================================================================ +========================================================================== +OPNFV Release Notes for the Colorado release of OPNFV Apex deployment tool +========================================================================== .. contents:: Table of Contents @@ -10,51 +10,60 @@ OPNFV Release Notes for the Brahmaputra release of OPNFV when using Apex as a de Abstract ======== -This document provides the release notes for Brahmaputra release with the Apex deployment toolchain. +This document provides the release notes for Colorado release with the Apex +deployment toolchain. License ======= -All Apex and "common" entities are protected by the Apache License ( http://www.apache.org/licenses/ ) +All Apex and "common" entities are protected by the Apache License +( http://www.apache.org/licenses/ ) Version history =============== -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-09-17 | 1.0.0 | Dan Radez | Rewritten for | -| | | | RDO Manager update | -+--------------------+--------------------+--------------------+--------------------+ ++-------------+-----------+-----------------+----------------------+ +| **Date** | **Ver.** | **Authors** | **Comment** | +| | | | | ++-------------+-----------+-----------------+----------------------+ +| 2016-08-11 | 2.0.0 | Dan Radez | Updates for Colorado | ++-------------+-----------+-----------------+----------------------+ +| 2015-09-17 | 1.0.0 | Dan Radez | Rewritten for | +| | | | RDO Manager update | ++-------------+-----------+-----------------+----------------------+ Important notes =============== -This is the OPNFV Brahmaputra release that implements the deploy stage of the OPNFV CI pipeline via Apex. +This is the OPNFV Colorado release that implements the deploy stage of the +OPNFV CI pipeline via Apex. -Apex is based on RDO Manager. More information at http://rdoproject.org +Apex is based on RDO's Triple-O installation tool chain. +More information at http://rdoproject.org -Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using Apex installer. +Carefully follow the installation-instructions which guide a user on how to +deploy OPNFV using Apex installer. Summary ======= -Brahmaputra release with the Apex deployment toolchain will establish an OPNFV target system -on a Pharos compliant lab infrastructure. The current definition of an OPNFV target system -is and OpenStack Liberty combined with OpenDaylight Beryllium. The system is deployed with -OpenStack High Availability (HA) for most OpenStack services. OpenDaylight is deployed in -non-HA form as HA support is not availble for OpenDaylight at the time of the Brahmaputra -release. Ceph storage is used as Cinder backend, and is the only supported storage for -Brahmaputra. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller node. +Colorado release with the Apex deployment toolchain will establish an OPNFV +target system on a Pharos compliant lab infrastructure. The current definition +of an OPNFV target system is and OpenStack Liberty combined with OpenDaylight +Beryllium. The system is deployed with OpenStack High Availability (HA) for +most OpenStack services. OpenDaylight is deployed in non-HA form as HA support +is not availble for OpenDaylight at the time of the Colorado release. Ceph +storage is used as Cinder backend, and is the only supported storage for +Colorado. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller +node. - Documentation is built by Jenkins - .iso image is built by Jenkins - .rpm packages are built by Jenkins -- Jenkins deploys a Brahmaputra release with the Apex deployment toolchain baremetal, - which includes 3 control+network nodes, and 2 compute nodes. +- Jenkins deploys a Colorado release with the Apex deployment toolchain + baremetal, which includes 3 control+network nodes, and 2 compute nodes. Release Data ============ @@ -63,16 +72,16 @@ Release Data | **Project** | apex | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | apex/brahmaputra.1.0 | +| **Repo/tag** | apex/colorado.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | brahmaputra.1.0 | +| **Release designation** | colorado.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2015-02-25 | +| **Release date** | 2016-09-14 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Brahmaputra release | +| **Purpose of the delivery** | OPNFV Colorado release | | | | +--------------------------------------+--------------------------------------+ @@ -81,10 +90,10 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of the Brahmaputra release with the Apex deployment toolchain. -It is based on following upstream versions: +This is the first tracked version of the Colorado release with the Apex +deployment toolchain. It is based on following upstream versions: -- OpenStack (Liberty release) +- OpenStack (Mitaka release) - OpenDaylight (Beryllium release) @@ -93,11 +102,14 @@ It is based on following upstream versions: Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of Brahmaputra release with the Apex deployment toolchain. +This is the first tracked version of Colorado release with the Apex +deployment toolchain. The following documentation is provided with this release: -- OPNFV Installation instructions for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 -- OPNFV Release Notes for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 (this document) +- OPNFV Installation instructions for the Colorado release with the Apex + deployment toolchain - ver. 1.0.0 +- OPNFV Release Notes for the Colorado release with the Apex deployment + toolchain - ver. 1.0.0 (this document) Feature additions ~~~~~~~~~~~~~~~~~ @@ -113,7 +125,7 @@ Feature additions | | | +--------------------------------------+--------------------------------------+ | JIRA: APEX-34 | Migrate and update Release | -| | Documentation for Brahmaputra | +| | Documentation for Colorado | +--------------------------------------+--------------------------------------+ Bug corrections @@ -144,8 +156,10 @@ opnfv-clean - Automatically resets a Target OPNFV Deployment Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 -- OPNFV Release Notes for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 (this document) +- OPNFV Installation instructions for the Colorado release with the Apex + deployment toolchain - ver. 1.0.0 +- OPNFV Release Notes for the Colorado release with the Apex deployment + toolchain - ver. 1.0.0 (this document) Known Limitations, Issues and Workarounds ========================================= @@ -210,7 +224,8 @@ Workarounds Test Result =========== -The Brahmaputra release with the Apex deployment toolchain has undergone QA test runs with the following results: +The Colorado release with the Apex deployment toolchain has undergone QA +test runs with the following results: +--------------------------------------+--------------------------------------+ | **TEST-SUITE** | **Results:** | @@ -223,9 +238,9 @@ The Brahmaputra release with the Apex deployment toolchain has undergone QA test References ========== -For more information on the OPNFV Brahmaputra release, please see: +For more information on the OPNFV Colorado release, please see: -http://wiki.opnfv.org/releases/brahmaputra +http://wiki.opnfv.org/releases/Colorado :Authors: Tim Rozet (trozet@redhat.com) :Authors: Dan Radez (dradez@redhat.com) -- cgit 1.2.3-korg