docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.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) <optionally add copywriters name>
   4
   5 This document provides scenario level details for <RELEASE> of <COMPONENT>.
   6
   7 .. contents::
   8    :depth: 3
   9    :local:
  10
  11 ============
  12 Introduction
  13 ============
  14 .. In this section explain the purpose of the scenario and the types of capabilities provided
  15
  16 Scenario components and composition
  17 ===================================
  18 .. In this section describe the unique components that make up the scenario,
  19 .. what each component provides and why it has been included in order
  20 .. to communicate to the user the capabilities available in this scenario.
  21
  22 Scenario usage overview
  23 =======================
  24 .. Provide a brief overview on how to use the scenario and the features available to the
  25 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
  26 .. where the specifics of the features are covered including examples and API's
  27
  28 Limitations, Issues and Workarounds
  29 ===================================
  30 .. Explain scenario limitations here, this should be at a design level rather than discussing
  31 .. faults or bugs.  If the system design only provide some expected functionality then provide
  32 .. some insight at this point.
  33
  34 References
  35 ==========
  36
  37 For more information on the OPNFV Fraser release, please visit
  38 http://www.opnfv.org/software