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.1.0                          |
  81 |                                      |                                      |
  82 +--------------------------------------+--------------------------------------+
  83 | **Release designation**              | Gambia 7.1                           |
  84 |                                      |                                      |
  85 +--------------------------------------+--------------------------------------+
  86 | **Release date**                     | December 14, 2018                    |
  87 |                                      |                                      |
  88 +--------------------------------------+--------------------------------------+
  89 | **Purpose of the delivery**          | OPNFV Gambia 7.1 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.1 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 - ``ODL`` ``BGPVPN`` scenario;
 134 - ``IDF`` support for configuring cluster-level ``MTU``;
 135
 136 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.1 New features`_
 137 filter.
 138
 139 Bug Corrections
 140 ~~~~~~~~~~~~~~~
 141
 142 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.1 Bugs (fixed)`_
 143 filter.
 144
 145 Software Deliverables
 146 ~~~~~~~~~~~~~~~~~~~~~
 147
 148 - `fuel git repository`_ with multiarch (``x86_64``, ``aarch64`` or ``mixed``)
 149   installer script files
 150
 151 Documentation Deliverables
 152 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 153
 154 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
 155
 156 - Release notes (This document)
 157
 158 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
 159
 160 Scenario Matrix
 161 ---------------
 162
 163 +-------------------------+---------------+-------------+------------+
 164 |                         | ``baremetal`` | ``virtual`` | ``hybrid`` |
 165 +=========================+===============+=============+============+
 166 | os-nosdn-nofeature-noha |               | ``x86_64``  |            |
 167 +-------------------------+---------------+-------------+------------+
 168 | os-nosdn-nofeature-ha   | ``x86_64``,   |             |            |
 169 |                         | ``aarch64``   |             |            |
 170 +-------------------------+---------------+-------------+------------+
 171 | os-nosdn-ovs-noha       |               | ``x86_64``  |            |
 172 +-------------------------+---------------+-------------+------------+
 173 | os-nosdn-ovs-ha         | ``x86_64``,   |             |            |
 174 |                         | ``aarch64``   |             |            |
 175 +-------------------------+---------------+-------------+------------+
 176 | os-odl-nofeature-noha   |               | ``x86_64``  |            |
 177 +-------------------------+---------------+-------------+------------+
 178 | os-odl-nofeature-ha     | ``x86_64``,   |             |            |
 179 |                         | ``aarch64``   |             |            |
 180 +-------------------------+---------------+-------------+------------+
 181 | os-odl-ovs-noha         |               | ``x86_64``  |            |
 182 +-------------------------+---------------+-------------+------------+
 183 | os-odl-ovs-ha           | ``x86_64``    |             |            |
 184 +-------------------------+---------------+-------------+------------+
 185 | os-odl-bgpvpn-noha      |               | ``x86_64``  |            |
 186 +-------------------------+---------------+-------------+------------+
 187 | os-odl-sfc-noha         |               | ``x86_64``  |            |
 188 +-------------------------+---------------+-------------+------------+
 189 | os-ovn-nofeature-noha   |               | ``x86_64``  |            |
 190 +-------------------------+---------------+-------------+------------+
 191 | os-ovn-nofeature-ha     | ``aarch64``   |             |            |
 192 +-------------------------+---------------+-------------+------------+
 193
 194 Known Limitations, Issues and Workarounds
 195 =========================================
 196
 197 System Limitations
 198 ------------------
 199
 200 - **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades
 201
 202 - **Min number of blades:** 1 Jumpserver
 203
 204 - **Storage:** Cinder is the only supported storage configuration
 205
 206 - **Max number of networks:** 65k
 207
 208
 209 Known Issues
 210 ------------
 211
 212 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.1 Known issues`_
 213 filter.
 214
 215 Workarounds
 216 -----------
 217
 218 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.1 Workarounds`_
 219 filter.
 220
 221 Test Results
 222 ============
 223
 224 The ``Gambia`` 7.1 release with the Fuel deployment tool has undergone QA test
 225 runs, see separate test results.
 226
 227 References
 228 ==========
 229
 230 For more information on the OPNFV ``Gambia`` 7.1 release, please see:
 231
 232 #. `OPNFV Home Page`_
 233 #. `OPNFV Documentation`_
 234 #. `OPNFV Software Downloads`_
 235 #. `OPNFV Gambia Wiki Page`_
 236 #. `OpenStack Queens Release Artifacts`_
 237 #. `OpenStack Documentation`_
 238 #. `OpenDaylight Artifacts`_
 239 #. `Mirantis Cloud Platform Documentation`_
 240
 241 .. FIXME: cleanup unused refs, extend above list
 242 .. _`OpenDaylight`: https://www.opendaylight.org
 243 .. _`OpenDaylight Artifacts`: https://www.opendaylight.org/software/downloads
 244 .. _`MCP`: https://www.mirantis.com/software/mcp/
 245 .. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
 246 .. _`fuel git repository`: https://git.opnfv.org/fuel
 247 .. _`OpenStack Documentation`: https://docs.openstack.org/queens
 248 .. _`OpenStack Queens Release Artifacts`: https://www.openstack.org/software/queens
 249 .. _`OPNFV Home Page`: https://www.opnfv.org
 250 .. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/display/SWREL/Gambia
 251 .. _`OPNFV Documentation`: https://docs.opnfv.org
 252 .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads
 253 .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
 254 .. OPNFV Fuel Gambia JIRA filters
 255 .. _`OPNFV Fuel JIRA: Gambia 7.1 Bugs (fixed)`: https://jira.opnfv.org/issues/?filter=12601
 256 .. _`OPNFV Fuel JIRA: Gambia 7.1 New features`: https://jira.opnfv.org/issues/?filter=12600
 257 .. _`OPNFV Fuel JIRA: Gambia 7.1 Known issues`: https://jira.opnfv.org/issues/?filter=12602
 258 .. _`OPNFV Fuel JIRA: Gambia 7.1 Workarounds`: https://jira.opnfv.org/issues/?filter=12603