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
5 ************************
6 OPNFV Fuel Release Notes
7 ************************
12 This document provides the release notes for ``Gambia`` release with the Fuel
15 Starting with this release, both ``x86_64`` and ``aarch64`` architectures
16 are supported at the same time by the ``fuel`` codebase.
21 All Fuel and "common" entities are protected by the `Apache License 2.0`_.
26 This is the OPNFV ``Gambia`` release that implements the deploy stage of the
27 OPNFV CI pipeline via Fuel.
29 Fuel is based on the `MCP`_ installation tool chain.
30 More information available at `Mirantis Cloud Platform Documentation`_.
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.
36 Carefully follow the installation instructions.
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.
47 Fuel also supports non-HA deployments, which deploys a
48 single controller, one gateway node and a number of compute nodes.
50 Fuel supports ``x86_64``, ``aarch64`` or ``mixed`` architecture clusters.
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.
56 For ``Gambia``, the typical use of Fuel as an OpenStack installer is
57 supplemented with OPNFV unique components such as:
60 - Open Virtual Network (``OVN``)
61 - `Vector Packet Processing`_
63 As well as OPNFV-unique configurations of the Hardware and Software stack.
65 This ``Gambia`` artifact provides Fuel as the deployment stage tool in the
66 OPNFV CI pipeline including:
68 - Automated (Jenkins, RTD) documentation build & publish (multiple documents);
69 - Automated (Jenkins) build & publish of Salt Master Docker image;
70 - Automated (Jenkins) deployment of ``Gambia`` running on baremetal or a nested
71 hypervisor environment (KVM);
72 - Automated (Jenkins) validation of the ``Gambia`` deployment
77 +--------------------------------------+--------------------------------------+
78 | **Project** | fuel |
80 +--------------------------------------+--------------------------------------+
81 | **Repo/tag** | opnfv-7.2.0 |
83 +--------------------------------------+--------------------------------------+
84 | **Release designation** | Gambia 7.2 |
86 +--------------------------------------+--------------------------------------+
87 | **Release date** | January 18, 2019 |
89 +--------------------------------------+--------------------------------------+
90 | **Purpose of the delivery** | OPNFV Gambia 7.2 release |
91 +--------------------------------------+--------------------------------------+
96 Module Version Changes
97 ~~~~~~~~~~~~~~~~~~~~~~
99 This is the first tracked version of the ``Gambia`` release with the Fuel
100 deployment toolchain. It is based on following upstream versions:
102 - MCP (``Q2`18`` GA release)
104 - OpenStack (``Queens`` release)
106 - OpenDaylight (``Fluorine`` release)
108 - Ubuntu (``16.04`` release)
113 This is the ``Gambia`` 7.2 release.
114 It comes with the following documentation:
116 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
118 - Release notes (This document)
120 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
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;
134 - ``ODL`` ``BGPVPN`` scenario;
135 - ``IDF`` support for configuring cluster-level ``MTU``;
137 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.2 New features`_
143 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.2 Bugs (fixed)`_
146 Software Deliverables
147 ~~~~~~~~~~~~~~~~~~~~~
149 - `fuel git repository`_ with multiarch (``x86_64``, ``aarch64`` or ``mixed``)
150 installer script files
152 Documentation Deliverables
153 ~~~~~~~~~~~~~~~~~~~~~~~~~~
155 - :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
157 - Release notes (This document)
159 - :ref:`OPNFV Fuel Userguide <fuel-userguide>`
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 +-------------------------+---------------+-------------+------------+
198 Known Limitations, Issues and Workarounds
199 =========================================
204 - **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades
206 - **Min number of blades:** 1 Jumpserver
208 - **Storage:** Cinder is the only supported storage configuration
210 - **Max number of networks:** 65k
216 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.2 Known issues`_
222 For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.2 Workarounds`_
228 The ``Gambia`` 7.2 release with the Fuel deployment tool has undergone QA test
229 runs, see separate test results.
234 For more information on the OPNFV ``Gambia`` 7.2 release, please see:
236 #. `OPNFV Home Page`_
237 #. `OPNFV Documentation`_
238 #. `OPNFV Software Downloads`_
239 #. `OPNFV Gambia Wiki Page`_
240 #. `OpenStack Queens Release Artifacts`_
241 #. `OpenStack Documentation`_
242 #. `OpenDaylight Artifacts`_
243 #. `Mirantis Cloud Platform Documentation`_
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/queens
253 .. _`OpenStack Queens Release Artifacts`: https://www.openstack.org/software/queens
254 .. _`OPNFV Home Page`: https://www.opnfv.org
255 .. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/display/SWREL/Gambia
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 Gambia JIRA filters
260 .. _`OPNFV Fuel JIRA: Gambia 7.2 Bugs (fixed)`: https://jira.opnfv.org/issues/?filter=12604
261 .. _`OPNFV Fuel JIRA: Gambia 7.2 New features`: https://jira.opnfv.org/issues/?filter=12605
262 .. _`OPNFV Fuel JIRA: Gambia 7.2 Known issues`: https://jira.opnfv.org/issues/?filter=12606
263 .. _`OPNFV Fuel JIRA: Gambia 7.2 Workarounds`: https://jira.opnfv.org/issues/?filter=12607