diff options
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 6 | ||||
| -rw-r--r-- | docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst | 25 | ||||
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 30 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 13 |
4 files changed, 70 insertions, 4 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 013991e..4cc2f05 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -17,7 +17,7 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 2018-03-xx | Fraser 1.0 | Qiaowei Ren | | +| 2018-04-10 | Fraser | Qiaowei Ren | | | | | | | +--------------------+--------------------+--------------------+--------------------+ @@ -47,10 +47,10 @@ Release Data | **Release designation** | Fraser | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2018-03-xx | +| **Release date** | 2018-04-10 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Fraser release 1.0 | +| **Purpose of the delivery** | OPNFV Fraser release | | | | +--------------------------------------+--------------------------------------+ 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 diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..e427873 --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. SPDX-License-Identifier CC-BY-4.0 +.. (c) Authors of Clover + + +================================================================ +Stor4NFV User Guide (Fraser Release) +================================================================ + +This document provides the Stor4NFV user guide for the OPNFV Fraser release. + +Description +=========== + +Stor4NFV provides a storage solution based on Ceph and OpenSDS, and focuses +on the optimization for storage intensive use cases of NFV, like I/O performance +improvements. + +As project Stor4NFV's first release, the Fraser release includes installation and simple +validation of foundational upstream projects including OpenSDS and Ceph. + +What is in Fraser? +================== + + * Integrate OpenSDS with Ceph + + * Build Compass installer of Stor4NFV + + * Test case for Yardstick and Functest diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..ca71b3d --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Authors of Clover + +================================= +Stor4NFV User Guide +================================= + +.. toctree:: + :maxdepth: 1 + + userguide |