foreman/docs/src/release-notes.rst

   1 =============================================================================================
   2 OPNFV Release Notes for the Arno SR1 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 SR1 release with the Foreman/QuickStack deployment
  14 toolchain.
  15
  16 License
  17 =======
  18
  19 All Foreman/QuickStack and "common" entities are protected by the Apache License
  20 ( http://www.apache.org/licenses/ )
  21
  22
  23 Version history
  24 ===============
  25
  26 +--------------------+--------------------+--------------------+--------------------+
  27 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  28 |                    |                    |                    |                    |
  29 +--------------------+--------------------+--------------------+--------------------+
  30 | 2015-04-16         | 0.1.0              | Tim Rozet          | First draft        |
  31 |                    |                    |                    |                    |
  32 +--------------------+--------------------+--------------------+--------------------+
  33 | 2015-06-02         | 0.1.1              | Chris Price        | Minor Edits        |
  34 |                    |                    |                    |                    |
  35 +--------------------+--------------------+--------------------+--------------------+
  36 | 2015-06-03         | 0.1.2              | Tim Rozet          | Minor Edits        |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39 | 2015-09-10         | 0.2.0              | Tim Rozet          | Updated for SR1    |
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42
  43
  44 Important notes
  45 ===============
  46
  47 This is the OPNFV Arno SR1 release that implements the deploy stage of the OPNFV CI pipeline.
  48
  49 Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using
  50 Foreman/QuickStack installer.
  51
  52 Summary
  53 =======
  54
  55 Arno release with the Foreman/QuickStack deployment toolchain will establish an OPNFV target system on
  56 a Pharos compliant lab infrastructure.  The current definition of an OPNFV target system is and
  57 OpenStack Juno version combined with OpenDaylight version: Helium.  The system is deployed with
  58 OpenStack High Availability (HA) for most OpenStack services.  OpenDaylight is deployed in non-HA form
  59 as HA is not availble for Arno SR1 release.  Ceph storage is used as Cinder backend, and is the only
  60 supported storage for Arno.  Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller node.
  61
  62 - Documentation is built by Jenkins
  63 - .iso image is built by Jenkins
  64 - Jenkins deploys an Arno release with the Foreman/QuickStack deployment toolchain baremetal, which includes 3 control+network nodes, and 2 compute nodes.
  65
  66 Release Data
  67 ============
  68
  69 +--------------------------------------+--------------------------------------+
  70 | **Project**                          | genesis                              |
  71 |                                      |                                      |
  72 +--------------------------------------+--------------------------------------+
  73 | **Repo/tag**                         | genesis/arno.2015.2.0                |
  74 |                                      |                                      |
  75 +--------------------------------------+--------------------------------------+
  76 | **Release designation**              | arno.2015.2.0                        |
  77 |                                      |                                      |
  78 +--------------------------------------+--------------------------------------+
  79 | **Release date**                     | 2015-09-23                           |
  80 |                                      |                                      |
  81 +--------------------------------------+--------------------------------------+
  82 | **Purpose of the delivery**          | OPNFV Arno SR1 release               |
  83 |                                      |                                      |
  84 +--------------------------------------+--------------------------------------+
  85
  86 Version change
  87 --------------
  88
  89 Module version changes
  90 ~~~~~~~~~~~~~~~~~~~~~~
  91 This is the Service Release 1 version of the Arno release with the Foreman/QuickStack deployment
  92 toolchain. It is based on following upstream versions:
  93
  94 - OpenStack (Juno release)
  95
  96 - OpenDaylight Helium-SR3
  97
  98 - CentOS 7
  99
 100 Document version changes
 101 ~~~~~~~~~~~~~~~~~~~~~~~~
 102
 103 This is the SR1 version of Arno release with the Foreman/QuickStack deployment toolchain. The following
 104 documentation is provided with this release:
 105
 106 - OPNFV Installation instructions for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 0.2.0
 107 - OPNFV Release Notes for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 0.2.0 (this document)
 108
 109 Feature additions
 110 ~~~~~~~~~~~~~~~~~
 111
 112 +--------------------------------------+--------------------------------------+
 113 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 114 |                                      |                                      |
 115 +--------------------------------------+--------------------------------------+
 116 | JIRA: BGS-73                         | Changes Virtual deployments to       |
 117 |                                      | only require 1 interface, and adds   |
 118 |                                      | accesbility in China                 |
 119 +--------------------------------------+--------------------------------------+
 120 | JIRA: BGS-75                         | Adds ability to specify number of    |
 121 |                                      | floating IPs                         |
 122 +--------------------------------------+--------------------------------------+
 123 | JIRA: APEX-3                         | clean now removes all VMs            |
 124 |                                      |                                      |
 125 +--------------------------------------+--------------------------------------+
 126 | JIRA: APEX-4                         | Adds ability to specify NICs to      |
 127 |                                      | bridge to on the jumphost            |
 128 +--------------------------------------+--------------------------------------+
 129 | JIRA: BGS-86                         | Adds ability to specify domain name  |
 130 |                                      | for deployment                       |
 131 +--------------------------------------+--------------------------------------+
 132 | JIRA: APEX-1                         | Adds ability to specify VM resources |
 133 |                                      | such as disk size, memory, vcpus     |
 134 +--------------------------------------+--------------------------------------+
 135 | JIRA: APEX-33                        | Adds ability to use single interface |
 136 |                                      | for baremetal installs               |
 137 +--------------------------------------+--------------------------------------+
 138
 139 Bug corrections
 140 ~~~~~~~~~~~~~~~
 141
 142 **JIRA TICKETS:**
 143
 144 +--------------------------------------+--------------------------------------+
 145 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 146 |                                      |                                      |
 147 +--------------------------------------+--------------------------------------+
 148 | JIRA: BGS-65                         | Fixes external network bridge and    |
 149 |                                      | increases neutron quota limits       |
 150 +--------------------------------------+--------------------------------------+
 151 | JIRA: BGS-74                         | Fixes verification of vbox drivers   |
 152 |                                      |                                      |
 153 +--------------------------------------+--------------------------------------+
 154 | JIRA: BGS-59                         | Adds ODL Deployment stack docs to    |
 155 |                                      | Foreman Guide                        |
 156 +--------------------------------------+--------------------------------------+
 157 | JIRA: BGS-60                         | Migrates github bgs_vagrant project  |
 158 |                                      | into Genesis                         |
 159 +--------------------------------------+--------------------------------------+
 160 | JIRA: BGS-89                         | Fixes public allocation IP           |
 161 |                                      |                                      |
 162 +--------------------------------------+--------------------------------------+
 163 | JIRA: BGS-71                         | Adds check to ensure subnets are the |
 164 |                                      | minimum size required                |
 165 +--------------------------------------+--------------------------------------+
 166 | JIRA: BGS-78                         | Fixes Foreman clean to not hang and  |
 167 |                                      | now also removes libvirt             |
 168 +--------------------------------------+--------------------------------------+
 169 | JIRA: APEX-7                         | Adds check to make sure 3 control    |
 170 |                                      | nodes are set when HA is enabled     |
 171 +--------------------------------------+--------------------------------------+
 172 | JIRA: BGS-68                         | Adds check to make sure baremetal    |
 173 |                                      | nodes are powered off when deploying |
 174 +--------------------------------------+--------------------------------------+
 175 | JIRA: APEX-14                        | Fixes Vagrant base box to be opnfv   |
 176 |                                      |                                      |
 177 +--------------------------------------+--------------------------------------+
 178 | JIRA: APEX-8                         | Fixes puppet modules to come from    |
 179 |                                      | the Genesis repo                     |
 180 +--------------------------------------+--------------------------------------+
 181 | JIRA: APEX-17                        | Fixes clean to kill vagrant processes|
 182 |                                      | correctly                            |
 183 +--------------------------------------+--------------------------------------+
 184 | JIRA: APEX-2                         | Removes default vagrant route from   |
 185 |                                      | virtual nodes                        |
 186 +--------------------------------------+--------------------------------------+
 187 | JIRA: APEX-9                         | Fixes external network to be created |
 188 |                                      | by the services tenant               |
 189 +--------------------------------------+--------------------------------------+
 190 | JIRA: APEX-10                        | Disables DHCP on external neutron    |
 191 |                                      | network                              |
 192 +--------------------------------------+--------------------------------------+
 193 | JIRA: APEX-19                        | Adds check to ensure provided arg    |
 194 |                                      | static_ip_range is correct           |
 195 +--------------------------------------+--------------------------------------+
 196 | JIRA: APEX-12                        | Fixes horizon IP URL for non-HA      |
 197 |                                      | deployments                          |
 198 +--------------------------------------+--------------------------------------+
 199
 200
 201 Deliverables
 202 ------------
 203
 204 Software deliverables
 205 ~~~~~~~~~~~~~~~~~~~~~
 206 Foreman/QuickStack@OPNFV .iso file
 207 deploy.sh - Automatically deploys Target OPNFV System to Bare Metal or VMs
 208
 209 Documentation deliverables
 210 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 211 - OPNFV Installation instructions for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.2.0
 212 - OPNFV Release Notes for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.2.0 (this document)
 213
 214 Known Limitations, Issues and Workarounds
 215 =========================================
 216
 217 System Limitations
 218 ------------------
 219
 220 **Max number of blades:**   1 Foreman/QuickStack master, 3 Controllers, 20 Compute blades
 221
 222 **Min number of blades:**   1 Foreman/QuickStack master, 1 Controller, 1 Compute blade
 223
 224 **Storage:**    Ceph is the only supported storage configuration.
 225
 226 **Min master requirements:** At least 2048 MB of RAM
 227
 228
 229 Known issues
 230 ------------
 231
 232 **JIRA TICKETS:**
 233
 234 +--------------------------------------+--------------------------------------+
 235 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 236 |                                      |                                      |
 237 +--------------------------------------+--------------------------------------+
 238 | JIRA: APEX-13                        | Keystone Config: bind host is wrong  |
 239 |                                      | for admin user                       |
 240 +--------------------------------------+--------------------------------------+
 241 | JIRA: APEX-38                        | Neutron fails to provide DHCP address|
 242 |                                      | to instance                          |
 243 +--------------------------------------+--------------------------------------+
 244
 245 Workarounds
 246 -----------
 247 **-**
 248
 249
 250 Test Result
 251 ===========
 252
 253 The Arno release with the Foreman/QuickStack deployment toolchain has undergone QA test runs with the
 254 following results:
 255
 256 +--------------------------------------+--------------------------------------+
 257 | **TEST-SUITE**                       | **Results:**                         |
 258 |                                      |                                      |
 259 +--------------------------------------+--------------------------------------+
 260 | **-**                                | **-**                                |
 261 +--------------------------------------+--------------------------------------+
 262
 263
 264 References
 265 ==========
 266
 267 For more information on the OPNFV Arno release, please see:
 268
 269 http://wiki.opnfv.org/release/arno
 270
 271 :Authors: Tim Rozet (trozet@redhat.com)
 272 :Version: 0.2
 273
 274 **Documentation tracking**
 275
 276 Revision: _sha1_
 277
 278 Build date:  _date_
 279