.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-.. (c) Sofia Wallin Ericsson AB
+.. (c) Sofia Wallin Ericsson AB and other contributors
-====================
-OPNFV Installation
-====================
+============
+Installation
+============
Abstract
========
-The following document provides an overview of the instructions required for the installation
-of the Danube release of OPNFV.
+This an overview document for the installation of the Gambia release of OPNFV.
-The Danube release can be installed using a tool from the following integration projects in OPNFV:
-Apex, Compass4Nfv, Fuel and JOID. Each installer provides the ability to install a common OPNFV
+The Gambia release can be installed making use of any of the installer projects in OPNFV:
+Apex, Compass4Nfv or Fuel. Each installer provides the ability to install a common OPNFV
platform as well as integrating additional features delivered through a variety of scenarios by
the OPNFV community.
Introduction
============
-The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical
-infrastructure. A composition of components, tools and configurations is identified in OPNFV as a
+The OPNFV platform is comprised of a variety of upstream components that may be deployed on your
+infrastructure. A composition of components, tools and configurations is identified in OPNFV as a
deployment scenario.
The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, and
it is important to understand your required target platform capabilities before installing and
configuring your scenarios.
-An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined
-in the `Pharos specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_.
+An OPNFV installation requires either a physical infrastructure environment as defined
+in the `Pharos specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_, or a virtual one.
When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines.
A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc.,
where each scenario will include different source components or configurations.
-To learn more about the scenarios supported in the Danube release refer to the scenario
+To learn more about the scenarios supported in the Gabmia release refer to the scenario
description documents provided:
-- :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>`
-- :ref:`os-nosdn-kvm_ovs_dpdk-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk-noha>`
-- :ref:`os-nosdn-kvm_ovs_dpdk_bar-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk_bar-noha>`
-- :ref:`os-odl_l3-fdio-noha <os-odl_l3-fdio-noha>`
-- :ref:`os-odl_l2-fdio-ha <os-odl_l2-fdio-ha>`
-- :ref:`os-odl_l2-fdio-noha <os-odl_l2-fdio-noha>`
-- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>`
-- :ref:`os-odl-gluon-noha <gluon-scenario>`
-- :ref:`os-nosdn-openo-ha <opera-os-nosdn-openo-ha>`
-- `os-odl_l2-sfc-ha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-ha/index.html>`_
-- `os-odl_l2-sfc-noha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-noha/index.html>`_
-- :ref:`os-nosdn-lxd-ha <os-nosdn-lxd-ha>`
-- :ref:`os-nosdn-lxd-noha <os-nosdn-lxd-noha>`
-- :ref:`k8-nosdn-nofeature-noha <k8-nosdn-nofeature-noha>`
-- :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>`
-- `os-nosdn-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-nosdn-ovs-ha/index.html>`_
+- :ref:`k8-nosdn-stor4nfv-ha <stor4nfv:k8-nosdn-stor4nfv-ha>`
+- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>`
+- :ref:`os-nosdn-stor4nfv-ha <os-nosdn-stor4nfv-ha>`
- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha>`
-- :ref:`os-nosdn-ovs <os-nosdn-ovs>`
-- `os-odl_l3-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-odl_l3-ovs-ha/index.html>`_
-- :ref:`os-odl_l3-ovs-noha <os-odl_l3-ovs-noha>`
-
+- :ref:`os-nosdn-vpp-noha <os-nosdn-vpp-noha>`
+- :ref:`os-nosdn-vpp-ha <os-nosdn-vpp-ha>`
+- :ref:`os-odl-ovs-noha <os-odl-ovs-noha>`
+- :ref:`os-odl-sfc-noha <os-odl-sfc-noha>`
+- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>`
+- :ref:`os-odl-bgpvpn-noha <os-odl-bgpvpn-noha>`
+- :ref:`os-odl-bgpvpn-ha <os-odl-bgpvpn-ha>`
+- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>`
+- :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>`
+- :ref:`k8-nosdn-virtlet-noha <k8-nosdn-virtlet-noha>`
+- :ref:`k8-ovn-kata-noha <k8-ovn-kata-noha>`
Installation Procedure
======================
Detailed step by step instructions for working with an installation toolchain and installing
-the required scenario are provided by each installation project. The four projects providing installation
-support for the OPNFV Danube release are; Apex, Compass4nfv, Fuel and Joid.
+the required scenario are provided by the installation projects. The projects providing installation
+support for the OPNFV Gambia release are: Apex, Compass4nfv and Fuel.
The instructions for each toolchain can be found in these links:
- :ref:`Apex installation instruction <apex-installation>`
- :ref:`Compass4nfv installation instruction <compass4nfv-installation>`
- :ref:`Fuel installation instruction <fuel-installation>`
-- :ref:`Joid installation instruction <joid-installation>`
OPNFV Test Frameworks
=====================
-If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV
+If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV,
your system will have been validated once the installation is completed.
-The basic deployment validation only addresses a small part of capabilities provided in
-the platform and you may want to execute more exhaustive tests. Some investigation will be required to
+The basic deployment validation only addresses a small part of capabilities in
+the platform and you may want to execute more exhaustive tests. Some investigation will be required to
select the right test suites to run on your platform.
-Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>`
\ No newline at end of file
+Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>`
Code Review / opnfvdocs.git / blobdiff