foreman/docs/src/release-notes.rst

   1 ===========================================================================================
   2 OPNFV Release Note for  the Arno release of OPNFV when using Foreman as a deployment tool
   3 ===========================================================================================
   4
   5
   6 .. contents:: Table of Contents
   7    :backlinks: none
   8
   9
  10 Abstract
  11 ========
  12
  13 This document provides the release notes for Arno release with the Foreman/QuickStack deployment toolchain.
  14
  15 License
  16 =======
  17
  18 All Foreman/QuickStack and "common" entities are protected by the Apache License ( http://www.apache.org/licenses/ )
  19
  20
  21 Version history
  22 ===============
  23
  24 +--------------------+--------------------+--------------------+--------------------+
  25 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28 | 2015-04-16         | 0.1.0              | Tim Rozet          | First draft        |
  29 |                    |                    |                    |                    |
  30 +--------------------+--------------------+--------------------+--------------------+
  31 | 2015-06-02         | 0.1.1              | Chris Price        | Minor Edits        |
  32 |                    |                    |                    |                    |
  33 +--------------------+--------------------+--------------------+--------------------+
  34 | 2015-06-03         | 0.1.2              | Tim Rozet          | Minor Edits        |
  35 |                    |                    |                    |                    |
  36 +--------------------+--------------------+--------------------+--------------------+
  37
  38 Important notes
  39 ===============
  40
  41 This is the initial OPNFV Arno release that implements the deploy stage of the OPNFV CI pipeline.
  42
  43 Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using Foreman/QuickStack installer.
  44
  45 Summary
  46 =======
  47
  48 Arno release with the Foreman/QuickStack 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 Juno version combined with OpenDaylight version: Helium.  The system is deployed with OpenStack High Availability (HA) for most OpenStack services.  OpenDaylight is deployed in non-HA form as HA is not availble for Arno release.  Ceph storage is used as Cinder backend, and is the only supported storage for Arno.  Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller node.
  49
  50 - Documentation is built by Jenkins
  51 - .iso image is built by Jenkins
  52 - Jenkins deploys an Arno release with the Foreman/QuickStack deployment toolchain baremetal, which includes 3 control+network nodes, and 2 compute nodes.
  53
  54 Release Data
  55 ============
  56
  57 +--------------------------------------+--------------------------------------+
  58 | **Project**                          | genesis                              |
  59 |                                      |                                      |
  60 +--------------------------------------+--------------------------------------+
  61 | **Repo/tag**                         | genesis/arno.2015.1.0                |
  62 |                                      |                                      |
  63 +--------------------------------------+--------------------------------------+
  64 | **Release designation**              | arno.2015.1.0                        |
  65 |                                      |                                      |
  66 +--------------------------------------+--------------------------------------+
  67 | **Release date**                     | 2015-06-04                           |
  68 |                                      |                                      |
  69 +--------------------------------------+--------------------------------------+
  70 | **Purpose of the delivery**          | OPNFV Arno release                   |
  71 |                                      |                                      |
  72 +--------------------------------------+--------------------------------------+
  73
  74 Version change
  75 --------------
  76
  77 Module version changes
  78 ~~~~~~~~~~~~~~~~~~~~~~
  79 This is the first tracked version of the Arno release with the Foreman/QuickStack deployment toolchain. It is based on following upstream versions:
  80
  81 - OpenStack (Juno release)
  82
  83 - OpenDaylight Helium-SR3
  84
  85 - CentOS 7
  86
  87 Document version changes
  88 ~~~~~~~~~~~~~~~~~~~~~~~~
  89
  90 This is the first tracked version of Arno release with the Foreman/QuickStack deployment toolchain. The following documentation is provided with this release:
  91
  92 - OPNFV Installation instructions for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0
  93 - OPNFV Release Notes for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0 (this document)
  94
  95 Feature additions
  96 ~~~~~~~~~~~~~~~~~
  97
  98 +--------------------------------------+--------------------------------------+
  99 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 100 |                                      |                                      |
 101 +--------------------------------------+--------------------------------------+
 102 | JIRA: BGS-4                          | OPNFV base system install            |
 103 |                                      | using Foreman/Quickstack.            |
 104 +--------------------------------------+--------------------------------------+
 105
 106 Bug corrections
 107 ~~~~~~~~~~~~~~~
 108
 109 **JIRA TICKETS:**
 110
 111 +--------------------------------------+--------------------------------------+
 112 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 113 |                                      |                                      |
 114 +--------------------------------------+--------------------------------------+
 115 |                                      |                                      |
 116 |                                      |                                      |
 117 +--------------------------------------+--------------------------------------+
 118
 119 Deliverables
 120 ------------
 121
 122 Software deliverables
 123 ~~~~~~~~~~~~~~~~~~~~~
 124 Foreman/QuickStack@OPNFV .iso file
 125 deploy.sh - Automatically deploys Target OPNFV System to Bare Metal
 126
 127 Documentation deliverables
 128 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 129 - OPNFV Installation instructions for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0
 130 - OPNFV Release Notes for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0 (this document)
 131
 132 Known Limitations, Issues and Workarounds
 133 =========================================
 134
 135 System Limitations
 136 ------------------
 137
 138 **Max number of blades:**   1 Foreman/QuickStack master, 3 Controllers, 20 Compute blades
 139
 140 **Min number of blades:**   1 Foreman/QuickStack master, 1 Controller, 1 Compute blade
 141
 142 **Storage:**    Ceph is the only supported storage configuration.
 143
 144 **Min master requirements:** At least 2048 MB of RAM
 145
 146
 147 Known issues
 148 ------------
 149
 150 **JIRA TICKETS:**
 151
 152 +--------------------------------------+--------------------------------------+
 153 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 154 |                                      |                                      |
 155 +--------------------------------------+--------------------------------------+
 156 | JIRA: BGS-13                         | bridge br-ex is not auto configured  |
 157 |                                      | by puppet                            |
 158 +--------------------------------------+--------------------------------------+
 159
 160 Workarounds
 161 -----------
 162 **-**
 163
 164
 165 Test Result
 166 ===========
 167
 168 The Arno release with the Foreman/QuickStack deployment toolchain has undergone QA test runs with the following results:
 169
 170 +--------------------------------------+--------------------------------------+
 171 | **TEST-SUITE**                       | **Results:**                         |
 172 |                                      |                                      |
 173 +--------------------------------------+--------------------------------------+
 174 | **-**                                | **-**                                |
 175 +--------------------------------------+--------------------------------------+
 176
 177
 178 References
 179 ==========
 180
 181 For more information on the OPNFV Arno release, please see:
 182
 183 http://wiki.opnfv.org/release/arno
 184
 185 :Authors: Tim Rozet (trozet@redhat.com)
 186 :Version: 0.2
 187
 188 **Documentation tracking**
 189
 190 Revision: _sha1_
 191
 192 Build date:  _date_
 193