docs/release/release-notes/release-notes.rst

   1 ========================================================================
   2 OPNFV Release Notes for the Gambia release of OPNFV Apex deployment tool
   3 ========================================================================
   4
   5 Abstract
   6 ========
   7
   8 This document provides the release notes for Gambia release with the Apex
   9 deployment toolchain.
  10
  11 License
  12 =======
  13
  14 All Apex and "common" entities are protected by the Apache 2.0 License
  15 ( http://www.apache.org/licenses/ )
  16
  17 Important Notes
  18 ===============
  19
  20 This is the OPNFV Gambia release that implements the deploy stage of the
  21 OPNFV CI pipeline via Apex.
  22
  23 Apex is based on RDO's Triple-O installation tool chain.
  24 More information at http://rdoproject.org
  25
  26 Carefully follow the installation-instructions which guide a user on how to
  27 deploy OPNFV using Apex installer.
  28
  29 Summary
  30 =======
  31
  32 Gambia release with the Apex deployment toolchain will establish an OPNFV
  33 target system on a Pharos compliant lab infrastructure.  The current definition
  34 of an OPNFV target system is OpenStack Pike combined with an SDN
  35 controller, such as OpenDaylight.  The system is deployed with OpenStack High
  36 Availability (HA) for most OpenStack services.  SDN controllers are deployed
  37 on every controller unless deploying with one the HA FD.IO scenarios.  Ceph
  38 storage is used as Cinder backend, and is the only supported storage for
  39 Gambia.  Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
  40 node in an HA setup.  Apex also supports non-HA deployments, which deploys a
  41 single controller and n number of compute nodes.  Furthermore, Apex is
  42 capable of deploying scenarios in a bare metal or virtual fashion.  Virtual
  43 deployments use multiple VMs on the Jump Host and internal networking to
  44 simulate the a bare metal deployment.
  45
  46 - Documentation is built by Jenkins
  47 - .iso image is built by Jenkins
  48 - .rpm packages are built by Jenkins
  49 - Jenkins deploys a Gambia release with the Apex deployment toolchain
  50   bare metal, which includes 3 control+network nodes, and 2 compute nodes.
  51
  52 Release Data
  53 ============
  54
  55 +--------------------------------------+--------------------------------------+
  56 | **Project**                          | apex                                 |
  57 |                                      |                                      |
  58 +--------------------------------------+--------------------------------------+
  59 | **Repo/tag**                         | opnfv-7.0.0                          |
  60 |                                      |                                      |
  61 +--------------------------------------+--------------------------------------+
  62 | **Release designation**              | 7.0.0                                |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Release date**                     | 2018-11-09                           |
  66 |                                      |                                      |
  67 +--------------------------------------+--------------------------------------+
  68 | **Purpose of the delivery**          | OPNFV Gambia release                 |
  69 |                                      |                                      |
  70 +--------------------------------------+--------------------------------------+
  71
  72 Version change
  73 --------------
  74
  75 Module version changes
  76 ~~~~~~~~~~~~~~~~~~~~~~
  77 This is the first tracked version of the Gambia release with the Apex
  78 deployment toolchain. It is based on following upstream versions:
  79
  80 - OpenStack (Queens release)
  81
  82 - OpenDaylight (Oxygen releases)
  83
  84 - CentOS 7
  85
  86 Document Version Changes
  87 ~~~~~~~~~~~~~~~~~~~~~~~~
  88
  89 This is the first tracked version of Gambia release with the Apex
  90 deployment toolchain.
  91 The following documentation is provided with this release:
  92
  93 - OPNFV Installation instructions for the Gambia release with the Apex
  94   deployment toolchain - ver. 1.0.0
  95 - OPNFV Release Notes for the Gambia release with the Apex deployment
  96   toolchain - ver. 1.0.0 (this document)
  97
  98 Deliverables
  99 ------------
 100
 101 Software Deliverables
 102 ~~~~~~~~~~~~~~~~~~~~~
 103 - Apex .rpm (python34-opnfv-apex)
 104 - build.py - Builds the above artifact
 105 - opnfv-deploy - Automatically deploys Target OPNFV System
 106 - opnfv-clean - Automatically resets a Target OPNFV Deployment
 107 - opnfv-util - Utility to connect to or debug Overcloud nodes + OpenDaylight
 108
 109 Documentation Deliverables
 110 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 111 - OPNFV Installation instructions for the Gambia release with the Apex
 112   deployment toolchain - ver. 7.0
 113 - OPNFV Release Notes for the Gambia release with the Apex deployment
 114   toolchain - ver. 7.0 (this document)
 115
 116 Known Limitations, Issues and Workarounds
 117 =========================================
 118
 119 System Limitations
 120 ------------------
 121
 122 **Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
 123
 124 **Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
 125
 126 **Storage:**    Ceph is the only supported storage configuration.
 127
 128 **Min master requirements:** At least 16GB of RAM for baremetal Jump Host,
 129 24GB for virtual deployments (noHA).
 130
 131
 132 Known Issues
 133 ------------
 134
 135 **JIRA TICKETS:**
 136
 137 +--------------------------------------+--------------------------------------+
 138 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 139 |                                      |                                      |
 140 +--------------------------------------+--------------------------------------+
 141 | JIRA: APEX-280                       | Deleted network not cleaned up       |
 142 |                                      | on controller                        |
 143 +--------------------------------------+--------------------------------------+
 144 | JIRA: APEX-295                       | Missing support for VLAN tenant      |
 145 |                                      | networks                             |
 146 +--------------------------------------+--------------------------------------+
 147 | JIRA: APEX-368                       | Ceilometer stores samples and events |
 148 |                                      | forever                              |
 149 +--------------------------------------+--------------------------------------+
 150 | JIRA: APEX-371                       | Ceph partitions need to be prepared  |
 151 |                                      | on deployment when using 2nd disk    |
 152 +--------------------------------------+--------------------------------------+
 153 | JIRA: APEX-375                       | Default glance storage points to     |
 154 |                                      | http,swift when ceph disabled        |
 155 +--------------------------------------+--------------------------------------+
 156 | JIRA: APEX-389                       | Compute kernel parameters are used   |
 157 |                                      | for all nodes                        |
 158 +--------------------------------------+--------------------------------------+
 159 | JIRA: APEX-412                       | Install failures with UEFI           |
 160 +--------------------------------------+--------------------------------------+
 161
 162
 163 Workarounds
 164 -----------
 165 **-**
 166
 167
 168 Test Result
 169 ===========
 170
 171 Please reference Functest project documentation for test results with the
 172 Apex installer.
 173
 174
 175 References
 176 ==========
 177
 178 For more information on the OPNFV Gambia release, please see:
 179
 180 http://wiki.opnfv.org/releases/Gambia
 181
 182 :Authors: Tim Rozet (trozet@redhat.com)
 183 :Authors: Dan Radez (dradez@redhat.com)
 184 :Version: 7.0