docs/release/userguide.introduction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. (c) Sofia Wallin (sofia.wallin@ericssion.com)
   4
   5 ======================================
   6 OPNFV User Guide & Configuration Guide
   7 ======================================
   8
   9 Abstract
  10 ========
  11
  12 OPNFV is a collaborative project aimed at providing a variety of virtualization
  13 deployments intended to host applications serving the networking and carrier
  14 industries. This document provides guidance and instructions for using platform
  15 features designed to support these applications, made available in the OPNFV
  16 Colorado release.
  17
  18 This document is not intended to replace or replicate documentation from other
  19 upstream open source projects such as KVM, OpenDaylight, or OpenStack, but to highlight the
  20 features and capabilities delivered through the OPNFV project.
  21
  22
  23 Introduction
  24 ============
  25
  26 OPNFV provides a suite of scenarios, infrastructure deployment options, which
  27 are able to be installed to host virtualized network functions (VNFs).
  28 This Guide intends to help users of the platform leverage the features and
  29 capabilities delivered by the OPNFV project.
  30
  31 OPNFVs' Continuous Integration builds, deploys and tests combinations of virtual
  32 infrastructure components in what are defined as scenarios. A scenario may
  33 include components such as KVM, OpenDaylight, OpenStack, OVS, etc., where each
  34 scenario will include different source components or configurations. Scenarios
  35 are designed to enable specific features and capabilities in the platform that
  36 can be leveraged by the OPNFV User community.
  37
  38
  39 Feature Overview
  40 ================
  41
  42 The following links outline the feature deliverables from participating OPNFV
  43 projects in the Colorado release. Each of the participating projects provides
  44 detailed descriptions about the delivered features including use cases,
  45 implementation and configuration specifics.
  46
  47 The following Configuration Guides and User Guides assume that the reader already has some
  48 information about a given project's specifics and deliverables. These Guides
  49 are intended to be used following the installation with an OPNFV installer
  50 to allow users to deploy and implement feature delivered by OPNFV.
  51
  52 If you are unsure about the specifics of a given project, please refer to the
  53 OPNFV wiki page at http://wiki.opnfv.org, for more details.
  54
  55
  56 Feature Configuration Guides
  57 ============================
  58
  59 - :ref:`Armband Configuration Guide <armband-configguide>`
  60 - :ref:`Copper Configuration Guide <copper-configguide>`
  61 - :ref:`Doctor Configuration Guide <doctor-configguide>`
  62 - :ref:`IPv6 Configuration Guide <ipv6-configguide>`
  63 - :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>`
  64 - :ref:`Multisite Configuration Guide <multisite-configguide>`
  65 - :ref:`ONOSFW Configuration Guide <onosfw-configguide>`
  66 - :ref:`Promise Configuration Guide <promise-configguide>`
  67 - :ref:`SFC Configuration Guide <sfc-configguide>`
  68
  69
  70 Feature User Guides
  71 ===================
  72
  73 - :ref:`Copper User Guide <copper-userguide>`
  74 - :ref:`Doctor User Guide <doctor-userguide>`
  75 - :ref:`Domino User Guide <domino-userguide>`
  76 - :ref:`IPv6 User Guide <ipv6-userguide>`
  77 - :ref:`KVMforNFV User Guide <kvmfornfv-userguide>`
  78 - :ref:`Multisite User Guide <multisite-userguide>`
  79 - :ref:`ONOSFW User Guide <onosfw-userguide>`
  80 - :ref:`Parser User Guide <parser-userguide>`
  81 - :ref:`Promise User Guide <promise-userguide>`
  82 - :ref:`SDNVPN User Guide <sdnvpn-userguide>`
  83 - :ref:`SFC User Guide <sfc-userguide>`