docs/release/userguide.introduction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) Sofia Wallin (sofia.wallin@ericssion.com)
   4
   5 ================
   6 OPNFV Userguide
   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 industry. 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 open source projects such as OpenStack or OpenDaylight, rather 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 depoyment 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 in support of these applications.
  30
  31 OPNFV 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 OpenStack, OpenDaylight, OVS, KVM 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 deliveries from the participant 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 on a per OPNFV project basis.
  46
  47 The following are Configuration Guides and User Guides and assume that the reader has already some
  48 information about a given projects specifics and deliverables. These guides
  49 are intended to be used following the installation of a given OPNFV installer
  50 to allow a user 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 projects home page, found on http://wiki.opnfv.org, for specific details.
  54
  55 You can find project specific usage and configuration information below:
  56
  57 Feature Configuration Guides
  58 ============================
  59
  60 - `Armband configuration guide <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_
  61 - `Copper configuration guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_
  62 - `Doctor configuration guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/installationprocedure/index.html>`_
  63 - `IPv6 configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_
  64 - `KVMforNFV configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_
  65 - `Moon configuration guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_
  66 - `Multisite configuration guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_
  67 - `ONOSFW configuration guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/installationprocedure/index.html>`_
  68 - `OVSNFV configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_
  69 - `Promise configuration guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/installationprocedure/index.html>`_
  70 - `SFC configuration guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_
  71
  72
  73 Feature User Guides
  74 ===================
  75
  76 - `Copper user guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_
  77 - `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_
  78 - `Domino user guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_
  79 - `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_
  80 - `KVMforNFV user guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_
  81 - `Moon user guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_
  82 - `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_
  83 - `ONOSFW user guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_
  84 - `OVSNFV user guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_
  85 - `Parser user guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_
  86 - `Promise user guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/userguide/index.html>`_
  87 - `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_
  88 - `SFC user guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_