docs/release/installation.introduction.rst

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