+.. _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 <armband-configguide>`
-- :ref:`Copper Configuration Guide <copper-configguide>`
+- :ref:`Auto Configuration Guide <auto-configguide>`
+- :ref:`Barometer Configuration Guide <barometer-configguide>`
+- :ref:`Clover Configuration Guide <clover:clover_configguide>`
- :ref:`Doctor Configuration Guide <doctor-configguide>`
- :ref:`IPv6 Configuration Guide <ipv6-configguide>`
-- :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>`
-- :ref:`Moon Configuration Guide <moon-configguide>`
-- :ref:`Multisite Configuration Guide <multisite-configguide>`
- :ref:`ONOSFW Configuration Guide <onosfw-configguide>`
-- :ref:`OVSNFV Configuration Guide <ovsnfv-configguide>`
-- :ref:`Promise Configuration Guide <promise-configguide>`
+- :ref:`Orchestra Configuration Guide <orchestra-configguide>`
+- :ref:`Parser Configuration Guide <parser-configguide>`
+- :ref:`Promise Configuration Guide <promise:promise-configguide>`
+- :ref:`SDNVPN Configuration Guide <sdnvpn-configguide>`
- :ref:`SFC Configuration Guide <sfc-configguide>`
-
Feature User Guides
===================
-- :ref:`Copper User Guide <copper-userguide>`
+- :ref:`Auto User Guide <auto-userguide>`
+- :ref:`Barometer User Guide <barometer-userguide>`
+- :ref:`Clover User Guide <clover:clover_userguide>`
+- :ref:`Container4NFV User Guide <container4nfv-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:`Moon User Guide <moon-userguide>`
-- :ref:`Multisite User Guide <multisite-userguide>`
+- :ref:`OpenContrail Virtual Networking User Guide <ovno-userguide>`
- :ref:`ONOSFW User Guide <onosfw-userguide>`
-- :ref:`OVSNFV User Guide <ovsnfv-userguide>`
+- :ref:`Orchestra User Guide <orchestra-userguide>`
+- :ref:`OVNO User Guide <ovno-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:`Stor4NFV User Guide <stor4nfv:stor4nfv-userguide>`
Code Review / opnfvdocs.git / blobdiff