diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/installation.introduction.rst | 66 | ||||
| -rw-r--r-- | docs/release/release-notes.rst | 20 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 38 |
3 files changed, 71 insertions, 53 deletions
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index cc43aa199..cdf1479b2 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -2,19 +2,19 @@ .. 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 +.. (c) Sofia Wallin Ericsson AB and other contributors -============= +============ Installation -============= +============ Abstract ======== -This document provides an overview of the installation of the Danube release of OPNFV. +This an overview document for the installation of the Euphrates 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 +The Euphrates 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. @@ -23,7 +23,7 @@ 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 +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 @@ -45,20 +45,16 @@ 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 +To learn more about the scenarios supported in the Euphrates 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-odl-fdio-ha <os-odl-fdio-ha>` +- :ref:`os-odl-fdio-noha <os-odl-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>` +- :ref:`os-odl-bgpvpn-noha <sdnvpn-os-odl-bgpvpn-noha>` +- :ref:`os-odl-bgpvpn-ha <sdnvpn-os-odl-bgpvpn-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>` @@ -67,18 +63,36 @@ description documents provided: - :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>` - +- :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-ovs_dpdk-ha <os-odl-ovs_dpdk-ha>` +- :ref:`os-odl-ovs_dpdk-noha <os-odl-ovs_dpdk-noha>` +- :ref:`os-odl-fdio-dvr-noha <os-odl-fdio-dvr-noha>` +- :ref:`os-odl-fdio-dvr-ha <os-odl-fdio-dvr-ha>` +- :ref:`os-odl-fdio-ipv6-noha <os-odl-fdio-ipv6-noha>` +- :ref:`os-odl-fdio-ipv6-ha <os-odl-fdio-ipv6-ha>` +- :ref:`os-nosdn-fdio-ha <os-nosdn-fdio-ha>` +- :ref:`os-k8s-fdio <os-k8s-fdio>` +- :ref:`os-odl-k8s_coe-noha <os-odl-k8s_coe-noha>` +- :ref:`os-odl-k8s_coe-ha <os-odl-k8s_coe-ha>` +- :ref:`os-nosdn-kvm_ovs_dpdk-ha <os-nosdn-kvm_ovs_dpdk-ha>` +- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>` +- :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>` +- :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>` 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 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: @@ -91,10 +105,10 @@ The instructions for each toolchain can be found in these links: 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 part of capabilities provided in -the platform and you may want to execute more exhaustive tests. Some investigation will be required to +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 <testing-userguide>` diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index 2eb74d723..9e6e5c301 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -3,12 +3,12 @@ .. 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 +Release notes as provided by participating projects in OPNFV are captured in this section. +These include details of software versions used, known limitations, and outstanding trouble reports. Project release notes: @@ -18,12 +18,12 @@ Project release notes: :ref:`Armband Release Notes <armband-release-notes-label>` +:ref:`Barometer Release Notes <barometer-releasenotes>` + :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>` @@ -40,14 +40,18 @@ Project release notes: :ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>` -:ref:`Netready Release Notes <netready-releasenotes>` +:ref:`NFVBench Release Notes <nfvbench-releasenotes>` -:ref:`Opera Release Notes <opera-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 <samplenvf-releasenotes>` + :ref:`SDNVPN Release Notes <sdnvpn-releasenotes>` :ref:`SFC Release Notes <sfc-releasenotes>` diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 888392762..ef48e590c 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -2,11 +2,11 @@ .. 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) +.. (c) Sofia Wallin (sofia.wallin@ericsson.com) and other contributors -================================= +================================ User Guide & Configuration Guide -================================= +================================ Abstract ======== @@ -14,11 +14,11 @@ 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. +features designed to support these applications that are made available in the OPNFV +Euphrates 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 +upstream open source projects such as KVM, OpenDaylight, OpenStack, etc., but to highlight the features and capabilities delivered through the OPNFV project. @@ -27,43 +27,43 @@ 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. +This document intends to help users of the platform leverage the features and +capabilities delivered by OPNFV. 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. +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 +projects in the Euphrates release. Each of the participating projects provides detailed descriptions about the delivered features including use cases, -implementation and configuration specifics. +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 +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. +OPNFV wiki page at http://wiki.opnfv.org for more details. Feature Configuration Guides ============================ -- :ref:`Copper Configuration Guide <copper-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:`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>` @@ -73,13 +73,13 @@ Feature Configuration Guides Feature User Guides =================== -- :ref:`Copper User Guide <copper-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:`Netready User Guide <netready-userguide>` -- :ref:`ONOSFW User Guide <onosfw-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>` |