diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release/installation.introduction.rst | 49 | ||||
| -rw-r--r-- | docs/release/release-notes.rst | 12 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 31 |
3 files changed, 23 insertions, 69 deletions
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 7a5132dcf..b109a3fcd 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -11,57 +11,16 @@ Installation Abstract ======== -This an overview document for the installation of the Iruya release of OPNFV. - -The Iruya release can be installed making use of one of the installer projects in OPNFV: -Airship or Fuel. 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 Iruya release refer to the scenario -description documents provided: - -- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha>` -- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>` +This is the installation document for the OPNFV Jerma release, please use this document for further reference. Installation Procedure ====================== -Detailed step by step instructions for working with an installation toolchain and installing -the required scenario is provided by the installation projects. The projects providing installation -support for the OPNFV Iruya release are: Airship and Fuel. +Each of the test Frameworks and other projects will have separate installations procedures: see the individual project documentation. -The instructions for each toolchain can be found in these links: +- :ref:`Airship Installation Guide <airship-installation>` +- :ref:`Kuberef Installation Guide <kuberef-installation>` -- :ref:`Airship installation instruction <airship-installation>` -- :ref:`Fuel installation instruction <fuel-installation>` OPNFV Test Frameworks ===================== diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index e79b9a422..72ea1450a 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -18,18 +18,16 @@ Project release notes: :ref:`Barometer Release Notes <barometer-releasenotes>` +:ref:`CIRV Release Notes <cirv-releasenotes>` + :ref:`Doctor Release Notes <doctor-releasenotes>` -:ref:`Fuel Release Notes <fuel-releasenotes>` +:ref:`Dovetail Release Notes <dovetail-releasenotes>` :ref:`Functest Release Notes <functest-releasenotes>` -:ref:`NFVBench Release Notes <nfvbench-releasenotes>` +:ref:`Kuberef Release Notes <kuberef-releasenotes>` :ref:`SampleVNF Release Notes <samplevnf-releasenotes>` -:ref:`Stor4NFV Release Notes <stor4nfv-releasenotes>` - -:ref:`StorPerf Release Notes <storperf-releasenotes>` - -:ref:`Yardstick Release Notes <yardstick-releasenotes>` +:ref:`VSPerf Release Notes <vsperf-releasenotes>` diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 1a5c2da77..8a790821b 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -11,11 +11,12 @@ 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 that are made available in the OPNFV -Iruya release. +One of OPNFV's project goals is to reduce time to integrate and deploy NFV infrastructure and onboard VNF/CNFs +for those who supply components and those who operationalize these platforms. The OPNFV community +does this by implementing, testing and deploying tools for conformance and performance of NFV infrastructure, 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 OPNFV +Jerma 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 @@ -25,26 +26,18 @@ features and capabilities delivered through the OPNFV project. Introduction ============ -OPNFV provides a suite of scenarios, infrastructure deployment options, which +OPNFV provides a 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. -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 Iruya release. Each of the participating projects provides +projects in the Jerma release. Each of the participating projects provides detailed descriptions about the delivered features including use cases, -implementation, and configuration specifics. +implementation, and configuration specifics in the project documentation. 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 @@ -59,11 +52,15 @@ Feature Configuration Guides ============================ - :ref:`Barometer Configuration Guide <barometer-configguide>` +- :ref:`CIRV Configuration Guide <cirv-configguide>` - :ref:`Doctor Configuration Guide <doctor-configguide>` Feature User Guides =================== - :ref:`Barometer User Guide <barometer-userguide>` +- :ref:`CIRV User Guide <cirv-userguide>` - :ref:`Doctor User Guide <doctor-userguide>` -- :ref:`Stor4NFV User Guide <stor4nfv:stor4nfv-userguide>` +* :doc:`SampleVNF User Guide <samplevnf:testing/user/userguide/index>` +* :doc:`VSPERF Configuration and User Guide <vswitchperf:testing/user/configguide/index>` + |