--- /dev/null
+---
+project: 'Storage For NFV (Stor4NFV)'
+project_creation_date: 'September 12th 2017'
+project_category: ''
+lifecycle_state: 'Incubation
+Proposal'
+project_lead: &opnfv_stor4nfv_ptl
+ name: 'Shane Wang'
+ email: 'shane.wang@intel.com'
+ company: 'intel.com'
+ id: 'shanewang'
+ timezone: 'Unknown'
+primary_contact: *opnfv_stor4nfv_ptl
+issue_tracking:
+ type: 'jira'
+ url: 'https://jira.opnfv.org/projects/[STOR4NFV]'
+ key: '[STOR4NFV]'
+mailing_list:
+ type: 'mailman2'
+ url: 'opnfv-tech-discuss@lists.opnfv.org'
+ tag: '[stor4nfv]'
+realtime_discussion:
+ type: irc
+ server: 'freenode.net'
+ channel: '#opnfv-stor4nfv'
+meetings:
+ - type: 'gotomeeting+irc'
+ agenda: # eg: 'https://wiki.opnfv.org/display/'
+ url: # eg: 'https://global.gotomeeting.com/join/819733085'
+ server: 'freenode.net'
+ channel: '#opnfv-meeting'
+ repeats: 'weekly'
+ time: # eg: '16:00 UTC'
+repositories:
+ - 'stor4nfv'
+committers:
+ - <<: *opnfv_stor4nfv_ptl
+ - name: 'Tushar Gohad'
+ email: 'tushar.gohad@intel.com'
+ company: 'intel.com'
+ id: 'tsg'
+ - name: 'Haomai Wang'
+ email: 'haomai@xsky.com'
+ company: 'xsky.com'
+ id: 'yuyuyu101'
+ - name: 'Hui Wang'
+ email: 'wanghui71@huawei.com'
+ company: 'huawei.com'
+ id: 'leonwang'
+ - name: 'luwei he'
+ email: 'heluwei@huawei.com'
+ company: 'huawei.com'
+ id: 'helloway'
+ - name: 'Lisa Li'
+ email: 'xiaoyan.li@intel.com'
+ company: 'intel.com'
+ id: 'lixiaoy1'
+ - name: 'Qiaowei Ren'
+ email: 'qiaowei.ren@intel.com'
+ company: 'intel.com'
+ id: 'qiaoweir'
+tsc:
+ # yamllint disable rule:line-length
+ approval: 'http//meetbot.opnfv.org/meetings/opnfv-meeting/2017/opnfv-meeting.2017-08-29-12.58.html'
+ # yamllint enable rule:line-length
.. 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
.. http://creativecommons.org/licenses/by/4.0
-This document provides the release notes for Fraser 1.0 of StorPerf.
-
-.. contents::
- :depth: 3
- :local:
-
-
-Version history
-===============
-
-
-+--------------------+--------------------+--------------------+--------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| 2018-04-10 | Fraser | Qiaowei Ren | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-
-
Important notes
----------------
| **Repo/commit-ID** | |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Fraser |
+| **Release designation** | |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 2018-04-10 |
+| **Release date** | |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Fraser release |
+| **Purpose of the delivery** | |
| | |
+--------------------------------------+--------------------------------------+
.. 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
============
https://wiki.opnfv.org/display/STOR
-For more information on the OPNFV Fraser release, please visit
+For more information on the OPNFV Gambia release, please visit
-http://www.opnfv.org/fraser
+http://www.opnfv.org/gambia
--- /dev/null
+.. 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
--- /dev/null
+.. 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
.. (c) Authors of Clover
-================================================================
-Stor4NFV User Guide (Fraser Release)
-================================================================
+===================
+Stor4NFV User Guide
+===================
-This document provides the Stor4NFV user guide for the OPNFV Fraser release.
+This document provides the Stor4NFV user guide for the OPNFV Gambia release.
Description
===========
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
+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?
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Authors of Clover
-=================================
+.. _stor4nfv-userguide:
+
+===================
Stor4NFV User Guide
-=================================
+===================
.. toctree::
:maxdepth: 1
Code Review / stor4nfv.git / commitdiff