Updating Release Documentation for Brahmaputra 07/9907/1
authorDan Radez <dradez@redhat.com>
Wed, 10 Feb 2016 15:51:19 +0000 (10:51 -0500)
committerTim Rozet <trozet@redhat.com>
Fri, 12 Feb 2016 20:50:47 +0000 (20:50 +0000)
Change-Id: I24171998a0f08a59410d3992cfbb785e01969429
(cherry picked from commit 56954ac259083be55831e771a7b39a7fcacac9e9)

docs/release-notes/release-notes.rst

index cfb0db5..ab54bf4 100644 (file)
@@ -1,5 +1,5 @@
 ============================================================================================
-OPNFV Release Notes for the Bramaputra release of OPNFV when using Apex as a deployment tool
+OPNFV Release Notes for the Brahmaputra release of OPNFV when using Apex as a deployment tool
 ============================================================================================
 
 
@@ -10,7 +10,7 @@ OPNFV Release Notes for the Bramaputra release of OPNFV when using Apex as a dep
 Abstract
 ========
 
-This document provides the release notes for Bramaputra release with the Apex deployment toolchain.
+This document provides the release notes for Brahmaputra release with the Apex deployment toolchain.
 
 License
 =======
@@ -29,23 +29,11 @@ Version history
 | 2015-09-17         | 1.0.0              | Dan Radez          | Rewritten for      |
 |                    |                    |                    | RDO Manager update |
 +--------------------+--------------------+--------------------+--------------------+
-| 2015-09-10         | 0.2.0              | Tim Rozet          | Updated for SR1    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2015-06-03         | 0.1.2              | Tim Rozet          | Minor Edits        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2015-06-02         | 0.1.1              | Chris Price        | Minor Edits        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2015-04-16         | 0.1.0              | Tim Rozet          | First draft        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
 
 Important notes
 ===============
 
-This is the OPNFV Bramaputra release that implements the deploy stage of the OPNFV CI pipeline via Apex.
+This is the OPNFV Brahmaputra 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
 
@@ -54,18 +42,18 @@ Carefully follow the installation-instructions which guide a user on how to depl
 Summary
 =======
 
-Bramaputra release with the Apex deployment toolchain will establish an OPNFV target system
+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 version combined with OpenDaylight version: Lithium.  The system
-is deployed with OpenStack High Availability (HA) for most OpenStack services.  OpenDaylight
-is deployed in non-HA form as HAi support is not availble for OpenDaylight at the time of
-the Bramaputra release.  Ceph storage is used as Cinder backend, and is the only supported
-storage for Bramaputra. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
-node.
+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.
 
 - Documentation is built by Jenkins
 - .iso image is built by Jenkins
-- Jenkins deploys a Bramaputra release with the Apex deployment toolchain baremetal,
+- .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.
 
 Release Data
@@ -75,16 +63,16 @@ Release Data
 | **Project**                          | apex                                 |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | apex/bramaputra.2016.1.0             |
+| **Repo/tag**                         | apex/brahmaputra.1.0                 |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | arno.2016.1.0                        |
+| **Release designation**              | brahmaputra.1.0                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | 2015-02-??                           |
+| **Release date**                     | 2015-02-25                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | OPNFV Bramaputra release             |
+| **Purpose of the delivery**          | OPNFV Brahmaputra release            |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -93,23 +81,23 @@ Version change
 
 Module version changes
 ~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of the Bramapurta release with the Apex deployment toolchain.
+This is the first tracked version of the Brahmaputra release with the Apex deployment toolchain.
 It is based on following upstream versions:
 
 - OpenStack (Liberty release)
 
-- OpenDaylight Lithium
+- OpenDaylight (Beryllium release)
 
 - CentOS 7
 
 Document version changes
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-This is the first tracked version of Bramaputra release with the Apex deployment toolchain.
+This is the first tracked version of Brahmaputra release with the Apex deployment toolchain.
 The following documentation is provided with this release:
 
-- OPNFV Installation instructions for the Bramaputra release with the Apex deployment toolchain - ver. 1.0.0
-- OPNFV Release Notes for the Bramaputra release with the Apex deployment toolchain - ver. 1.0.0 (this document)
+- 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)
 
 Feature additions
 ~~~~~~~~~~~~~~~~~
@@ -125,7 +113,7 @@ Feature additions
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | JIRA: APEX-34                        | Migrate and update Release           |
-|                                      | Documentation for Bramaputra         |
+|                                      | Documentation for Brahmaputra        |
 +--------------------------------------+--------------------------------------+
 
 Bug corrections
@@ -147,23 +135,17 @@ Deliverables
 Software deliverables
 ~~~~~~~~~~~~~~~~~~~~~
 Apex .iso file
-Instack qcow2 disk image
-Overcloud glance disk images
-- deploy-ramdisk-ironic.initramfs
-- deploy-ramdisk-ironic.kernel
-- discovery-ramdisk.initramfs
-- discovery-ramdisk.kernel
-- fedora-user.qcow2
-- overcloud-full.initrd
-- overcloud-full.qcow2
-- overcloud-full.vmlinuz
+Apex overcloud .rpm (opnfv-apex)
+Apex undercloud .rpm (opnfv-apex-undercloud)
+Apex common .rpm (opnfv-apex-common)
 build.sh - Builds the above artifacts
-deploy.sh - Automatically deploys Target OPNFV System to Bare Metal
+opnfv-deploy - Automatically deploys Target OPNFV System
+opnfv-clean - Automatically resets a Target OPNFV Deployment
 
 Documentation deliverables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
-- OPNFV Installation instructions for the Bramaputra release with the Apex deployment toolchain - ver. 1.0.0
-- OPNFV Release Notes for the Bramaputra release with the Apex deployment toolchain - ver. 1.0.0 (this document)
+- 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)
 
 Known Limitations, Issues and Workarounds
 =========================================
@@ -171,13 +153,13 @@ Known Limitations, Issues and Workarounds
 System Limitations
 ------------------
 
-**Max number of blades:**   1 Apex master, 3 Controllers, 20 Compute blades
+**Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
 
-**Min number of blades:**   1 Apex master, 1 Controller, 1 Compute blade
+**Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
 
 **Storage:**    Ceph is the only supported storage configuration.
 
-**Min master requirements:** At least 2048 MB of RAM
+**Min master requirements:** At least 16GB of RAM
 
 
 Known issues
@@ -189,7 +171,7 @@ Known issues
 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| JIRA: APEX-31                        | Support installs without internet    |
+|                                      |                                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -201,7 +183,7 @@ Workarounds
 Test Result
 ===========
 
-The Bramaputra release with the Apex deployment toolchain has undergone QA test runs with the following results:
+The Brahmaputra release with the Apex deployment toolchain has undergone QA test runs with the following results:
 
 +--------------------------------------+--------------------------------------+
 | **TEST-SUITE**                       | **Results:**                         |
@@ -214,9 +196,9 @@ The Bramaputra release with the Apex deployment toolchain has undergone QA test
 References
 ==========
 
-For more information on the OPNFV Bramaputra release, please see:
+For more information on the OPNFV Brahmaputra release, please see:
 
-http://wiki.opnfv.org/releases/bramaputra
+http://wiki.opnfv.org/releases/brahmaputra
 
 :Authors: Tim Rozet (trozet@redhat.com)
 :Authors: Dan Radez (dradez@redhat.com)