diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/installation.introduction.rst | 100 | ||||
| -rw-r--r-- | docs/release/overview.rst | 296 | ||||
| -rw-r--r-- | docs/release/release-notes.rst | 57 | ||||
| -rw-r--r-- | docs/release/subrelease.rst | 43 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 87 |
5 files changed, 583 insertions, 0 deletions
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst new file mode 100644 index 0000000..cc43aa1 --- /dev/null +++ b/docs/release/installation.introduction.rst @@ -0,0 +1,100 @@ +.. _opnfv-installation: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Sofia Wallin Ericsson AB + +============= +Installation +============= + +Abstract +======== + +This document provides an overview of the installation of the Danube release of OPNFV. + +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 +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, and +it is important to understand your required target platform capabilities before installing and +configuring your scenarios. + +An OPNFV installation requires either a physical infrastructure environment as defined +in the `Pharos specification <https://wiki.opnfv.org/display/pharos/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 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 Danube release refer to the scenario +description documents provided: + +- :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>` +- :ref:`os-nosdn-kvm_ovs_dpdk-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk-noha>` +- :ref:`os-nosdn-kvm_ovs_dpdk_bar-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk_bar-noha>` +- :ref:`os-odl_l3-fdio-noha <os-odl_l3-fdio-noha>` +- :ref:`os-odl_l2-fdio-ha <os-odl_l2-fdio-ha>` +- :ref:`os-odl_l2-fdio-noha <os-odl_l2-fdio-noha>` +- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>` +- :ref:`os-odl_l2-bgpvpn-noha <sdnvpn-os-odl_l2-bgpvpn-noha>` +- :ref:`os-odl_l2-bgpvpn-ha <sdnvpn-os-odl_l2-bgpvpn-ha>` +- :ref:`os-odl-gluon-noha <gluon-scenario>` +- :ref:`os-nosdn-openo-ha <opera-os-nosdn-openo-ha>` +- `os-odl_l2-sfc-ha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-ha/index.html>`_ +- `os-odl_l2-sfc-noha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-noha/index.html>`_ +- :ref:`os-nosdn-lxd-ha <os-nosdn-lxd-ha>` +- :ref:`os-nosdn-lxd-noha <os-nosdn-lxd-noha>` +- :ref:`k8-nosdn-nofeature-noha <k8-nosdn-nofeature-noha>` +- :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>` +- `os-nosdn-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-nosdn-ovs-ha/index.html>`_ +- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha>` +- :ref:`os-nosdn-ovs <os-nosdn-ovs>` +- `os-odl_l3-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-odl_l3-ovs-ha/index.html>`_ +- :ref:`os-odl_l3-ovs-noha <os-odl_l3-ovs-noha>` +- :ref:`os-odl_l3-fdio-ha <os-odl_l3-fdio-ha>` + + +Installation Procedure +====================== + +Detailed step by step instructions for working with an installation toolchain and installing +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: + +- :ref:`Apex installation instruction <apex-installation>` +- :ref:`Compass4nfv installation instruction <compass4nfv-installation>` +- :ref:`Daisy installation instruction <daisy-installation>` +- :ref:`Fuel installation instruction <fuel-installation>` +- :ref:`JOID installation instruction <joid-installation>` + +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 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 <testing-userguide>` diff --git a/docs/release/overview.rst b/docs/release/overview.rst new file mode 100644 index 0000000..7e1d136 --- /dev/null +++ b/docs/release/overview.rst @@ -0,0 +1,296 @@ +.. _opnfv-overview: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +================ +Platform overview +================ + +Introduction +============ + +Network Functions Virtualization (NFV) is transforming the networking industry via +software-defined infrastructures and open source is the proven method for quickly developing +software for commercial products and services that can move markets. +Open Platform for NFV (OPNFV) facilitates the development and evolution of NFV +components across various open source ecosystems. Through system level integration, +deployment and testing, OPNFV constructs a reference NFV platform to accelerate the +transformation of enterprise and service provider networks. +As an open source project, OPNFV is uniquely positioned to bring together the work +of standards bodies, open source communities, service providers and commercial suppliers to deliver +a de facto NFV platform for the industry. + +By integrating components from upstream projects, the community is able to conduct performance +and use case-based testing on a variety of solutions to ensure the platform’s suitability for +NFV use cases. OPNFV also works upstream with other open source communities to bring contributions +and learnings from its work directly to those communities in the form of blueprints, patches, bugs, +and new code. + +OPNFV initially focused on building NFV Infrastructure (NFVI) and Virtualised Infrastructure +Management (VIM) by integrating components from upstream projects such as OpenDaylight, +OpenStack, Ceph Storage, KVM, Open vSwitch, and Linux. +More recently, OPNFV has extended its portfolio of forwarding solutions to include fd.io and ODP, +is able to run on both Intel and ARM commercial and white-box hardware, support VM, Container and +BareMetal workloads, and includes Management and Network Orchestration MANO components primarily +for application composition and management in the Danube release. + +These capabilities, along with application programmable interfaces (APIs) to other NFV +elements, form the basic infrastructure required for Virtualized Network Functions (VNF) +and MANO components. + +Concentrating on these components while also considering proposed projects on additional +topics (such as the MANO components and applications themselves), OPNFV aims to enhance +NFV services by increasing performance and power efficiency improving reliability, +availability and serviceability, and delivering comprehensive platform instrumentation. + + +OPNFV Platform Architecture +=========================== + +The OPNFV project addresses a number of aspects in the development of a consistent virtualisation +platform including common hardware requirements, software architecture, MANO and applications. + + +OPNFV Platform Overview Diagram + +.. image:: ../images/opnfvplatformgraphic.png + :alt: Overview infographic of the opnfv platform and projects. + + +To address these areas effectively, the OPNFV platform architecture can be decomposed +into the following basic building blocks: + +* Hardware: with the Infra working group, Pharos project and associated activities +* Software Platform: through the platform integration and deployment projects +* MANO: through the MANO working group and associated projects +* Applications: which affect all other areas and drive requirements for OPNFV + +OPNFV Lab Infrastructure +======================== + +The infrastructure working group oversees such topics as lab management, workflow, +definitions, metrics and tools for OPNFV infrastructure. + +Fundamental to the WG is the +`Pharos Specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_ +which provides a set of defined lab infrastructures over a geographically and technically +diverse federated global OPNFV lab. + +Labs may instantiate bare-metal and virtual environments that are accessed remotely by the +community and used for OPNFV platform and feature development, build, deploy and testing. +No two labs are the same and the heterogeneity of the Pharos environment provides the ideal +platform for establishing hardware and software abstractions providing well understood +performance characteristics. + +Community labs are hosted by OPNFV member companies on a voluntary basis. +The Linux Foundation also hosts an OPNFV lab that provides centralized CI +and other production resources which are linked to community labs. +Future lab capabilities will include the ability easily automate deploy and test of any +OPNFV install scenario in any lab environment as well as on a nested "lab as a service" +virtual infrastructure. + +OPNFV Software Platform Architecture +==================================== + +The OPNFV software platform is comprised exclusively of open source implementations of +platform component pieces. OPNFV is able to draw from the rich ecosystem of NFV related +technologies available in open-source then integrate, test, measure and improve these +components in conjunction with our source communities. + +While the composition of the OPNFV software platform is highly complex and constituted of many +projects and components, a subset of these projects gain the most attention from the OPNFV community +to drive the development of new technologies and capabilities. + +--------------------------------- +Virtual Infrastructure Management +--------------------------------- + +OPNFV derives it's virtual infrastructure management from one of our largest upstream ecosystems +OpenStack. OpenStack provides a complete reference cloud management system and associated technologies. +While the OpenStack community sustains a broad set of projects, not all technologies are relevant in +an NFV domain, the OPNFV community consumes a sub-set of OpenStack projects where the usage and +composition may vary depending on the installer and scenario. + +For details on the scenarios available in OPNFV and the specific composition of components +refer to the :ref:`OPNFV User Guide & Configuration Guide <opnfv-user-config>` + +----------------- +Operating Systems +----------------- + +OPNFV currently uses Linux on all target machines, this can include Ubuntu, Centos or SUSE linux. The +specific version of Linux used for any deployment is documented in the installation guide. + +----------------------- +Networking Technologies +----------------------- + +SDN Controllers +--------------- + +OPNFV, as an NFV focused project, has a significant investment on networking technologies +and provides a broad variety of integrated open source reference solutions. The diversity +of controllers able to be used in OPNFV is supported by a similarly diverse set of +forwarding technologies. + +There are many SDN controllers available today relevant to virtual environments +where the OPNFV community supports and contributes to a number of these. The controllers +being worked on by the community during this release of OPNFV include: + +* Neutron: an OpenStack project to provide “network connectivity as a service” between + interface devices (e.g., vNICs) managed by other OpenStack services (e.g., nova). +* OpenDaylight: addresses multivendor, traditional and greenfield networks, establishing the + industry’s de facto SDN platform and providing the foundation for networks of the future. +* ONOS: a carrier-grade SDN network operating system designed for high availability, + performance, scale-out. + +.. OpenContrail SDN controller is planned to be supported in the next release. + +Data Plane +---------- + +OPNFV extends Linux virtual networking capabilities by using virtual switching +and routing components. The OPNFV community proactively engages with these source +communities to address performance, scale and resiliency needs apparent in carrier +networks. + +* FD.io (Fast data - Input/Output): a collection of several projects and libraries to + amplify the transformation that began with Data Plane Development Kit (DPDK) to support + flexible, programmable and composable services on a generic hardware platform. +* Open vSwitch: a production quality, multilayer virtual switch designed to enable + massive network automation through programmatic extension, while still supporting standard + management interfaces and protocols. + +Deployment Architecture +======================= + +A typical OPNFV deployment starts with three controller nodes running in a high availability +configuration including control plane components from OpenStack, SDN, etc. and a minimum +of two compute nodes for deployment of workloads (VNFs). +A detailed description of the hardware requirements required to support the 5 node configuration +can be found in pharos specification: `Pharos Project <https://www.opnfv.org/developers/pharos>`_ + +In addition to the deployment on a highly available physical infrastructure, OPNFV can be +deployed for development and lab purposes in a virtual environment. In this case each of the hosts +is provided by a virtual machine and allows control and workload placement using nested virtualization. + +The initial deployment is done using a staging server, referred to as the "jumphost". +This server-either physical or virtual-is first installed with the installation program +that then installs OpenStack and other components on the controller nodes and compute nodes. +See the :ref:`OPNFV User Guide & Configuration Guide <opnfv-user-config>` for more details. + + +The OPNFV Testing Ecosystem +=========================== + +The OPNFV community has set out to address the needs of virtualization in the carrier +network and as such platform validation and measurements are a cornerstone to the +iterative releases and objectives. + +To simplify the complex task of feature, component and platform validation and characterization +the testing community has established a fully automated method for addressing all key areas of +platform validation. This required the integration of a variety of testing frameworks in our CI +systems, real time and automated analysis of results, storage and publication of key facts for +each run as shown in the following diagram. + +.. image:: ../images/OPNFV_testing_working_group.png + :alt: Overview infographic of the OPNFV testing Ecosystem + +Release Verification +==================== + +The OPNFV community relies on its testing community to establish release criteria for each OPNFV +release. Each release cycle the testing criteria become more stringent and better representative +of our feature and resiliency requirements. + + +As each OPNFV release establishes a set of deployment scenarios to validate, the testing +infrastructure and test suites need to accommodate these features and capabilities. It’s not +only in the validation of the scenarios themselves where complexity increases, there are test +cases that require multiple datacenters to execute when evaluating features, including multisite +and distributed datacenter solutions. + +The release criteria as established by the testing teams include passing a set of test cases +derived from the functional testing project ‘functest,’ a set of test cases derived from our +platform system and performance test project ‘yardstick,’ and a selection of test cases for +feature capabilities derived from other test projects such as bottlenecks, vsperf, cperf and +storperf. The scenario needs to be able to be deployed, pass these tests, and be removed from +the infrastructure iteratively (no less that 4 times) in order to fulfil the release criteria. + +-------- +Functest +-------- + +Functest provides a functional testing framework incorporating a number of test suites +and test cases that test and verify OPNFV platform functionality. +The scope of Functest and relevant test cases can be found in the :ref:`Functest User Guide <functest-userguide>` + +Functest provides both feature project and component test suite integration, leveraging +OpenStack and SDN controllers testing frameworks to verify the key components of the OPNFV +platform are running successfully. + +--------- +Yardstick +--------- + +Yardstick is a testing project for verifying the infrastructure compliance when running VNF applications. +Yardstick benchmarks a number of characteristics and performance vectors on the infrastructure making it +a valuable pre-deployment NFVI testing tools. + +Yardstick provides a flexible testing framework for launching other OPNFV testing projects. + +There are two types of test cases in Yardstick: + +* Yardstick generic test cases and OPNFV feature test cases; + including basic characteristics benchmarking in compute/storage/network area. +* OPNFV feature test cases include basic telecom feature testing from OPNFV projects; + for example nfv-kvm, sfc, ipv6, Parser, Availability and SDN VPN + +System Evaluation and compliance testing +======================================== + +The OPNFV community is developing a set of test suites intended to evaluate a set of reference +behaviors and capabilities for NFV systems developed externally from the OPNFV ecosystem to +evaluate and measure their ability to provide the features and capabilities developed in the +OPNFV ecosystem. + +The Dovetail project will provide a test framework and methodology able to be used on any NFV platform, +including an agreed set of test cases establishing an evaluation criteria for exercising +an OPNFV compatible system. The Dovetail project has begun establishing the test framework +and will provide a preliminary methodology for the Danube release. Work will continue to +develop these test cases to establish a stand alone compliance evaluation solution +in future releases. + +Additional Testing +================== + +Besides the test suites and cases for release verification, additional testing is performed to validate +specific features or characteristics of the OPNFV platform. +These testing framework and test cases may include some specific needs; such as extended measurements, +additional testing stimuli, or tests simulating environmental disturbances or failures. + +These additional testing activities provide a more complete evaluation of the OPNFV platform. +Some of the projects focused on these testing areas include: + +------ +VSPERF +------ + +VSPERF provides an automated test-framework and comprehensive test suite for measuring data-plane +performance of the NFVI including switching technology, physical and virtual network interfaces. +The provided test cases with network topologies can be customized while also allowing individual +versions of Operating System, vSwitch and hypervisor to be specified. + +----------- +Bottlenecks +----------- + +Bottlenecks provides a framework to find system limitations and bottlenecks, providing +root cause isolation capabilities to facilitate system evaluation. + + +.. _`OPNFV Configuration Guide`: `OPNFV User Guide & Configuration Guide` +.. _`OPNFV User Guide`: `OPNFV User Guide & Configuration Guide` +.. _`Dovetail project`: https://wiki.opnfv.org/display/dovetail diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst new file mode 100644 index 0000000..2eb74d7 --- /dev/null +++ b/docs/release/release-notes.rst @@ -0,0 +1,57 @@ +.. _opnfv-releasenotes: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +============== +Release Notes +============== + +Release notes as provided by the OPNFV participating documents are captured in this section. +These include details of software versions used, known limitations and outstanding trouble +reports. + +Project release notes: +---------------------- + +:ref:`Apex Release Notes <apex-releasenotes>` + +:ref:`Armband Release Notes <armband-release-notes-label>` + +:ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>` + +:ref:`Compass4nfv Release Notes <compass4nfv-releasenotes>` + +:ref:`Copper Release Notes <copper-releasenotes>` + +:ref:`Daisy Release Notes <daisy-releasenotes>` + +:ref:`Doctor Release Notes <doctor-releasenotes>` + +:ref:`FDS Release Notes <fds-releasenotes>` + +:ref:`Fuel Release Notes <fuel-releasenotes>` + +:ref:`Functest Release Notes <functest-releasenotes>` + +:ref:`IPV6 Release Notes <ipv6-releasenotes>` + +:ref:`Joid Release Notes <joid-releasenotes>` + +:ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>` + +:ref:`Netready Release Notes <netready-releasenotes>` + +:ref:`Opera Release Notes <opera-releasenotes>` + +:ref:`Parser Release Notes <parser-releasenotes>` + +:ref:`QTIP Release Notes <qtip-releasenotes>` + +:ref:`SDNVPN Release Notes <sdnvpn-releasenotes>` + +:ref:`SFC Release Notes <sfc-releasenotes>` + +:ref:`VSPERF Release Notes <vswitchperf-releasenotes>` + +:ref:`Yardstick Release Notes <yardstick-releasenotes>` diff --git a/docs/release/subrelease.rst b/docs/release/subrelease.rst new file mode 100644 index 0000000..075fcbd --- /dev/null +++ b/docs/release/subrelease.rst @@ -0,0 +1,43 @@ +================== +Subrelease Guides +================== + +Apex +----- +.. toctree:: + :maxdepth: 1 + + ../submodules/apex/docs/releasenotes/index + ../submodules/apex/docs/installationprocedure/index + +Compass +-------- +.. toctree:: + :maxdepth: 1 + + ../submodules/compass4nfv/docs/releasenotes/index + ../submodules/compass4nfv/docs/installationprocedure/index + +Daisy +------- +.. toctree:: + :maxdepth: 1 + + ../submodules/daisy/docs/release/release-notes/index + ../submodules/daisy/docs/release/installation/index + +Fuel +----- +.. toctree:: + :maxdepth: 1 + + ../submodules/fuel/docs/releasenotes/index + ../submodules/fuel/docs/installationprocedure/index + +Joid +----- +.. toctree:: + :maxdepth: 1 + + ../submodules/joid/docs/releasenotes/index + ../submodules/joid/docs/installationprocedure/index diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst new file mode 100644 index 0000000..8883927 --- /dev/null +++ b/docs/release/userguide.introduction.rst @@ -0,0 +1,87 @@ +.. _opnfv-user-config: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Sofia Wallin (sofia.wallin@ericssion.com) + +================================= +User Guide & Configuration Guide +================================= + +Abstract +======== + +OPNFV is a collaborative project aimed at providing a variety of virtualisation +deployments intended to host applications serving the networking and carrier +industries. This document provides guidance and instructions for using platform +features designed to support these applications, made available in the OPNFV +Danube release. + +This document is not intended to replace or replicate documentation from other +upstream open source projects such as KVM, OpenDaylight, or OpenStack, but to highlight the +features and capabilities delivered through the OPNFV project. + + +Introduction +============ + +OPNFV provides a suite of scenarios, infrastructure deployment options, which +are able to be installed to host virtualised network functions (VNFs). +This Guide intends to help users of the platform leverage the features and +capabilities delivered by the OPNFV project. + +OPNFVs' Continuous Integration builds, deploys and tests combinations of virtual +infrastructure components in what are defined as scenarios. A scenario may +include components such as KVM, OpenDaylight, OpenStack, OVS, etc., where each +scenario will include different source components or configurations. Scenarios +are designed to enable specific features and capabilities in the platform that +can be leveraged by the OPNFV User community. + + +Feature Overview +================ + +The following links outline the feature deliverables from participating OPNFV +projects in the Danube release. Each of the participating projects provides +detailed descriptions about the delivered features including use cases, +implementation and configuration specifics. + +The following Configuration Guides and User Guides assume that the reader already has some +information about a given project's specifics and deliverables. These Guides +are intended to be used following the installation with an OPNFV installer +to allow users to deploy and implement feature delivered by OPNFV. + +If you are unsure about the specifics of a given project, please refer to the +OPNFV wiki page at http://wiki.opnfv.org, for more details. + + +Feature Configuration Guides +============================ + +- :ref:`Copper Configuration Guide <copper-configguide>` +- :ref:`Doctor Configuration Guide <doctor-configguide>` +- :ref:`IPv6 Configuration Guide <ipv6-configguide>` +- :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>` +- :ref:`Netready Configuration Guide <netready-configguide>` +- :ref:`ONOSFW Configuration Guide <onosfw-configguide>` +- :ref:`Parser Configuration Guide <parser-configguide>` +- :ref:`Promise Configuration Guide <promise-configguide>` +- :ref:`SDNVPN Configuration Guide <sdnvpn-configguide>` +- :ref:`SFC Configuration Guide <sfc-configguide>` + + +Feature User Guides +=================== + +- :ref:`Copper User Guide <copper-userguide>` +- :ref:`Doctor User Guide <doctor-userguide>` +- :ref:`Domino User Guide <domino-userguide>` +- :ref:`IPv6 User Guide <ipv6-userguide>` +- :ref:`KVMforNFV User Guide <kvmfornfv-userguide>` +- :ref:`Netready User Guide <netready-userguide>` +- :ref:`ONOSFW User Guide <onosfw-userguide>` +- :ref:`Parser User Guide <parser-userguide>` +- :ref:`Promise User Guide <promise-userguide>` +- :ref:`SDNVPN User Guide <sdnvpn-userguide>` +- :ref:`SFC User Guide <sfc-userguide>` + |