docs/installationprocedure/installation.introduction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3    .. (c) Sofia Wallin Ericsson AB
   4
   5 ========
   6 Abstract
   7 ========
   8
   9 The following document provides an overview of the instructions required for the installation
  10 of the Colorado release of OPNFV.
  11
  12 The Colorado release can be installed using a variety of technologies provided by the
  13 integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and JOID.
  14 Each installer provides the ability to install a common OPNFV platform as well as integrating
  15 additional features delivered through a variety of scenarios by the OPNFV community.
  16
  17 ============
  18 Introduction
  19 ============
  20
  21 The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical
  22 infrastructure.  A composition of components, tools and configurations is identified in OPNFV as a
  23 deployment scenario.
  24 The various OPNFV scenarios provide unique features and capabilities that you may want to leverage,
  25 it is important to understand your required target platform capabilities before installing and
  26 configuring your target scenario.
  27
  28 An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined
  29 in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/3.0/docs/specification/index.html>`_.
  30 When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines.
  31
  32 =========
  33 Scenarios
  34 =========
  35
  36 OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment
  37 architectures and locations. Each scenario provides specific capabilities and/or components aimed to
  38 solve specific problems for the deployment of VNF’s.
  39 A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc...
  40 where each scenario will include different source components or configurations.
  41
  42 To learn more about the scenarios supported in the Colorado release refer to the scenario
  43 description documents provided:
  44
  45 - Accelerated OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/3.0/docs/scenarios_os-nosdn-ovs/index.html>`_
  46 - Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/sdnvpn/colorado/3.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
  47   - FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha <http://artifacts.opnfv.org/fds/colorado/3.0/scenarios_os-odl_l2-fdio-noha/index.html>`_
  48 - FD.io based forwarding for OPNFV `os-nosdn-fdio-noha <http://artifacts.opnfv.org/fds/colorado/3.0/docs/scenarios_os-nosdn-fdio-noha/index.html>`_
  49 - High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/3.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
  50 - Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/3.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
  51 - Accelerated KVM hypervisor `os-nosdn-kvm-ha <http://artifacts.opnfv.org/kvmfornfv/colorado/3.0/docs/scenarios_os-nosdn-kvm-ha/index.html>`_
  52 - LXD container hypervisor `os-nosdn-lxd-noha <http://artifacts.opnfv.org/joid/colorado/3.0/docs/scenarios_os-nosdn-lxd-noha/index.html>`_
  53 - High Availability LXD container hypervisor `os-nosdn-lxd-ha <http://artifacts.opnfv.org/joid/colorado/3.0/docs/scenarios_os-nosdn-lxd-ha/index.html>`_
  54
  55 ======================
  56 Installation Procedure
  57 ======================
  58
  59 Detailed step by step instructions for working with an installation toolchain and installing
  60 the required scenario are provided by each installation project.  The four projects providing installation
  61 support for the OPNFV Colorado release are; Apex, Compass4nfv, Fuel and Joid.
  62
  63 The instructions for each toolchain can be found in these links:
  64
  65 - `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/3.0/docs/installationprocedure/index.html>`_
  66 - `Compass4nfv installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/3.0/docs/installationprocedure/index.html>`_
  67 - `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html>`_
  68 - `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/3.0/docs/installationprocedure/index.html>`_
  69
  70 =====================
  71 OPNFV Test Frameworks
  72 =====================
  73
  74 If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV
  75 your system will have been validated once the installation is completed.
  76 The basic deployment validation only addresses a small component of the capability provided in
  77 the platform and you may desire to execute more exhaustive tests.  Some investigation is required to
  78 select the right test suites to run on your platform from the available projects and suites.
  79
  80 Many of the OPNFV test project provide user-guide documentation and installation instructions as provided below:
  81
  82 - `Functest user guide <http://artifacts.opnfv.org/functest/colorado/3.0/docs/userguide/index.html>`_
  83 - `Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/3.0/docs/userguide/index.html>`_
  84 - `vSwitchPerf user guide <http://artifacts.opnfv.org/vswitchperf/colorado/3.0/index.html>`_
  85 - `Software Fastpath Service Quality Metrics (SFQM) user guide <http://artifacts.opnfv.org/fastpathmetrics/colorado/3.0/index.html>`_
  86 - `Bottlenecks user guide <http://artifacts.opnfv.org/bottlenecks/colorado/3.0/docs/installationprocedure/index.html>`_
  87 - `Storage Performance Benchmarking for NFVI (StorPerf) user guide <http://artifacts.opnfv.org/storperf/colorado/3.0/docs/userguide/index.html>`_
  88
  89 ==============
  90 Security Notes
  91 ==============
  92
  93 The following patches were applied to fix security issues discovered in opnfv
  94 projects, during the c-release cycle.
  95
  96 - `Removal of private keys <https://gerrit.opnfv.org/gerrit/#/c/21995/>`_
  97 - `Fix security issues of eval-s in testapi <https://gerrit.opnfv.org/gerrit/#/c/20751/>`_
  98 - `Implements use of yaml.safe_load <https://gerrit.opnfv.org/gerrit/#/c/20911/>`_
  99 - `Fix security issues reported by the security audit <https://gerrit.opnfv.org/gerrit/#/c/20693/>`_
 100 - `Fix issues found in security review <https://gerrit.opnfv.org/gerrit/#/c/21541/>`_
 101 - `Removing OpenSteak Project <https://gerrit.opnfv.org/gerrit/#/c/22139/>`_
 102 - `Remove unsed files in open-contrail role <https://gerrit.opnfv.org/gerrit/#/c/21997/>`_
 103 - `Get rid of private key in repo <https://gerrit.opnfv.org/gerrit/#/c/21985>`_
 104 - `Handling file loads and tmp dirs differently <https://gerrit.opnfv.org/gerrit/#/c/21499>`_
 105 - `Remove `Debug = True when run Flask and add logger <https://gerrit.opnfv.org/gerrit/#/c/21799/>`_