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 The k8-nosdn-stor4nfv-ha is intended to be used to install the OPNFV Stor4NFV project in a standard
  17 OPNFV High Availability mode. The OPNFV Stor4NFV project integrates the OpenSDS and Ceph projects
  18 into the OPNFV environment.
  19
  20 Scenario components and composition
  21 ===================================
  22 .. In this section describe the unique components that make up the scenario,
  23 .. what each component provides and why it has been included in order
  24 .. to communicate to the user the capabilities available in this scenario.
  25
  26 This scenario installs everything needed to use the Stor4NFV project in an OPNFV
  27 environment. Mainly two upstream projects, including OpenSDS and Ceph, will be installed
  28 and deployed.
  29
  30 Ceph plays a role as the data plane and the backend driver of OpenSDS. 'dock' service of
  31 OpenSDS need to be deployed in Ceph monitor node. The users can use OpenSDS, control plane,
  32 to create, inquire, and delete storage resources.
  33
  34 Scenario usage overview
  35 =======================
  36 .. Provide a brief overview on how to use the scenario and the features available to the
  37 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
  38 .. where the specifics of the features are covered including examples and API's
  39
  40 Once this scenario is installed, it will be possible for kubernetes to create volume through
  41 OpenSDS API to call Ceph, and in this case, Ceph will be used for storage backend together
  42 with OpenSDS.
  43
  44 Limitations, Issues and Workarounds
  45 ===================================
  46 .. Explain scenario limitations here, this should be at a design level rather than discussing
  47 .. faults or bugs.  If the system design only provide some expected functionality then provide
  48 .. some insight at this point.
  49
  50 References
  51 ==========
  52
  53 For more information about Stor4NFV, please visit
  54
  55 https://wiki.opnfv.org/display/PROJ/Stor4NFV
  56
  57 https://wiki.opnfv.org/display/STOR
  58
  59 For more information on the OPNFV Fraser release, please visit
  60
  61 http://www.opnfv.org/fraser