X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Finstallation.introduction.rst;h=a89bd3fb93cc1e297ced75c95dc8a94e1c32c58f;hb=cd1c8d7ce7fb499ed7798bb76098131c15408165;hp=201112cadce42d205eea8309cfc2bc920f748127;hpb=d438301ca7244e66d5082312e3e84fcfb219f11b;p=opnfvdocs.git diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 201112cad..a89bd3fb9 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -1,104 +1,94 @@ +.. _opnfv-installation: + .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - .. (c) Sofia Wallin Ericsson AB +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Sofia Wallin Ericsson AB and other contributors + +============ +Installation +============ -======== Abstract ======== -The following document provides an overview of the instructions required for the installation -of the Colorado release of OPNFV. +This an overview document for the installation of the Fraser release of OPNFV. + +The Fraser release can be installed making use of any of the installer projects in OPNFV: +Apex, Compass4Nfv, Daisy4NFV, 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. -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. -============ Introduction ============ -The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical -infrastructure. A composition of components, tools and configurations is identified in OPNFV as a +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. -========= + 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 Fraser 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:`k8-nosdn-lb-noha ` +- :ref:`k8-ovn-lb-noha ` +- :ref:`k8-nosdn-lb_ceph-noha ` +- :ref:`k8-canal-lb-noha ` +- :ref:`os-nosdn-ovs-noha ` +- :ref:`os-nosdn-ovs-ha ` +- :ref:`os-nosdn-bar-ha ` +- :ref:`os-nosdn-bar-noha ` +- :ref:`k8-nosdn-stor4nfv-ha ` +- :ref:`os-nosdn-bar-ha ` +- :ref:`os-nosdn-bar-noha ` +- :ref:`os-nosdn-ovs-noha ` +- :ref:`os-nosdn-ovs-ha ` +- :ref:`os-odl-sfc-ha ` +- :ref:`os-odl-sfc-noha ` +- :ref:`os-odl-bgpvpn-noha ` +- :ref:`os-odl-bgpvpn-ha ` + 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 projects providing installation +support for the OPNFV Euphrates release are: Apex, Compass4nfv, Daisy4NFV, 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:`Daisy 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 +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 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 `