diff options
Diffstat (limited to 'docs/release')
-rw-r--r-- | docs/release/release-notes/index.rst | 13 | ||||
-rw-r--r-- | docs/release/release-notes/release-notes.rst | 37 | ||||
-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 | 55 | ||||
-rw-r--r-- | docs/release/scenarios/os-nosdn-stor4nfv-ha/index.rst | 17 | ||||
-rw-r--r-- | docs/release/scenarios/os-nosdn-stor4nfv-ha/scenario.description.rst | 57 | ||||
-rw-r--r-- | docs/release/userguide/feature.userguide.rst | 30 | ||||
-rw-r--r-- | docs/release/userguide/index.rst | 15 |
8 files changed, 241 insertions, 0 deletions
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..c9fdf47 --- /dev/null +++ b/docs/release/release-notes/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 + +.. _stor4nfv-releasenotes: + +====================== +Stor4NFV Release Notes +====================== + +.. toctree:: + :maxdepth: 1 + + release-notes.rst diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..b80056a --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,37 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Important notes +---------------- + +The Stor4NFV project is currently only supported on Compass installer. + +Summary +-------- + +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. + +Release Data +------------- + ++--------------------------------------+--------------------------------------+ +| **Project** | Stor4NFV | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | | +| | | ++--------------------------------------+--------------------------------------+ + + 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..0349ab6 --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-stor4nfv-ha/scenario.description.rst @@ -0,0 +1,55 @@ +.. 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> + +============ +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 +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +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 Gambia release, please visit + +http://www.opnfv.org/gambia diff --git a/docs/release/scenarios/os-nosdn-stor4nfv-ha/index.rst b/docs/release/scenarios/os-nosdn-stor4nfv-ha/index.rst new file mode 100644 index 0000000..8ff242e --- /dev/null +++ b/docs/release/scenarios/os-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> + +.. _os-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/os-nosdn-stor4nfv-ha/scenario.description.rst b/docs/release/scenarios/os-nosdn-stor4nfv-ha/scenario.description.rst new file mode 100644 index 0000000..d0d42b0 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-stor4nfv-ha/scenario.description.rst @@ -0,0 +1,57 @@ +.. 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 + +The os-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 openstack 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 +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +References +========== + +For more information about Stor4NFV, please visit + +https://wiki.opnfv.org/display/PROJ/Stor4NFV + +https://wiki.opnfv.org/display/STOR diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..8bcc1ea --- /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 +=================== + +This document provides the Stor4NFV user guide for the OPNFV Gambia 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 Gambia 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..3ac92f3 --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,15 @@ +.. 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-userguide: + +=================== +Stor4NFV User Guide +=================== + +.. toctree:: + :maxdepth: 1 + + userguide |