aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release-notes.rst
blob: 4c6c3bd5019cb4a93fb6f297db1c100ba66f554a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Open Platform for NFV Project, Inc. and its contributors

************************
OPNFV Fuel Release Notes
************************

Abstract
========

This document provides the release notes for ``Gambia`` release with the Fuel
deployment toolchain.

Starting with this release, both ``x86_64`` and ``aarch64`` architectures
are supported at the same time by the ``fuel`` codebase.

License
=======

All Fuel and "common" entities are protected by the `Apache License 2.0`_.

Important Notes
===============

This is the OPNFV ``Gambia`` release that implements the deploy stage of the
OPNFV CI pipeline via Fuel.

Fuel is based on the `MCP`_ installation tool chain.
More information available at `Mirantis Cloud Platform Documentation`_.

The goal of the ``Gambia`` release and this Fuel-based deployment process is
to establish a lab ready platform accelerating further development
of the OPNFV infrastructure.

Carefully follow the installation instructions.

Summary
=======

``Gambia`` release with the Fuel deployment toolchain will establish an OPNFV
target system on a Pharos compliant lab infrastructure. The current definition
of an OPNFV target system is OpenStack Queens combined with an SDN
controller, such as OpenDaylight. The system is deployed with OpenStack High
Availability (HA) for most OpenStack services.

Fuel also supports non-HA deployments, which deploys a
single controller, one gateway node and a number of compute nodes.

Fuel supports ``x86_64``, ``aarch64`` or ``mixed`` architecture clusters.

Furthermore, Fuel is capable of deploying scenarios in a ``baremetal``,
``virtual`` or ``hybrid`` fashion. ``virtual`` deployments use multiple VMs on
the Jump Host and internal networking to simulate the ``baremetal`` deployment.

For ``Gambia``, the typical use of Fuel as an OpenStack installer is
supplemented with OPNFV unique components such as:

- `OpenDaylight`_
- Open Virtual Network (``OVN``)

As well as OPNFV-unique configurations of the Hardware and Software stack.

This ``Gambia`` artifact provides Fuel as the deployment stage tool in the
OPNFV CI pipeline including:

- Automated (Jenkins, RTD) documentation build & publish (multiple documents);
- Automated (Jenkins) build & publish of Salt Master Docker image;
- Automated (Jenkins) deployment of ``Gambia`` running on baremetal or a nested
  hypervisor environment (KVM);
- Automated (Jenkins) validation of the ``Gambia`` deployment

Release Data
============

+--------------------------------------+--------------------------------------+
| **Project**                          | fuel                                 |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | opnfv-7.1.0                          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Gambia 7.1                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | December 14, 2018                    |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV Gambia 7.1 release             |
+--------------------------------------+--------------------------------------+

Version Change
--------------

Module Version Changes
~~~~~~~~~~~~~~~~~~~~~~

This is the first tracked version of the ``Gambia`` release with the Fuel
deployment toolchain. It is based on following upstream versions:

- MCP (``Q2`18`` GA release)

- OpenStack (``Queens`` release)

- OpenDaylight (``Fluorine`` release)

- Ubuntu (``16.04`` release)

Document Changes
~~~~~~~~~~~~~~~~

This is the ``Gambia`` 7.1 release.
It comes with the following documentation:

- :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`

- Release notes (This document)

- :ref:`OPNFV Fuel Userguide <fuel-userguide>`

Reason for Version
------------------

Feature Additions
~~~~~~~~~~~~~~~~~

- ``multiarch`` cluster support;
- ``hybrid`` cluster support;
- ``PDF``/``IDF`` support for ``virtual`` PODs;
- ``baremetal`` support for noHA deployments;
- containerized Salt Master;
- ``OVN`` scenarios;
- ``ODL`` ``BGPVPN`` scenario;
- ``IDF`` support for configuring cluster-level ``MTU``;

For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.1 New features`_
filter.

Bug Corrections
~~~~~~~~~~~~~~~

For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.1 Bugs (fixed)`_
filter.

Software Deliverables
~~~~~~~~~~~~~~~~~~~~~

- `fuel git repository`_ with multiarch (``x86_64``, ``aarch64`` or ``mixed``)
  installer script files

Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~

- :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`

- Release notes (This document)

- :ref:`OPNFV Fuel Userguide <fuel-userguide>`

Scenario Matrix
---------------

+-------------------------+---------------+-------------+------------+
|                         | ``baremetal`` | ``virtual`` | ``hybrid`` |
+=========================+===============+=============+============+
| os-nosdn-nofeature-noha |               | ``x86_64``  |            |
+-------------------------+---------------+-------------+------------+
| os-nosdn-nofeature-ha   | ``x86_64``,   |             |            |
|                         | ``aarch64``   |             |            |
+-------------------------+---------------+-------------+------------+
| os-nosdn-ovs-noha       |               | ``x86_64``  |            |
+-------------------------+---------------+-------------+------------+
| os-nosdn-ovs-ha         | ``x86_64``,   |             |            |
|                         | ``aarch64``   |             |            |
+-------------------------+---------------+-------------+------------+
| os-odl-nofeature-noha   |               | ``x86_64``  |            |
+-------------------------+---------------+-------------+------------+
| os-odl-nofeature-ha     | ``x86_64``,   |             |            |
|                         | ``aarch64``   |             |            |
+-------------------------+---------------+-------------+------------+
| os-odl-ovs-noha         |               | ``x86_64``  |            |
+-------------------------+---------------+-------------+------------+
| os-odl-ovs-ha           | ``x86_64``    |             |            |
+-------------------------+---------------+-------------+------------+
| os-odl-bgpvpn-noha      |               | ``x86_64``  |            |
+-------------------------+---------------+-------------+------------+
| os-odl-sfc-noha         |               | ``x86_64``  |            |
+-------------------------+---------------+-------------+------------+
| os-ovn-nofeature-noha   |               | ``x86_64``  |            |
+-------------------------+---------------+-------------+------------+
| os-ovn-nofeature-ha     | ``aarch64``   |             |            |
+-------------------------+---------------+-------------+------------+

Known Limitations, Issues and Workarounds
=========================================

System Limitations
------------------

- **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades

- **Min number of blades:** 1 Jumpserver

- **Storage:** Cinder is the only supported storage configuration

- **Max number of networks:** 65k


Known Issues
------------

For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.1 Known issues`_
filter.

Workarounds
-----------

For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.1 Workarounds`_
filter.

Test Results
============

The ``Gambia`` 7.1 release with the Fuel deployment tool has undergone QA test
runs, see separate test results.

References
==========

For more information on the OPNFV ``Gambia`` 7.1 release, please see:

#. `OPNFV Home Page`_
#. `OPNFV Documentation`_
#. `OPNFV Software Downloads`_
#. `OPNFV Gambia Wiki Page`_
#. `OpenStack Queens Release Artifacts`_
#. `OpenStack Documentation`_
#. `OpenDaylight Artifacts`_
#. `Mirantis Cloud Platform Documentation`_

.. FIXME: cleanup unused refs, extend above list
.. _`OpenDaylight`: https://www.opendaylight.org
.. _`OpenDaylight Artifacts`: https://www.opendaylight.org/software/downloads
.. _`MCP`: https://www.mirantis.com/software/mcp/
.. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
.. _`fuel git repository`: https://git.opnfv.org/fuel
.. _`OpenStack Documentation`: https://docs.openstack.org/queens
.. _`OpenStack Queens Release Artifacts`: https://www.openstack.org/software/queens
.. _`OPNFV Home Page`: https://www.opnfv.org
.. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/display/SWREL/Gambia
.. _`OPNFV Documentation`: https://docs.opnfv.org
.. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads
.. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
.. OPNFV Fuel Gambia JIRA filters
.. _`OPNFV Fuel JIRA: Gambia 7.1 Bugs (fixed)`: https://jira.opnfv.org/issues/?filter=12601
.. _`OPNFV Fuel JIRA: Gambia 7.1 New features`: https://jira.opnfv.org/issues/?filter=12600
.. _`OPNFV Fuel JIRA: Gambia 7.1 Known issues`: https://jira.opnfv.org/issues/?filter=12602
.. _`OPNFV Fuel JIRA: Gambia 7.1 Workarounds`: https://jira.opnfv.org/issues/?filter=12603