Bug 1845461

Summary: [Doc] To access user serviceable snapshot, it should be activated
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Sonal <sarora>
Component: doc-Administration_GuideAssignee: Agil Antony <agantony>
doc-Administration_Guide sub component: Default QA Contact: Arthy Loganathan <aloganat>
Status: CLOSED CURRENTRELEASE Docs Contact:
Severity: medium    
Priority: medium CC: agantony, asriram, puebele, rhs-bugs, storage-doc, sunkumar
Version: rhgs-3.5Keywords: ZStream
Target Milestone: ---   
Target Release: RHGS 3.5.z Batch Update 3   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-01-11 08:58:16 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:
Embargoed:
Bug Depends On:    
Bug Blocks: 1822639    

Description Sonal 2020-06-09 09:54:10 UTC 
Document URL: 

https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.5/html-single/administration_guide/index#sect-User_Serviceable_Snapshots

Section Number and Name: 

8.13. User Serviceable Snapshots

Describe the issue: 

To access snapshot via .snaps directory (user serviceable snapshot), it should be activated first. Otherwise, the snapshot directory is not visible in .snaps.

The documentation should mention this.

Suggestions for improvement: 

Activate the snapshot to access it via user-serviceable snapshot:
# gluster snapshot activate <snapshot-name>

Additional information: 
-
Comment 1 Sunny Kumar 2020-06-09 13:18:03 UTC 
Hi Sonal,

Thanks for bringing this to notice. 

We can have this in section but it is mentioned in the beginning of document section 8.13 and will not harm to mention with full description.

'''
With User Serviceable Snapshot feature, you can access the activated snapshots of the snapshot volume.

'''

/sunny
Comment 2 Sonal 2020-06-12 13:57:42 UTC 
Hi Sunny,

I missed it in the document. Thanks for pointing.
It would be verbose to add the snapshot activation command in the section: `8.13.1. Enabling and Disabling User Serviceable Snapshot`

Regards,
Sonal Arora
Comment 7 Arthy Loganathan 2020-11-11 05:31:24 UTC 
Verified the fix in the link,

https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.5/html-single/administration_guide/index?lb_target=stage#Enabling_and_Disabling_User_Serviceable_Snapshots