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 Installation Instruction
7 ***********************************
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.
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.
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.
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
34 The audience of this document is assumed to have good knowledge of
35 networking and Unix/Linux administration.
37 Before starting the installation of the ``Gambia`` release of
38 OPNFV, using Fuel as a deployment tool, some planning must be
44 Prior to installation, a number of deployment specific parameters must be
47 #. Provider sub-net and gateway information
49 #. Provider ``VLAN`` information
51 #. Provider ``DNS`` addresses
53 #. Provider ``NTP`` addresses
55 #. How many nodes and what roles you want to deploy (Controllers, Computes)
57 This information will be needed for the configuration procedures
58 provided in this document.
63 Mininum hardware requirements depend on the deployment type.
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``).
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.
79 Hardware Requirements for ``virtual`` Deploys
80 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
82 The following minimum hardware requirements must be met for the ``virtual``
83 installation of ``Gambia`` using Fuel:
85 +------------------+------------------------------------------------------+
86 | **HW Aspect** | **Requirement** |
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 +------------------+------------------------------------------------------+
100 Hardware Requirements for ``baremetal`` Deploys
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103 The following minimum hardware requirements must be met for the ``baremetal``
104 installation of ``Gambia`` using Fuel:
106 +------------------+------------------------------------------------------+
107 | **HW Aspect** | **Requirement** |
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 |
115 | | - 3 KVM servers which will run all the controller |
118 | | - 2 Compute nodes |
122 | | ``kvm01``, ``kvm02``, ``kvm03`` nodes and the |
123 | | ``jumpserver`` must have the same architecture |
124 | | (either ``x86_64`` or ``aarch64``). |
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 |
140 | | - 3 VLANs (``public``, ``mgmt``, ``private``) - |
141 | | can be a mix of tagged/native |
143 | | - 1 Un-Tagged VLAN for PXE Boot - |
144 | | ``PXE/admin`` Network |
148 | | These can be allocated to a single NIC |
149 | | or spread out over multiple NICs. |
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 +------------------+------------------------------------------------------+
162 Hardware Requirements for ``hybrid`` (``baremetal`` + ``virtual``) Deploys
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
165 The following minimum hardware requirements must be met for the ``hybrid``
166 installation of ``Gambia`` using Fuel:
168 +------------------+------------------------------------------------------+
169 | **HW Aspect** | **Requirement** |
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:: |
178 | | Depends on ``PDF`` configuration. |
180 | | If the control plane is virtualized, minimum |
181 | | baremetal requirements are: |
183 | | - 2 Compute nodes |
185 | | If the computes are virtualized, minimum |
186 | | baremetal requirements are: |
188 | | - 3 KVM servers which will run all the controller |
193 | | ``kvm01``, ``kvm02``, ``kvm03`` nodes and the |
194 | | ``jumpserver`` must have the same architecture |
195 | | (either ``x86_64`` or ``aarch64``). |
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 +------------------+------------------------------------------------------+
214 Help with Hardware Requirements
215 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
217 Calculate hardware requirements:
219 When choosing the hardware on which you will deploy your OpenStack
220 environment, you should think about:
222 - CPU -- Consider the number of virtual machines that you plan to deploy in
223 your cloud environment and the CPUs per virtual machine.
225 - Memory -- Depends on the amount of RAM assigned per virtual machine and the
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.
231 - Networking -- Depends on the Choose Network Topology, the network bandwidth
232 per virtual machine, and network storage.
234 Top of the Rack (``TOR``) Configuration Requirements
235 ====================================================
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).
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.
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.
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.
258 Manual configuration of the ``Gambia`` hardware platform should
259 be carried out according to the `OPNFV Pharos Specification`_.
261 OPNFV Software Prerequisites
262 ============================
266 All prerequisites described in this chapter apply to the ``jumpserver``
269 OS Distribution Support
270 ~~~~~~~~~~~~~~~~~~~~~~~
272 The Jumpserver node should be pre-provisioned with an operating system,
273 according to the `OPNFV Pharos specification`_.
275 OPNFV Fuel has been validated by CI using the following distributions
276 installed on the Jumpserver:
278 - ``CentOS 7`` (recommended by Pharos specification);
279 - ``Ubuntu Xenial 16.04``;
281 .. TOPIC:: ``aarch64`` notes
283 For an ``aarch64`` Jumpserver, the ``libvirt`` minimum required
284 version is ``3.x``, ``3.5`` or newer highly recommended.
288 ``CentOS 7`` (``aarch64``) distro provided packages are already new
293 ``Ubuntu 16.04`` (``arm64``), distro packages are too old and 3rd party
294 repositories should be used.
296 For convenience, Armband provides a DEB repository holding all the
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:
303 .. code-block:: console
305 jenkins@jumpserver:~$ cat /etc/apt/sources.list.d/armband.list
306 deb http://linux.enea.com/mcp-repos/queens/xenial queens-armband main
308 jenkins@jumpserver:~$ sudo apt-key adv --keyserver keys.gnupg.net \
310 jenkins@jumpserver:~$ sudo apt-get update
312 OS Distribution Packages
313 ~~~~~~~~~~~~~~~~~~~~~~~~
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.
319 This includes Python, QEMU, libvirt etc.
323 To disable automatic package installation (and/or upgrade) during
324 deployment, check out the ``-P`` deploy argument.
328 The install script expects ``libvirt`` to be already running on the
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.
335 Therefore, it is recommended to install ``libvirt`` explicitly on the
336 Jumpserver before the deployment.
338 While not mandatory, upgrading the kernel on the Jumpserver is also highly
341 .. code-block:: console
343 jenkins@jumpserver:~$ sudo apt-get install \
344 linux-image-generic-hwe-16.04-edge libvirt-bin
345 jenkins@jumpserver:~$ sudo reboot
350 The user running the deploy script on the Jumpserver should belong to
351 ``sudo`` and ``libvirt`` groups, and have passwordless sudo access.
355 Throughout this documentation, we will use the ``jenkins`` username for
358 The following example adds the groups to the user ``jenkins``:
360 .. code-block:: console
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
368 jenkins@jumpserver:~$ sudo visudo
370 %jenkins ALL=(ALL) NOPASSWD:ALL
372 Local Artifact Storage
373 ~~~~~~~~~~~~~~~~~~~~~~
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
379 .. code-block:: console
381 jenkins@jumpserver:~$ mkdir -p -m 777 /home/jenkins/tmpdir
383 Network Configuration
384 ~~~~~~~~~~~~~~~~~~~~~
386 Relevant Linux bridges should also be pre-configured for certain networks,
387 depending on the type of the deployment.
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 +------------+---------------+--------------+---------------+---------------+
412 IP addresses should be assigned to the created bridge interfaces (not
413 to one of its ports).
417 ``PXE/admin`` bridge (``admin_br``) **must** have an IP address.
419 Changes ``deploy.sh`` Will Perform to Jumpserver OS
420 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
424 The install script will alter Jumpserver sysconf and disable
425 ``net.bridge.bridge-nf-call``.
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).
433 OPNFV Software Configuration (``XDF``)
434 ======================================
436 .. versionadded:: 5.0.0
437 .. versionchanged:: 7.0.0
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
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;
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``.
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.
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`` |
478 +----------+------------------------+--------------------+--------------------+
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.
487 - ``mcp/scripts/pharos/config/pdf/pod1.schema.yaml``
488 - ``mcp/scripts/pharos/config/pdf/idf-pod1.schema.yaml``
490 Schema files are also used during the initial deployment phase to validate
491 the user-supplied input ``PDF``/``IDF`` files.
496 The Pod Descriptor File is a hardware description of the POD
497 infrastructure. The information is modeled under a ``yaml`` structure.
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
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,
511 A reference file with the expected ``yaml`` structure is available at:
513 - ``mcp/scripts/pharos/config/pdf/pod1.yaml``
515 For more information on ``PDF``, see the `OPNFV PDF Wiki Page`_.
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
523 For more details on the way IP addresses are assigned, see
524 :ref:`OPNFV Fuel User Guide <fuel-userguide>`.
526 ``PDF``/``IDF`` Role (hostname) Mapping
527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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).
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 +-------------+------------------+----------------------+
551 To switch node role(s), simply reorder the node definitions in
552 ``PDF``/``IDF`` (make sure to keep them in sync).
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.
564 The ``IDF`` file must be named after the ``PDF`` it attaches to, with the
569 A reference file with the expected ``yaml`` structure is available at:
571 - ``mcp/scripts/pharos/config/pdf/idf-pod1.yaml``
573 The file follows a ``yaml`` structure and at least two sections
574 (``idf.net_config`` and ``idf.fuel``) are expected.
576 The ``idf.fuel`` section defines several sub-sections required by the OPNFV
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;
592 version: 0.1 # fixed, the only supported version (mandatory)
593 net_config: # POD network configuration overview (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 interface_mtu: 1500 # Cluster-level MTU (optional)
613 ntp_strata_host1: 1.pool.ntp.org # NTP1 (optional)
614 ntp_strata_host2: 0.pool.ntp.org # NTP2 (optional)
615 node: ... # List of per-node cfg (mandatory)
616 reclass: # Additional params (mandatory)
617 node: ... # List of per-node cfg (mandatory)
622 ``idf.net_config`` was introduced as a mechanism to map all the usual cluster
623 networks (internal and provider networks, e.g. ``mgmt``) to their ``VLAN``
624 tags, ``CIDR`` and a physical interface index (used to match networks to
625 interface names, like ``eth0``, on the cluster nodes).
630 The mapping between one network segment (e.g. ``mgmt``) and its ``CIDR``/
631 ``VLAN`` is not configurable on a per-node basis, but instead applies to
632 all the nodes in the cluster.
634 For each network, the following parameters are currently supported:
636 +--------------------------+--------------------------------------------------+
637 | ``idf.net_config.*`` key | Details |
638 +==========================+==================================================+
639 | ``interface`` | The index of the interface to use for this net. |
640 | | For each cluster node (if network is present), |
641 | | OPNFV Fuel will determine the underlying physical|
642 | | interface by picking the element at index |
643 | | ``interface`` from the list of network interface |
644 | | names defined in |
645 | | ``idf.fuel.network.node.*.interfaces``. |
646 | | Required for each network. |
650 | | The interface index should be the |
651 | | same on all cluster nodes. This can be |
652 | | achieved by ordering them accordingly in |
653 | | ``PDF``/``IDF``. |
654 +--------------------------+--------------------------------------------------+
655 | ``vlan`` | ``VLAN`` tag (integer) or the string ``native``. |
656 | | Required for each network. |
657 +--------------------------+--------------------------------------------------+
658 | ``ip-range`` | When specified, all cluster IPs dynamically |
659 | | allocated by OPNFV Fuel for that network will be |
660 | | assigned inside this range. |
661 | | Required for ``oob``, optional for others. |
665 | | For now, only range start address is used. |
666 +--------------------------+--------------------------------------------------+
667 | ``network`` | Network segment address. |
668 | | Required for each network, except ``oob``. |
669 +--------------------------+--------------------------------------------------+
670 | ``mask`` | Network segment mask. |
671 | | Required for each network, except ``oob``. |
672 +--------------------------+--------------------------------------------------+
673 | ``gateway`` | Gateway IP address. |
674 | | Required for ``public``, N/A for others. |
675 +--------------------------+--------------------------------------------------+
676 | ``dns`` | List of DNS IP addresses. |
677 | | Required for ``public``, N/A for others. |
678 +--------------------------+--------------------------------------------------+
680 Sample ``public`` network configuration block:
690 ip-range: 10.0.16.100-10.0.16.253
697 .. TOPIC:: ``hybrid`` POD notes
699 Interface indexes must be the same for all nodes, which is problematic
700 when mixing ``virtual`` nodes (where all interfaces were untagged
701 so far) with ``baremetal`` nodes (where interfaces usually carry
706 To achieve this, a special ``jumpserver`` network layout is used:
707 ``mgmt``, ``storage``, ``private``, ``public`` are trunked together
708 in a single ``trunk`` bridge:
710 - without decapsulating them (if they are also tagged on ``baremetal``);
711 a ``trunk.<vlan_tag>`` interface should be created on the
712 ``jumpserver`` for each tagged VLAN so the kernel won't drop the
714 - by decapsulating them first (if they are also untagged on
715 ``baremetal`` nodes);
717 The ``trunk`` bridge is then used for all bridges OPNFV Fuel
718 is aware of in ``idf.fuel.jumphost.bridges``, e.g. for a ``trunk`` where
719 only ``mgmt`` network is not decapsulated:
732 # mgmt network is not decapsulated for jumpserver infra VMs,
733 # to align with the VLAN configuration of baremetal nodes.
738 The Linux kernel limits the name of network interfaces to 16 characters.
739 Extra care is required when choosing bridge names, so appending the
740 ``VLAN`` tag won't lead to an interface name length exceeding that limit.
745 ``idf.fuel.network`` allows mapping the cluster networks (e.g. ``mgmt``) to
746 their physical interface name (e.g. ``eth0``) and bus address on the cluster
749 ``idf.fuel.network.node`` should be a list with the same number (and order) of
750 elements as the cluster nodes defined in ``PDF``, e.g. the second cluster node
751 in ``PDF`` will use the interface name and bus address defined in the second
754 Below is a sample configuration block for a single node with two interfaces:
762 # Ordered-list, index should be in sync with node index in PDF
764 # Ordered-list, index should be in sync with interface index
769 # Bus-info reported by `ethtool -i ethX`
777 ``idf.fuel.reclass`` provides a way of overriding default values in the
778 reclass cluster model.
780 This currently covers strictly compute parameter tuning, including huge
781 pages, ``CPU`` pinning and other ``DPDK`` settings.
783 ``idf.fuel.reclass.node`` should be a list with the same number (and order) of
784 elements as the cluster nodes defined in ``PDF``, e.g. the second cluster node
785 in ``PDF`` will use the parameters defined in the second list element.
787 The following parameters are currently supported:
789 +---------------------------------+-------------------------------------------+
790 | ``idf.fuel.reclass.node.*`` | Details |
792 +=================================+===========================================+
793 | ``nova_cpu_pinning`` | List of CPU cores nova will be pinned to. |
797 | | Currently disabled. |
798 +---------------------------------+-------------------------------------------+
799 | ``compute_hugepages_size`` | Size of each persistent huge pages. |
801 | | Usual values are ``2M`` and ``1G``. |
802 +---------------------------------+-------------------------------------------+
803 | ``compute_hugepages_count`` | Total number of persistent huge pages. |
804 +---------------------------------+-------------------------------------------+
805 | ``compute_hugepages_mount`` | Mount point to use for huge pages. |
806 +---------------------------------+-------------------------------------------+
807 | ``compute_kernel_isolcpu`` | List of certain CPU cores that are |
808 | | isolated from Linux scheduler. |
809 +---------------------------------+-------------------------------------------+
810 | ``compute_dpdk_driver`` | Kernel module to provide userspace I/O |
812 +---------------------------------+-------------------------------------------+
813 | ``compute_ovs_pmd_cpu_mask`` | Hexadecimal mask of CPUs to run ``DPDK`` |
814 | | Poll-mode drivers. |
815 +---------------------------------+-------------------------------------------+
816 | ``compute_ovs_dpdk_socket_mem`` | Set of amount huge pages in ``MB`` to be |
817 | | used by ``OVS-DPDK`` daemon taken for each|
818 | | ``NUMA`` node. Set size is equal to |
819 | | ``NUMA`` nodes count, elements are |
820 | | divided by comma. |
821 +---------------------------------+-------------------------------------------+
822 | ``compute_ovs_dpdk_lcore_mask`` | Hexadecimal mask of ``DPDK`` lcore |
823 | | parameter used to run ``DPDK`` processes. |
824 +---------------------------------+-------------------------------------------+
825 | ``compute_ovs_memory_channels`` | Number of memory channels to be used. |
826 +---------------------------------+-------------------------------------------+
827 | ``dpdk0_driver`` | NIC driver to use for physical network |
829 +---------------------------------+-------------------------------------------+
830 | ``dpdk0_n_rxq`` | Number of ``RX`` queues. |
831 +---------------------------------+-------------------------------------------+
833 Sample ``compute_params`` configuration block (for a single node):
842 common: &compute_params_common
843 compute_hugepages_size: 2M
844 compute_hugepages_count: 2048
845 compute_hugepages_mount: /mnt/hugepages_2M
847 <<: *compute_params_common
848 compute_dpdk_driver: uio
849 compute_ovs_pmd_cpu_mask: "0x6"
850 compute_ovs_dpdk_socket_mem: "1024"
851 compute_ovs_dpdk_lcore_mask: "0x8"
852 compute_ovs_memory_channels: "2"
853 dpdk0_driver: igb_uio
859 Scenario Descriptor Files are not yet implemented in the OPNFV Fuel ``Gambia``
862 Instead, embedded OPNFV Fuel scenarios files are locally available in
863 ``mcp/config/scenario``.
865 OPNFV Software Installation and Deployment
866 ==========================================
868 This section describes the process of installing all the components needed to
869 deploy the full OPNFV reference platform stack across a server cluster.
876 OPNFV releases previous to ``Gambia`` used to rely on the ``virtual``
877 keyword being part of the POD name (e.g. ``ericsson-virtual2``) to
878 configure the deployment type as ``virtual``. Otherwise ``baremetal``
881 ``Gambia`` and newer releases are more flexbile towards supporting a mix
882 of ``baremetal`` and ``virtual`` nodes, so the type of deployment is
883 now automatically determined based on the cluster nodes types in ``PDF``:
885 +---------------------------------+-------------------------------------------+
886 | ``PDF`` has nodes of type | Deployment type |
887 +---------------+-----------------+ |
888 | ``baremetal`` | ``virtual`` | |
889 +===============+=================+===========================================+
890 | yes | no | ``baremetal`` |
891 +---------------+-----------------+-------------------------------------------+
892 | yes | yes | ``hybrid`` |
893 +---------------+-----------------+-------------------------------------------+
894 | no | yes | ``virtual`` |
895 +---------------+-----------------+-------------------------------------------+
897 Based on that, the deployment script will later enable/disable certain extra
898 nodes (e.g. ``mas01``) and/or ``STATE`` files (e.g. ``maas``).
903 High availability of OpenStack services is determined based on scenario name,
904 e.g. ``os-nosdn-nofeature-noha`` vs ``os-nosdn-nofeature-ha``.
908 ``HA`` scenarios imply a virtualized control plane (``VCP``) for the
909 OpenStack services running on the 3 ``kvm`` nodes.
913 An experimental feature argument (``-N``) is supported by the deploy
914 script for disabling ``VCP``, although it might not be supported by
915 all scenarios and is not being continuosly validated by OPNFV CI/CD.
919 ``virtual`` ``HA`` deployments are not officially supported, due to
920 poor performance and various limitations of nested virtualization on
921 both ``x86_64`` and ``aarch64`` architectures.
925 ``virtual`` ``HA`` deployments without ``VCP`` are supported, but
928 +-------------------------------+-------------------------+-------------------+
929 | Feature | ``HA`` scenario | ``noHA`` scenario |
930 +===============================+=========================+===================+
931 | ``VCP`` | yes, | no |
932 | (Virtualized Control Plane) | disabled with ``-N`` | |
933 +-------------------------------+-------------------------+-------------------+
934 | OpenStack APIs SSL | yes | no |
935 +-------------------------------+-------------------------+-------------------+
936 | Storage | ``GlusterFS`` | ``NFS`` |
937 +-------------------------------+-------------------------+-------------------+
939 Steps to Start the Automatic Deploy
940 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
942 These steps are common for ``virtual``, ``baremetal`` or ``hybrid`` deploys,
943 ``x86_64``, ``aarch64`` or ``mixed`` (``x86_64`` and ``aarch64``):
945 - Clone the OPNFV Fuel code from gerrit
946 - Checkout the ``Gambia`` release tag
947 - Start the deploy script
951 The deployment uses the OPNFV Pharos project as input (``PDF`` and
952 ``IDF`` files) for hardware and network configuration of all current
955 When deploying a new POD, one may pass the ``-b`` flag to the deploy
956 script to override the path for the labconfig directory structure
957 containing the ``PDF`` and ``IDF`` (``<URI to configuration repo ...>`` is
958 the absolute path to a local or remote directory structure, populated
959 similar to `pharos git repo`_, i.e. ``PDF``/``IDF`` reside in a
960 subdirectory called ``labs/<lab_name>``).
962 .. code-block:: console
964 jenkins@jumpserver:~$ git clone https://git.opnfv.org/fuel
965 jenkins@jumpserver:~$ cd fuel
966 jenkins@jumpserver:~/fuel$ git checkout opnfv-7.2.0
967 jenkins@jumpserver:~/fuel$ ci/deploy.sh -l <lab_name> \
969 -b <URI to configuration repo containing the PDF/IDF files> \
972 -S <Storage directory for deploy artifacts> |& tee deploy.log
976 Besides the basic options, there are other recommended deploy arguments:
978 - use ``-D`` option to enable the debug info
979 - use ``-S`` option to point to a tmp dir where the disk images are saved.
980 The deploy artifacts will be re-used on subsequent (re)deployments.
981 - use ``|& tee`` to save the deploy log to a file
983 Typical Cluster Examples
984 ~~~~~~~~~~~~~~~~~~~~~~~~
986 Common cluster layouts usually fall into one of the cases described below,
987 categorized by deployment type (``baremetal``, ``virtual`` or ``hybrid``) and
988 high availability (``HA`` or ``noHA``).
990 A simplified overview of the steps ``deploy.sh`` will automatically perform is:
992 - create a Salt Master Docker container on the jumpserver, which will drive
993 the rest of the installation;
994 - ``baremetal`` or ``hybrid`` only: create a ``MaaS`` infrastructure node VM,
995 which will be leveraged using Salt to handle OS provisioning on the
997 - leverage Salt to install & configure OpenStack;
1001 A virtual network ``mcpcontrol`` is always created for initial connection
1002 of the VMs on Jumphost.
1006 A single cluster deployment per ``jumpserver`` node is currently supported,
1007 indifferent of its type (``virtual``, ``baremetal`` or ``hybrid``).
1009 Once the deployment is complete, the following should be accessible:
1011 +---------------+----------------------------------+---------------------------+
1012 | Resource | ``HA`` scenario | ``noHA`` scenario |
1013 +===============+==================================+===========================+
1014 | ``Horizon`` | ``https://<prx public VIP>`` | ``http://<ctl VIP>:8078`` |
1017 +---------------+----------------------------------+---------------------------+
1018 | ``SaltStack`` | ``http://<prx public VIP>:8090`` | N/A |
1020 | Documentation | | |
1021 +---------------+----------------------------------+---------------------------+
1025 For more details on locating and importing the generated SSL certificate,
1026 see :ref:`OPNFV Fuel User Guide <fuel-userguide>`.
1028 ``virtual`` ``noHA`` POD
1029 ------------------------
1031 In the following figure there are two generic examples of ``virtual`` deploys,
1032 each on a separate Jumphost node, both behind the same ``TOR`` switch:
1034 - Jumphost 1 has only virsh bridges (created by the deploy script);
1035 - Jumphost 2 has a mix of Linux (manually created) and ``libvirt`` managed
1036 bridges (created by the deploy script);
1038 .. figure:: img/fuel_virtual_noha.png
1041 :alt: OPNFV Fuel Virtual noHA POD Network Layout Examples
1043 OPNFV Fuel Virtual noHA POD Network Layout Examples
1045 +-------------+------------------------------------------------------------+
1046 | ``cfg01`` | Salt Master Docker container |
1047 +-------------+------------------------------------------------------------+
1048 | ``ctl01`` | Controller VM |
1049 +-------------+------------------------------------------------------------+
1050 | ``gtw01`` | Gateway VM with neutron services |
1051 | | (``DHCP`` agent, ``L3`` agent, ``metadata`` agent etc) |
1052 +-------------+------------------------------------------------------------+
1053 | ``odl01`` | VM on which ``ODL`` runs |
1054 | | (for scenarios deployed with ODL) |
1055 +-------------+------------------------------------------------------------+
1056 | ``cmp001``, | Compute VMs |
1058 +-------------+------------------------------------------------------------+
1062 If external access to the ``public`` network is not required, there is
1063 little to no motivation to create a custom ``PDF``/``IDF`` set for a
1066 Instead, the existing virtual PODs definitions in `pharos git repo`_ can
1069 - ``ericsson-virtual1`` for ``x86_64``;
1070 - ``arm-virtual2`` for ``aarch64``;
1072 .. code-block:: console
1074 # example deploy cmd for an x86_64 virtual cluster
1075 jenkins@jumpserver:~/fuel$ ci/deploy.sh -l ericsson \
1077 -s os-nosdn-nofeature-noha \
1079 -S /home/jenkins/tmpdir |& tee deploy.log
1081 ``baremetal`` ``noHA`` POD
1082 --------------------------
1086 These scenarios are not tested in OPNFV CI, so they are considered
1089 .. figure:: img/fuel_baremetal_noha.png
1092 :alt: OPNFV Fuel Baremetal noHA POD Network Layout Example
1094 OPNFV Fuel Baremetal noHA POD Network Layout Example
1096 +-------------+------------------------------------------------------------+
1097 | ``cfg01`` | Salt Master Docker container |
1098 +-------------+------------------------------------------------------------+
1099 | ``mas01`` | MaaS Node VM |
1100 +-------------+------------------------------------------------------------+
1101 | ``ctl01`` | Baremetal controller node |
1102 +-------------+------------------------------------------------------------+
1103 | ``gtw01`` | Baremetal Gateway with neutron services |
1104 | | (dhcp agent, L3 agent, metadata, etc) |
1105 +-------------+------------------------------------------------------------+
1106 | ``odl01`` | Baremetal node on which ODL runs |
1107 | | (for scenarios deployed with ODL, otherwise unused |
1108 +-------------+------------------------------------------------------------+
1109 | ``cmp001``, | Baremetal Computes |
1111 +-------------+------------------------------------------------------------+
1112 | Tenant VM | VM running in the cloud |
1113 +-------------+------------------------------------------------------------+
1115 ``baremetal`` ``HA`` POD
1116 ------------------------
1118 .. figure:: img/fuel_baremetal_ha.png
1121 :alt: OPNFV Fuel Baremetal HA POD Network Layout Example
1123 OPNFV Fuel Baremetal HA POD Network Layout Example
1125 +---------------------------+----------------------------------------------+
1126 | ``cfg01`` | Salt Master Docker container |
1127 +---------------------------+----------------------------------------------+
1128 | ``mas01`` | MaaS Node VM |
1129 +---------------------------+----------------------------------------------+
1130 | ``kvm01``, | Baremetals which hold the VMs with |
1131 | ``kvm02``, | controller functions |
1133 +---------------------------+----------------------------------------------+
1134 | ``prx01``, | Proxy VMs for Nginx |
1136 +---------------------------+----------------------------------------------+
1137 | ``msg01``, | RabbitMQ Service VMs |
1140 +---------------------------+----------------------------------------------+
1141 | ``dbs01``, | MySQL service VMs |
1144 +---------------------------+----------------------------------------------+
1145 | ``mdb01``, | Telemetry VMs |
1148 +---------------------------+----------------------------------------------+
1149 | ``odl01`` | VM on which ``OpenDaylight`` runs |
1150 | | (for scenarios deployed with ``ODL``) |
1151 +---------------------------+----------------------------------------------+
1152 | ``cmp001``, | Baremetal Computes |
1154 +---------------------------+----------------------------------------------+
1155 | Tenant VM | VM running in the cloud |
1156 +---------------------------+----------------------------------------------+
1158 .. code-block:: console
1160 # x86_x64 baremetal deploy on pod2 from Linux Foundation lab (lf-pod2)
1161 jenkins@jumpserver:~/fuel$ ci/deploy.sh -l lf \
1163 -s os-nosdn-nofeature-ha \
1165 -S /home/jenkins/tmpdir |& tee deploy.log
1167 .. code-block:: console
1169 # aarch64 baremetal deploy on pod5 from Enea ARM lab (arm-pod5)
1170 jenkins@jumpserver:~/fuel$ ci/deploy.sh -l arm \
1172 -s os-nosdn-nofeature-ha \
1174 -S /home/jenkins/tmpdir |& tee deploy.log
1176 ``hybrid`` ``noHA`` POD
1177 -----------------------
1179 .. figure:: img/fuel_hybrid_noha.png
1182 :alt: OPNFV Fuel Hybrid noHA POD Network Layout Examples
1184 OPNFV Fuel Hybrid noHA POD Network Layout Examples
1186 +-------------+------------------------------------------------------------+
1187 | ``cfg01`` | Salt Master Docker container |
1188 +-------------+------------------------------------------------------------+
1189 | ``mas01`` | MaaS Node VM |
1190 +-------------+------------------------------------------------------------+
1191 | ``ctl01`` | Controller VM |
1192 +-------------+------------------------------------------------------------+
1193 | ``gtw01`` | Gateway VM with neutron services |
1194 | | (``DHCP`` agent, ``L3`` agent, ``metadata`` agent etc) |
1195 +-------------+------------------------------------------------------------+
1196 | ``odl01`` | VM on which ``ODL`` runs |
1197 | | (for scenarios deployed with ODL) |
1198 +-------------+------------------------------------------------------------+
1199 | ``cmp001``, | Baremetal Computes |
1201 +-------------+------------------------------------------------------------+
1203 Automatic Deploy Breakdown
1204 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1206 When an automatic deploy is started, the following operations are performed
1207 sequentially by the deploy script:
1209 +------------------+----------------------------------------------------------+
1210 | **Deploy stage** | **Details** |
1211 +==================+==========================================================+
1212 | Argument | enviroment variables and command line arguments passed |
1213 | Parsing | to ``deploy.sh`` are interpreted |
1214 +------------------+----------------------------------------------------------+
1215 | Distribution | Install and/or configure mandatory requirements on the |
1216 | Package | ``jumpserver`` node: |
1218 | | - ``Docker`` (from upstream and not distribution repos, |
1219 | | as the version included in ``Ubuntu`` ``Xenial`` is |
1221 | | - ``docker-compose`` (from upstream, as the version |
1222 | | included in both ``CentOS 7`` and |
1223 | | ``Ubuntu Xenial 16.04`` has dependency issues on most |
1225 | | - ``virt-inst`` (from upstream, as the version included |
1226 | | in ``Ubuntu Xenial 16.04`` is outdated and lacks |
1227 | | certain required features); |
1228 | | - other miscelaneous requirements, depending on |
1229 | | ``jumpserver`` distribution OS; |
1233 | | - ``mcp/scripts/requirements_deb.yaml`` (``Ubuntu``) |
1234 | | - ``mcp/scripts/requirements_rpm.yaml`` (``CentOS``) |
1238 | | Mininum required ``Docker`` version is ``17.x``. |
1242 | | Mininum required ``virt-inst`` version is ``1.4``. |
1243 +------------------+----------------------------------------------------------+
1244 | Patch | For each ``git`` submodule in OPNFV Fuel repository, |
1245 | Apply | if a subdirectory with the same name exists under |
1246 | | ``mcp/patches``, all patches in that subdirectory are |
1247 | | applied using ``git-am`` to the respective ``git`` |
1250 | | This allows OPNFV Fuel to alter upstream repositories |
1251 | | contents before consuming them, including: |
1253 | | - ``Docker`` container build process customization; |
1254 | | - ``salt-formulas`` customization; |
1255 | | - ``reclass.system`` customization; |
1259 | | - ``mcp/patches/README.rst`` |
1260 +------------------+----------------------------------------------------------+
1261 | SSH RSA Keypair | If not already present, a RSA keypair is generated on |
1262 | Generation | the ``jumpserver`` node at: |
1264 | | - ``/var/lib/opnfv/mcp.rsa{,.pub}`` |
1266 | | The public key will be added to the ``authorized_keys`` |
1267 | | list for ``ubuntu`` user, so the private key can be used |
1268 | | for key-based logins on: |
1270 | | - ``cfg01``, ``mas01`` infrastructure nodes; |
1271 | | - all cluster nodes (``baremetal`` and/or ``virtual``), |
1272 | | including ``VCP`` VMs; |
1273 +------------------+----------------------------------------------------------+
1274 | ``j2`` | Based on ``XDF`` (``PDF``, ``IDF``, ``SDF``) and |
1275 | Expansion | additional deployment configuration determined during |
1276 | | ``argument parsing`` stage described above, all jinja2 |
1277 | | templates are expanded, including: |
1279 | | - various classes in ``reclass.cluster``; |
1280 | | - docker-compose ``yaml`` for Salt Master bring-up; |
1281 | | - ``libvirt`` network definitions (``xml``); |
1282 +------------------+----------------------------------------------------------+
1283 | Jumpserver | Basic validation that common ``jumpserver`` requirements |
1284 | Requirements | are satisfied, e.g. ``PXE/admin`` is Linux bridge if |
1285 | Check | ``baremetal`` nodes are defined in the ``PDF``. |
1286 +------------------+----------------------------------------------------------+
1287 | Infrastucture | .. NOTE:: |
1289 | | All steps apply to and only to the ``jumpserver``. |
1291 | | - prepare virtual machines; |
1292 | | - (re)create ``libvirt`` managed networks; |
1293 | | - apply ``sysctl`` configuration; |
1294 | | - apply ``udev`` configuration; |
1295 | | - create & start virtual machines prepared earlier; |
1296 | | - create & start Salt Master (``cfg01``) Docker |
1298 +------------------+----------------------------------------------------------+
1299 | ``STATE`` | Based on deployment type, scenario and other parameters, |
1300 | Files | a ``STATE`` file list is constructed, then executed |
1305 | | The table below lists all current ``STATE`` files |
1306 | | and their intended action. |
1310 | | For more information on how the list of ``STATE`` |
1311 | | files is constructed, see |
1312 | | :ref:`OPNFV Fuel User Guide <fuel-userguide>`. |
1313 +------------------+----------------------------------------------------------+
1314 | Log | Contents of ``/var/log`` are recursively gathered from |
1315 | Collection | all the nodes, then archived together for later |
1317 +------------------+----------------------------------------------------------+
1319 ``STATE`` Files Overview
1320 ------------------------
1322 +---------------------------+-------------------------------------------------+
1323 | ``STATE`` file | Targets involved and main intended action |
1324 +===========================+=================================================+
1325 | ``virtual_init`` | ``cfg01``: reclass node generation |
1327 | | ``jumpserver`` VMs (e.g. ``mas01``): basic OS |
1329 +---------------------------+-------------------------------------------------+
1330 | ``maas`` | ``mas01``: OS, MaaS installation, |
1331 | | ``baremetal`` node commissioning and deploy |
1335 | | Skipped if no ``baremetal`` nodes are |
1336 | | defined in ``PDF`` (``virtual`` deploy). |
1337 +---------------------------+-------------------------------------------------+
1338 | ``baremetal_init`` | ``kvm``, ``cmp``: OS install, config |
1339 +---------------------------+-------------------------------------------------+
1340 | ``dpdk`` | ``cmp``: configure OVS-DPDK |
1341 +---------------------------+-------------------------------------------------+
1342 | ``networks`` | ``ctl``: create OpenStack networks |
1343 +---------------------------+-------------------------------------------------+
1344 | ``neutron_gateway`` | ``gtw01``: configure Neutron gateway |
1345 +---------------------------+-------------------------------------------------+
1346 | ``opendaylight`` | ``odl01``: install & configure ``ODL`` |
1347 +---------------------------+-------------------------------------------------+
1348 | ``openstack_noha`` | cluster nodes: install OpenStack without ``HA`` |
1349 +---------------------------+-------------------------------------------------+
1350 | ``openstack_ha`` | cluster nodes: install OpenStack with ``HA`` |
1351 +---------------------------+-------------------------------------------------+
1352 | ``virtual_control_plane`` | ``kvm``: create ``VCP`` VMs |
1354 | | ``VCP`` VMs: basic OS config |
1358 | | Skipped if ``-N`` deploy argument is used. |
1359 +---------------------------+-------------------------------------------------+
1360 | ``tacker`` | ``ctl``: install & configure Tacker |
1361 +---------------------------+-------------------------------------------------+
1366 Please refer to the :ref:`OPNFV Fuel Release Notes <fuel-releasenotes>`
1372 For more information on the OPNFV ``Gambia`` 7.2 release, please see:
1374 #. `OPNFV Home Page`_
1375 #. `OPNFV Documentation`_
1376 #. `OPNFV Software Downloads`_
1377 #. `OPNFV Gambia Wiki Page`_
1378 #. `OpenStack Queens Release Artifacts`_
1379 #. `OpenStack Documentation`_
1380 #. `OpenDaylight Artifacts`_
1381 #. `Mirantis Cloud Platform Documentation`_
1382 #. `Saltstack Documentation`_
1383 #. `Saltstack Formulas`_
1386 .. FIXME: cleanup unused refs, extend above list
1387 .. _`OpenDaylight`: https://www.opendaylight.org
1388 .. _`OpenDaylight Artifacts`: https://www.opendaylight.org/software/downloads
1389 .. _`MCP`: https://www.mirantis.com/software/mcp/
1390 .. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
1391 .. _`fuel git repository`: https://git.opnfv.org/fuel
1392 .. _`pharos git repo`: https://git.opnfv.org/pharos
1393 .. _`OpenStack Documentation`: https://docs.openstack.org/queens
1394 .. _`OpenStack Queens Release Artifacts`: https://www.openstack.org/software/queens
1395 .. _`OPNFV Home Page`: https://www.opnfv.org
1396 .. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/display/SWREL/Gambia
1397 .. _`OPNFV Documentation`: https://docs.opnfv.org
1398 .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads
1399 .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
1400 .. _`Saltstack Documentation`: https://docs.saltstack.com/en/latest/topics/
1401 .. _`Saltstack Formulas`: https://salt-formulas.readthedocs.io/en/latest/
1402 .. _`Reclass`: https://reclass.pantsfullofunix.net
1403 .. _`OPNFV Pharos Specification`: https://wiki.opnfv.org/display/pharos/Pharos+Specification
1404 .. _`OPNFV PDF Wiki Page`: https://wiki.opnfv.org/display/INF/POD+Descriptor
Code Review / fuel.git / blob