summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorQiaowei Ren <qiaowei.ren@intel.com>2018-05-03 15:38:23 +0800
committerQiaowei Ren <qiaowei.ren@intel.com>2018-05-03 16:01:42 +0800
commit6ed368563ae3244594da858974e5c6924ece3a95 (patch)
tree1bf6ae57d4ee16cc20402e81bc064470be6ab327 /docs
parent12234e85d8b07e17296ba48329e287cf354c151a (diff)
update k8-nosdn-stor4nfv-ha scenario documentation
Change-Id: Iea38168d2819cbbedcfcc799dfd93840aaf53d4a Signed-off-by: Qiaowei Ren <qiaowei.ren@intel.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst25
1 files changed, 24 insertions, 1 deletions
diff --git a/docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst b/docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst
index ec3a0a3..4c478bd 100644
--- a/docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst
+++ b/docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst
@@ -13,18 +13,34 @@ Introduction
============
.. In this section explain the purpose of the scenario and the types of capabilities provided
+The k8-nosdn-stor4nfv-ha is intended to be used to install the OPNFV Stor4NFV project in a standard
+OPNFV High Availability mode. The OPNFV Stor4NFV project integrates the OpenSDS and Ceph projects
+into the OPNFV environment.
+
Scenario components and composition
===================================
.. In this section describe the unique components that make up the scenario,
.. what each component provides and why it has been included in order
.. to communicate to the user the capabilities available in this scenario.
+This scenario installs everything needed to use the Stor4NFV project in an OPNFV
+environment. Mainly two upstream projects, including OpenSDS and Ceph, will be installed
+and deployed.
+
+Ceph plays a role as the data plane and the backend driver of OpenSDS. 'dock' service of
+OpenSDS need to be deployed in Ceph monitor node. The users can use OpenSDS, control plane,
+to create, inquire, and delete storage resources.
+
Scenario usage overview
=======================
.. Provide a brief overview on how to use the scenario and the features available to the
.. user. This should be an "introduction" to the userguide document, and explicitly link to it,
.. where the specifics of the features are covered including examples and API's
+Once this scenario is installed, it will be possible for kubernetes to create volume through
+OpenSDS API to call Ceph, and in this case, Ceph will be used for storage backend together
+with OpenSDS.
+
Limitations, Issues and Workarounds
===================================
.. Explain scenario limitations here, this should be at a design level rather than discussing
@@ -34,5 +50,12 @@ Limitations, Issues and Workarounds
References
==========
+For more information about Stor4NFV, please visit
+
+https://wiki.opnfv.org/display/PROJ/Stor4NFV
+
+https://wiki.opnfv.org/display/STOR
+
For more information on the OPNFV Fraser release, please visit
-http://www.opnfv.org/software
+
+http://www.opnfv.org/fraser