Abstract
========
-This document describes how to install the ``Hunter`` release of
+This document describes how to install the ``Iruya`` 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 ``Hunter`` release of OPNFV when using Fuel as a
+configure the ``Iruya`` 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 ``Hunter`` compliant
+step-by-step guide that results in an OPNFV ``Iruya`` 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 ``Hunter`` release of
+Before starting the installation of the ``Iruya`` 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 ``Hunter`` using Fuel:
+installation of ``Iruya`` using Fuel:
+------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following minimum hardware requirements must be met for the ``baremetal``
-installation of ``Hunter`` using Fuel:
+installation of ``Iruya`` using Fuel:
+------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following minimum hardware requirements must be met for the ``hybrid``
-installation of ``Hunter`` using Fuel:
+installation of ``Iruya`` using Fuel:
+------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
infrastructure as well as the provider networks and the private tenant
VLANs needs to be manually configured.
-Manual configuration of the ``Hunter`` hardware platform should
+Manual configuration of the ``Iruya`` hardware platform should
be carried out according to the `OPNFV Pharos Specification`_.
OPNFV Software Prerequisites
``SDF``
~~~~~~~
-Scenario Descriptor Files are not yet implemented in the OPNFV Fuel ``Hunter``
+Scenario Descriptor Files are not yet implemented in the OPNFV Fuel ``Iruya``
release.
Instead, embedded OPNFV Fuel scenarios files are locally available in
.. WARNING::
- OPNFV releases previous to ``Hunter`` used to rely on the ``virtual``
+ OPNFV releases previous to ``Iruya`` 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 ``Hunter`` release tag
+- Checkout the ``Iruya`` 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-8.1.0
+ jenkins@jumpserver:~/fuel$ git checkout opnfv-9.0.0
jenkins@jumpserver:~/fuel$ ci/deploy.sh -l <lab_name> \
-p <pod_name> \
-b <URI to configuration repo containing the PDF/IDF files> \
References
==========
-For more information on the OPNFV ``Hunter`` 8.1 release, please see:
+For more information on the OPNFV ``Iruya`` 9.0 release, please see:
#. `OPNFV Home Page`_
#. `OPNFV Documentation`_
#. `OPNFV Software Downloads`_
-#. `OPNFV Hunter Wiki Page`_
+#. `OPNFV Iruya Wiki Page`_
#. `OpenStack Rocky Release Artifacts`_
#. `OpenStack Documentation`_
#. `OpenDaylight Artifacts`_
.. _`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 Hunter Wiki Page`: https://wiki.opnfv.org/display/SWREL/Hunter
+.. _`OPNFV Iruya Wiki Page`: https://wiki.opnfv.org/display/SWREL/Iruya
.. _`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
Abstract
========
-This document provides the release notes for ``Hunter`` release with the Fuel
+This document provides the release notes for ``Iruya`` release with the Fuel
deployment toolchain.
Starting with ``Gambia`` release, both ``x86_64`` and ``aarch64`` architectures
Important Notes
===============
-This is the OPNFV ``Hunter`` release that implements the deploy stage of the
+This is the OPNFV ``Iruya`` release that implements the deploy stage of the
OPNFV CI pipeline via Fuel.
Fuel is based on the `MCP`_ installation tool chain.
More information available at `Mirantis Cloud Platform Documentation`_.
-The goal of the ``Hunter`` release and this Fuel-based deployment process is
+The goal of the ``Iruya`` release and this Fuel-based deployment process is
to establish a lab ready platform accelerating further development
of the OPNFV infrastructure.
Summary
=======
-``Hunter`` release with the Fuel deployment toolchain will establish an OPNFV
+``Iruya`` release with the Fuel deployment toolchain will establish an OPNFV
target system on a Pharos compliant lab infrastructure. The current definition
of an OPNFV target system is OpenStack Queens combined with an SDN
controller, such as OpenDaylight. The system is deployed with OpenStack High
``virtual`` or ``hybrid`` fashion. ``virtual`` deployments use multiple VMs on
the Jump Host and internal networking to simulate the ``baremetal`` deployment.
-For ``Hunter``, the typical use of Fuel as an OpenStack installer is
+For ``Iruya``, the typical use of Fuel as an OpenStack installer is
supplemented with OPNFV unique components such as:
- `OpenDaylight`_
-- Open Virtual Network (``OVN``)
-- `Vector Packet Processing`_
As well as OPNFV-unique configurations of the Hardware and Software stack.
-This ``Hunter`` artifact provides Fuel as the deployment stage tool in the
+This ``Iruya`` artifact provides Fuel as the deployment stage tool in the
OPNFV CI pipeline including:
- Automated (Jenkins, RTD) documentation build & publish (multiple documents);
- Automated (Jenkins) build & publish of Salt Master Docker image;
-- Automated (Jenkins) deployment of ``Hunter`` running on baremetal or a nested
+- Automated (Jenkins) deployment of ``Iruya`` running on baremetal or a nested
hypervisor environment (KVM);
-- Automated (Jenkins) validation of the ``Hunter`` deployment
+- Automated (Jenkins) validation of the ``Iruya`` deployment
Release Data
============
| **Project** | fuel |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | opnfv-8.1.0 |
+| **Repo/tag** | opnfv-9.0.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Hunter 8.1 |
+| **Release designation** | Iruya 9.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | June 24, 2019 |
+| **Release date** | January 31, 2020 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Hunter 8.1 release |
+| **Purpose of the delivery** | OPNFV Iruya 9.0 release |
+--------------------------------------+--------------------------------------+
Version Change
Module Version Changes
~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of the ``Hunter`` release with the Fuel
+This is the first tracked version of the ``Iruya`` release with the Fuel
deployment toolchain. It is based on following upstream versions:
- MCP (``Q1`19`` GA release)
-- OpenStack (``Rocky`` release)
+- OpenStack (``Stein`` release)
-- OpenDaylight (``Fluorine`` release)
+- OpenDaylight (``Neon`` release)
-- Ubuntu (``16.04`` release)
+- Ubuntu (``18.04`` release)
Document Changes
~~~~~~~~~~~~~~~~
-This is the ``Hunter`` 8.1 release.
+This is the ``Iruya`` 9.0 release.
It comes with the following documentation:
- :ref:`OPNFV Fuel Installation Instruction <fuel-installation>`
Feature Additions
~~~~~~~~~~~~~~~~~
-- ``multiarch`` cluster support;
-- ``hybrid`` cluster support;
-- ``PDF``/``IDF`` support for ``virtual`` PODs;
-- ``baremetal`` support for noHA deployments;
-- containerized Salt Master;
-- ``OVN`` scenarios;
-- ``ODL`` ``BGPVPN`` scenario;
-- ``IDF`` support for configuring cluster-level ``MTU``;
+Due to reduced schedule, this is a maintainance release.
Bug Corrections
~~~~~~~~~~~~~~~
-For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.1 Bugs (fixed)`_
-filter.
+N/A
Software Deliverables
~~~~~~~~~~~~~~~~~~~~~
| os-nosdn-nofeature-ha | ``x86_64``, | | |
| | ``aarch64`` | | |
+-------------------------+---------------+-------------+------------+
-| os-nosdn-ovs-noha | | ``x86_64`` | |
-+-------------------------+---------------+-------------+------------+
-| os-nosdn-ovs-ha | ``x86_64``, | | |
-| | ``aarch64`` | | |
-+-------------------------+---------------+-------------+------------+
| os-odl-nofeature-noha | | ``x86_64`` | |
+-------------------------+---------------+-------------+------------+
| os-odl-nofeature-ha | ``x86_64``, | | |
-| | ``aarch64`` | | |
-+-------------------------+---------------+-------------+------------+
-| os-odl-ovs-noha | | ``x86_64`` | |
-+-------------------------+---------------+-------------+------------+
-| os-odl-ovs-ha | ``x86_64`` | | |
-+-------------------------+---------------+-------------+------------+
-| os-odl-bgpvpn-noha | | ``x86_64`` | |
-+-------------------------+---------------+-------------+------------+
-| os-odl-sfc-noha | | ``x86_64`` | |
-+-------------------------+---------------+-------------+------------+
-| os-ovn-nofeature-noha | | ``x86_64`` | |
-+-------------------------+---------------+-------------+------------+
-| os-ovn-nofeature-ha | ``aarch64`` | | |
-+-------------------------+---------------+-------------+------------+
-| os-nosdn-fdio-noha | ``x86_64``, | | |
-| | ``aarch64`` | | |
+-------------------------+---------------+-------------+------------+
Known Limitations, Issues and Workarounds
Test Results
============
-The ``Hunter`` 8.1 release with the Fuel deployment tool has undergone QA test
+The ``Iruya`` 9.0 release with the Fuel deployment tool has undergone QA test
runs, see separate test results.
References
==========
-For more information on the OPNFV ``Hunter`` 8.1 release, please see:
+For more information on the OPNFV ``Iruya`` 9.0 release, please see:
#. `OPNFV Home Page`_
#. `OPNFV Documentation`_
#. `OPNFV Software Downloads`_
-#. `OPNFV Hunter Wiki Page`_
+#. `OPNFV Iruya Wiki Page`_
#. `OpenStack Queens Release Artifacts`_
#. `OpenStack Documentation`_
#. `OpenDaylight Artifacts`_
.. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
.. _`fuel git repository`: https://git.opnfv.org/fuel
.. _`OpenStack Documentation`: https://docs.openstack.org/rocky
-.. _`OpenStack Rocky Release Artifacts`: https://www.openstack.org/software/rocky
+.. _`OpenStack Stein Release Artifacts`: https://www.openstack.org/software/stein
.. _`OPNFV Home Page`: https://www.opnfv.org
-.. _`OPNFV Hunter Wiki Page`: https://wiki.opnfv.org/display/SWREL/Hunter
+.. _`OPNFV Iruya Wiki Page`: https://wiki.opnfv.org/display/SWREL/Iruya
.. _`OPNFV Documentation`: https://docs.opnfv.org
.. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads
.. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
-.. OPNFV Fuel Hunter JIRA filters
-.. _`OPNFV Fuel JIRA: Hunter 8.1 Bugs (fixed)`: https://jira.opnfv.org/issues/?filter=12710
.. toctree::
:maxdepth: 2
- os-nosdn-ovs-noha/index.rst
- os-nosdn-ovs-ha/index.rst
- os-ovn-nofeature-noha/index.rst
- os-ovn-nofeature-ha/index.rst
- os-nosdn-fdio-noha/index.rst
- os-odl-ovs-noha/index.rst
- os-nosdn-onap-ha/index.rst
- os-nosdn-onap-noha/index.rst
+ os-nosdn-nofeature-noha/index.rst
+ os-nosdn-nofeature-ha/index.rst
+ os-odl-nofeature-noha/index.rst
+ os-odl-nofeature-ha/index.rst
--- /dev/null
+.. _os-nosdn-nofeature-ha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2018 Mirantis Inc., Enea Software AB and others
+
+==============================================
+os-nosdn-nofeature-ha overview and description
+==============================================
+
+.. toctree::
+ :maxdepth: 2
+
+.. include:: os-nosdn-nofeature-ha.rst
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2018 Mirantis Inc., Enea Software AB and others
+
+This document provides scenario level details for Iruya 9.0 of
+deployment with no SDN controller and no extra features enabled.
+
+Introduction
+============
+
+This scenario is used primarily to validate and deploy a Stein OpenStack
+deployment without any NFV features or SDN controller enabled.
+
+Scenario components and composition
+===================================
+
+This scenario is composed of common OpenStack services enabled by default,
+including Nova, Neutron, Glance, Cinder, Keystone, Horizon.
+
+All services are in HA, meaning that there are multiple cloned instances of
+each service, and they are balanced by HA Proxy using a Virtual IP Address
+per service.
+
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by setting os-nosdn-nofeature-ha as scenario
+deploy parameter.
+
+Limitations, Issues and Workarounds
+===================================
+
+None
+
+References
+==========
+
+For more information on the OPNFV Iruya release, please visit
+https://www.opnfv.org/software
--- /dev/null
+.. _os-nosdn-nofeature-noha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2018 Mirantis Inc., Enea Software AB and others
+
+================================================
+os-nosdn-nofeature-noha overview and description
+================================================
+
+.. toctree::
+ :maxdepth: 2
+
+.. include:: os-nosdn-nofeature-noha.rst
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2018 Mirantis Inc., Enea Software AB and others
+
+This document provides scenario level details for Iruya 9.0 of
+deployment with no SDN controller and no extra features enabled.
+
+Introduction
+============
+
+This scenario is used primarily to validate and deploy a Stein OpenStack
+deployment without any NFV features or SDN controller enabled.
+
+
+Scenario components and composition
+===================================
+
+This scenario is composed of common OpenStack services enabled by default,
+including Nova, Neutron, Glance, Cinder, Keystone, Horizon.
+
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by setting os-nosdn-nofeature-noha as scenario
+deploy parameter.
+
+
+Limitations, Issues and Workarounds
+===================================
+
+Tested on virtual deploy only.
+
+References
+==========
+
+For more information on the OPNFV Iruya release, please visit
+https://www.opnfv.org/software
--- /dev/null
+.. _os-odl-nofeature-ha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2018 Mirantis Inc., Enea Software AB and others
+
+============================================
+os-odl-nofeature-ha overview and description
+============================================
+
+.. toctree::
+ :maxdepth: 2
+
+.. include:: os-odl-nofeature-ha.rst
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2018 Mirantis Inc., Enea Software AB and others
+
+This document provides scenario level details for Iruya 9.0 of
+deployment with OpenDaylight controller.
+
+Introduction
+============
+
+This scenario is used primarily to validate and deploy a Stein OpenStack
+deployment with OpenDaylight Neon controller enabled.
+
+
+Scenario components and composition
+===================================
+
+This scenario is composed of common OpenStack services enabled by default,
+including Nova, Neutron, Glance, Cinder, Keystone, Horizon. All services
+are in HA, meaning that there are multiple cloned instances of each service,
+and they are balanced by HA Proxy using a Virtual IP Address per service.
+OpenDaylight is installed as a SDN controller on one of the controller nodes.
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by setting os-odl-nofeature-noha as scenario
+deploy parameter.
+
+
+Limitations, Issues and Workarounds
+===================================
+
+None
+
+References
+==========
+
+For more information on the OPNFV Iruya release, please visit
+https://www.opnfv.org/software
--- /dev/null
+.. _os-odl-nofeature-noha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2018 Mirantis Inc., Enea Software AB and others
+
+==============================================
+os-odl-nofeature-noha overview and description
+==============================================
+
+.. toctree::
+ :maxdepth: 2
+
+.. include:: os-odl-nofeature-noha.rst
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2018 Mirantis Inc., Enea Software AB and others
+
+This document provides scenario level details for Iruya 9.0 of
+deployment with OpenDaylight controller.
+
+Introduction
+============
+
+This scenario is used primarily to validate and deploy a Stein OpenStack
+with OpenDaylight Neon controller enabled.
+
+
+Scenario components and composition
+===================================
+
+This scenario is composed of common OpenStack services enabled by default,
+including Nova, Neutron, Glance, Cinder, Keystone, Horizon. It also installs
+OpenDaylight as a SDN controller on the dedicated node.
+
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by setting up os-odl-nofeature-noha as scenario
+deploy parameter.
+
+
+Limitations, Issues and Workarounds
+===================================
+
+Tested on virtual deploy only.
+
+References
+==========
+
+For more information on the OPNFV Iruya release, please visit
+https://www.opnfv.org/software
Abstract
========
-This document contains details about using OPNFV Fuel ``Hunter`` release after
+This document contains details about using OPNFV Fuel ``Iruya`` release after
it was deployed. For details on how to deploy OpenStack, check
the installation instructions in the :ref:`fuel_userguide_references` section.
Code Review / fuel.git / commitdiff