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