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
  35 Important notes
  36 ===============
  37
  38 This is the initial OPNFV Arno release that implements the deploy stage of the OPNFV CI pipeline.
  39
  40 Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using Foreman/QuickStack installer.
  41
  42 Summary
  43 =======
  44
  45 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.
  46
  47 - Documentation is built by Jenkins
  48 - .iso image is built by Jenkins
  49 - Jenkins deploys an Arno release with the Foreman/QuickStack deployment toolchain baremetal, which includes 3 control+network nodes, and 2 compute nodes.
  50
  51 Release Data
  52 ============
  53
  54 +--------------------------------------+--------------------------------------+
  55 | **Project**                          | genesis/bgs                          |
  56 |                                      |                                      |
  57 +--------------------------------------+--------------------------------------+
  58 | **Repo/tag**                         | genesis/arno_1.0.0                   |
  59 |                                      |                                      |
  60 +--------------------------------------+--------------------------------------+
  61 | **Release designation**              | Arno 1.0.0                           |
  62 |                                      |                                      |
  63 +--------------------------------------+--------------------------------------+
  64 | **Release date**                     | 2015-06-04                           |
  65 |                                      |                                      |
  66 +--------------------------------------+--------------------------------------+
  67 | **Purpose of the delivery**          | OPNFV Arno release                   |
  68 |                                      |                                      |
  69 +--------------------------------------+--------------------------------------+
  70
  71 Version change
  72 --------------
  73
  74 Module version changes
  75 ~~~~~~~~~~~~~~~~~~~~~~
  76 This is the first tracked version of the Arno release with the Foreman/QuickStack deployment toolchain. It is based on following upstream versions:
  77
  78 - OpenStack (Juno release)
  79
  80 - OpenDaylight Helium-SR2
  81
  82 - CentOS 7
  83
  84 Document version changes
  85 ~~~~~~~~~~~~~~~~~~~~~~~~
  86
  87 This is the first tracked version of Arno release with the Foreman/QuickStack deployment toolchain. The following documentation is provided with this release:
  88
  89 - OPNFV Installation instructions for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0
  90 - OPNFV Release Notes for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0 (this document)
  91
  92 Feature additions
  93 ~~~~~~~~~~~~~~~~~
  94
  95 +--------------------------------------+--------------------------------------+
  96 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  97 |                                      |                                      |
  98 +--------------------------------------+--------------------------------------+
  99 | JIRA: BGS-4                          | OPNFV base system install            |
 100 |                                      | using Foreman/Quickstack.            |
 101 +--------------------------------------+--------------------------------------+
 102
 103 Bug corrections
 104 ~~~~~~~~~~~~~~~
 105
 106 **JIRA TICKETS:**
 107
 108 +--------------------------------------+--------------------------------------+
 109 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 110 |                                      |                                      |
 111 +--------------------------------------+--------------------------------------+
 112 |                                      |                                      |
 113 |                                      |                                      |
 114 +--------------------------------------+--------------------------------------+
 115
 116 Deliverables
 117 ------------
 118
 119 Software deliverables
 120 ~~~~~~~~~~~~~~~~~~~~~
 121 Foreman/QuickStack@OPNFV .iso file
 122 deploy.sh - Automatically deploys Target OPNFV System to Bare Metal
 123
 124 Documentation deliverables
 125 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 126 - OPNFV Installation instructions for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0
 127 - OPNFV Release Notes for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0 (this document)
 128
 129 Known Limitations, Issues and Workarounds
 130 =========================================
 131
 132 System Limitations
 133 ------------------
 134
 135 **Max number of blades:**   1 Foreman/QuickStack master, 3 Controllers, 20 Compute blades
 136
 137 **Min number of blades:**   1 Foreman/QuickStack master, 1 Controller, 1 Compute blade
 138
 139 **Storage:**    Ceph is the only supported storage configuration.
 140
 141 **Min master requirements:** At least 2048 MB of RAM
 142
 143
 144 Known issues
 145 ------------
 146
 147 **JIRA TICKETS:**
 148
 149 +--------------------------------------+--------------------------------------+
 150 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 151 |                                      |                                      |
 152 +--------------------------------------+--------------------------------------+
 153 | JIRA: BGS-13                         | bridge br-ex is not auto configured  |
 154 |                                      | by puppet                            |
 155 +--------------------------------------+--------------------------------------+
 156
 157 Workarounds
 158 -----------
 159 **-**
 160
 161
 162 Test Result
 163 ===========
 164
 165 The Arno release with the Foreman/QuickStack deployment toolchain has undergone QA test runs with the following results:
 166
 167 +--------------------------------------+--------------------------------------+
 168 | **TEST-SUITE**                       | **Results:**                         |
 169 |                                      |                                      |
 170 +--------------------------------------+--------------------------------------+
 171 | **-**                                | **-**                                |
 172 +--------------------------------------+--------------------------------------+
 173
 174
 175 References
 176 ==========
 177
 178 For more information on the OPNFV Arno release, please see:
 179
 180 http://wiki.opnfv.org/release/arno
 181
 182 :Authors: Tim Rozet (trozet@redhat.com)
 183 :Version: 0.2
 184
 185 **Documentation tracking**
 186
 187 Revision: _sha1_
 188
 189 Build date:  _date_
 190