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) Anuket CCC, AT&T, and other contributors
   6
   7 ================================
   8 User Guide and Configuration Guide
   9 ================================
  10
  11 Abstract
  12 ========
  13
  14 One of Anuket's project goals is to reduce time to integrate and deploy cloud infrastructures and onboard VNF/CNFs for
  15 those who supply components and those who operationalize these platforms. The Anuket community does this by
  16 implementing, testing and deploying tools for conformance and performance of cloud infrastructures, aligned with
  17 industry reference architectures. This document provides guidance and instructions for using platform features designed
  18 to support the tools that are made available in the Anuket project.
  19
  20 This document is not intended to replace or replicate documentation from other upstream open source projects such as
  21 KVM, OpenDaylight, OpenStack, etc., but to highlight the features and capabilities delivered through the Anuket project.
  22
  23 Introduction
  24 ============
  25
  26 Anuket provides infrastructure deployment options, which are able to be installed to host virtualised network functions
  27 (VNFs) and cloud native network functions (CNFs). This document intends to help users leverage the features and
  28 capabilities delivered by Anuket.
  29
  30 Feature overview
  31 ================
  32
  33 The following links outline the feature deliverables from Anuket sub-projects. Each of the sub-projects provide detailed
  34 descriptions about the features delivered including use cases, implementation, and configuration specifics in the
  35 sub-project documentation.
  36
  37 The following Configuration Guides and User Guides assume that the reader already has some knowledge about a given
  38 sub-project's specifics and capabilities. These Guides are intended to allow users to deploy and implement features that
  39 are part of the Anuket release.
  40
  41 The `Anuket developer wiki  <http://wiki.anuket.io>`_ might contain more details about the specific projects.
  42
  43 Configuration guides
  44 ====================
  45
  46 * :ref:`Barometer Configuration Guide <barometer-configguide>`
  47 * :ref:`CIRV-SDV Configuration Guide <cirv-sdv-configguide>`
  48 * :ref:`Kuberef Configuration Guide <kuberef-configguide>`
  49 * :doc:`ViNePERF Configuration Guide <vineperf:testing/user/configguide/index>`
  50 * :doc:`Functest Configuration Guide <functest:testing/user/configguide/index>`
  51
  52 User guides
  53 ===========
  54
  55 * :ref:`Barometer User Guide <barometer-userguide>`
  56 * :ref:`CIRV-SDV User Guide <cirv-sdv-userguide>`
  57 * :ref:`Kuberef User Guide <kuberef-userguide>`
  58 * :doc:`ViNePerf Configuration and User Guide <vineperf:testing/user/configguide/index>`
  59 * :doc:`Functest User Guide <functest:testing/user/userguide/index>`
  60