X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Fuserguide.introduction.rst;h=e98fb51159603605cb51a35f76c45f6023992eb1;hb=df89827146946a4986d4901c60fc7a8109c72b4d;hp=b4ebab25a3a1336eb8cd6a287fa73e74535e1cb3;hpb=77a324e8f19bb42d08116a895d2c31fac2e608f9;p=opnfvdocs.git diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index b4ebab25a..e98fb5115 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -1,88 +1,101 @@ +.. _opnfv-user-config: + .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Sofia Wallin (sofia.wallin@ericssion.com) +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Sofia Wallin (sofia.wallin@ericsson.com) and other contributors -====================================== -OPNFV User Guide & Configuration Guide -====================================== +================================ +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 -industry. This document provides guidance and instructions for using platform -features designed to support these applications, made available in the OPNFV -Colorado release. +industries. This document provides guidance and instructions for using platform +features designed to support these applications that are made available in the OPNFV +Gambia release. This document is not intended to replace or replicate documentation from other -open source projects such as OpenStack or OpenDaylight, rather highlight the +upstream open source projects such as KVM, OpenDaylight, OpenStack, etc., but to highlight the features and capabilities delivered through the OPNFV project. Introduction ============ -OPNFV provides a suite of scenarios, infrastructure depoyment options, which -are able to be installed to host virtualized network functions (VNFs). -This Guide intends to help Users of the platform leverage the features and -capabilities delivered by the OPNFV project in support of these applications. +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. -OPNFV Continuous Integration builds, deploys and tests combinations of virtual +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 OpenStack, OpenDaylight, OVS, KVM etc. where each -scenario will include different source components or Configurations. Scenarios +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 deliveries from the participant OPNFV -projects in the Colorado release. Each of the participating projects provides -detailed descriptions about the delivered features. Including use cases, -implementation and Configuration specifics on a per OPNFV project basis. +The following links outline the feature deliverables from participating OPNFV +projects in the Gambia release. Each of the participating projects provides +detailed descriptions about the delivered features including use cases, +implementation, and configuration specifics. -The following are Configuration Guides and User Guides and assume that the reader has already some -information about a given projects specifics and deliverables. These Guides -are intended to be used following the installation of a given OPNFV installer -to allow a user to deploy and implement feature delivered by OPNFV. +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 projects home page, found on http://wiki.opnfv.org, for specific details. +OPNFV wiki page at http://wiki.opnfv.org for more details. -You can find project specific usage and Configuration information below: Feature Configuration Guides ============================ -- :ref:`Armband Configuration Guide ` -- :ref:`Copper Configuration Guide ` +- :ref:`Auto Configuration Guide ` +- :ref:`Barometer Configuration Guide ` +- :ref:`Clover Configuration Guide ` +- :ref:`Container4NFV Configuration Guide ` - :ref:`Doctor Configuration Guide ` +- :ref:`Edge Cloud Configuration Guide ` +- :ref:`FDS Configuration Guide ` +- :ref:`High Availability Configuration Guide ` - :ref:`IPv6 Configuration Guide ` -- :ref:`KVMforNFV Configuration Guide ` -- :ref:`Moon Configuration Guide ` -- :ref:`Multisite Configuration Guide ` - :ref:`ONOSFW Configuration Guide ` -- :ref:`OVSNFV Configuration Guide ` +- :ref:`Orchestra Configuration Guide ` +- :ref:`OVN4NFV Configuration Guide ` +- :ref:`OVNO Configuration Guide ` +- :ref:`Parser Configuration Guide ` - :ref:`Promise Configuration Guide ` +- :ref:`SDNVPN Configuration Guide ` - :ref:`SFC Configuration Guide ` - +- :ref:`Stor4NFV Configuration Guide ` Feature User Guides =================== -- :ref:`Copper User Guide ` +- :ref:`Auto User Guide ` +- :ref:`Barometer User Guide ` +- :ref:`Clover User Guide ` +- :ref:`Container4NFV User Guide ` +- :ref:`Edge Cloud User Guide ` - :ref:`Doctor User Guide ` -- :ref:`Domino User Guide ` +- :ref:`FDS User Guide ` +- :ref:`High Availability User Guide ` - :ref:`IPv6 User Guide ` -- :ref:`KVMforNFV User Guide ` -- :ref:`Moon User Guide ` -- :ref:`Multisite User Guide ` +- :ref:`OpenContrail Virtual Networking User Guide ` - :ref:`ONOSFW User Guide ` -- :ref:`OVSNFV User Guide ` +- :ref:`Orchestra User Guide ` +- :ref:`OVN4NFV User Guide ` +- :ref:`OVNO User Guide ` - :ref:`Parser User Guide ` - :ref:`Promise User Guide ` - :ref:`SDNVPN User Guide ` - :ref:`SFC User Guide ` +- :ref:`Stor4NFV User Guide `