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

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) Open Platform for NFV Project, Inc. and its contributors
   4
   5 ************************
   6 OPNFV Fuel Release Notes
   7 ************************
   8
   9 Abstract
  10 ========
  11
  12 This document provides the release notes for ``Gambia`` release with the Fuel
  13 deployment toolchain.
  14
  15 Starting with this release, both ``x86_64`` and ``aarch64`` architectures
  16 are supported at the same time by the ``fuel`` codebase.
  17
  18 License
  19 =======
  20
  21 All Fuel and "common" entities are protected by the `Apache License 2.0`_.
  22
  23 Important Notes
  24 ===============
  25
  26 This is the OPNFV ``Gambia`` release that implements the deploy stage of the
  27 OPNFV CI pipeline via Fuel.
  28
  29 Fuel is based on the `MCP`_ installation tool chain.
  30 More information available at `Mirantis Cloud Platform Documentation`_.
  31
  32 The goal of the ``Gambia`` release and this Fuel-based deployment process is
  33 to establish a lab ready platform accelerating further development
  34 of the OPNFV infrastructure.
  35
  36 Carefully follow the installation instructions.
  37
  38 Summary
  39 =======
  40
  41 ``Gambia`` release with the Fuel deployment toolchain will establish an OPNFV
  42 target system on a Pharos compliant lab infrastructure. The current definition
  43 of an OPNFV target system is OpenStack Queens combined with an SDN
  44 controller, such as OpenDaylight. The system is deployed with OpenStack High
  45 Availability (HA) for most OpenStack services.
  46
  47 Fuel also supports non-HA deployments, which deploys a
  48 single controller, one gateway node and a number of compute nodes.
  49
  50 Fuel supports ``x86_64``, ``aarch64`` or ``mixed`` architecture clusters.
  51
  52 Furthermore, Fuel is capable of deploying scenarios in a ``baremetal``,
  53 ``virtual`` or ``hybrid`` fashion. ``virtual`` deployments use multiple VMs on
  54 the Jump Host and internal networking to simulate the ``baremetal`` deployment.
  55
  56 For ``Gambia``, the typical use of Fuel as an OpenStack installer is
  57 supplemented with OPNFV unique components such as:
  58
  59 - `OpenDaylight`_
  60 - Open Virtual Network (``OVN``)
  61
  62 As well as OPNFV-unique configurations of the Hardware and Software stack.
  63
  64 This ``Gambia`` artifact provides Fuel as the deployment stage tool in the
  65 OPNFV CI pipeline including:
  66
  67 - Automated (Jenkins, RTD) documentation build & publish (multiple documents);
  68 - Automated (Jenkins) build & publish of Salt Master Docker image;
  69 - Automated (Jenkins) deployment of ``Gambia`` running on baremetal or a nested
  70   hypervisor environment (KVM);
  71 - Automated (Jenkins) validation of the ``Gambia`` deployment
  72
  73 Release Data
  74 ============
  75
  76 +--------------------------------------+--------------------------------------+
  77 | **Project**                          | fuel                                 |
  78 |                                      |                                      |
  79 +--------------------------------------+--------------------------------------+
  80 | **Repo/tag**                         | opnfv-7.0.0                          |
  81 |                                      |                                      |
  82 +--------------------------------------+--------------------------------------+
  83 | **Release designation**              | Gambia 7.0                           |
  84 |                                      |                                      |
  85 +--------------------------------------+--------------------------------------+
  86 | **Release date**                     | November 9, 2018                     |
  87 |                                      |                                      |
  88 +--------------------------------------+--------------------------------------+
  89 | **Purpose of the delivery**          | OPNFV Gambia 7.0 release             |
  90 +--------------------------------------+--------------------------------------+
  91
  92 Version Change
  93 --------------
  94
  95 Module Version Changes
  96 ~~~~~~~~~~~~~~~~~~~~~~
  97
  98 This is the first tracked version of the ``Gambia`` release with the Fuel
  99 deployment toolchain. It is based on following upstream versions:
 100
 101 - MCP (``Q2`18`` GA release)
 102
 103 - OpenStack (``Queens`` release)
 104
 105 - OpenDaylight (``Fluorine`` release)
 106
 107 - Ubuntu (``16.04`` release)
 108
 109 Document Changes
 110 ~~~~~~~~~~~~~~~~
 111
 112 This is the ``Gambia`` 7.0 release.
 113 It comes with the following documentation:
 114
 115 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
 116
 117 - Release notes (This document)
 118
 119 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
 120
 121 Reason for Version
 122 ------------------
 123
 124 Feature Additions
 125 ~~~~~~~~~~~~~~~~~
 126
 127 - ``multiarch`` cluster support;
 128 - ``hybrid`` cluster support;
 129 - ``PDF``/``IDF`` support for ``virtual`` PODs;
 130 - ``baremetal`` support for noHA deployments;
 131 - containerized Salt Master;
 132 - ``OVN`` scenarios;
 133
 134 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia New features`_ filter.
 135
 136 Bug Corrections
 137 ~~~~~~~~~~~~~~~
 138
 139 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia Bugs (fixed)`_ filter.
 140
 141 Software Deliverables
 142 ~~~~~~~~~~~~~~~~~~~~~
 143
 144 - `fuel git repository`_ with multiarch (``x86_64``, ``aarch64`` or ``mixed``)
 145   installer script files
 146
 147 Documentation Deliverables
 148 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 149
 150 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
 151
 152 - Release notes (This document)
 153
 154 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
 155
 156 Scenario Matrix
 157 ---------------
 158
 159 +-------------------------+---------------+-------------+------------+
 160 |                         | ``baremetal`` | ``virtual`` | ``hybrid`` |
 161 +=========================+===============+=============+============+
 162 | os-nosdn-nofeature-noha |               | ``x86_64``  |            |
 163 +-------------------------+---------------+-------------+------------+
 164 | os-nosdn-nofeature-ha   | ``x86_64``,   |             |            |
 165 |                         | ``aarch64``   |             |            |
 166 +-------------------------+---------------+-------------+------------+
 167 | os-nosdn-ovs-noha       |               | ``x86_64``  |            |
 168 +-------------------------+---------------+-------------+------------+
 169 | os-nosdn-ovs-ha         | ``x86_64``,   |             |            |
 170 |                         | ``aarch64``   |             |            |
 171 +-------------------------+---------------+-------------+------------+
 172 | os-odl-nofeature-noha   |               | ``x86_64``  |            |
 173 +-------------------------+---------------+-------------+------------+
 174 | os-odl-nofeature-ha     | ``x86_64``,   |             |            |
 175 |                         | ``aarch64``   |             |            |
 176 +-------------------------+---------------+-------------+------------+
 177 | os-odl-ovs-noha         |               | ``x86_64``  |            |
 178 +-------------------------+---------------+-------------+------------+
 179 | os-odl-ovs-ha           | ``x86_64``    |             |            |
 180 +-------------------------+---------------+-------------+------------+
 181 | os-ovn-nofeature-noha   |               | ``x86_64``  |            |
 182 +-------------------------+---------------+-------------+------------+
 183 | os-ovn-nofeature-ha     | ``aarch64``   |             |            |
 184 +-------------------------+---------------+-------------+------------+
 185
 186 Known Limitations, Issues and Workarounds
 187 =========================================
 188
 189 System Limitations
 190 ------------------
 191
 192 - **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades
 193
 194 - **Min number of blades:** 1 Jumpserver
 195
 196 - **Storage:** Cinder is the only supported storage configuration
 197
 198 - **Max number of networks:** 65k
 199
 200
 201 Known Issues
 202 ------------
 203
 204 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia Known issues`_ filter.
 205
 206 Workarounds
 207 -----------
 208
 209 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia Workarounds`_ filter.
 210
 211 Test Results
 212 ============
 213
 214 The ``Gambia`` 7.0 release with the Fuel deployment tool has undergone QA test
 215 runs, see separate test results.
 216
 217 References
 218 ==========
 219
 220 For more information on the OPNFV ``Gambia`` 7.0 release, please see:
 221
 222 #. `OPNFV Home Page`_
 223 #. `OPNFV Documentation`_
 224 #. `OPNFV Software Downloads`_
 225 #. `OPNFV Gambia Wiki Page`_
 226 #. `OpenStack Queens Release Artifacts`_
 227 #. `OpenStack Documentation`_
 228 #. `OpenDaylight Artifacts`_
 229 #. `Mirantis Cloud Platform Documentation`_
 230
 231 .. FIXME: cleanup unused refs, extend above list
 232 .. _`OpenDaylight`: https://www.opendaylight.org/software
 233 .. _`OpenDaylight Artifacts`: https://www.opendaylight.org/software/downloads
 234 .. _`MCP`: https://www.mirantis.com/software/mcp/
 235 .. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
 236 .. _`fuel git repository`: https://git.opnfv.org/fuel
 237 .. _`OpenStack Documentation`: https://docs.openstack.org
 238 .. _`OpenStack Queens Release Artifacts`: https://www.openstack.org/software/queens
 239 .. _`OPNFV Home Page`: https://www.opnfv.org
 240 .. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/releases/Gambia
 241 .. _`OPNFV Documentation`: https://docs.opnfv.org
 242 .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/download
 243 .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
 244 .. OPNFV Fuel Gambia JIRA filters
 245 .. _`OPNFV Fuel JIRA: Gambia Bugs (fixed)`: https://jira.opnfv.org/issues/?filter=12503
 246 .. _`OPNFV Fuel JIRA: Gambia New features`: https://jira.opnfv.org/issues/?filter=12504
 247 .. _`OPNFV Fuel JIRA: Gambia Known issues`: https://jira.opnfv.org/issues/?filter=12505
 248 .. _`OPNFV Fuel JIRA: Gambia Workarounds`: https://jira.opnfv.org/issues/?filter=12506