diff options
| author |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-04-30 13:57:24 -0700 |
|---|---|---|
| committer |   Qiaowei Ren <qiaowei.ren@intel.com> | 2018-05-03 08:09:49 +0000 |
| commit | 12234e85d8b07e17296ba48329e287cf354c151a (patch) | |
| tree | 0455dfb60b791337193518bc49b75073c667b675 /docs/release | |
| parent | 957abb60ddc82354234687328460147e19607caf (diff) | |
k8-nosdn-stor4nfv-ha Scenario Documentation
Documentation for the k8nosdn-stor4nfv-ha scenario.
Change-Id: I80b3814cff636deec41331c6e4bbdec63a5ce7ae
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
(cherry picked from commit 91625f4898dcdcba64f1941c6c56f13938c9d4ea)
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/scenarios/k8-nosdn-stor4nfv-ha/index.rst | 17 | ||||
| -rw-r--r-- | docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst | 38 |
2 files changed, 55 insertions, 0 deletions
diff --git a/docs/release/scenarios/k8-nosdn-stor4nfv-ha/index.rst b/docs/release/scenarios/k8-nosdn-stor4nfv-ha/index.rst new file mode 100644 index 0000000..363390a --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-stor4nfv-ha/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +.. _k8-nosdn-stor4nfv-ha: + +********************************************* +k8-nosdn-stor4nfv-ha overview and description +********************************************* +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 1 + + scenario.description diff --git a/docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst b/docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst new file mode 100644 index 0000000..ec3a0a3 --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst @@ -0,0 +1,38 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +This document provides scenario level details for <RELEASE> of <COMPONENT>. + +.. contents:: + :depth: 3 + :local: + +============ +Introduction +============ +.. In this section explain the purpose of the scenario and the types of capabilities provided + +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. + +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 + +Limitations, Issues and Workarounds +=================================== +.. Explain scenario limitations here, this should be at a design level rather than discussing +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +References +========== + +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/software |