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