Bug 1386546

Summary: [Doc RFE] Document how to provision storage using dynamic provisioning
Product: Red Hat Gluster Storage Reporter: Anjana Suparna Sriram <asriram>
Component: doc-Container_Native_Storage_with_OpenShiftAssignee: Bhavana <bmohanra>
Status: CLOSED CURRENTRELEASE QA Contact: krishnaram Karthick <kramdoss>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: cns-3.4CC: annair, asriram, bmohanra, hchiramm, kramdoss, pprakash, rcyriac, rhs-bugs, storage-doc
Target Milestone: ---Keywords: FutureFeature
Target Release: CNS 3.4Flags: hchiramm: needinfo-
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-01-23 07:23:15 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Bug Depends On:    
Bug Blocks: 1385252    

Description Anjana Suparna Sriram 2016-10-19 08:49:52 UTC
Additional info: This bug tracks documentation for the following use cases outlined in CNS 3.4 Content Plan: https://docs.google.com/document/d/1SrbUxavmmdbLn7FT2nhOAlX0Q3VTsqPCZyx6wV3gjn0/edit#

Use Case #1 As an administrator, I need to understand concepts related to provisioning storage for a CNS 3.4 deployment.

Documentation: Provide descriptive content and workload information related to the following concepts:
- dynamic provisioning
- storage class 
- claims
- glusterFS

Use Case #2 As an administrator, I need to create a storage class that points to a CNS 3.4 deployment.
Documentation: Provide detailed instructions regarding how to create a storage class. Provide an applicable example that reflects a CNS 3.4 context.

Use Case #3 As an administrator, I need to create a claim that uses a specific storage class to provision CNS 3.4 volumes.
Documentation: Provide detailed instructions regarding how to create a claim.
Provide an applicable example with a storage class that reflects a CNS 3.4 context.

Use Case #4 As an administrator, I need to understand the ramifications/impact that deleting a claim has on both my CNS 3.4 persistent volume and the actual volume. 
Documentation: Provide comprehensive information that explains the impact and consequences (if any) that occurs when a claim is deleted.

Comment 5 Bhavana 2016-11-07 10:20:11 UTC
Worked with Humble and reworked on the TOC and the workflow. Currently going through the video created by Humble to try out and document the commands.

Updated TOC: https://docs.google.com/document/d/16VFLcm2DUtEg__3-FbikKI0lmlkyf9e1BkxmUKz--zM/edit#heading=h.ekhdtd8n5rrn

Video: https://asciinema.org/a/90986

Comment 6 Bhavana 2016-11-10 12:15:00 UTC
The updated steps are added in the following google doc:

https://docs.google.com/document/d/16VFLcm2DUtEg__3-FbikKI0lmlkyf9e1BkxmUKz--zM/edit#heading=h.ekhdtd8n5rrn

Need to add oc specific commands and sync up with Humble for a review.

Comment 7 Bhavana 2016-11-14 07:17:04 UTC
Hi Humble,

I have updated the following google doc based on our discussion:

https://docs.google.com/a/redhat.com/document/d/16VFLcm2DUtEg__3-FbikKI0lmlkyf9e1BkxmUKz--zM/edit?usp=sharing

Please note that I am in the process of bringing up a container setup and add oc specific outputs for each of the command. The o/ps currently are kubernetes specific which will be changed. 

Let me know if there are anymore changes that are required to be made for the same.

Thanks

Comment 8 Humble Chirammal 2016-11-14 13:27:07 UTC
(In reply to Bhavana from comment #7)

LGTM.

Comment 11 krishnaram Karthick 2017-01-06 05:40:34 UTC
1) section 5.2.1,

After creating a Storage Class, a secret for heketi authentication must be creating before proceeding with the creation of persistent volume claim. 

should be,

After creating a Storage Class, a secret for heketi authentication must be created before proceeding with the creation of persistent volume claim. 

2) 

secretNamespace + secretName: Identification of Secret instance that containes

should be,

secretNamespace + secretName: Identification of Secret instance that contains

3) Under,  ⁠5.2.1.2. Creating Secret for Heketi Authentication

Create a secret file by executing the following command: 

should be,

Create a secret file, sample secret file is provided below

4) Similar to the above comment,

"Create a Persistent Volume Claim file by executing the following command: " has to be changed

5)  To verify that the persistent volume is mounted inside the container, execute the following command: 
# oc rsh busybox

The command provided only logs into the shell of the application pod. To check if the mountpoint exists, 'df' command has to be executed in the shell

Comment 12 krishnaram Karthick 2017-01-06 05:43:16 UTC
Also, can you please confirm if this bug has only introduced section "5.2 Dynamic Provisioning of Volumes". I don't see what changes has been introduced as part of this bug.

Comment 14 krishnaram Karthick 2017-01-06 14:18:58 UTC
Looks good, moving the bug to verified.