docs/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) Christopher Price (Ericsson AB)
   4
   5 ========
   6 Overview
   7 ========
   8
   9 OPNFV provides a variety of virtual infrastructure deployments designed to
  10 host virtualised network functions (VNFs).  This guide intends to help users of
  11 the platform leverage the features and capabilities delivered by the OPNFV project.
  12
  13 OPNFV Continuous Integration builds, deploys and tests combinations of virtual
  14 infrastructure components in what are defined as scenarios.  A scenario may include
  15 components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will
  16 include different source components or configurations.  Scenarios are designed to
  17 enable specific features and capabilities in the platform that can be leveraged by the
  18 OPNFV user community.
  19
  20 OPNFV Features
  21 ==============
  22
  23 Each OPNFV scenario provides unique features and capabilities, it is important to
  24 ensure you have a scenario deployed on your infrastructure that provides the right capabilities
  25 for your needs before working through the user guide.
  26
  27 This user guide outlines how to work with key components and features in the platform,
  28 each feature description section will indicate the scenarios that provide the components
  29 and configurations required to use it.
  30
  31 .. include:: ../scenario/featurematrix.rst
  32
  33 For details on which scenarios are best for you and how to install and configure them
  34 on your infrastructure the
  35 `OPNFV Configuration Guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/index.html>`_
  36 provides a valuable reference.
  37
  38 The user guide will describe how to enable and utilise features and use cases implemented and
  39 tested on deployed OPNFV scenarios.  For details of the use cases and tests that have been run
  40 you should check the validation procedures section of the
  41 `OPNFV Configuration Guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/post-install.html>`_.
  42 This will provide information about the specific use cases that have been validated and are working on your deployment.
  43
  44 General usage guidelines
  45 ========================
  46
  47 The user guide for OPNFV features and capabilities provide step by step instructions
  48 for using features that have been configured according to the installation and configuration
  49 instructions.
  50
  51 This guide is structured in a manner that will provide usage instructions for each feature in its own
  52 section.  Start by identifying the feature capability you would like to leverage, then read through
  53 the relevant user guide section to understand how to work with the feature.
  54 The combination of platform features, if available in a given scenario and not otherwise indicated,
  55 should operate according to the documentation.
  56 Dependencies between features will be highlighted in the user guide text.
  57
  58 You may wish to use the platform in a manner that the development teams have not foreseen, or
  59 exercise capabilities not fully validated on the platform.  If you experience issues leveraging the
  60 platform for the uses you have envisioned, the `OPNFV user mailing list <"mailto:opnfv-user@lists.opnfv.org">`_
  61 provides a mechanism to establish a dialog with the community to help you overcome any issues identified.
  62
  63 It may be that you have identified a bug in the system, or that you are trying to execute a use case
  64 that has not yet been implemented.  In either case it is important for OPNFV to learn about it as we are in
  65 essence a development project looking to ensure the required capabilities for our users are available.