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 ``Hunter`` release with the Fuel
  13 deployment toolchain.
  14
  15 Starting with ``Gambia`` 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 ``Hunter`` 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 ``Hunter`` 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 ``Hunter`` 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 ``Hunter``, 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 - `Vector Packet Processing`_
  62
  63 As well as OPNFV-unique configurations of the Hardware and Software stack.
  64
  65 This ``Hunter`` artifact provides Fuel as the deployment stage tool in the
  66 OPNFV CI pipeline including:
  67
  68 - Automated (Jenkins, RTD) documentation build & publish (multiple documents);
  69 - Automated (Jenkins) build & publish of Salt Master Docker image;
  70 - Automated (Jenkins) deployment of ``Hunter`` running on baremetal or a nested
  71   hypervisor environment (KVM);
  72 - Automated (Jenkins) validation of the ``Hunter`` deployment
  73
  74 Release Data
  75 ============
  76
  77 +--------------------------------------+--------------------------------------+
  78 | **Project**                          | fuel                                 |
  79 |                                      |                                      |
  80 +--------------------------------------+--------------------------------------+
  81 | **Repo/tag**                         | opnfv-8.0.0                          |
  82 |                                      |                                      |
  83 +--------------------------------------+--------------------------------------+
  84 | **Release designation**              | Hunter 8.0                           |
  85 |                                      |                                      |
  86 +--------------------------------------+--------------------------------------+
  87 | **Release date**                     | May 10, 2019                         |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90 | **Purpose of the delivery**          | OPNFV Hunter 8.0 release             |
  91 +--------------------------------------+--------------------------------------+
  92
  93 Version Change
  94 --------------
  95
  96 Module Version Changes
  97 ~~~~~~~~~~~~~~~~~~~~~~
  98
  99 This is the first tracked version of the ``Hunter`` release with the Fuel
 100 deployment toolchain. It is based on following upstream versions:
 101
 102 - MCP (``Q1`19`` GA release)
 103
 104 - OpenStack (``Rocky`` release)
 105
 106 - OpenDaylight (``Fluorine`` release)
 107
 108 - Ubuntu (``16.04`` release)
 109
 110 Document Changes
 111 ~~~~~~~~~~~~~~~~
 112
 113 This is the ``Hunter`` 8.0 release.
 114 It comes with the following documentation:
 115
 116 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
 117
 118 - Release notes (This document)
 119
 120 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
 121
 122 Reason for Version
 123 ------------------
 124
 125 Feature Additions
 126 ~~~~~~~~~~~~~~~~~
 127
 128 - ``multiarch`` cluster support;
 129 - ``hybrid`` cluster support;
 130 - ``PDF``/``IDF`` support for ``virtual`` PODs;
 131 - ``baremetal`` support for noHA deployments;
 132 - containerized Salt Master;
 133 - ``OVN`` scenarios;
 134 - ``ODL`` ``BGPVPN`` scenario;
 135 - ``IDF`` support for configuring cluster-level ``MTU``;
 136
 137 For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.0 New features`_
 138 filter.
 139
 140 Bug Corrections
 141 ~~~~~~~~~~~~~~~
 142
 143 For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.0 Bugs (fixed)`_
 144 filter.
 145
 146 Software Deliverables
 147 ~~~~~~~~~~~~~~~~~~~~~
 148
 149 - `fuel git repository`_ with multiarch (``x86_64``, ``aarch64`` or ``mixed``)
 150   installer script files
 151
 152 Documentation Deliverables
 153 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 154
 155 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
 156
 157 - Release notes (This document)
 158
 159 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
 160
 161 Scenario Matrix
 162 ---------------
 163
 164 +-------------------------+---------------+-------------+------------+
 165 |                         | ``baremetal`` | ``virtual`` | ``hybrid`` |
 166 +=========================+===============+=============+============+
 167 | os-nosdn-nofeature-noha |               | ``x86_64``  |            |
 168 +-------------------------+---------------+-------------+------------+
 169 | os-nosdn-nofeature-ha   | ``x86_64``,   |             |            |
 170 |                         | ``aarch64``   |             |            |
 171 +-------------------------+---------------+-------------+------------+
 172 | os-nosdn-ovs-noha       |               | ``x86_64``  |            |
 173 +-------------------------+---------------+-------------+------------+
 174 | os-nosdn-ovs-ha         | ``x86_64``,   |             |            |
 175 |                         | ``aarch64``   |             |            |
 176 +-------------------------+---------------+-------------+------------+
 177 | os-odl-nofeature-noha   |               | ``x86_64``  |            |
 178 +-------------------------+---------------+-------------+------------+
 179 | os-odl-nofeature-ha     | ``x86_64``,   |             |            |
 180 |                         | ``aarch64``   |             |            |
 181 +-------------------------+---------------+-------------+------------+
 182 | os-odl-ovs-noha         |               | ``x86_64``  |            |
 183 +-------------------------+---------------+-------------+------------+
 184 | os-odl-ovs-ha           | ``x86_64``    |             |            |
 185 +-------------------------+---------------+-------------+------------+
 186 | os-odl-bgpvpn-noha      |               | ``x86_64``  |            |
 187 +-------------------------+---------------+-------------+------------+
 188 | os-odl-sfc-noha         |               | ``x86_64``  |            |
 189 +-------------------------+---------------+-------------+------------+
 190 | os-ovn-nofeature-noha   |               | ``x86_64``  |            |
 191 +-------------------------+---------------+-------------+------------+
 192 | os-ovn-nofeature-ha     | ``aarch64``   |             |            |
 193 +-------------------------+---------------+-------------+------------+
 194 | os-nosdn-fdio-noha      | ``x86_64``,   |             |            |
 195 |                         | ``aarch64``   |             |            |
 196 +-------------------------+---------------+-------------+------------+
 197
 198 Known Limitations, Issues and Workarounds
 199 =========================================
 200
 201 System Limitations
 202 ------------------
 203
 204 - **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades
 205
 206 - **Min number of blades:** 1 Jumpserver
 207
 208 - **Storage:** Cinder is the only supported storage configuration
 209
 210 - **Max number of networks:** 65k
 211
 212
 213 Known Issues
 214 ------------
 215
 216 For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.0 Known issues`_
 217 filter.
 218
 219 Workarounds
 220 -----------
 221
 222 For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.0 Workarounds`_
 223 filter.
 224
 225 Test Results
 226 ============
 227
 228 The ``Hunter`` 8.0 release with the Fuel deployment tool has undergone QA test
 229 runs, see separate test results.
 230
 231 References
 232 ==========
 233
 234 For more information on the OPNFV ``Hunter`` 8.0 release, please see:
 235
 236 #. `OPNFV Home Page`_
 237 #. `OPNFV Documentation`_
 238 #. `OPNFV Software Downloads`_
 239 #. `OPNFV Hunter Wiki Page`_
 240 #. `OpenStack Queens Release Artifacts`_
 241 #. `OpenStack Documentation`_
 242 #. `OpenDaylight Artifacts`_
 243 #. `Mirantis Cloud Platform Documentation`_
 244
 245 .. FIXME: cleanup unused refs, extend above list
 246 .. _`OpenDaylight`: https://www.opendaylight.org
 247 .. _`Vector Packet Processing`: https://wiki.fd.io/view/VPP
 248 .. _`OpenDaylight Artifacts`: https://www.opendaylight.org/software/downloads
 249 .. _`MCP`: https://www.mirantis.com/software/mcp/
 250 .. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
 251 .. _`fuel git repository`: https://git.opnfv.org/fuel
 252 .. _`OpenStack Documentation`: https://docs.openstack.org/rocky
 253 .. _`OpenStack Rocky Release Artifacts`: https://www.openstack.org/software/rocky
 254 .. _`OPNFV Home Page`: https://www.opnfv.org
 255 .. _`OPNFV Hunter Wiki Page`: https://wiki.opnfv.org/display/SWREL/Hunter
 256 .. _`OPNFV Documentation`: https://docs.opnfv.org
 257 .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads
 258 .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
 259 .. OPNFV Fuel Hunter JIRA filters
 260 .. _`OPNFV Fuel JIRA: Hunter 8.0 Bugs (fixed)`: https://jira.opnfv.org/issues/?filter=12705
 261 .. _`OPNFV Fuel JIRA: Hunter 8.0 New features`: https://jira.opnfv.org/issues/?filter=12706
 262 .. _`OPNFV Fuel JIRA: Hunter 8.0 Known issues`: https://jira.opnfv.org/issues/?filter=12707
 263 .. _`OPNFV Fuel JIRA: Hunter 8.0 Workarounds`: https://jira.opnfv.org/issues/?filter=12708