docs/release/installation.introduction.rst

   1 .. _opnfv-installation:
   2
   3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   4 .. SPDX-License-Identifier: CC-BY-4.0
   5 .. (c) Sofia Wallin Ericsson AB
   6
   7 ====================
   8 OPNFV Installation
   9 ====================
  10
  11 Abstract
  12 ========
  13
  14 The following document provides an overview of the instructions required for the installation
  15 of the Danube release of OPNFV.
  16
  17 The Danube release can be installed using a tool from the following integration projects in OPNFV:
  18 Apex, Compass4Nfv, Fuel and JOID.  Each installer provides the ability to install a common OPNFV
  19 platform as well as integrating additional features delivered through a variety of scenarios by
  20 the OPNFV community.
  21
  22
  23 Introduction
  24 ============
  25
  26 The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical
  27 infrastructure.  A composition of components, tools and configurations is identified in OPNFV as a
  28 deployment scenario.
  29
  30 The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, and
  31 it is important to understand your required target platform capabilities before installing and
  32 configuring your scenarios.
  33
  34 An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined
  35 in the `Pharos specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_.
  36 When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines.
  37
  38
  39 Scenarios
  40 =========
  41
  42 OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment
  43 architectures and locations. Each scenario provides specific capabilities and/or components aimed at
  44 solving specific problems for the deployment of VNF’s.
  45
  46 A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc.,
  47 where each scenario will include different source components or configurations.
  48
  49 To learn more about the scenarios supported in the Danube release refer to the scenario
  50 description documents provided:
  51
  52 - :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>`
  53 - :ref:`os-nosdn-kvm_ovs_dpdk-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk-noha>`
  54 - :ref:`os-nosdn-kvm_ovs_dpdk_bar-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk_bar-noha>`
  55 - :ref:`os-odl_l3-fdio-noha <os-odl_l3-fdio-noha>`
  56 - :ref:`os-odl_l2-fdio-ha <os-odl_l2-fdio-ha>`
  57 - :ref:`os-odl_l2-fdio-noha <os-odl_l2-fdio-noha>`
  58 - :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>`
  59 - :ref:`os-odl-gluon-noha <gluon-scenario>`
  60 - :ref:`os-nosdn-openo-ha <opera-os-nosdn-openo-ha>`
  61 - `os-odl_l2-sfc-ha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-ha/index.html>`_
  62 - `os-odl_l2-sfc-noha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-noha/index.html>`_
  63 - :ref:`os-nosdn-lxd-ha <os-nosdn-lxd-ha>`
  64 - :ref:`os-nosdn-lxd-noha <os-nosdn-lxd-noha>`
  65 - :ref:`k8-nosdn-nofeature-noha <k8-nosdn-nofeature-noha>`
  66 - :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>`
  67 - `os-nosdn-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-nosdn-ovs-ha/index.html>`_
  68 - :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha>`
  69 - :ref:`os-nosdn-ovs <os-nosdn-ovs>`
  70 - `os-odl_l3-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-odl_l3-ovs-ha/index.html>`_
  71 - :ref:`os-odl_l3-ovs-noha <os-odl_l3-ovs-noha>`
  72
  73
  74 Installation Procedure
  75 ======================
  76
  77 Detailed step by step instructions for working with an installation toolchain and installing
  78 the required scenario are provided by each installation project.  The four projects providing installation
  79 support for the OPNFV Danube release are; Apex, Compass4nfv, Fuel and Joid.
  80
  81 The instructions for each toolchain can be found in these links:
  82
  83 - :ref:`Apex installation instruction <apex-installation>`
  84 - :ref:`Compass4nfv installation instruction <compass4nfv-installation>`
  85 - :ref:`Fuel installation instruction <fuel-installation>`
  86 - :ref:`Joid installation instruction <joid-installation>`
  87
  88 OPNFV Test Frameworks
  89 =====================
  90
  91 If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV
  92 your system will have been validated once the installation is completed.
  93 The basic deployment validation only addresses a small part of capabilities provided in
  94 the platform and you may want to execute more exhaustive tests.  Some investigation will be required to
  95 select the right test suites to run on your platform.
  96
  97 Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>`