+.. _opnfv-installation:
+
.. 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
-====================
-OPNFV Installation
-====================
+=============
+Installation
+=============
Abstract
========
-The following document provides an overview of the instructions required for the installation
-of the Danube release of OPNFV.
+This document provides an overview of the installation of the Danube 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 Danube release can be installed making use of any of the installer projects in OPNFV:
+Apex, Compass4Nfv, Fuel or JOID. 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
+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.
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.
To learn more about the scenarios supported in the Danube release refer to the scenario
description documents provided:
-- Links to scenario description documents need to be added here. (todo)
+- :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_l2-bgpvpn-noha <sdnvpn-os-odl_l2-bgpvpn-noha>`
+- :ref:`os-odl_l2-bgpvpn-ha <sdnvpn-os-odl_l2-bgpvpn-ha>`
+- :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:`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-odl_l3-fdio-ha <os-odl_l3-fdio-ha>`
+
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 four projects providing installation
+support for the OPNFV Danube release are: Apex, Compass4nfv, Fuel and JOID.
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>`
-
+- :ref:`JOID installation instruction <joid-installation>`
OPNFV Test Frameworks
=====================
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 as listed below:
-
-- :ref:`Functest user guide <functest-userguide>`
-- :ref:`Yardstick user guide <yardstick-userguidde>`
-- :ref:`vSwitchPerf user guide <vswitchperf-userguide>`
-- :ref:`Software Fastpath Service Quality Metrics (SFQM) user guide <fastpathmetrics-userguide>`
-- :ref:`Bottlenecks user guide <bottlenecks-userguide>`
-- :ref:`Storage Performance Benchmarking for NFVI (StorPerf) user guide <storperf-userguide>`
-
-
-Security Notes
-==============
-
-The following patches were applied to fix security issues discovered in OPNFV
-projects, during the Danube release cycle.
-
-- Links to security patches need to be added here. (todo)
+Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>`
Code Review / opnfvdocs.git / blobdiff