Abstract
========
-This document describes how to install the ``Gambia`` release of
+This document describes how to install the ``Hunter`` release of
OPNFV when using Fuel as a deployment tool, covering its usage,
limitations, dependencies and required system resources.
============
This document provides guidelines on how to install and
-configure the ``Gambia`` release of OPNFV when using Fuel as a
+configure the ``Hunter`` release of OPNFV when using Fuel as a
deployment tool, including required software and hardware configurations.
Although the available installation options provide a high degree of
freedom in how the system is set up, including architecture, services
and features, etc., said permutations may not provide an OPNFV
compliant reference architecture. This document provides a
-step-by-step guide that results in an OPNFV ``Gambia`` compliant
+step-by-step guide that results in an OPNFV ``Hunter`` compliant
deployment.
The audience of this document is assumed to have good knowledge of
networking and Unix/Linux administration.
-Before starting the installation of the ``Gambia`` release of
+Before starting the installation of the ``Hunter`` release of
OPNFV, using Fuel as a deployment tool, some planning must be
done.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following minimum hardware requirements must be met for the ``virtual``
-installation of ``Gambia`` using Fuel:
+installation of ``Hunter`` using Fuel:
+------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following minimum hardware requirements must be met for the ``baremetal``
-installation of ``Gambia`` using Fuel:
+installation of ``Hunter`` using Fuel:
+------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
+==================+======================================================+
| **1 Jumpserver** | A physical node (also called Foundation Node) that |
-| | hosts the Salt Master container and MaaS VM |
+| | hosts the Salt Master and MaaS containers |
+------------------+------------------------------------------------------+
| **# of nodes** | Minimum 5 |
| | |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following minimum hardware requirements must be met for the ``hybrid``
-installation of ``Gambia`` using Fuel:
+installation of ``Hunter`` using Fuel:
+------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
+==================+======================================================+
| **1 Jumpserver** | A physical node (also called Foundation Node) that |
-| | hosts the Salt Master container, MaaS VM and |
+| | hosts the Salt Master and MaaS containers, and |
| | each of the virtual nodes defined in ``PDF`` |
+------------------+------------------------------------------------------+
| **# of nodes** | .. NOTE:: |
infrastructure as well as the provider networks and the private tenant
VLANs needs to be manually configured.
-Manual configuration of the ``Gambia`` hardware platform should
+Manual configuration of the ``Hunter`` hardware platform should
be carried out according to the `OPNFV Pharos Specification`_.
OPNFV Software Prerequisites
.. code-block:: console
jenkins@jumpserver:~$ cat /etc/apt/sources.list.d/armband.list
- deb http://linux.enea.com/mcp-repos/queens/xenial queens-armband main
+ deb http://linux.enea.com/mcp-repos/rocky/xenial rocky-armband main
jenkins@jumpserver:~$ sudo apt-key adv --keyserver keys.gnupg.net \
--recv 798AB1D1
The install script will alter Jumpserver sysconf and disable
``net.bridge.bridge-nf-call``.
+.. WARNING::
+
+ On Jumpservers running Ubuntu with AppArmor enabled, when deploying
+ on baremetal nodes (i.e. when MaaS is used), the install script
+ will disable certain conflicting AppArmor profiles that interfere with
+ MaaS services inside the container, e.g. ``ntpd``, ``named``, ``dhcpd``,
+ ``tcpdump``.
+
.. WARNING::
The install script will automatically install and/or upgrade the
private: 'trunk'
public: 'trunk'
trunks:
- # mgmt network is not decapsulated for jumpserver infra VMs,
+ # mgmt network is not decapsulated for jumpserver infra nodes,
# to align with the VLAN configuration of baremetal nodes.
mgmt: True
``SDF``
~~~~~~~
-Scenario Descriptor Files are not yet implemented in the OPNFV Fuel ``Gambia``
+Scenario Descriptor Files are not yet implemented in the OPNFV Fuel ``Hunter``
release.
Instead, embedded OPNFV Fuel scenarios files are locally available in
.. WARNING::
- OPNFV releases previous to ``Gambia`` used to rely on the ``virtual``
+ OPNFV releases previous to ``Hunter`` used to rely on the ``virtual``
keyword being part of the POD name (e.g. ``ericsson-virtual2``) to
configure the deployment type as ``virtual``. Otherwise ``baremetal``
was implied.
``x86_64``, ``aarch64`` or ``mixed`` (``x86_64`` and ``aarch64``):
- Clone the OPNFV Fuel code from gerrit
-- Checkout the ``Gambia`` release tag
+- Checkout the ``Hunter`` release tag
- Start the deploy script
.. NOTE::
jenkins@jumpserver:~$ git clone https://git.opnfv.org/fuel
jenkins@jumpserver:~$ cd fuel
- jenkins@jumpserver:~/fuel$ git checkout opnfv-7.0.0
+ jenkins@jumpserver:~/fuel$ git checkout opnfv-8.0.0
jenkins@jumpserver:~/fuel$ ci/deploy.sh -l <lab_name> \
-p <pod_name> \
-b <URI to configuration repo containing the PDF/IDF files> \
- create a Salt Master Docker container on the jumpserver, which will drive
the rest of the installation;
-- ``baremetal`` or ``hybrid`` only: create a ``MaaS`` infrastructure node VM,
+- ``baremetal`` or ``hybrid`` only: create a ``MaaS`` container node,
which will be leveraged using Salt to handle OS provisioning on the
``baremetal`` nodes;
- leverage Salt to install & configure OpenStack;
.. NOTE::
- A virtual network ``mcpcontrol`` is always created for initial connection
- of the VMs on Jumphost.
+ A Docker network ``mcpcontrol`` is always created for initial connection
+ of the infrastructure containers (``cfg01``, ``mas01``) on Jumphost.
.. WARNING::
+-------------+------------------------------------------------------------+
| ``cfg01`` | Salt Master Docker container |
+-------------+------------------------------------------------------------+
- | ``mas01`` | MaaS Node VM |
+ | ``mas01`` | MaaS Node Docker container |
+-------------+------------------------------------------------------------+
| ``ctl01`` | Baremetal controller node |
+-------------+------------------------------------------------------------+
+---------------------------+----------------------------------------------+
| ``cfg01`` | Salt Master Docker container |
+---------------------------+----------------------------------------------+
- | ``mas01`` | MaaS Node VM |
+ | ``mas01`` | MaaS Node Docker container |
+---------------------------+----------------------------------------------+
| ``kvm01``, | Baremetals which hold the VMs with |
| ``kvm02``, | controller functions |
+-------------+------------------------------------------------------------+
| ``cfg01`` | Salt Master Docker container |
+-------------+------------------------------------------------------------+
- | ``mas01`` | MaaS Node VM |
+ | ``mas01`` | MaaS Node Docker container |
+-------------+------------------------------------------------------------+
| ``ctl01`` | Controller VM |
+-------------+------------------------------------------------------------+
+===========================+=================================================+
| ``virtual_init`` | ``cfg01``: reclass node generation |
| | |
-| | ``jumpserver`` VMs (e.g. ``mas01``): basic OS |
+| | ``jumpserver`` VMs (if present): basic OS |
| | config |
+---------------------------+-------------------------------------------------+
-| ``maas`` | ``mas01``: OS, MaaS installation, |
+| ``maas`` | ``mas01``: OS, MaaS configuration |
| | ``baremetal`` node commissioning and deploy |
| | |
| | .. NOTE:: |
References
==========
-For more information on the OPNFV ``Gambia`` 7.0 release, please see:
+For more information on the OPNFV ``Hunter`` 8.0 release, please see:
#. `OPNFV Home Page`_
#. `OPNFV Documentation`_
#. `OPNFV Software Downloads`_
-#. `OPNFV Gambia Wiki Page`_
-#. `OpenStack Queens Release Artifacts`_
+#. `OPNFV Hunter Wiki Page`_
+#. `OpenStack Rocky Release Artifacts`_
#. `OpenStack Documentation`_
#. `OpenDaylight Artifacts`_
#. `Mirantis Cloud Platform Documentation`_
.. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
.. _`fuel git repository`: https://git.opnfv.org/fuel
.. _`pharos git repo`: https://git.opnfv.org/pharos
-.. _`OpenStack Documentation`: https://docs.openstack.org/queens
-.. _`OpenStack Queens Release Artifacts`: https://www.openstack.org/software/queens
+.. _`OpenStack Documentation`: https://docs.openstack.org/rocky
+.. _`OpenStack Rocky Release Artifacts`: https://www.openstack.org/software/rocky
.. _`OPNFV Home Page`: https://www.opnfv.org
-.. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/display/SWREL/Gambia
+.. _`OPNFV Hunter Wiki Page`: https://wiki.opnfv.org/display/SWREL/Hunter
.. _`OPNFV Documentation`: https://docs.opnfv.org
.. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads
.. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0