diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/index.rst | 208 | ||||
| -rw-r--r-- | docs/release/installation.introduction.rst | 43 | ||||
| -rw-r--r-- | docs/release/overview.rst | 24 | ||||
| -rw-r--r-- | docs/release/release-notes.rst | 99 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 13 |
5 files changed, 40 insertions, 347 deletions
diff --git a/docs/release/index.rst b/docs/release/index.rst deleted file mode 100644 index 6f3ee54b8..000000000 --- a/docs/release/index.rst +++ /dev/null @@ -1,208 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Open Platform for NFV Project, Inc. and its contributors - -******************* -OPNFV Documentation -******************* - -============================== -Colorado Release Documentation -============================== - -OPNFV release documentation is structured with brief platform-level documents referencing -more detailed installation instructions and descriptive documentation. - -Platform documentation -====================== - -* `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/overview/index.html>`_ -* `OPNFV Installation instruction <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/installationprocedure/index.html>`_ -* `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/userguide/index.html>`_ - -Installation instructions -========================= - -* `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/2.0/docs/installationprocedure/index.html>`_ -* `Apex release notes <http://artifacts.opnfv.org/apex/colorado/2.0/docs/releasenotes/index.html>`_ -* `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/installationprocedure/index.html>`_ -* `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/releasenotes/index.html>`_ -* `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installationprocedure/index.html>`_ -* `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/releasenotes/index.html>`_ -* `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/2.0/docs/installationprocedure/index.html>`_ -* `Joid release notes <http://artifacts.opnfv.org/joid/colorado/2.0/docs/releasenotes/index.html>`_ - -Feature project documentation -============================= - ---------------- -ARMband project ---------------- - -* `Installation instruction <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/armband/colorado/2.0/docs/releasenotes/index.html>`_ - ----------------------------------------------- -Copper release documentation ----------------------------------------------- - -* `Design documentation <http://artifacts.opnfv.org/copper/colorado/2.0/docs/design/index.html>`_ -* `Installation instruction <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_ -* `User guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/copper/colorado/2.0/docs/releasenotes/index.html>`_ - ------------------------------------------------------ -Doctor features and capabilities ------------------------------------------------------ - -* `Project overview <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/scenarios/index.html>`_ -* `User guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/releasenotes/index.html>`_ - ----------------------------------------------------------------- -Domino features and capabilities ----------------------------------------------------------------- - -* `User guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_ - -------------------------------------------------- -FastDataStacks feature and scenario documentation -------------------------------------------------- - -* `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/2.0/scenarios_os-odl_l2-fdio-noha/index.html>`_ - ------------------------------------- -IPv6 platform support and capability ------------------------------------- - -* `Configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_ -* `User guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_ - ------------ -KVM for NFV ------------ - -* `Installation instruction <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_ -* `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/configurationguide/index.html>`_ -* `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/releasenotes/index.html>`_ - --------------------------------- -MOON security management for NFV --------------------------------- - -* `Project and Scenario overview <http://artifacts.opnfv.org/moon/colorado/docs/scenarios_os-odl_l2-moon-ha/index.html>`_ -* `Installation instruction <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_ -* `User guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/moon/colorado/2.0/docs/releasenotes/index.html>`_ - ----------------------------- -Multisite datacenter project ----------------------------- - -* `Installation instruction <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_ -* `User guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/releasenotes/index.html>`_ - -------------------------- -Network readiness project -------------------------- - -* `Requirements document <http://artifacts.opnfv.org/netready/colorado/2.0/docs/requirements/index.html>`_ - ----------------------- -ONOS framework project ----------------------- - -* `Installation instruction <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/installationprocedure/index.html>`_ -* `User guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_ - ----------------------------- -OVSNFV release documentation ----------------------------- - -* `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`_ -* `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_ -* `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_ - --------------- -Parser project --------------- - -* `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/2.0/docs/parser_docs/index.html>`_ -* `Installation instruction <http://artifacts.opnfv.org/parser/colorado/2.0/docs/installationprocedure/index.html>`_ -* `User guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_ - ------- -Pharos ------- - -* `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`_ -* `Configuration guide <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/configguide/index.html>`_ - -------- -Promise -------- - -* `Requirement specification <http://artifacts.opnfv.org/promise/colorado/2.0/docs/requirements/index.html>`_ -* `Installation and configuration guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/installationprocedure/index.html>`_ -* `User guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/userguide/index.html>`_ - ------- -SDNVPN ------- - -* `BGPVPN scenario description <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_ -* `User guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/release-notes/index.html>`_ - ---- -SFC ---- - -* `Design documentation <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/design/index.html>`_ -* `SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_ -* `High availability SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_ -* `Installation instruction <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_ -* `User guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/releasenotes/index.html>`_ - ------------------------------------------------- -Software fast-path quality metrics documentation ------------------------------------------------- - -* `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/2.0/index.html>`_ - - -Test Project documentation -========================== - -------------------------- -Bottlenecks documentation -------------------------- - -* `Installation instruction <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/installationprocedure/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/releasenotes/index.html>`_ - ----------------------- -Functest documentation ----------------------- - -* `Configuration guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/configguide/index.html>`_ -* `User guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/userguide/index.html>`_ -* `Developer guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/devguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/index.html>`_ - -------------------------- -vSwitchPerf documentation -------------------------- - -* `Release and development documentation <http://artifacts.opnfv.org/vswitchperf/colorado/2.0/docs/index.html>`_ - ------------------------ -Yardstick documentation ------------------------ - -* `User guide <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/userguide/index.html>`_ -* `Release notes <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/release/index.html>`_ - diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index bacedb76d..e31c5b1ee 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -10,12 +10,12 @@ Abstract ======== The following document provides an overview of the instructions required for the installation -of the Colorado release of OPNFV. +of the Danube release of OPNFV. -The Colorado release can be installed using a tool from the following -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 using a tool from the following integration projects 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 @@ -30,7 +30,7 @@ it is important to understand your required target platform capabilities before configuring your scenarios. An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined -in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`. +in the `Pharos specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`. When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. @@ -44,25 +44,17 @@ 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 <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`_ -- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_ -- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha <http://artifacts.opnfv.org/fds/colorado/2.0/scenarios_os-odl_l2-fdio-noha/index.html>`_ -- High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_ -- Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_ -- Accelerated KVM hypervisor `os-nosdn-kvm-ha <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/scenarios_os-nosdn-kvm-ha/index.html>`_ -- LXD container hypervisor `os-nosdn-lxd-noha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-noha/index.html>`_ -- High Availability LXD container hypervisor `os-nosdn-lxd-ha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-ha/index.html>`_ - +- Links to scenario description documents need to be added here. (todo) 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. +support for the OPNFV Danube release are; Apex, Compass4nfv, Fuel and Joid. The instructions for each toolchain can be found in these links: @@ -94,16 +86,7 @@ Many of the OPNFV test project provide user-guide documentation and installation Security Notes ============== -The following patches were applied to fix security issues discovered in opnfv -projects, during the Colorado release cycle. - -- `Removal of private keys <https://gerrit.opnfv.org/gerrit/#/c/21995/>`_ -- `Fix security issues of eval-s in testapi <https://gerrit.opnfv.org/gerrit/#/c/20751/>`_ -- `Implements use of yaml.safe_load <https://gerrit.opnfv.org/gerrit/#/c/20911/>`_ -- `Fix security issues reported by the security audit <https://gerrit.opnfv.org/gerrit/#/c/20693/>`_ -- `Fix issues found in security review <https://gerrit.opnfv.org/gerrit/#/c/21541/>`_ -- `Removing OpenSteak Project <https://gerrit.opnfv.org/gerrit/#/c/22139/>`_ -- `Remove unsed files in open-contrail role <https://gerrit.opnfv.org/gerrit/#/c/21997/>`_ -- `Get rid of private key in repo <https://gerrit.opnfv.org/gerrit/#/c/21985>`_ -- `Handling file loads and tmp dirs differently <https://gerrit.opnfv.org/gerrit/#/c/21499>`_ -- `Remove 'Debug = True' when run Flask and add logger <https://gerrit.opnfv.org/gerrit/#/c/21799/>`_ +The following patches were applied to fix security issues discovered in OPNFV +projects, during the Danube release cycle. + +- Links to security patches need to be added here. (todo) diff --git a/docs/release/overview.rst b/docs/release/overview.rst index 712430662..07a38c18a 100644 --- a/docs/release/overview.rst +++ b/docs/release/overview.rst @@ -30,9 +30,9 @@ OPNFV initially focused on building NFV Infrastructure (NFVI) and Virtualised In 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, and includes -Management and Network Orchestration MANO components primarily for application composition -and management in the Colorado release. +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) @@ -71,7 +71,8 @@ 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 Project <https://www.opnfv.org/developers/pharos>`_ +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. @@ -111,8 +112,7 @@ an NFV domain, the OPNFV community consumes a sub-set of OpenStack projects wher 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 OPNFV installation instruction: -http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/installationprocedure/index.html +refer to the `OPNFV User Guide & Configuration Guide`_ ----------------- Operating Systems @@ -168,7 +168,7 @@ A typical OPNFV deployment starts with three controller nodes running in a high 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: http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html +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 @@ -194,7 +194,7 @@ systems, real time and automated analysis of results, storage and publication of each run as shown in the following diagram. .. image:: ../images/OPNFV_testing_group.png - :alt: Overview infographic of the Colorado OPNFV testing Ecosystem + :alt: Overview infographic of the OPNFV testing Ecosystem Release Verification ==================== @@ -215,7 +215,7 @@ derived from the functional testing project ‘functest,’ a set of test cases 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 fulfill the release criteria. +the infrastructure iteratively (no less that 4 times) in order to fulfil the release criteria. -------- Functest @@ -257,7 +257,7 @@ 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 Colorado release. Work will continue to +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. @@ -289,6 +289,6 @@ Bottlenecks provides a framework to find system limitations and bottlenecks, pro root cause isolation capabilities to facilitate system evaluation. -.. _`OPNFV Configuration Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/configguide -.. _`OPNFV User Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/userguide +.. _`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 index 02ba32fbf..24f6dc84d 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -5,182 +5,97 @@ OPNFV Release Notes =================== -Apex ------ +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>` -Armband --------- :ref:`Armband Release Notes <armband-releasenotes>` -Availability -------------- -No Release documentation - -Bottlenecks ------------- :ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>` -Compass4nfv ------------- :ref:`Compass4nfv Release Notes <compass4nfv-releasenotes>` -Conductor ----------- :ref:`Conductor Release Notes <conductor-releasenotes>` -Copper -------- :ref:`Copper Release Notes <copper-releasenotes>` -Daisy ------- :ref:`Daisy Release Notes <daisy-releasenotes>` -Doctor -------- :ref:`Doctor Release Notes <doctor-releasenotes>` -Domino -------- :ref:`Domino Release Notes <domino-releasenotes>` -Dovetail ---------- :ref:`Dovetail Release Notes <dovetail-releasenotes>` -Dpacc ------- :ref:`Dpacc Release Notes <dpacc-releasenotes>` -Enfv ------ :ref:`Enfv Release Notes <enfv-releasenotes>` -Escalator ----------- :ref:`Escalator Release Notes <escalator-releasenotes>` -Fastpathmetrics ----------------- :ref:`Fastpathmetrics Release Notes <fastpathmetrics-releasenotes>` -Fds ----- :ref:`Fds Release Notes <fds-releasenotes>` -Fuel ------ :ref:`Fuel Release Notes <fuel-releasenotes>` -Functest ---------- :ref:`Functest Release Notes <functest-releasenotes>` -Genesisreq ------------ :ref:`Genesisreq Release Notes <genesisreq-releasenotes>` -Inspector ----------- :ref:`Inspector Release Notes <inspector-releasenotes>` -Ipv6 ----- :ref:`Ipv6 Release Notes <ipv6-releasenotes>` -Joid ------ :ref:`Joid Release Notes <joid-releasenotes>` -Kvmfornfv ----------- :ref:`Kvmfornfv Release Notes <kvmfornfv-releasenotes>` -Lsoapi -------- :ref:`Lsoapi Release Notes <lsoapi-releasenotes>` -Moon ------ :ref:`Moon Release Notes <moon-releasenotes>` -Multisite ----------- :ref:`Multisite Release Notes <multisite-releasenotes>` -Netready ---------- :ref:`Netready Release Notes <netready-releasenotes>` -Octopus --------- :ref:`Octopus Release Notes <octopus-releasenotes>` -Onosfw -------- :ref:`Onosfw Release Notes <onosfw-releasenotes>` -Ovsnfv -------- :ref:`Ovsnfv Release Notes <ovsnfv-releasenotes>` -Parser -------- :ref:`Parser Release Notes <parser-releasenotes>` -Pharos -------- :ref:`Pharos Release Notes <pharos-releasenotes>` -Prediction ------------ :ref:`Prediction Release Notes <prediction-releasenotes>` -Promise --------- :ref:`Promise Release Notes <promise-releasenotes>` -QTIP ------ :ref:`QTIP Release Notes <qtip-releasenotes>` -Releng -------- :ref:`Releng Release Notes <releng-releasenotes>` -Sdnvpn -------- :ref:`Sdnvpn Release Notes <sdnvpn-releasenotes>` -Sfc ----- :ref:`Sfc Release Notes <sfc-releasenotes>` -Storperf ---------- :ref:`Storperf Release Notes <storperf-releasenotes>` -Ves ----- :ref:`Ves Release Notes <ves-releasenotes>` -Vnf_Forwarding_Graph -------------------- :ref:`Vnf_Forwarding_Graph Release Notes <vnf_forwarding_graph-releasenotes>` -VSPERF ------------- :ref:`VSPERF Release Notes <vswitchperf-releasenotes>` -Yardstick ----------- :ref:`Yardstick Release Notes <yardstick-releasenotes>` -Ovno ------ :ref:`Ovno Release Notes <ovno-releasenotes>` -Snaps ------- :ref:`Snaps Release Notes <snaps-releasenotes>` diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index d143a743f..18f349793 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -9,11 +9,11 @@ OPNFV User Guide & Configuration Guide Abstract ======== -OPNFV is a collaborative project aimed at providing a variety of virtualization +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 -Colorado release. +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 @@ -24,7 +24,7 @@ Introduction ============ OPNFV provides a suite of scenarios, infrastructure deployment options, which -are able to be installed to host virtualized network functions (VNFs). +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. @@ -40,7 +40,7 @@ Feature Overview ================ The following links outline the feature deliverables from participating OPNFV -projects in the Colorado release. Each of the participating projects provides +projects in the Danube release. Each of the participating projects provides detailed descriptions about the delivered features including use cases, implementation and configuration specifics. @@ -62,11 +62,13 @@ Feature Configuration Guides - :ref:`IPv6 Configuration Guide <ipv6-configguide>` - :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>` - :ref:`Multisite Configuration Guide <multisite-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 =================== @@ -76,6 +78,7 @@ Feature User Guides - :ref:`IPv6 User Guide <ipv6-userguide>` - :ref:`KVMforNFV User Guide <kvmfornfv-userguide>` - :ref:`Multisite User Guide <multisite-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>` |