X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Finstallation.introduction.rst;h=c1450adef5b405cc60547944e62a698b3009d839;hb=5717b4a34f77ac079a48c4e25d1f22631a4d0622;hp=904c2d66b22fb3a2f19ff119abec6fd7ebfc093f;hpb=1faf85b14d14a4f7331094a449d8e6daff67b7f0;p=opnfvdocs.git diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 904c2d66b..c1450adef 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -1,5 +1,7 @@ +.. _opnfv-installation: + .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. SPDX-License-Identifier: CC-BY-4.0 .. (c) Sofia Wallin Ericsson AB ==================== @@ -9,27 +11,27 @@ OPNFV Installation Abstract ======== -The following document provides an overview of the instructions required for the installation -of the Colorado release of OPNFV. +This document provides an overview of the installation of the Danube 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 Danube release can be installed making use of any of the installer projects in OPNFV: +Apex, Compass4Nfv, 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 +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 `_. +An OPNFV installation requires either a physical infrastructure environment as defined +in the `Pharos specification `_, or a virtual one. When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. @@ -37,71 +39,58 @@ Scenarios ========= 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 Danube release refer to the scenario description documents provided: -- Accelerated OVS `os-nosdn-ovs `_ -- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn `_ -- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha `_ -- High availability service function chaining `os-odl-l2-sfc-ha `_ -- Service function chaining `os-odl-l2-sfc-noha `_ -- Accelerated KVM hypervisor `os-nosdn-kvm-ha `_ -- LXD container hypervisor `os-nosdn-lxd-noha `_ -- High Availability LXD container hypervisor `os-nosdn-lxd-ha `_ +- :ref:`os-nosdn-kvm-ha ` +- :ref:`os-nosdn-kvm_ovs_dpdk-noha ` +- :ref:`os-nosdn-kvm_ovs_dpdk_bar-noha ` +- :ref:`os-odl_l3-fdio-noha ` +- :ref:`os-odl_l2-fdio-ha ` +- :ref:`os-odl_l2-fdio-noha ` +- :ref:`os-nosdn-fdio-noha ` +- :ref:`os-odl-gluon-noha ` +- :ref:`os-nosdn-openo-ha ` +- `os-odl_l2-sfc-ha `_ +- `os-odl_l2-sfc-noha `_ +- :ref:`os-nosdn-lxd-ha ` +- :ref:`os-nosdn-lxd-noha ` +- :ref:`k8-nosdn-nofeature-noha ` +- :ref:`k8-nosdn-lb-noha ` +- `os-nosdn-ovs-ha `_ +- :ref:`os-nosdn-ovs-noha ` +- :ref:`os-nosdn-ovs ` +- `os-odl_l3-ovs-ha `_ +- :ref:`os-odl_l3-ovs-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 four projects providing installation +support for the OPNFV Danube release are: Apex, Compass4nfv, Fuel and JOID. The instructions for each toolchain can be found in these links: -- `Apex installation instruction `_ -- `Compass4nfv installation instruction `_ -- `Fuel installation instruction `_ -- `Joid installation instruction `_ - +- :ref:`Apex installation instruction ` +- :ref:`Compass4nfv installation instruction ` +- :ref:`Fuel installation instruction ` +- :ref:`JOID installation instruction ` OPNFV Test Frameworks ===================== 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: - -- `Functest user guide `_ -- `Yardstick user guide `_ -- `vSwitchPerf user guide `_ -- `Software Fastpath Service Quality Metrics (SFQM) user guide `_ -- `Bottlenecks user guide `_ -- `Storage Performance Benchmarking for NFVI (StorPerf) user guide `_ - - -Security Notes -============== - -The following patches were applied to fix security issues discovered in opnfv -projects, during the c-release cycle. - -- `Removal of private keys `_ -- `Fix security issues of eval-s in testapi `_ -- `Implements use of yaml.safe_load `_ -- `Fix security issues reported by the security audit `_ -- `Fix issues found in security review `_ -- `Removing OpenSteak Project `_ -- `Remove unsed files in open-contrail role `_ -- `Get rid of private key in repo `_ -- `Handling file loads and tmp dirs differently `_ -- `Remove `Debug = True when run Flask and add logger `_ +The basic deployment validation only addresses a small part of capabilities provided 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 `