Bug 1318221 - [Doc RFE] Add a new section on how to enable and use windows shadow copy (Volume Snapshot Service, VSS) functionality
Summary: [Doc RFE] Add a new section on how to enable and use windows shadow copy (Vol...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat
Component: doc-Administration_Guide
Version: rhgs-3.1
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: RHGS 3.1.3
Assignee: Bhavana
QA Contact: Vivek Das
URL:
Whiteboard:
Depends On:
Blocks: 1311845
TreeView+ depends on / blocked
 
Reported: 2016-03-16 10:06 UTC by Anjana Suparna Sriram
Modified: 2016-06-29 14:20 UTC (History)
9 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-06-29 14:20:43 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Anjana Suparna Sriram 2016-03-16 10:06:47 UTC

Comment 2 Bhavana 2016-05-11 10:12:30 UTC
Hello Rajesh,

Based on our meeting, following are the minutes:

1) New section to be added as section 7.3.6 Accessing Snapshots in Windows

http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-3.1.2-Stage_Administration_Guide%20%28html-single%29/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#idm140599957869776

2) Initial TOC as follows:
   a) Overview
   b) Configuration changes to smb.conf
   c) Accessing Snapshot
   d) Troubleshooting (if required)

Let me know if we need any further changes to the above mentioned TOC.

Also, can you please share the changes that has to be done to the smb.conf file.

Thanks,
Bhavana

Comment 3 rjoseph 2016-05-13 10:40:19 UTC
The TOC looks fine to me.

Following link provide details about shadow_copy feature
https://www.samba.org/samba/docs/man/manpages/vfs_shadow_copy2.8.html

The above link has details about existing smb.conf options.

Apart from those we have added two more options:

shadow:snapprefix - Regular expression to match prefix of snapshot name. We only support Basic Regular Expression (BRE)

shadow:delimiter - delimiter is used to separate shadow:snapprefix and shadow:format. The default value for this is "_GMT"

e.g. if the snapshot name is Snap1_GMT-2016.05.11-06.24.36 then
shadow:delimiter can be "_GMT" and shadow:snapprefix can be [a-z]*[0-9]

Comment 4 Bhavana 2016-05-16 10:53:58 UTC
Thanks Rajesh,

Following is the initial draft of the newly created section:

7.3.6. Accessing Snapshots in Windows

http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#idm139639410607664

Please note the section is WIP.

For the initial introduction, should I explain Volume Shadow Copy Service in depth ?

Also, i require a sample of the smb.conf file after making the required configurations, which can be used as an example.

Comment 6 Bhavana 2016-05-19 06:45:27 UTC
Thanks Rajesh!

Following is the updated link:

http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#idm140704723781152

Do let me know if there are any more changes/additions that are required for the same.

Comment 7 rjoseph 2016-05-24 13:18:04 UTC
Following changes needs to be done:

I think we should keep the smb.conf section consistent throughout our documentation. Therefore I think it would be good to use the same format as mentioned in section 7.3.2, especially table 7.6


Remove following line
"Add the following two additional parameters to the smb.conf file: " 


Remove following section section
"7.3.6.2. Prerequisites to Access Snapshots"

This section should be merged with the previous section as steps.

Also as discussed it would be good to provide link of this (VSS) section in "17.13.3. Viewing and Retrieving Snapshots using CIFS for Windows Client"


In section "7.3.6.3. Accessing Snapshot" you need to add one more step:
2) Click on "Restore previous versions"

Comment 8 Bhavana 2016-05-25 08:31:09 UTC
Thanks Rajesh.

I have made the changes as suggested and created a table to describe the various options. This matches the format as mentioned in the previous section.

Following is the updated link:

http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#sect-accessing_snapshots_windows

Moving the bug on_qa

Comment 9 Vivek Das 2016-06-07 08:24:39 UTC
"shadow:sscanf" & "shadow:snapdirseverywhere" either remove it from <Table 7.7. Configuration Options> & smb.conf example or retain in both.

7.3.6.2. Accessing Snapshot
Instead of
1. Right Click on the file for which the previous version is required.

Do
1.  Right Click on the file or directory for which the previous version is required.

Figure 7.1. Accessing Snapshot > This should show restore data (snapshots).

Comment 10 Bhavana 2016-06-08 09:01:58 UTC
Hi Vivek,

The "shadow:sscanf" & "shadow:snapdirseverywhere options are now removed from the document (both in the table and the example)

The first step is edited as suggested and the new image is now added to show restore data.

http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#sect-accessing_snapshots_windows

Comment 11 Vivek Das 2016-06-10 06:47:27 UTC
(In reply to Bhavana from comment #10)
> Hi Vivek,
> 
> The "shadow:sscanf" & "shadow:snapdirseverywhere options are now removed
> from the document (both in the table and the example)
> 
> The first step is edited as suggested and the new image is now added to show
> restore data.
> 
> http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-
> Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/
> lastBuild/artifact/tmp/en-US/html-single/index.html#sect-
> accessing_snapshots_windows

Nicely done. Marking it as verified.


Note You need to log in before you can comment on or make changes to this bug.