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 ``Iruya`` 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 ``Iruya`` 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 ``Iruya`` 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 ``Iruya`` 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 ``Iruya``, the typical use of Fuel as an OpenStack installer is
  57 supplemented with OPNFV unique components such as:
  58
  59 - `OpenDaylight`_
  60
  61 As well as OPNFV-unique configurations of the Hardware and Software stack.
  62
  63 This ``Iruya`` artifact provides Fuel as the deployment stage tool in the
  64 OPNFV CI pipeline including:
  65
  66 - Automated (Jenkins, RTD) documentation build & publish (multiple documents);
  67 - Automated (Jenkins) build & publish of Salt Master Docker image;
  68 - Automated (Jenkins) deployment of ``Iruya`` running on baremetal or a nested
  69   hypervisor environment (KVM);
  70 - Automated (Jenkins) validation of the ``Iruya`` deployment
  71
  72 Release Data
  73 ============
  74
  75 +--------------------------------------+--------------------------------------+
  76 | **Project**                          | fuel                                 |
  77 |                                      |                                      |
  78 +--------------------------------------+--------------------------------------+
  79 | **Repo/tag**                         | opnfv-9.0.0                          |
  80 |                                      |                                      |
  81 +--------------------------------------+--------------------------------------+
  82 | **Release designation**              | Iruya 9.0                            |
  83 |                                      |                                      |
  84 +--------------------------------------+--------------------------------------+
  85 | **Release date**                     | January 31, 2020                     |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88 | **Purpose of the delivery**          | OPNFV Iruya 9.0 release              |
  89 +--------------------------------------+--------------------------------------+
  90
  91 Version Change
  92 --------------
  93
  94 Module Version Changes
  95 ~~~~~~~~~~~~~~~~~~~~~~
  96
  97 This is the first tracked version of the ``Iruya`` release with the Fuel
  98 deployment toolchain. It is based on following upstream versions:
  99
 100 - MCP (``Q1`19`` GA release)
 101
 102 - OpenStack (``Stein`` release)
 103
 104 - OpenDaylight (``Neon`` release)
 105
 106 - Ubuntu (``18.04`` release)
 107
 108 Document Changes
 109 ~~~~~~~~~~~~~~~~
 110
 111 This is the ``Iruya`` 9.0 release.
 112 It comes with the following documentation:
 113
 114 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
 115
 116 - Release notes (This document)
 117
 118 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
 119
 120 Reason for Version
 121 ------------------
 122
 123 Feature Additions
 124 ~~~~~~~~~~~~~~~~~
 125
 126 Due to reduced schedule, this is a maintainance release.
 127
 128 Bug Corrections
 129 ~~~~~~~~~~~~~~~
 130
 131 N/A
 132
 133 Software Deliverables
 134 ~~~~~~~~~~~~~~~~~~~~~
 135
 136 - `fuel git repository`_ with multiarch (``x86_64``, ``aarch64`` or ``mixed``)
 137   installer script files
 138
 139 Documentation Deliverables
 140 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 141
 142 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
 143
 144 - Release notes (This document)
 145
 146 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
 147
 148 Scenario Matrix
 149 ---------------
 150
 151 +-------------------------+---------------+-------------+------------+
 152 |                         | ``baremetal`` | ``virtual`` | ``hybrid`` |
 153 +=========================+===============+=============+============+
 154 | os-nosdn-nofeature-noha |               | ``x86_64``  |            |
 155 +-------------------------+---------------+-------------+------------+
 156 | os-nosdn-nofeature-ha   | ``x86_64``,   |             |            |
 157 |                         | ``aarch64``   |             |            |
 158 +-------------------------+---------------+-------------+------------+
 159 | os-odl-nofeature-noha   |               | ``x86_64``  |            |
 160 +-------------------------+---------------+-------------+------------+
 161 | os-odl-nofeature-ha     | ``x86_64``,   |             |            |
 162 +-------------------------+---------------+-------------+------------+
 163
 164 Known Limitations, Issues and Workarounds
 165 =========================================
 166
 167 System Limitations
 168 ------------------
 169
 170 - **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades
 171
 172 - **Min number of blades:** 1 Jumpserver
 173
 174 - **Storage:** Cinder is the only supported storage configuration
 175
 176 - **Max number of networks:** 65k
 177
 178
 179 Known Issues
 180 ------------
 181
 182 None
 183
 184 Workarounds
 185 -----------
 186
 187 None
 188
 189 Test Results
 190 ============
 191
 192 The ``Iruya`` 9.0 release with the Fuel deployment tool has undergone QA test
 193 runs, see separate test results.
 194
 195 References
 196 ==========
 197
 198 For more information on the OPNFV ``Iruya`` 9.0 release, please see:
 199
 200 #. `OPNFV Home Page`_
 201 #. `OPNFV Documentation`_
 202 #. `OPNFV Software Downloads`_
 203 #. `OPNFV Iruya Wiki Page`_
 204 #. `OpenStack Queens Release Artifacts`_
 205 #. `OpenStack Documentation`_
 206 #. `OpenDaylight Artifacts`_
 207 #. `Mirantis Cloud Platform Documentation`_
 208
 209 .. FIXME: cleanup unused refs, extend above list
 210 .. _`OpenDaylight`: https://www.opendaylight.org
 211 .. _`Vector Packet Processing`: https://wiki.fd.io/view/VPP
 212 .. _`OpenDaylight Artifacts`: https://www.opendaylight.org/software/downloads
 213 .. _`MCP`: https://www.mirantis.com/software/mcp/
 214 .. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
 215 .. _`fuel git repository`: https://git.opnfv.org/fuel
 216 .. _`OpenStack Documentation`: https://docs.openstack.org/rocky
 217 .. _`OpenStack Stein Release Artifacts`: https://www.openstack.org/software/stein
 218 .. _`OPNFV Home Page`: https://www.opnfv.org
 219 .. _`OPNFV Iruya Wiki Page`: https://wiki.opnfv.org/display/SWREL/Iruya
 220 .. _`OPNFV Documentation`: https://docs.opnfv.org
 221 .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads
 222 .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0