docs/release/userguide.introduction.rst

   1 .. _opnfv-user-config:
   2
   3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   4 .. SPDX-License-Identifier: CC-BY-4.0
   5 .. (c) Sofia Wallin (sofia.wallin@ericsson.com) and other contributors
   6
   7 ================================
   8 User Guide & Configuration Guide
   9 ================================
  10
  11 Abstract
  12 ========
  13
  14 One of OPNFV's project goals is to reduce time to integrate and deploy NFV infrastructure and onboard VNF/CNFs
  15 for those who supply components and those who operationalize these platforms. The OPNFV community
  16 does this by implementing, testing and deploying tools for conformance and performance of NFV infrastructure, aligned
  17 with industry reference architectures. This document provides guidance and instructions for using platform
  18 features designed to support the tools that are made available in the OPNFV
  19 Jerma release.
  20
  21 This document is not intended to replace or replicate documentation from other
  22 upstream open source projects such as KVM, OpenDaylight, OpenStack, etc., but to highlight the
  23 features and capabilities delivered through the OPNFV project.
  24
  25
  26 Introduction
  27 ============
  28
  29 OPNFV provides a infrastructure deployment options, which
  30 are able to be installed to host virtualised network functions (VNFs).
  31 This document intends to help users of the platform leverage the features and
  32 capabilities delivered by OPNFV.
  33
  34 Feature Overview
  35 ================
  36
  37 The following links outline the feature deliverables from participating OPNFV
  38 projects in the Jerma release. Each of the participating projects provides
  39 detailed descriptions about the delivered features including use cases,
  40 implementation, and configuration specifics in the project documentation.
  41
  42 The following Configuration Guides and User Guides assume that the reader already has some
  43 knowledge about a given project's specifics and deliverables. These Guides
  44 are intended to be used following the installation with an OPNFV installer
  45 to allow users to deploy and implement feature delivered by OPNFV.
  46
  47 If you are unsure about the specifics of a given project, please refer to the
  48 OPNFV wiki page at http://wiki.opnfv.org for more details.
  49
  50
  51 Feature Configuration Guides
  52 ============================
  53
  54 - :ref:`Barometer Configuration Guide <barometer-configguide>`
  55 - :ref:`CIRV Configuration Guide <cirv-configguide>`
  56 - :ref:`Doctor Configuration Guide <doctor-configguide>`
  57
  58 Feature User Guides
  59 ===================
  60
  61 - :ref:`Barometer User Guide <barometer-userguide>`
  62 - :ref:`CIRV User Guide <cirv-userguide>`
  63 - :ref:`Doctor User Guide <doctor-userguide>`
  64 *   :doc:`SampleVNF User Guide <samplevnf:testing/user/userguide/index>`
  65 *   :doc:`VSPERF Configuration and User Guide <vswitchperf:testing/user/configguide/index>`
  66