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 Colorado release of OPNFV.
  14
  15 The Colorado release can be installed using a tool from the following
  16 integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and JOID.
  17 Each installer provides the ability to install a common OPNFV platform as well as integrating
  18 additional features delivered through a variety of scenarios by 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 <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`.
  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 Colorado release refer to the scenario
  48 description documents provided:
  49
  50 - Accelerated OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`_
  51 - 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>`_
  52 - 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>`_
  53 - 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>`_
  54 - 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>`_
  55 - Accelerated KVM hypervisor `os-nosdn-kvm-ha <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/scenarios_os-nosdn-kvm-ha/index.html>`_
  56 - LXD container hypervisor `os-nosdn-lxd-noha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-noha/index.html>`_
  57 - 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>`_
  58
  59
  60 Installation Procedure
  61 ======================
  62
  63 Detailed step by step instructions for working with an installation toolchain and installing
  64 the required scenario are provided by each installation project.  The four projects providing installation
  65 support for the OPNFV Colorado release are; Apex, Compass4nfv, Fuel and Joid.
  66
  67 The instructions for each toolchain can be found in these links:
  68
  69 - :ref:`Apex installation instruction <apex-installation>`
  70 - :ref:`Compass4nfv installation instruction <compass4nfv-installation>`
  71 - :ref:`Fuel installation instruction <fuel-installation>`
  72 - :ref:`Joid installation instruction <joid-installation>`
  73
  74
  75 OPNFV Test Frameworks
  76 =====================
  77
  78 If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV
  79 your system will have been validated once the installation is completed.
  80 The basic deployment validation only addresses a small part of capabilities provided in
  81 the platform and you may want to execute more exhaustive tests.  Some investigation will be required to
  82 select the right test suites to run on your platform.
  83
  84 Many of the OPNFV test project provide user-guide documentation and installation instructions as listed below:
  85
  86 - :ref:`Functest user guide <functest-userguide>`
  87 - :ref:`Yardstick user guide <yardstick-userguidde>`
  88 - :ref:`vSwitchPerf user guide <vswitchperf-userguide>`
  89 - :ref:`Software Fastpath Service Quality Metrics (SFQM) user guide <fastpathmetrics-userguide>`
  90 - :ref:`Bottlenecks user guide <bottlenecks-userguide>`
  91 - :ref:`Storage Performance Benchmarking for NFVI (StorPerf) user guide <storperf-userguide>`
  92
  93
  94 Security Notes
  95 ==============
  96
  97 The following patches were applied to fix security issues discovered in opnfv
  98 projects, during the Colorado release cycle.
  99
 100 - `Removal of private keys <https://gerrit.opnfv.org/gerrit/#/c/21995/>`_
 101 - `Fix security issues of eval-s in testapi <https://gerrit.opnfv.org/gerrit/#/c/20751/>`_
 102 - `Implements use of yaml.safe_load <https://gerrit.opnfv.org/gerrit/#/c/20911/>`_
 103 - `Fix security issues reported by the security audit <https://gerrit.opnfv.org/gerrit/#/c/20693/>`_
 104 - `Fix issues found in security review <https://gerrit.opnfv.org/gerrit/#/c/21541/>`_
 105 - `Removing OpenSteak Project <https://gerrit.opnfv.org/gerrit/#/c/22139/>`_
 106 - `Remove unsed files in open-contrail role <https://gerrit.opnfv.org/gerrit/#/c/21997/>`_
 107 - `Get rid of private key in repo <https://gerrit.opnfv.org/gerrit/#/c/21985>`_
 108 - `Handling file loads and tmp dirs differently <https://gerrit.opnfv.org/gerrit/#/c/21499>`_
 109 - `Remove 'Debug = True' when run Flask and add logger <https://gerrit.opnfv.org/gerrit/#/c/21799/>`_