+.. _opnfv-installation:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Sofia Wallin Ericsson AB
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (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 Colorado release of OPNFV.
+This an overview document for the installation of the Euphrates release of OPNFV.
-The Colorado release can be installed using a variety of technologies provided by the
-integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and 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.
+The Euphrates release can be installed making use of any of the installer projects in OPNFV:
+Apex, Compass4Nfv, Daisy4NFV, 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
-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,
+
+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 target scenario.
+configuring your scenarios.
-An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined
-in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`.
+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.
=========
OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment
-architectures and locations. Each scenario provides specific capabilities and/or components aimed to
-solve specific problems for the deployment of VNF’s.
-A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc...
+architectures and locations. Each scenario provides specific capabilities and/or components aimed at
+solving specific problems for the deployment of VNF’s.
+
+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 Colorado release refer to the scenario
+To learn more about the scenarios supported in the Euphrates release refer to the scenario
description documents provided:
-- Accelerated OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`
-- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`
-- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha <http://artifacts.opnfv.org/fds/colorado/2.0/scenarios_os-odl_l2-fdio-noha/index.html>`
-- High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`
-- Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`
-- Accelerated KVM hypervisor `os-nosdn-kvm-ha <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/scenarios_os-nosdn-kvm-ha/index.html>`
-- LXD container hypervisor `os-nosdn-lxd-noha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-noha/index.html>`
-- High Availability LXD container hypervisor `os-nosdn-lxd-ha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-ha/index.html>`
-
+- :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-odl-fdio-ha <os-odl-fdio-ha>`
+- :ref:`os-odl-fdio-noha <os-odl-fdio-noha>`
+- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>`
+- :ref:`os-odl-bgpvpn-noha <sdnvpn-os-odl-bgpvpn-noha>`
+- :ref:`os-odl-bgpvpn-ha <sdnvpn-os-odl-bgpvpn-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-calipso-noha <os-nosdn-calipso-noha>`
+- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>`
+- :ref:`os-nosdn-ovs_dpdk-noha <os-nosdn-ovs_dpdk-noha>`
+- :ref:`os-odl-ovs_dpdk-ha <os-odl-ovs_dpdk-ha>`
+- :ref:`os-odl-ovs_dpdk-noha <os-odl-ovs_dpdk-noha>`
+- :ref:`os-odl-fdio-dvr-noha <os-odl-fdio-dvr-noha>`
+- :ref:`os-odl-fdio-dvr-ha <os-odl-fdio-dvr-ha>`
+- :ref:`os-odl-fdio-ipv6-noha <os-odl-fdio-ipv6-noha>`
+- :ref:`os-odl-fdio-ipv6-ha <os-odl-fdio-ipv6-ha>`
+- :ref:`os-nosdn-fdio-ha <os-nosdn-fdio-ha>`
+- :ref:`os-k8s-fdio <os-k8s-fdio>`
+- :ref:`os-odl-k8s_coe-noha <os-odl-k8s_coe-noha>`
+- :ref:`os-odl-k8s_coe-ha <os-odl-k8s_coe-ha>`
+- :ref:`os-nosdn-kvm_ovs_dpdk-ha <os-nosdn-kvm_ovs_dpdk-ha>`
+- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>`
+- :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>`
+- :ref:`os-odl_l2-moon-ha <os-odl_l2-moon-ha>`
+- :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>`
+- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>`
+- :ref:`os-onos-sfc-ha <os-onos-sfc-ha>`
+- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>`
+- :ref:`os-nosdn-openbaton-ha <os-nosdn-openbaton-ha>`
+- :ref:`k8-ovn-lb-noha <k8-ovn-lb-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 Colorado release are; Apex, Compass4nfv, Fuel and Joid.
+the required scenario are provided by the installation projects. The projects providing installation
+support for the OPNFV Euphrates release are: Apex, Compass4nfv, Daisy4NFV, 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:`Daisy installation instruction <daisy-installation>`
- :ref:`Fuel installation instruction <fuel-installation>`
-- :ref:`Joid installation instruction <joid-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 component of the capability provided in
-the platform and you may desire to execute more exhaustive tests. Some investigation is required to
-select the right test suites to run on your platform from the available projects and suites.
-
-Many of the OPNFV test project provide user-guide documentation and installation instructions as provided 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 c-release cycle.
-
-- :ref:`Removal of private keys <https://gerrit.opnfv.org/gerrit/#/c/21995/>`
-- :ref:`Fix security issues of eval-s in testapi <https://gerrit.opnfv.org/gerrit/#/c/20751/>`
-- :ref:`Implements use of yaml.safe_load <https://gerrit.opnfv.org/gerrit/#/c/20911/>`
-- :ref:`Fix security issues reported by the security audit <https://gerrit.opnfv.org/gerrit/#/c/20693/>`
-- :ref:`Fix issues found in security review <https://gerrit.opnfv.org/gerrit/#/c/21541/>`
-- :ref:`Removing OpenSteak Project <https://gerrit.opnfv.org/gerrit/#/c/22139/>`
-- :ref:`Remove unsed files in open-contrail role <https://gerrit.opnfv.org/gerrit/#/c/21997/>`
-- :ref:`Get rid of private key in repo <https://gerrit.opnfv.org/gerrit/#/c/21985>`
-- :ref:`Handling file loads and tmp dirs differently <https://gerrit.opnfv.org/gerrit/#/c/21499>`
-- :ref:`Remove `Debug = True when run Flask and add logger <https://gerrit.opnfv.org/gerrit/#/c/21799/>`
+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>`
Code Review / opnfvdocs.git / blobdiff