diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/installation.introduction.rst | 107 | ||||
| -rw-r--r-- | docs/release/overview.rst | 76 | ||||
| -rw-r--r-- | docs/release/release-notes.rst | 49 | ||||
| -rw-r--r-- | docs/release/subrelease.rst | 40 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 110 |
5 files changed, 94 insertions, 288 deletions
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 33955f59a..22ccd55b3 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -2,100 +2,37 @@ .. 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 and other contributors +.. (c) Anuket CCC, AT&T, and other contributors -============ -Installation -============ +========================= +Installation Introduction +========================= -Abstract -======== +This is the collection of installation documents for Anuket. Use this document for further reference. -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. - - -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. +Anuket specifications +===================== -To learn more about the scenarios supported in the Fraser release refer to the scenario -description documents provided: +It is recommended to use the online version of the :doc:`Anuket Specifications <cntt:index>`. -- :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>` -- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>` -- `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>` -- :ref:`os-nosdn-ovs-ha <os-nosdn-ovs-ha1>` -- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha1>` -- :ref:`os-nosdn-calipso-noha <os-nosdn-calipso-noha>` -- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>` -- :ref:`os-nosdn-ovs_dpdk-noha <os-nosdn-ovs_dpdk-noha>` -- :ref:`os-odl-fdio-dvr-noha <os-odl-fdio-dvr-noha>` -- :ref:`os-nosdn-fdio-ha <os-nosdn-fdio-ha>` -- :ref:`os-nosdn-kvm_ovs_dpdk-ha <os-nosdn-kvm_ovs_dpdk-ha>` -- :ref:`os-odl_l2-moon-ha <os-odl_l2-moon-ha>` -- :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>` -- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>` -- :ref:`os-onos-sfc-ha <os-onos-sfc-ha>` -- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>` -- :ref:`os-nosdn-openbaton-ha <os-nosdn-openbaton-ha>` -- :ref:`k8-ovn-lb-noha <k8-ovn-lb-noha>` -- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>` -- :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>` +Implementation projects +======================= -Installation Procedure -====================== +- :ref:`Barometer Installation Guide <barometer-docker-userguide>` -Detailed step by step instructions for working with an installation toolchain and installing -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. +Testing projects and frameworks +=============================== -The instructions for each toolchain can be found in these links: +- :ref:`ViNePERF installation Guide <vineperf-installation>` +- :doc:`Functest Installation Guide <functest:testing/user/configguide/index>` -- :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>` +Testing can be started after the installation of the test frameworks. The basic deployment validation only addresses +some of the generic capabilities of cloud infrastructures. To run more exhaustive tests, some investigation is +required to select the right test suites to run. -OPNFV Test Frameworks -===================== +For more instructions on using the Anuket testing projects after installation, see :ref:`this document <testing-userguide>`. -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 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. +Integration projects +==================== -Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>` +- :ref:`Kuberef Installation Guide <kuberef-installation>` diff --git a/docs/release/overview.rst b/docs/release/overview.rst index c7614de5c..6dd65cc79 100644 --- a/docs/release/overview.rst +++ b/docs/release/overview.rst @@ -4,6 +4,8 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors +NOTE: This Document will be updated for Anuket in the Lakelse Release. + ================= Platform overview ================= @@ -28,20 +30,16 @@ NFV use cases. OPNFV also works upstream with other open source communities to b and learnings from its work directly to those communities in the form of blueprints, patches, bugs, and new code. -OPNFV focuses on building NFV Infrastructure (NFVI) and Virtualised Infrastructure -Management (VIM) by integrating components from upstream projects such as OpenDaylight, ONOS, OpenContrail, -OVN, OpenStack, Kubernetes, Ceph Storage, KVM, Open vSwitch, and Linux. -More recently, OPNFV has extended its portfolio of forwarding solutions to include DPDK, 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. +OPNFV focuses on building NFV Infrastructure (NFVI) and Virtualized Infrastructure Management (VIM) by +integrating components from upstream projects such as OpenDaylight, OVN, OpenStack, Kubernetes, +Ceph Storage, KVM, Open vSwitch, Linux, DPDK and FD.io. OPNFV- is able to run on both Intel and +ARM commercial and white-box hardware, support VM, Container and BareMetal workloads. 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 +Concentrating on these components, OPNFV aims to enhance NFV services by increasing performance and power efficiency improving reliability, availability and serviceability, and delivering comprehensive platform instrumentation. @@ -55,7 +53,7 @@ platform including common hardware requirements, software architecture, MANO and OPNFV Platform Overview Diagram -.. image:: ../images/diagram_euphrates.png +.. image:: ../images/hunter.png :alt: Overview infographic of the opnfv platform and projects. @@ -64,7 +62,6 @@ into the following basic building blocks: * Hardware: Infrastructure working group, Pharos project and associated activities * Software Platform: Platform integration and deployment projects -* MANO: MANO working group and associated projects * Tooling and testing: Testing working group and test projects * Applications: All other areas and drive requirements for OPNFV @@ -75,7 +72,7 @@ The infrastructure working group oversees such topics as lab management, workflo definitions, metrics and tools for OPNFV infrastructure. Fundamental to the WG is the -`Pharos Specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_ +`Pharos Specification <http://artifacts.opnfv.org/pharos/docs/pharos-spec.html>`_ which provides a set of defined lab infrastructures over a geographically and technically diverse federated global OPNFV lab. @@ -88,9 +85,10 @@ 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. + +The Lab-as-a-service (LaaS) offering provides developers to readily access NFV infrastructure on demand. +Ongoing lab capabilities will include the ability to easily automate deployment and test of any OPNFV install +scenario in any lab environment using a concept called “Dynamic CI”. OPNFV Software Platform Architecture ==================================== @@ -104,22 +102,21 @@ components in conjunction with our upstream communities. 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 -the NFV domain, the OPNFV community consumes a sub-set of OpenStack projects and the usage and -composition may vary depending on the installer and scenario. +OPNFV derives its Virtual Infrastructure Management from OpenStack and Kubernetes. 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 the NFV domain, the OPNFV community +consumes a sub-set of OpenStack projects and the usage and composition may vary depending on the installer and scenario. +Additionally, OPNFV also uses Kubernetes, the popular Container Orchestration Engine. Kubernetes is intended to be a VIM for +Cloud Native Network Functions (CNFs). 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>`. -OPNFV now also has initial support for containerized VNFs. - ----------------- Operating Systems ----------------- -OPNFV currently uses Linux on all target machines, this can include Ubuntu, Centos or SUSE Linux. The +OPNFV currently uses Linux on all target machines. The specific version of Linux used for any deployment is documented in the installation guide. Networking Technologies @@ -141,10 +138,8 @@ being worked on by the community during this release of OPNFV include: 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. -* OpenContrail: An open source SDN controller designed for cloud and NFV use cases. It has an - analytics engine, well defined northbound REST APIs to configure and gather ops/analytics data. -* OVN: A virtual networking solution developed by the same team that created OVS. OVN stands for - Open Virtual Networking and is dissimilar from the above projects in that it focuses only on overlay networks. +* OVN: a distributed control-plane on top of the popular Open vSwitch (OVS) offers network virtualization + services. ---------- Data Plane @@ -162,16 +157,6 @@ networks. * DPDK: a set of libraries that bypass the kernel and provide polling mechanisms, instead of interrupt based operations, to speed up packet processing. DPDK works with both OVS and FD.io. ----- -MANO ----- -OPNFV integrates open source MANO projects for NFV orchestration and VNF management. -New MANO projects are constantly being added, currently OPNFV integrates: -* OpenBaton: Open Baton is a ETSI NFV compliant Management and Orchestration (MANO) Framework. - It enables virtual Network Services deployments on top of heterogeneous NFV Infrastructures. - OpenBaton is also used to deploy vIMS (clearwater and openIMS). - - Deployment Architecture ======================= @@ -249,6 +234,9 @@ There are two types of test cases in Yardstick: * OPNFV feature test cases include basic telecom feature testing from OPNFV projects; for example nfv-kvm, sfc, ipv6, Parser, Availability and SDN VPN +With the addition of the Network Service Benchmarking (NSB) initiative, it is possible to use Yardstick NSB +for benchmarking the performance of VNFs and Network Services. + System Evaluation and compliance testing ======================================== @@ -257,12 +245,9 @@ behaviors and capabilities for NFV systems developed externally from the OPNFV e 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, +The Dovetail project provides 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. +an OPNFV compatible system. Additional Testing ================== @@ -287,13 +272,6 @@ NFVBench NFVbench is a lightweight end-to-end dataplane benchmarking framework project. It includes traffic generator(s) and measures a number of packet performance related metrics. ----- -QTIP ----- -QTIP boils down NFVI compute and storage performance into one single metric for easy comparison. -QTIP crunches these numbers based on five different categories of compute metrics and relies on -Storperf for storage metrics. - -------- Storperf -------- diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index 8aad8a4d6..9f7f08061 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -2,64 +2,25 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) Anuket CCC, AT&T, and other contributors ============= Release Notes ============= -Release notes as provided by participating projects in OPNFV are captured in this section. +Release notes as provided by participating projects in Anuket 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:`Auto Release Notes <auto-releasenotes>` - :ref:`Barometer Release Notes <barometer-releasenotes>` -:ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>` - -:ref:`Compass4nfv Release Notes <compass4nfv-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:`CIRV-SDV Release Notes <cirv-sdv-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:`Moon Release Notes <moon-releasenotes>` - -:ref:`Netready Release Notes <netready-releasenotes>` - -:ref:`NFVBench Release Notes <nfvbench-releasenotes>` - -:ref:`Orchestra Release Notes <orchestra-releasenotes>` - -:ref:`Parser Release Notes <parser-releasenotes>` - -:ref:`Promise Release Notes <promise-releasenotes>` - -:ref:`QTIP Release Notes <qtip-releasenotes>` - -:ref:`SampleVNF Release Notes <samplevnf-releasenotes>` - -:ref:`SDNVPN Release Notes <sdnvpn-releasenotes>` - -:ref:`SFC Release Notes <sfc-releasenotes>` - -:ref:`VSPERF Release Notes <vswitchperf-releasenotes>` +:ref:`Kuberef Release Notes <kuberef-releasenotes>` -:ref:`Yardstick Release Notes <yardstick-releasenotes>` +:ref:`ViNePERF Release Notes <vineperf-releasenotes>` diff --git a/docs/release/subrelease.rst b/docs/release/subrelease.rst index 075fcbde1..e39b6ca79 100644 --- a/docs/release/subrelease.rst +++ b/docs/release/subrelease.rst @@ -2,42 +2,4 @@ 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 +None. diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 3b747e61e..827d2c7b8 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -2,91 +2,59 @@ .. 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@ericsson.com) and other contributors +.. (c) Anuket CCC, AT&T, and other contributors ================================ -User Guide & Configuration Guide +User Guide and 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 that are made available in the OPNFV -Fraser release. - -This document is not intended to replace or replicate documentation from other -upstream open source projects such as KVM, OpenDaylight, OpenStack, etc., but to highlight the -features and capabilities delivered through the OPNFV project. +One of Anuket's project goals is to reduce time to integrate and deploy cloud infrastructures and onboard VNF/CNFs for +those who supply components and those who operationalize these platforms. The Anuket community does this by +implementing, testing and deploying tools for conformance and performance of cloud infrastructures, aligned with +industry reference architectures. This document provides guidance and instructions for using platform features designed +to support the tools that are made available in the Anuket project. +This document is not intended to replace or replicate documentation from other upstream open source projects such as +KVM, OpenDaylight, OpenStack, etc., but to highlight the features and capabilities delivered through the Anuket project. Introduction ============ -OPNFV provides a suite of scenarios, infrastructure deployment options, which -are able to be installed to host virtualised network functions (VNFs). -This document intends to help users of the platform leverage the features and -capabilities delivered by OPNFV. +Anuket provides infrastructure deployment options, which are able to be installed to host virtualised network functions +(VNFs) and cloud native network functions (CNFs). This document intends to help users leverage the features and +capabilities delivered by Anuket. + +Feature overview +================ -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. +The following links outline the feature deliverables from Anuket sub-projects. Each of the sub-projects provide detailed +descriptions about the features delivered including use cases, implementation, and configuration specifics in the +sub-project documentation. +The following Configuration Guides and User Guides assume that the reader already has some knowledge about a given +sub-project's specifics and capabilities. These Guides are intended to allow users to deploy and implement features that +are part of the Anuket release. -Feature Overview -================ +The `Anuket developer wiki <http://wiki.anuket.io>`_ might contain more details about the specific projects. + +Configuration guides +==================== + +* :ref:`Barometer Configuration Guide <barometer-configguide>` +* :ref:`CIRV-SDV Configuration Guide <cirv-sdv-configguide>` +* :ref:`Kuberef Configuration Guide <kuberef-configguide>` +* :doc:`ViNePERF Configuration Guide <vineperf:testing/user/configguide/index>` +* :doc:`Functest Configuration Guide <functest:testing/user/configguide/index>` + +User guides +=========== -The following links outline the feature deliverables from participating OPNFV -projects in the Fraser 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 -knowledge 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:`Auto Configuration Guide <auto-configguide>` -- :ref:`Barometer Configuration Guide <barometer-configguide>` -- :ref:`Doctor Configuration Guide <doctor-configguide>` -- :ref:`Domino Configuration Guide <domino-configguide>` -- :ref:`IPv6 Configuration Guide <ipv6-configguide>` -- :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>` -- :ref:`Moon Configuration Guide <moon-configguide>` -- :ref:`Netready Configuration Guide <netready-configguide>` -- :ref:`ONOSFW Configuration Guide <onosfw-configguide>` -- :ref:`Orchestra Configuration Guide <orchestra-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:`Auto User Guide <auto-userguide>` -- :ref:`Barometer User Guide <barometer-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:`OpenContrail Virtual Networking User Guide <ovno-userguide>` -- :ref:`Orchestra User Guide <orchestra-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>` +* :ref:`Barometer User Guide <barometer-userguide>` +* :ref:`CIRV-SDV User Guide <cirv-sdv-userguide>` +* :ref:`Kuberef User Guide <kuberef-userguide>` +* :doc:`ViNePerf Configuration and User Guide <vineperf:testing/user/configguide/index>` +* :doc:`Functest User Guide <functest:testing/user/userguide/index>` |