+.. _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
+
+================================
+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
+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 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
============================
-- `Armband configuration guide <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_
-- `Copper configuration guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_
-- `Doctor configuration guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/installationprocedure/index.html>`_
-- `IPv6 configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_
-- `KVMforNFV configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_
-- `Moon configuration guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_
-- `Multisite configuration guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_
-- `ONOSFW configuration guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/installationprocedure/index.html>`_
-- `OVSNFV configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_
-- `Promise configuration guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/installationprocedure/index.html>`_
-- `SFC configuration guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_
-
+- :ref:`Auto Configuration Guide <auto-configguide>`
+- :ref:`Barometer Configuration Guide <barometer-configguide>`
+- :ref:`Clover Configuration Guide <clover-configguide>`
+- :ref:`Container4NFV Configuration Guide <xyz-configguide>`
+- :ref:`Doctor Configuration Guide <doctor-configguide>`
+- :ref:`Edge Cloud Configuration Guide <xyz-configguide>`
+- :ref:`FDS Configuration Guide <fds-configguide>`
+- :ref:`High Availability Configuration Guide <xyz-configguide>`
+- :ref:`IPv6 Configuration Guide <ipv6-configguide>`
+- :ref:`ONOSFW Configuration Guide <onosfw-configguide>`
+- :ref:`Orchestra Configuration Guide <orchestra-configguide>`
+- :ref:`OVN4NFV Configuration Guide <xyz-configguide>`
+- :ref:`OVNO Configuration Guide <ovno-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>`
+- :ref:`Stor4NFV Configuration Guide <stor4nfv-configguide>`
Feature User Guides
===================
-- `Copper user guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_
-- `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_
-- `Domino user guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_
-- `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_
-- `KVMforNFV user guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_
-- `Moon user guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_
-- `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_
-- `ONOSFW user guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_
-- `OVSNFV user guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_
-- `Parser user guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_
-- `Promise user guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/userguide/index.html>`_
-- `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_
-- `SFC user guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_
+- :ref:`Auto User Guide <auto-userguide>`
+- :ref:`Barometer User Guide <barometer-userguide>`
+- :ref:`Clover User Guide <clover-userguide>`
+- :ref:`Container4NFV User Guide <xyz-userguide>`
+- :ref:`Edge Cloud User Guide <xyz-userguide>`
+- :ref:`Doctor User Guide <doctor-userguide>`
+- :ref:`FDS User Guide <fds-userguide>`
+- :ref:`High Availability User Guide <xyz-userguide>`
+- :ref:`IPv6 User Guide <ipv6-userguide>`
+- :ref:`OpenContrail Virtual Networking User Guide <ovno-userguide>`
+- :ref:`ONOSFW User Guide <onosfw-userguide>`
+- :ref:`Orchestra User Guide <orchestra-userguide>`
+- :ref:`OVN4NFV User Guide <xyz-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-userguide>`
Code Review / opnfvdocs.git / blobdiff