Merge "[docs] Add PXE/admin DHCP warning" into stable/gambia
[fuel.git] / docs / release / installation / installation.instruction.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 Installation Instruction
7 ***********************************
8
9 Abstract
10 ========
11
12 This document describes how to install the ``Gambia`` release of
13 OPNFV when using Fuel as a deployment tool, covering its usage,
14 limitations, dependencies and required system resources.
15
16 This is an unified documentation for both ``x86_64`` and ``aarch64``
17 architectures. All information is common for both architectures
18 except when explicitly stated.
19
20 Introduction
21 ============
22
23 This document provides guidelines on how to install and
24 configure the ``Gambia`` release of OPNFV when using Fuel as a
25 deployment tool, including required software and hardware configurations.
26
27 Although the available installation options provide a high degree of
28 freedom in how the system is set up, including architecture, services
29 and features, etc., said permutations may not provide an OPNFV
30 compliant reference architecture. This document provides a
31 step-by-step guide that results in an OPNFV ``Gambia`` compliant
32 deployment.
33
34 The audience of this document is assumed to have good knowledge of
35 networking and Unix/Linux administration.
36
37 Before starting the installation of the ``Gambia`` release of
38 OPNFV, using Fuel as a deployment tool, some planning must be
39 done.
40
41 Preparations
42 ============
43
44 Prior to installation, a number of deployment specific parameters must be
45 collected, those are:
46
47 #.     Provider sub-net and gateway information
48
49 #.     Provider ``VLAN`` information
50
51 #.     Provider ``DNS`` addresses
52
53 #.     Provider ``NTP`` addresses
54
55 #.     How many nodes and what roles you want to deploy (Controllers, Computes)
56
57 This information will be needed for the configuration procedures
58 provided in this document.
59
60 Hardware Requirements
61 =====================
62
63 Mininum hardware requirements depend on the deployment type.
64
65 .. WARNING::
66
67     If ``baremetal`` nodes are present in the cluster, the architecture of the
68     nodes running the control plane (``kvm01``, ``kvm02``, ``kvm03`` for
69     ``HA`` scenarios, respectively ``ctl01``, ``gtw01``, ``odl01`` for
70     ``noHA`` scenarios) and the ``jumpserver`` architecture must be the same
71     (either ``x86_64`` or ``aarch64``).
72
73 .. TIP::
74
75     The compute nodes may have different architectures, but extra
76     configuration might be required for scheduling VMs on the appropiate host.
77     This use-case is not tested in OPNFV CI, so it is considered experimental.
78
79 Hardware Requirements for ``virtual`` Deploys
80 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81
82 The following minimum hardware requirements must be met for the ``virtual``
83 installation of ``Gambia`` using Fuel:
84
85 +------------------+------------------------------------------------------+
86 | **HW Aspect**    | **Requirement**                                      |
87 |                  |                                                      |
88 +==================+======================================================+
89 | **1 Jumpserver** | A physical node (also called Foundation Node) that   |
90 |                  | will host a Salt Master container and each of the VM |
91 |                  | nodes in the virtual deploy                          |
92 +------------------+------------------------------------------------------+
93 | **CPU**          | Minimum 1 socket with Virtualization support         |
94 +------------------+------------------------------------------------------+
95 | **RAM**          | Minimum 32GB/server (Depending on VNF work load)     |
96 +------------------+------------------------------------------------------+
97 | **Disk**         | Minimum 100GB (SSD or 15krpm SCSI highly recommended)|
98 +------------------+------------------------------------------------------+
99
100 Hardware Requirements for ``baremetal`` Deploys
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102
103 The following minimum hardware requirements must be met for the ``baremetal``
104 installation of ``Gambia`` using Fuel:
105
106 +------------------+------------------------------------------------------+
107 | **HW Aspect**    | **Requirement**                                      |
108 |                  |                                                      |
109 +==================+======================================================+
110 | **1 Jumpserver** | A physical node (also called Foundation Node) that   |
111 |                  | hosts the Salt Master container and MaaS VM          |
112 +------------------+------------------------------------------------------+
113 | **# of nodes**   | Minimum 5                                            |
114 |                  |                                                      |
115 |                  | - 3 KVM servers which will run all the controller    |
116 |                  |   services                                           |
117 |                  |                                                      |
118 |                  | - 2 Compute nodes                                    |
119 |                  |                                                      |
120 |                  | .. WARNING::                                         |
121 |                  |                                                      |
122 |                  |     ``kvm01``, ``kvm02``, ``kvm03`` nodes and the    |
123 |                  |     ``jumpserver`` must have the same architecture   |
124 |                  |     (either ``x86_64`` or ``aarch64``).              |
125 |                  |                                                      |
126 |                  | .. NOTE::                                            |
127 |                  |                                                      |
128 |                  |     ``aarch64`` nodes should run an ``UEFI``         |
129 |                  |     compatible firmware with PXE support             |
130 |                  |     (e.g. ``EDK2``).                                 |
131 +------------------+------------------------------------------------------+
132 | **CPU**          | Minimum 1 socket with Virtualization support         |
133 +------------------+------------------------------------------------------+
134 | **RAM**          | Minimum 16GB/server (Depending on VNF work load)     |
135 +------------------+------------------------------------------------------+
136 | **Disk**         | Minimum 256GB 10kRPM spinning disks                  |
137 +------------------+------------------------------------------------------+
138 | **Networks**     | Mininum 4                                            |
139 |                  |                                                      |
140 |                  | - 3 VLANs (``public``, ``mgmt``, ``private``) -      |
141 |                  |   can be a mix of tagged/native                      |
142 |                  |                                                      |
143 |                  | - 1 Un-Tagged VLAN for PXE Boot -                    |
144 |                  |   ``PXE/admin`` Network                              |
145 |                  |                                                      |
146 |                  | .. NOTE::                                            |
147 |                  |                                                      |
148 |                  |     These can be allocated to a single NIC           |
149 |                  |     or spread out over multiple NICs.                |
150 |                  |                                                      |
151 |                  | .. WARNING::                                         |
152 |                  |                                                      |
153 |                  |     No external ``DHCP`` server should be present    |
154 |                  |     in the ``PXE/admin`` network segment, as it      |
155 |                  |     would interfere with ``MaaS`` ``DHCP`` during    |
156 |                  |     ``baremetal`` node commissioning/deploying.      |
157 +------------------+------------------------------------------------------+
158 | **Power mgmt**   | All targets need to have power management tools that |
159 |                  | allow rebooting the hardware (e.g. ``IPMI``).        |
160 +------------------+------------------------------------------------------+
161
162 Hardware Requirements for ``hybrid`` (``baremetal`` + ``virtual``) Deploys
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164
165 The following minimum hardware requirements must be met for the ``hybrid``
166 installation of ``Gambia`` using Fuel:
167
168 +------------------+------------------------------------------------------+
169 | **HW Aspect**    | **Requirement**                                      |
170 |                  |                                                      |
171 +==================+======================================================+
172 | **1 Jumpserver** | A physical node (also called Foundation Node) that   |
173 |                  | hosts the Salt Master container, MaaS VM and         |
174 |                  | each of the virtual nodes defined in ``PDF``         |
175 +------------------+------------------------------------------------------+
176 | **# of nodes**   | .. NOTE::                                            |
177 |                  |                                                      |
178 |                  |     Depends on ``PDF`` configuration.                |
179 |                  |                                                      |
180 |                  | If the control plane is virtualized, minimum         |
181 |                  | baremetal requirements are:                          |
182 |                  |                                                      |
183 |                  | - 2 Compute nodes                                    |
184 |                  |                                                      |
185 |                  | If the computes are virtualized, minimum             |
186 |                  | baremetal requirements are:                          |
187 |                  |                                                      |
188 |                  | - 3 KVM servers which will run all the controller    |
189 |                  |   services                                           |
190 |                  |                                                      |
191 |                  | .. WARNING::                                         |
192 |                  |                                                      |
193 |                  |     ``kvm01``, ``kvm02``, ``kvm03`` nodes and the    |
194 |                  |     ``jumpserver`` must have the same architecture   |
195 |                  |     (either ``x86_64`` or ``aarch64``).              |
196 |                  |                                                      |
197 |                  | .. NOTE::                                            |
198 |                  |                                                      |
199 |                  |     ``aarch64`` nodes should run an ``UEFI``         |
200 |                  |     compatible firmware with PXE support             |
201 |                  |     (e.g. ``EDK2``).                                 |
202 +------------------+------------------------------------------------------+
203 | **CPU**          | Minimum 1 socket with Virtualization support         |
204 +------------------+------------------------------------------------------+
205 | **RAM**          | Minimum 16GB/server (Depending on VNF work load)     |
206 +------------------+------------------------------------------------------+
207 | **Disk**         | Minimum 256GB 10kRPM spinning disks                  |
208 +------------------+------------------------------------------------------+
209 | **Networks**     | Same as for ``baremetal`` deployments                |
210 +------------------+------------------------------------------------------+
211 | **Power mgmt**   | Same as for ``baremetal`` deployments                |
212 +------------------+------------------------------------------------------+
213
214 Help with Hardware Requirements
215 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
216
217 Calculate hardware requirements:
218
219 When choosing the hardware on which you will deploy your OpenStack
220 environment, you should think about:
221
222 - CPU -- Consider the number of virtual machines that you plan to deploy in
223   your cloud environment and the CPUs per virtual machine.
224
225 - Memory -- Depends on the amount of RAM assigned per virtual machine and the
226   controller node.
227
228 - Storage -- Depends on the local drive space per virtual machine, remote
229   volumes that can be attached to a virtual machine, and object storage.
230
231 - Networking -- Depends on the Choose Network Topology, the network bandwidth
232   per virtual machine, and network storage.
233
234 Top of the Rack (``TOR``) Configuration Requirements
235 ====================================================
236
237 The switching infrastructure provides connectivity for the OPNFV
238 infrastructure operations, tenant networks (East/West) and provider
239 connectivity (North/South); it also provides needed connectivity for
240 the Storage Area Network (SAN).
241
242 To avoid traffic congestion, it is strongly suggested that three
243 physically separated networks are used, that is: 1 physical network
244 for administration and control, one physical network for tenant private
245 and public networks, and one physical network for SAN.
246
247 The switching connectivity can (but does not need to) be fully redundant,
248 in such case it comprises a redundant 10GE switch pair for each of the
249 three physically separated networks.
250
251 .. WARNING::
252
253     The physical ``TOR`` switches are **not** automatically configured from
254     the OPNFV Fuel reference platform. All the networks involved in the OPNFV
255     infrastructure as well as the provider networks and the private tenant
256     VLANs needs to be manually configured.
257
258 Manual configuration of the ``Gambia`` hardware platform should
259 be carried out according to the `OPNFV Pharos Specification`_.
260
261 OPNFV Software Prerequisites
262 ============================
263
264 .. NOTE::
265
266     All prerequisites described in this chapter apply to the ``jumpserver``
267     node.
268
269 OS Distribution Support
270 ~~~~~~~~~~~~~~~~~~~~~~~
271
272 The Jumpserver node should be pre-provisioned with an operating system,
273 according to the `OPNFV Pharos specification`_.
274
275 OPNFV Fuel has been validated by CI using the following distributions
276 installed on the Jumpserver:
277
278 - ``CentOS 7`` (recommended by Pharos specification);
279 - ``Ubuntu Xenial 16.04``;
280
281 .. TOPIC:: ``aarch64`` notes
282
283     For an ``aarch64`` Jumpserver, the ``libvirt`` minimum required
284     version is ``3.x``, ``3.5`` or newer highly recommended.
285
286     .. TIP::
287
288         ``CentOS 7`` (``aarch64``) distro provided packages are already new
289         enough.
290
291     .. WARNING::
292
293         ``Ubuntu 16.04`` (``arm64``), distro packages are too old and 3rd party
294         repositories should be used.
295
296     For convenience, Armband provides a DEB repository holding all the
297     required packages.
298
299     To add and enable the Armband repository on an Ubuntu 16.04 system,
300     create a new sources list file ``/apt/sources.list.d/armband.list``
301     with the following contents:
302
303     .. code-block:: console
304
305         jenkins@jumpserver:~$ cat /etc/apt/sources.list.d/armband.list
306         deb http://linux.enea.com/mcp-repos/queens/xenial queens-armband main
307
308         jenkins@jumpserver:~$ sudo apt-key adv --keyserver keys.gnupg.net \
309                                                --recv 798AB1D1
310         jenkins@jumpserver:~$ sudo apt-get update
311
312 OS Distribution Packages
313 ~~~~~~~~~~~~~~~~~~~~~~~~
314
315 By default, the ``deploy.sh`` script will automatically install the required
316 distribution package dependencies on the Jumpserver, so the end user does
317 not have to manually install them before starting the deployment.
318
319 This includes Python, QEMU, libvirt etc.
320
321 .. SEEALSO::
322
323     To disable automatic package installation (and/or upgrade) during
324     deployment, check out the ``-P`` deploy argument.
325
326 .. WARNING::
327
328     The install script expects ``libvirt`` to be already running on the
329     Jumpserver.
330
331 In case ``libvirt`` packages are missing, the script will install them; but
332 depending on the OS distribution, the user might have to start the
333 ``libvirt`` daemon service manually, then run the deploy script again.
334
335 Therefore, it is recommended to install ``libvirt`` explicitly on the
336 Jumpserver before the deployment.
337
338 While not mandatory, upgrading the kernel on the Jumpserver is also highly
339 recommended.
340
341 .. code-block:: console
342
343     jenkins@jumpserver:~$ sudo apt-get install \
344                           linux-image-generic-hwe-16.04-edge libvirt-bin
345     jenkins@jumpserver:~$ sudo reboot
346
347 User Requirements
348 ~~~~~~~~~~~~~~~~~
349
350 The user running the deploy script on the Jumpserver should belong to
351 ``sudo`` and ``libvirt`` groups, and have passwordless sudo access.
352
353 .. NOTE::
354
355     Throughout this documentation, we will use the ``jenkins`` username for
356     this role.
357
358 The following example adds the groups to the user ``jenkins``:
359
360 .. code-block:: console
361
362     jenkins@jumpserver:~$ sudo usermod -aG sudo jenkins
363     jenkins@jumpserver:~$ sudo usermod -aG libvirt jenkins
364     jenkins@jumpserver:~$ sudo reboot
365     jenkins@jumpserver:~$ groups
366     jenkins sudo libvirt
367
368     jenkins@jumpserver:~$ sudo visudo
369     ...
370     %jenkins ALL=(ALL) NOPASSWD:ALL
371
372 Local Artifact Storage
373 ~~~~~~~~~~~~~~~~~~~~~~
374
375 The folder containing the temporary deploy artifacts (``/home/jenkins/tmpdir``
376 in the examples below) needs to have mask ``777`` in order for ``libvirt`` to
377 be able to use them.
378
379 .. code-block:: console
380
381     jenkins@jumpserver:~$ mkdir -p -m 777 /home/jenkins/tmpdir
382
383 Network Configuration
384 ~~~~~~~~~~~~~~~~~~~~~
385
386 Relevant Linux bridges should also be pre-configured for certain networks,
387 depending on the type of the deployment.
388
389 +------------+---------------+----------------------------------------------+
390 | Network    | Linux Bridge  | Linux Bridge necessity based on deploy type  |
391 |            |               +--------------+---------------+---------------+
392 |            |               | ``virtual``  | ``baremetal`` | ``hybrid``    |
393 +============+===============+==============+===============+===============+
394 | PXE/admin  | ``admin_br``  | absent       | present       | present       |
395 +------------+---------------+--------------+---------------+---------------+
396 | management | ``mgmt_br``   | optional     | optional,     | optional,     |
397 |            |               |              | recommended,  | recommended,  |
398 |            |               |              | required for  | required for  |
399 |            |               |              | ``functest``, | ``functest``, |
400 |            |               |              | ``yardstick`` | ``yardstick`` |
401 +------------+---------------+--------------+---------------+---------------+
402 | internal   | ``int_br``    | optional     | optional      | present       |
403 +------------+---------------+--------------+---------------+---------------+
404 | public     | ``public_br`` | optional     | optional,     | optional,     |
405 |            |               |              | recommended,  | recommended,  |
406 |            |               |              | useful for    | useful for    |
407 |            |               |              | debugging     | debugging     |
408 +------------+---------------+--------------+---------------+---------------+
409
410 .. TIP::
411
412     IP addresses should be assigned to the created bridge interfaces (not
413     to one of its ports).
414
415 .. WARNING::
416
417     ``PXE/admin`` bridge (``admin_br``) **must** have an IP address.
418
419 Changes ``deploy.sh`` Will Perform to Jumpserver OS
420 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
421
422 .. WARNING::
423
424     The install script will alter Jumpserver sysconf and disable
425     ``net.bridge.bridge-nf-call``.
426
427 .. WARNING::
428
429     The install script will automatically install and/or upgrade the
430     required distribution package dependencies on the Jumpserver,
431     unless explicitly asked not to (via the ``-P`` deploy arg).
432
433 OPNFV Software Configuration (``XDF``)
434 ======================================
435
436 .. versionadded:: 5.0.0
437 .. versionchanged:: 7.0.0
438
439 Unlike the old approach based on OpenStack Fuel, OPNFV Fuel no longer has a
440 graphical user interface for configuring the environment, but instead
441 switched to OPNFV specific descriptor files that we will call generically
442 ``XDF``:
443
444 - ``PDF`` (POD Descriptor File) provides an abstraction of the target POD
445   with all its hardware characteristics and required parameters;
446 - ``IDF`` (Installer Descriptor File) extends the ``PDF`` with POD related
447   parameters required by the OPNFV Fuel installer;
448 - ``SDF`` (Scenario Descriptor File, **not** yet adopted) will later
449   replace embedded scenario definitions, describing the roles and layout of
450   the cluster enviroment for a given reference architecture;
451
452 .. TIP::
453
454     For ``virtual`` deployments, if the ``public`` network will be accessed
455     from outside the ``jumpserver`` node, a custom ``PDF``/``IDF`` pair is
456     required for customizing ``idf.net_config.public`` and
457     ``idf.fuel.jumphost.bridges.public``.
458
459 .. NOTE::
460
461     For OPNFV CI PODs, as well as simple (no ``public`` bridge) ``virtual``
462     deployments, ``PDF``/``IDF`` files are already available in the
463     `pharos git repo`_. They can be used as a reference for user-supplied
464     inputs or to kick off a deployment right away.
465
466 +----------+------------------------------------------------------------------+
467 | LAB/POD  | ``PDF``/``IDF`` availability based on deploy type                |
468 |          +------------------------+--------------------+--------------------+
469 |          | ``virtual``            | ``baremetal``      | ``hybrid``         |
470 +==========+========================+====================+====================+
471 | OPNFV CI | available in           | available in       | N/A, as currently  |
472 | POD      | `pharos git repo`_     | `pharos git repo`_ | there are 0 hybrid |
473 |          | (e.g.                  | (e.g. ``lf-pod2``, | PODs in OPNFV CI   |
474 |          | ``ericsson-virtual1``) | ``arm-pod5``)      |                    |
475 +----------+------------------------+--------------------+--------------------+
476 | local or | ``user-supplied``      | ``user-supplied``  | ``user-supplied``  |
477 | new POD  |                        |                    |                    |
478 +----------+------------------------+--------------------+--------------------+
479
480 .. TIP::
481
482     Both ``PDF`` and ``IDF`` structure are modelled as ``yaml`` schemas in the
483     `pharos git repo`_, also included as a git submodule in OPNFV Fuel.
484
485     .. SEEALSO::
486
487         - ``mcp/scripts/pharos/config/pdf/pod1.schema.yaml``
488         - ``mcp/scripts/pharos/config/pdf/idf-pod1.schema.yaml``
489
490     Schema files are also used during the initial deployment phase to validate
491     the user-supplied input ``PDF``/``IDF`` files.
492
493 ``PDF``
494 ~~~~~~~
495
496 The Pod Descriptor File is a hardware description of the POD
497 infrastructure. The information is modeled under a ``yaml`` structure.
498
499 The hardware description covers the ``jumphost`` node and a set of ``nodes``
500 for the cluster target boards. For each node the following characteristics
501 are defined:
502
503 - Node parameters including ``CPU`` features and total memory;
504 - A list of available disks;
505 - Remote management parameters;
506 - Network interfaces list including name, ``MAC`` address, link speed,
507   advanced features;
508
509 .. SEEALSO::
510
511     A reference file with the expected ``yaml`` structure is available at:
512
513     - ``mcp/scripts/pharos/config/pdf/pod1.yaml``
514
515     For more information on ``PDF``, see the `OPNFV PDF Wiki Page`_.
516
517 .. WARNING::
518
519     The fixed IPs defined in ``PDF`` are ignored by the OPNFV Fuel installer
520     script and it will instead assign addresses based on the network ranges
521     defined in ``IDF``.
522
523     For more details on the way IP addresses are assigned, see
524     :ref:`OPNFV Fuel User Guide <fuel-userguide>`.
525
526 ``PDF``/``IDF`` Role (hostname) Mapping
527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
528
529 Upcoming ``SDF`` support will introduce a series of possible node roles.
530 Until that happens, the role mapping logic is hardcoded, based on node index
531 in ``PDF``/``IDF`` (which should also be in sync, i.e. the parameters of the
532 ``n``-th cluster node defined in ``PDF`` should be the ``n``-th node in
533 ``IDF`` structures too).
534
535 +-------------+------------------+----------------------+
536 | Node index  | ``HA`` scenario  | ``noHA`` scenario    |
537 +=============+==================+======================+
538 | 1st         | ``kvm01``        | ``ctl01``            |
539 +-------------+------------------+----------------------+
540 | 2nd         | ``kvm02``        | ``gtw01``            |
541 +-------------+------------------+----------------------+
542 | 3rd         | ``kvm03``        | ``odl01``/``unused`` |
543 +-------------+------------------+----------------------+
544 | 4th,        | ``cmp001``,      | ``cmp001``,          |
545 | 5th,        | ``cmp002``,      | ``cmp002``,          |
546 | ...         | ``...``          | ``...``              |
547 +-------------+------------------+----------------------+
548
549 .. TIP::
550
551     To switch node role(s), simply reorder the node definitions in
552     ``PDF``/``IDF`` (make sure to keep them in sync).
553
554 ``IDF``
555 ~~~~~~~
556
557 The Installer Descriptor File extends the ``PDF`` with POD related parameters
558 required by the installer. This information may differ per each installer type
559 and it is not considered part of the POD infrastructure.
560
561 ``idf.*`` Overview
562 ------------------
563
564 The ``IDF`` file must be named after the ``PDF`` it attaches to, with the
565 prefix ``idf-``.
566
567 .. SEEALSO::
568
569     A reference file with the expected ``yaml`` structure is available at:
570
571     - ``mcp/scripts/pharos/config/pdf/idf-pod1.yaml``
572
573 The file follows a ``yaml`` structure and at least two sections
574 (``idf.net_config`` and ``idf.fuel``) are expected.
575
576 The ``idf.fuel`` section defines several sub-sections required by the OPNFV
577 Fuel installer:
578
579 - ``jumphost``: List of bridge names for each network on the Jumpserver;
580 - ``network``: List of device name and bus address info of all the target nodes.
581   The order must be aligned with the order defined in the ``PDF`` file.
582   The OPNFV Fuel installer relies on the ``IDF`` model to setup all node NICs
583   by defining the expected device name and bus address;
584 - ``maas``: Defines the target nodes commission timeout and deploy timeout;
585 - ``reclass``: Defines compute parameter tuning, including huge pages, ``CPU``
586   pinning and other ``DPDK`` settings;
587
588 .. code-block:: yaml
589
590     ---
591     idf:
592       version: 0.1     # fixed, the only supported version (mandatory)
593       net_config:      # POD network configuration overview (mandatory)
594         oob: ...       # mandatory
595         admin: ...     # mandatory
596         mgmt: ...      # mandatory
597         storage: ...   # mandatory
598         private: ...   # mandatory
599         public: ...    # mandatory
600       fuel:            # OPNFV Fuel specific section (mandatory)
601         jumphost:      # OPNFV Fuel jumpserver bridge configuration (mandatory)
602           bridges:                          # Bridge name mapping (mandatory)
603             admin: 'admin_br'               # <PXE/admin bridge name> or ~
604             mgmt: 'mgmt_br'                 # <mgmt bridge name> or ~
605             private: ~                      # <private bridge name> or ~
606             public: 'public_br'             # <public bridge name> or ~
607           trunks: ...                       # Trunked networks (optional)
608         maas:                               # MaaS timeouts (optional)
609           timeout_comissioning: 10          # commissioning timeout in minutes
610           timeout_deploying: 15             # deploy timeout in minutes
611         network:                            # Cluster nodes network (mandatory)
612           ntp_strata_host1: 1.pool.ntp.org  # NTP1 (optional)
613           ntp_strata_host2: 0.pool.ntp.org  # NTP2 (optional)
614           node: ...                         # List of per-node cfg (mandatory)
615         reclass:                            # Additional params (mandatory)
616           node: ...                         # List of per-node cfg (mandatory)
617
618 ``idf.net_config``
619 ------------------
620
621 ``idf.net_config`` was introduced as a mechanism to map all the usual cluster
622 networks (internal and provider networks, e.g. ``mgmt``) to their ``VLAN``
623 tags, ``CIDR`` and a physical interface index (used to match networks to
624 interface names, like ``eth0``, on the cluster nodes).
625
626
627 .. WARNING::
628
629     The mapping between one network segment (e.g. ``mgmt``) and its ``CIDR``/
630     ``VLAN`` is not configurable on a per-node basis, but instead applies to
631     all the nodes in the cluster.
632
633 For each network, the following parameters are currently supported:
634
635 +--------------------------+--------------------------------------------------+
636 | ``idf.net_config.*`` key | Details                                          |
637 +==========================+==================================================+
638 | ``interface``            | The index of the interface to use for this net.  |
639 |                          | For each cluster node (if network is present),   |
640 |                          | OPNFV Fuel will determine the underlying physical|
641 |                          | interface by picking the element at index        |
642 |                          | ``interface`` from the list of network interface |
643 |                          | names defined in                                 |
644 |                          | ``idf.fuel.network.node.*.interfaces``.          |
645 |                          | Required for each network.                       |
646 |                          |                                                  |
647 |                          | .. NOTE::                                        |
648 |                          |                                                  |
649 |                          |     The interface index should be the            |
650 |                          |     same on all cluster nodes. This can be       |
651 |                          |     achieved by ordering them accordingly in     |
652 |                          |     ``PDF``/``IDF``.                             |
653 +--------------------------+--------------------------------------------------+
654 | ``vlan``                 | ``VLAN`` tag (integer) or the string ``native``. |
655 |                          | Required for each network.                       |
656 +--------------------------+--------------------------------------------------+
657 | ``ip-range``             | When specified, all cluster IPs dynamically      |
658 |                          | allocated by OPNFV Fuel for that network will be |
659 |                          | assigned inside this range.                      |
660 |                          | Required for ``oob``, optional for others.       |
661 |                          |                                                  |
662 |                          | .. NOTE::                                        |
663 |                          |                                                  |
664 |                          |     For now, only range start address is used.   |
665 +--------------------------+--------------------------------------------------+
666 | ``network``              | Network segment address.                         |
667 |                          | Required for each network, except ``oob``.       |
668 +--------------------------+--------------------------------------------------+
669 | ``mask``                 | Network segment mask.                            |
670 |                          | Required for each network, except ``oob``.       |
671 +--------------------------+--------------------------------------------------+
672 | ``gateway``              | Gateway IP address.                              |
673 |                          | Required for ``public``, N/A for others.         |
674 +--------------------------+--------------------------------------------------+
675 | ``dns``                  | List of DNS IP addresses.                        |
676 |                          | Required for ``public``, N/A for others.         |
677 +--------------------------+--------------------------------------------------+
678
679 Sample ``public`` network configuration block:
680
681 .. code-block:: yaml
682
683     idf:
684         net_config:
685             public:
686               interface: 1
687               vlan: native
688               network: 10.0.16.0
689               ip-range: 10.0.16.100-10.0.16.253
690               mask: 24
691               gateway: 10.0.16.254
692               dns:
693                 - 8.8.8.8
694                 - 8.8.4.4
695
696 .. TOPIC:: ``hybrid`` POD notes
697
698     Interface indexes must be the same for all nodes, which is problematic
699     when mixing ``virtual`` nodes (where all interfaces were untagged
700     so far) with ``baremetal`` nodes (where interfaces usually carry
701     tagged VLANs).
702
703     .. TIP::
704
705         To achieve this, a special ``jumpserver`` network layout is used:
706         ``mgmt``, ``storage``, ``private``, ``public`` are trunked together
707         in a single ``trunk`` bridge:
708
709         - without decapsulating them (if they are also tagged on ``baremetal``);
710           a ``trunk.<vlan_tag>`` interface should be created on the
711           ``jumpserver`` for each tagged VLAN so the kernel won't drop the
712           packets;
713         - by decapsulating them  first (if they are also untagged on
714           ``baremetal`` nodes);
715
716     The ``trunk`` bridge is then used for all bridges OPNFV Fuel
717     is aware of in ``idf.fuel.jumphost.bridges``, e.g. for a ``trunk`` where
718     only ``mgmt`` network is not decapsulated:
719
720     .. code-block:: yaml
721
722         idf:
723             fuel:
724               jumphost:
725                 bridges:
726                   admin: 'admin_br'
727                   mgmt: 'trunk'
728                   private: 'trunk'
729                   public: 'trunk'
730                 trunks:
731                   # mgmt network is not decapsulated for jumpserver infra VMs,
732                   # to align with the VLAN configuration of baremetal nodes.
733                   mgmt: True
734
735 .. WARNING::
736
737     The Linux kernel limits the name of network interfaces to 16 characters.
738     Extra care is required when choosing bridge names, so appending the
739     ``VLAN`` tag won't lead to an interface name length exceeding that limit.
740
741 ``idf.fuel.network``
742 --------------------
743
744 ``idf.fuel.network`` allows mapping the cluster networks (e.g. ``mgmt``) to
745 their physical interface name (e.g. ``eth0``) and bus address on the cluster
746 nodes.
747
748 ``idf.fuel.network.node`` should be a list with the same number (and order) of
749 elements as the cluster nodes defined in ``PDF``, e.g. the second cluster node
750 in ``PDF`` will use the interface name and bus address defined in the second
751 list element.
752
753 Below is a sample configuration block for a single node with two interfaces:
754
755 .. code-block:: yaml
756
757     idf:
758       fuel:
759         network:
760           node:
761             # Ordered-list, index should be in sync with node index in PDF
762             - interfaces:
763                 # Ordered-list, index should be in sync with interface index
764                 # in PDF
765                 - 'ens3'
766                 - 'ens4'
767               busaddr:
768                 # Bus-info reported by `ethtool -i ethX`
769                 - '0000:00:03.0'
770                 - '0000:00:04.0'
771
772
773 ``idf.fuel.reclass``
774 --------------------
775
776 ``idf.fuel.reclass`` provides a way of overriding default values in the
777 reclass cluster model.
778
779 This currently covers strictly compute parameter tuning, including huge
780 pages, ``CPU`` pinning and other ``DPDK`` settings.
781
782 ``idf.fuel.reclass.node`` should be a list with the same number (and order) of
783 elements as the cluster nodes defined in ``PDF``, e.g. the second cluster node
784 in ``PDF`` will use the parameters defined in the second list element.
785
786 The following parameters are currently supported:
787
788 +---------------------------------+-------------------------------------------+
789 | ``idf.fuel.reclass.node.*``     | Details                                   |
790 | key                             |                                           |
791 +=================================+===========================================+
792 | ``nova_cpu_pinning``            | List of CPU cores nova will be pinned to. |
793 |                                 |                                           |
794 |                                 | .. NOTE::                                 |
795 |                                 |                                           |
796 |                                 |     Currently disabled.                   |
797 +---------------------------------+-------------------------------------------+
798 | ``compute_hugepages_size``      | Size of each persistent huge pages.       |
799 |                                 |                                           |
800 |                                 | Usual values are ``2M`` and ``1G``.       |
801 +---------------------------------+-------------------------------------------+
802 | ``compute_hugepages_count``     | Total number of persistent huge pages.    |
803 +---------------------------------+-------------------------------------------+
804 | ``compute_hugepages_mount``     | Mount point to use for huge pages.        |
805 +---------------------------------+-------------------------------------------+
806 | ``compute_kernel_isolcpu``      | List of certain CPU cores that are        |
807 |                                 | isolated from Linux scheduler.            |
808 +---------------------------------+-------------------------------------------+
809 | ``compute_dpdk_driver``         | Kernel module to provide userspace I/O    |
810 |                                 | support.                                  |
811 +---------------------------------+-------------------------------------------+
812 | ``compute_ovs_pmd_cpu_mask``    | Hexadecimal mask of CPUs to run ``DPDK``  |
813 |                                 | Poll-mode drivers.                        |
814 +---------------------------------+-------------------------------------------+
815 | ``compute_ovs_dpdk_socket_mem`` | Set of amount huge pages in ``MB`` to be  |
816 |                                 | used by ``OVS-DPDK`` daemon taken for each|
817 |                                 | ``NUMA`` node. Set size is equal to       |
818 |                                 | ``NUMA`` nodes count, elements are        |
819 |                                 | divided by comma.                         |
820 +---------------------------------+-------------------------------------------+
821 | ``compute_ovs_dpdk_lcore_mask`` | Hexadecimal mask of ``DPDK`` lcore        |
822 |                                 | parameter used to run ``DPDK`` processes. |
823 +---------------------------------+-------------------------------------------+
824 | ``compute_ovs_memory_channels`` | Number of memory channels to be used.     |
825 +---------------------------------+-------------------------------------------+
826 | ``dpdk0_driver``                | NIC driver to use for physical network    |
827 |                                 | interface.                                |
828 +---------------------------------+-------------------------------------------+
829 | ``dpdk0_n_rxq``                 | Number of ``RX`` queues.                  |
830 +---------------------------------+-------------------------------------------+
831
832 Sample ``compute_params`` configuration block (for a single node):
833
834 .. code-block:: yaml
835
836     idf:
837       fuel:
838         reclass:
839           node:
840             - compute_params:
841                 common: &compute_params_common
842                   compute_hugepages_size: 2M
843                   compute_hugepages_count: 2048
844                   compute_hugepages_mount: /mnt/hugepages_2M
845                 dpdk:
846                   <<: *compute_params_common
847                   compute_dpdk_driver: uio
848                   compute_ovs_pmd_cpu_mask: "0x6"
849                   compute_ovs_dpdk_socket_mem: "1024"
850                   compute_ovs_dpdk_lcore_mask: "0x8"
851                   compute_ovs_memory_channels: "2"
852                   dpdk0_driver: igb_uio
853                   dpdk0_n_rxq: 2
854
855 ``SDF``
856 ~~~~~~~
857
858 Scenario Descriptor Files are not yet implemented in the OPNFV Fuel ``Gambia``
859 release.
860
861 Instead, embedded OPNFV Fuel scenarios files are locally available in
862 ``mcp/config/scenario``.
863
864 OPNFV Software Installation and Deployment
865 ==========================================
866
867 This section describes the process of installing all the components needed to
868 deploy the full OPNFV reference platform stack across a server cluster.
869
870 Deployment Types
871 ~~~~~~~~~~~~~~~~
872
873 .. WARNING::
874
875     OPNFV releases previous to ``Gambia`` used to rely on the ``virtual``
876     keyword being part of the POD name (e.g. ``ericsson-virtual2``) to
877     configure the deployment type as ``virtual``. Otherwise ``baremetal``
878     was implied.
879
880 ``Gambia`` and newer releases are more flexbile towards supporting a mix
881 of ``baremetal`` and ``virtual`` nodes, so the type of deployment is
882 now automatically determined based on the cluster nodes types in ``PDF``:
883
884 +---------------------------------+-------------------------------------------+
885 | ``PDF`` has nodes of type       | Deployment type                           |
886 +---------------+-----------------+                                           |
887 | ``baremetal`` | ``virtual``     |                                           |
888 +===============+=================+===========================================+
889 | yes           | no              | ``baremetal``                             |
890 +---------------+-----------------+-------------------------------------------+
891 | yes           | yes             | ``hybrid``                                |
892 +---------------+-----------------+-------------------------------------------+
893 | no            | yes             | ``virtual``                               |
894 +---------------+-----------------+-------------------------------------------+
895
896 Based on that, the deployment script will later enable/disable certain extra
897 nodes (e.g. ``mas01``) and/or ``STATE`` files (e.g. ``maas``).
898
899 ``HA`` vs ``noHA``
900 ~~~~~~~~~~~~~~~~~~
901
902 High availability of OpenStack services is determined based on scenario name,
903 e.g. ``os-nosdn-nofeature-noha`` vs ``os-nosdn-nofeature-ha``.
904
905 .. TIP::
906
907     ``HA`` scenarios imply a virtualized control plane (``VCP``) for the
908     OpenStack services running on the 3 ``kvm`` nodes.
909
910     .. SEEALSO::
911
912         An experimental feature argument (``-N``) is supported by the deploy
913         script for disabling ``VCP``, although it might not be supported by
914         all scenarios and is not being continuosly validated by OPNFV CI/CD.
915
916 .. WARNING::
917
918     ``virtual`` ``HA`` deployments are not officially supported, due to
919     poor performance and various limitations of nested virtualization on
920     both ``x86_64`` and ``aarch64`` architectures.
921
922     .. TIP::
923
924         ``virtual`` ``HA`` deployments without ``VCP`` are supported, but
925         highly experimental.
926
927 +-------------------------------+-------------------------+-------------------+
928 | Feature                       | ``HA`` scenario         | ``noHA`` scenario |
929 +===============================+=========================+===================+
930 | ``VCP``                       | yes,                    | no                |
931 | (Virtualized Control Plane)   | disabled with ``-N``    |                   |
932 +-------------------------------+-------------------------+-------------------+
933 | OpenStack APIs SSL            | yes                     | no                |
934 +-------------------------------+-------------------------+-------------------+
935 | Storage                       | ``GlusterFS``           | ``NFS``           |
936 +-------------------------------+-------------------------+-------------------+
937
938 Steps to Start the Automatic Deploy
939 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
940
941 These steps are common for ``virtual``, ``baremetal`` or ``hybrid`` deploys,
942 ``x86_64``, ``aarch64`` or ``mixed`` (``x86_64`` and ``aarch64``):
943
944 - Clone the OPNFV Fuel code from gerrit
945 - Checkout the ``Gambia`` release tag
946 - Start the deploy script
947
948 .. NOTE::
949
950     The deployment uses the OPNFV Pharos project as input (``PDF`` and
951     ``IDF`` files) for hardware and network configuration of all current
952     OPNFV PODs.
953
954     When deploying a new POD, one may pass the ``-b`` flag to the deploy
955     script to override the path for the labconfig directory structure
956     containing the ``PDF`` and ``IDF`` (``<URI to configuration repo ...>`` is
957     the absolute path to a local or remote directory structure, populated
958     similar to `pharos git repo`_, i.e. ``PDF``/``IDF`` reside in a
959     subdirectory called ``labs/<lab_name>``).
960
961 .. code-block:: console
962
963     jenkins@jumpserver:~$ git clone https://git.opnfv.org/fuel
964     jenkins@jumpserver:~$ cd fuel
965     jenkins@jumpserver:~/fuel$ git checkout opnfv-7.0.0
966     jenkins@jumpserver:~/fuel$ ci/deploy.sh -l <lab_name> \
967                                             -p <pod_name> \
968                                             -b <URI to configuration repo containing the PDF/IDF files> \
969                                             -s <scenario> \
970                                             -D \
971                                             -S <Storage directory for deploy artifacts> |& tee deploy.log
972
973 .. TIP::
974
975     Besides the basic options,  there are other recommended deploy arguments:
976
977     - use ``-D`` option to enable the debug info
978     - use ``-S`` option to point to a tmp dir where the disk images are saved.
979       The deploy artifacts will be re-used on subsequent (re)deployments.
980     - use ``|& tee`` to save the deploy log to a file
981
982 Typical Cluster Examples
983 ~~~~~~~~~~~~~~~~~~~~~~~~
984
985 Common cluster layouts usually fall into one of the cases described below,
986 categorized by deployment type (``baremetal``, ``virtual`` or ``hybrid``) and
987 high availability (``HA`` or ``noHA``).
988
989 A simplified overview of the steps ``deploy.sh`` will automatically perform is:
990
991 - create a Salt Master Docker container on the jumpserver, which will drive
992   the rest of the installation;
993 - ``baremetal`` or ``hybrid`` only: create a ``MaaS`` infrastructure node VM,
994   which will be leveraged using Salt to handle OS provisioning on the
995   ``baremetal`` nodes;
996 - leverage Salt to install & configure OpenStack;
997
998 .. NOTE::
999
1000     A virtual network ``mcpcontrol`` is always created for initial connection
1001     of the VMs on Jumphost.
1002
1003 .. WARNING::
1004
1005     A single cluster deployment per ``jumpserver`` node is currently supported,
1006     indifferent of its type (``virtual``, ``baremetal`` or ``hybrid``).
1007
1008 Once the deployment is complete, the following should be accessible:
1009
1010 +---------------+----------------------------------+---------------------------+
1011 | Resource      | ``HA`` scenario                  | ``noHA`` scenario         |
1012 +===============+==================================+===========================+
1013 | ``Horizon``   | ``https://<prx public VIP>``     | ``http://<ctl VIP>:8078`` |
1014 | (Openstack    |                                  |                           |
1015 | Dashboard)    |                                  |                           |
1016 +---------------+----------------------------------+---------------------------+
1017 | ``SaltStack`` | ``http://<prx public VIP>:8090`` | N/A                       |
1018 | Deployment    |                                  |                           |
1019 | Documentation |                                  |                           |
1020 +---------------+----------------------------------+---------------------------+
1021
1022 .. SEEALSO::
1023
1024     For more details on locating and importing the generated SSL certificate,
1025     see :ref:`OPNFV Fuel User Guide <fuel-userguide>`.
1026
1027 ``virtual`` ``noHA`` POD
1028 ------------------------
1029
1030 In the following figure there are two generic examples of ``virtual`` deploys,
1031 each on a separate Jumphost node, both behind the same ``TOR`` switch:
1032
1033 - Jumphost 1 has only virsh bridges (created by the deploy script);
1034 - Jumphost 2 has a mix of Linux (manually created) and ``libvirt`` managed
1035   bridges (created by the deploy script);
1036
1037 .. figure:: img/fuel_virtual_noha.png
1038    :align: center
1039    :width: 60%
1040    :alt: OPNFV Fuel Virtual noHA POD Network Layout Examples
1041
1042    OPNFV Fuel Virtual noHA POD Network Layout Examples
1043
1044    +-------------+------------------------------------------------------------+
1045    | ``cfg01``   | Salt Master Docker container                               |
1046    +-------------+------------------------------------------------------------+
1047    | ``ctl01``   | Controller VM                                              |
1048    +-------------+------------------------------------------------------------+
1049    | ``gtw01``   | Gateway VM with neutron services                           |
1050    |             | (``DHCP`` agent, ``L3`` agent, ``metadata`` agent etc)     |
1051    +-------------+------------------------------------------------------------+
1052    | ``odl01``   | VM on which ``ODL`` runs                                   |
1053    |             | (for scenarios deployed with ODL)                          |
1054    +-------------+------------------------------------------------------------+
1055    | ``cmp001``, | Compute VMs                                                |
1056    | ``cmp002``  |                                                            |
1057    +-------------+------------------------------------------------------------+
1058
1059 .. TIP::
1060
1061     If external access to the ``public`` network is not required, there is
1062     little to no motivation to create a custom ``PDF``/``IDF`` set for a
1063     virtual deployment.
1064
1065     Instead, the existing virtual PODs definitions in `pharos git repo`_ can
1066     be used as-is:
1067
1068     - ``ericsson-virtual1`` for ``x86_64``;
1069     - ``arm-virtual2`` for ``aarch64``;
1070
1071 .. code-block:: console
1072
1073     # example deploy cmd for an x86_64 virtual cluster
1074     jenkins@jumpserver:~/fuel$ ci/deploy.sh -l ericsson \
1075                                             -p virtual1 \
1076                                             -s os-nosdn-nofeature-noha \
1077                                             -D \
1078                                             -S /home/jenkins/tmpdir |& tee deploy.log
1079
1080 ``baremetal`` ``noHA`` POD
1081 --------------------------
1082
1083 .. WARNING::
1084
1085     These scenarios are not tested in OPNFV CI, so they are considered
1086     experimental.
1087
1088 .. figure:: img/fuel_baremetal_noha.png
1089    :align: center
1090    :width: 60%
1091    :alt: OPNFV Fuel Baremetal noHA POD Network Layout Example
1092
1093    OPNFV Fuel Baremetal noHA POD Network Layout Example
1094
1095    +-------------+------------------------------------------------------------+
1096    | ``cfg01``   | Salt Master Docker container                               |
1097    +-------------+------------------------------------------------------------+
1098    | ``mas01``   | MaaS Node VM                                               |
1099    +-------------+------------------------------------------------------------+
1100    | ``ctl01``   | Baremetal controller node                                  |
1101    +-------------+------------------------------------------------------------+
1102    | ``gtw01``   | Baremetal Gateway with neutron services                    |
1103    |             | (dhcp agent, L3 agent, metadata, etc)                      |
1104    +-------------+------------------------------------------------------------+
1105    | ``odl01``   | Baremetal node on which ODL runs                           |
1106    |             | (for scenarios deployed with ODL, otherwise unused         |
1107    +-------------+------------------------------------------------------------+
1108    | ``cmp001``, | Baremetal Computes                                         |
1109    | ``cmp002``  |                                                            |
1110    +-------------+------------------------------------------------------------+
1111    | Tenant VM   | VM running in the cloud                                    |
1112    +-------------+------------------------------------------------------------+
1113
1114 ``baremetal`` ``HA`` POD
1115 ------------------------
1116
1117 .. figure:: img/fuel_baremetal_ha.png
1118    :align: center
1119    :width: 60%
1120    :alt: OPNFV Fuel Baremetal HA POD Network Layout Example
1121
1122    OPNFV Fuel Baremetal HA POD Network Layout Example
1123
1124    +---------------------------+----------------------------------------------+
1125    | ``cfg01``                 | Salt Master Docker container                 |
1126    +---------------------------+----------------------------------------------+
1127    | ``mas01``                 | MaaS Node VM                                 |
1128    +---------------------------+----------------------------------------------+
1129    | ``kvm01``,                | Baremetals which hold the VMs with           |
1130    | ``kvm02``,                | controller functions                         |
1131    | ``kvm03``                 |                                              |
1132    +---------------------------+----------------------------------------------+
1133    | ``prx01``,                | Proxy VMs for Nginx                          |
1134    | ``prx02``                 |                                              |
1135    +---------------------------+----------------------------------------------+
1136    | ``msg01``,                | RabbitMQ Service VMs                         |
1137    | ``msg02``,                |                                              |
1138    | ``msg03``                 |                                              |
1139    +---------------------------+----------------------------------------------+
1140    | ``dbs01``,                | MySQL service VMs                            |
1141    | ``dbs02``,                |                                              |
1142    | ``dbs03``                 |                                              |
1143    +---------------------------+----------------------------------------------+
1144    | ``mdb01``,                | Telemetry VMs                                |
1145    | ``mdb02``,                |                                              |
1146    | ``mdb03``                 |                                              |
1147    +---------------------------+----------------------------------------------+
1148    | ``odl01``                 | VM on which ``OpenDaylight`` runs            |
1149    |                           | (for scenarios deployed with ``ODL``)        |
1150    +---------------------------+----------------------------------------------+
1151    | ``cmp001``,               | Baremetal Computes                           |
1152    | ``cmp002``                |                                              |
1153    +---------------------------+----------------------------------------------+
1154    | Tenant VM                 | VM running in the cloud                      |
1155    +---------------------------+----------------------------------------------+
1156
1157 .. code-block:: console
1158
1159     # x86_x64 baremetal deploy on pod2 from Linux Foundation lab (lf-pod2)
1160     jenkins@jumpserver:~/fuel$ ci/deploy.sh -l lf \
1161                                             -p pod2 \
1162                                             -s os-nosdn-nofeature-ha \
1163                                             -D \
1164                                             -S /home/jenkins/tmpdir |& tee deploy.log
1165
1166 .. code-block:: console
1167
1168     # aarch64 baremetal deploy on pod5 from Enea ARM lab (arm-pod5)
1169     jenkins@jumpserver:~/fuel$ ci/deploy.sh -l arm \
1170                                             -p pod5 \
1171                                             -s os-nosdn-nofeature-ha \
1172                                             -D \
1173                                             -S /home/jenkins/tmpdir |& tee deploy.log
1174
1175 ``hybrid`` ``noHA`` POD
1176 -----------------------
1177
1178 .. figure:: img/fuel_hybrid_noha.png
1179    :align: center
1180    :width: 60%
1181    :alt: OPNFV Fuel Hybrid noHA POD Network Layout Examples
1182
1183    OPNFV Fuel Hybrid noHA POD Network Layout Examples
1184
1185    +-------------+------------------------------------------------------------+
1186    | ``cfg01``   | Salt Master Docker container                               |
1187    +-------------+------------------------------------------------------------+
1188    | ``mas01``   | MaaS Node VM                                               |
1189    +-------------+------------------------------------------------------------+
1190    | ``ctl01``   | Controller VM                                              |
1191    +-------------+------------------------------------------------------------+
1192    | ``gtw01``   | Gateway VM with neutron services                           |
1193    |             | (``DHCP`` agent, ``L3`` agent, ``metadata`` agent etc)     |
1194    +-------------+------------------------------------------------------------+
1195    | ``odl01``   | VM on which ``ODL`` runs                                   |
1196    |             | (for scenarios deployed with ODL)                          |
1197    +-------------+------------------------------------------------------------+
1198    | ``cmp001``, | Baremetal Computes                                         |
1199    | ``cmp002``  |                                                            |
1200    +-------------+------------------------------------------------------------+
1201
1202 Automatic Deploy Breakdown
1203 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1204
1205 When an automatic deploy is started, the following operations are performed
1206 sequentially by the deploy script:
1207
1208 +------------------+----------------------------------------------------------+
1209 | **Deploy stage** | **Details**                                              |
1210 +==================+==========================================================+
1211 | Argument         | enviroment variables and command line arguments passed   |
1212 | Parsing          | to ``deploy.sh`` are interpreted                         |
1213 +------------------+----------------------------------------------------------+
1214 | Distribution     | Install and/or configure mandatory requirements on the   |
1215 | Package          | ``jumpserver`` node:                                     |
1216 | Installation     |                                                          |
1217 |                  | - ``Docker`` (from upstream and not distribution repos,  |
1218 |                  |   as the version included in ``Ubuntu`` ``Xenial`` is    |
1219 |                  |   outdated);                                             |
1220 |                  | - ``docker-compose`` (from upstream, as the version      |
1221 |                  |   included in both ``CentOS 7`` and                      |
1222 |                  |   ``Ubuntu Xenial 16.04`` has dependency issues on most  |
1223 |                  |   systems);                                              |
1224 |                  | - ``virt-inst`` (from upstream, as the version included  |
1225 |                  |   in ``Ubuntu Xenial 16.04`` is outdated and lacks       |
1226 |                  |   certain required features);                            |
1227 |                  | - other miscelaneous requirements, depending on          |
1228 |                  |   ``jumpserver`` distribution OS;                        |
1229 |                  |                                                          |
1230 |                  | .. SEEALSO::                                             |
1231 |                  |                                                          |
1232 |                  |     - ``mcp/scripts/requirements_deb.yaml`` (``Ubuntu``) |
1233 |                  |     - ``mcp/scripts/requirements_rpm.yaml`` (``CentOS``) |
1234 |                  |                                                          |
1235 |                  | .. WARNING::                                             |
1236 |                  |                                                          |
1237 |                  |     Mininum required ``Docker`` version is ``17.x``.     |
1238 |                  |                                                          |
1239 |                  | .. WARNING::                                             |
1240 |                  |                                                          |
1241 |                  |     Mininum required ``virt-inst`` version is ``1.4``.   |
1242 +------------------+----------------------------------------------------------+
1243 | Patch            | For each ``git`` submodule in OPNFV Fuel repository,     |
1244 | Apply            | if a subdirectory with the same name exists under        |
1245 |                  | ``mcp/patches``, all patches in that subdirectory are    |
1246 |                  | applied using ``git-am`` to the respective ``git``       |
1247 |                  | submodule.                                               |
1248 |                  |                                                          |
1249 |                  | This allows OPNFV Fuel to alter upstream repositories    |
1250 |                  | contents before consuming them, including:               |
1251 |                  |                                                          |
1252 |                  | - ``Docker`` container build process customization;      |
1253 |                  | - ``salt-formulas`` customization;                       |
1254 |                  | - ``reclass.system`` customization;                      |
1255 |                  |                                                          |
1256 |                  | .. SEEALSO::                                             |
1257 |                  |                                                          |
1258 |                  |     - ``mcp/patches/README.rst``                         |
1259 +------------------+----------------------------------------------------------+
1260 | SSH RSA Keypair  | If not already present, a RSA keypair is generated on    |
1261 | Generation       | the ``jumpserver`` node at:                              |
1262 |                  |                                                          |
1263 |                  | - ``/var/lib/opnfv/mcp.rsa{,.pub}``                      |
1264 |                  |                                                          |
1265 |                  | The public key will be added to the ``authorized_keys``  |
1266 |                  | list for ``ubuntu`` user, so the private key can be used |
1267 |                  | for key-based logins on:                                 |
1268 |                  |                                                          |
1269 |                  | - ``cfg01``, ``mas01`` infrastructure nodes;             |
1270 |                  | - all cluster nodes (``baremetal`` and/or ``virtual``),  |
1271 |                  |   including ``VCP`` VMs;                                 |
1272 +------------------+----------------------------------------------------------+
1273 | ``j2``           | Based on ``XDF`` (``PDF``, ``IDF``, ``SDF``) and         |
1274 | Expansion        | additional deployment configuration determined during    |
1275 |                  | ``argument parsing`` stage described above, all jinja2   |
1276 |                  | templates are expanded, including:                       |
1277 |                  |                                                          |
1278 |                  | - various classes in ``reclass.cluster``;                |
1279 |                  | - docker-compose ``yaml`` for Salt Master bring-up;      |
1280 |                  | - ``libvirt`` network definitions (``xml``);             |
1281 +------------------+----------------------------------------------------------+
1282 | Jumpserver       | Basic validation that common ``jumpserver`` requirements |
1283 | Requirements     | are satisfied, e.g. ``PXE/admin`` is Linux bridge if     |
1284 | Check            | ``baremetal`` nodes are defined in the ``PDF``.          |
1285 +------------------+----------------------------------------------------------+
1286 | Infrastucture    | .. NOTE::                                                |
1287 | Setup            |                                                          |
1288 |                  |     All steps apply to and only to the ``jumpserver``.   |
1289 |                  |                                                          |
1290 |                  | - prepare virtual machines;                              |
1291 |                  | - (re)create ``libvirt`` managed networks;               |
1292 |                  | - apply ``sysctl`` configuration;                        |
1293 |                  | - apply ``udev`` configuration;                          |
1294 |                  | - create & start virtual machines prepared earlier;      |
1295 |                  | - create & start Salt Master (``cfg01``) Docker          |
1296 |                  |   container;                                             |
1297 +------------------+----------------------------------------------------------+
1298 | ``STATE``        | Based on deployment type, scenario and other parameters, |
1299 | Files            | a ``STATE`` file list is constructed, then executed      |
1300 |                  | sequentially.                                            |
1301 |                  |                                                          |
1302 |                  | .. TIP::                                                 |
1303 |                  |                                                          |
1304 |                  |     The table below lists all current ``STATE`` files    |
1305 |                  |     and their intended action.                           |
1306 |                  |                                                          |
1307 |                  | .. SEEALSO::                                             |
1308 |                  |                                                          |
1309 |                  |     For more information on how the list of ``STATE``    |
1310 |                  |     files is constructed, see                            |
1311 |                  |     :ref:`OPNFV Fuel User Guide <fuel-userguide>`.       |
1312 +------------------+----------------------------------------------------------+
1313 | Log              | Contents of ``/var/log`` are recursively gathered from   |
1314 | Collection       | all the nodes, then archived together for later          |
1315 |                  | inspection.                                              |
1316 +------------------+----------------------------------------------------------+
1317
1318 ``STATE`` Files Overview
1319 ------------------------
1320
1321 +---------------------------+-------------------------------------------------+
1322 | ``STATE`` file            | Targets involved and main intended action       |
1323 +===========================+=================================================+
1324 | ``virtual_init``          | ``cfg01``: reclass node generation              |
1325 |                           |                                                 |
1326 |                           | ``jumpserver`` VMs (e.g. ``mas01``): basic OS   |
1327 |                           | config                                          |
1328 +---------------------------+-------------------------------------------------+
1329 | ``maas``                  | ``mas01``: OS, MaaS installation,               |
1330 |                           | ``baremetal`` node commissioning and deploy     |
1331 |                           |                                                 |
1332 |                           | .. NOTE::                                       |
1333 |                           |                                                 |
1334 |                           |     Skipped if no ``baremetal`` nodes are       |
1335 |                           |     defined in ``PDF`` (``virtual`` deploy).    |
1336 +---------------------------+-------------------------------------------------+
1337 | ``baremetal_init``        | ``kvm``, ``cmp``: OS install, config            |
1338 +---------------------------+-------------------------------------------------+
1339 | ``dpdk``                  | ``cmp``: configure OVS-DPDK                     |
1340 +---------------------------+-------------------------------------------------+
1341 | ``networks``              | ``ctl``: create OpenStack networks              |
1342 +---------------------------+-------------------------------------------------+
1343 | ``neutron_gateway``       | ``gtw01``: configure Neutron gateway            |
1344 +---------------------------+-------------------------------------------------+
1345 | ``opendaylight``          | ``odl01``: install & configure ``ODL``          |
1346 +---------------------------+-------------------------------------------------+
1347 | ``openstack_noha``        | cluster nodes: install OpenStack without ``HA`` |
1348 +---------------------------+-------------------------------------------------+
1349 | ``openstack_ha``          | cluster nodes: install OpenStack with ``HA``    |
1350 +---------------------------+-------------------------------------------------+
1351 | ``virtual_control_plane`` | ``kvm``: create ``VCP`` VMs                     |
1352 |                           |                                                 |
1353 |                           | ``VCP`` VMs: basic OS config                    |
1354 |                           |                                                 |
1355 |                           | .. NOTE::                                       |
1356 |                           |                                                 |
1357 |                           |     Skipped if ``-N`` deploy argument is used.  |
1358 +---------------------------+-------------------------------------------------+
1359 | ``tacker``                | ``ctl``: install & configure Tacker             |
1360 +---------------------------+-------------------------------------------------+
1361
1362 Release Notes
1363 =============
1364
1365 Please refer to the :ref:`OPNFV Fuel Release Notes <fuel-releasenotes>`
1366 article.
1367
1368 References
1369 ==========
1370
1371 For more information on the OPNFV ``Gambia`` 7.0 release, please see:
1372
1373 #. `OPNFV Home Page`_
1374 #. `OPNFV Documentation`_
1375 #. `OPNFV Software Downloads`_
1376 #. `OPNFV Gambia Wiki Page`_
1377 #. `OpenStack Queens Release Artifacts`_
1378 #. `OpenStack Documentation`_
1379 #. `OpenDaylight Artifacts`_
1380 #. `Mirantis Cloud Platform Documentation`_
1381 #. `Saltstack Documentation`_
1382 #. `Saltstack Formulas`_
1383 #. `Reclass`_
1384
1385 .. FIXME: cleanup unused refs, extend above list
1386 .. _`OpenDaylight`: https://www.opendaylight.org/software
1387 .. _`OpenDaylight Artifacts`: https://www.opendaylight.org/software/downloads
1388 .. _`MCP`: https://www.mirantis.com/software/mcp/
1389 .. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
1390 .. _`fuel git repository`: https://git.opnfv.org/fuel
1391 .. _`pharos git repo`: https://git.opnfv.org/pharos
1392 .. _`OpenStack Documentation`: https://docs.openstack.org
1393 .. _`OpenStack Queens Release Artifacts`: https://www.openstack.org/software/queens
1394 .. _`OPNFV Home Page`: https://www.opnfv.org
1395 .. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/releases/Gambia
1396 .. _`OPNFV Documentation`: https://docs.opnfv.org
1397 .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/download
1398 .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
1399 .. _`Saltstack Documentation`: https://docs.saltstack.com/en/latest/topics/
1400 .. _`Saltstack Formulas`: https://salt-formulas.readthedocs.io/en/latest/
1401 .. _`Reclass`: https://reclass.pantsfullofunix.net
1402 .. _`OPNFV Pharos Specification`: https://wiki.opnfv.org/display/pharos/Pharos+Specification
1403 .. _`OPNFV PDF Wiki Page`: https://wiki.opnfv.org/display/INF/POD+Descriptor