Bug 1881945

Few comments.


1. Snapshot can be used as: "Cluster-level storage backup solutions". Doesn't this give a meaning that we can take snapshot of osd PVCs ?
2. Regarding the number of snapshots per PVC. We should wait for https://bugzilla.redhat.com/show_bug.cgi?id=1854503 and https://bugzilla.redhat.com/show_bug.cgi?id=1891757
3. Snapshots should be Ready. Mention this in verification step.
4. Change the procedure title "From the Snapshots page" to "From the Volume Snapshots page"
5. Change "PVC must not be in use and must be in the Bound state" to "PVC must be in BOUND state and not in use" or other appropriate statement. Just thought to mention the status first.
6. Add selection of volume snapshotclass in procedure "From the Persistent Volume Claims page"
7. Under the procedure "From the Persistent Volume Claims page" change "Click on the PVC for which you want to create the snapshot and in the Details tab" to ".... create the snapshot and in the details page". Need not make word 'details' bold. Action menu is available in the page, not specific to the Details tab.
8. In both the procedures, by clicking Create button Snapshot page will be shown. But this is mentioned only in first procedure. Also, remove the part " if the creation is successful." in step 4 of first procedure.
9. Step "5. To verify the creation of the snapshot, click on the PVC and click the Volume Snapshot tab to see the list of snapshots." in first procedure can be moved to verification steps.
10. Change "You can create a volume snapshot either from the Persistent Volume Claim (PVC) page or the Snapshots page" to "... or the Volume Snapshots page"



Changing the status back to Assigned.

In the first procedure, third option "Click the Volume Snapshot tab and click Create Volume Snapshots." can be removed. Such an option is not available.

Checked in 
$ oc get clusterversion
NAME      VERSION   AVAILABLE   PROGRESSING   SINCE   STATUS
version   4.6.0     True        False         83m     Cluster version is 4.6.0

$ oc get csv -n openshift-storage
NAME                         DISPLAY                       VERSION        REPLACES              PHASE
ocs-operator.v4.6.0-144.ci   OpenShift Container Storage   4.6.0-144.ci   ocs-operator.v4.5.1   Succeeded

One more comment.

In section 1.3. Deleting volume snapshots.
In the third step of first procedure, change "In the Volume Snapshots tab, beside the desired snapshot, click Action menu (⋮) → Delete." to "... → Delete Volume Snapshot."

In second procedure step 2, change "... click Create Volume Snapshots." to "... click Create Volume Snapshot."

In second procedure step 3, change "...Persistent Volume claim..." to "...Persistent Volume Claim..."

Suggesting some improvements in the doc content.


1. In step 2 of the second procedure, change from "In the Volume Snapshots tab,...." to "In the Volume Snapshots page,....". Change is needed because there is no separate tab in Volume Snapshots page.

2. In the second procedure, after step 2, add an additional step to select the Project.

3. First point in 'Verification Steps'
   Go to the details page of the PVC and click the Volume Snapshots tab to see the list of snapshots. Confirm that the new snapshot is listed.

4. In 7.3. Deleting volume snapshots, under the second procedure "From Snapshots page":
   Change "In the Volume Snapshot tab....." to "In the Volume Snapshots page....."

5. In 7.3. Deleting volume snapshots, title of second procedure should be changed to "From Volume Snapshots page"


Changing the status to assigned.

Hi Kusuma,

Adding the suggestions from Neha, Madhu and Yug.

1. Change "snapshot" to "volume snapshot" in these statements:
   5. Click Create. You will be redirected to the details page of the created snapshot.
   7. Click Create. You will be redirected to the details page of the created snapshot.
   First and second point in verification step.
   
2. Change the third point in verification step to "Wait for the volume snapshot to be in Ready state." Highlight the word "Ready" like it is done in present content.

3. In first point of verification step, make "Volume Snapshots" bold.

4. In 7.3. Deleting volume snapshots
   Add Prerequisite - Volume snapshot class used in the particular volume snapshot should be present
   
5. In 7.3. Deleting volume snapshots second procedure step 2, change 'Volume Snapshot page' to 'Volume Snapshots page'
   
6. Add verification steps under 7.3. Deleting volume snapshots
    * "Ensure that the deleted volume snapshot is not present in the Volume Snapshots(bold letters) tab in the Details page of the PVC." Split to two sentences if 
      needed.
    * "Click Storage → Volume Snapshots and ensure that the deleted volume snapshot is not listed."
    
7. In 7.3. Deleting volume snapshots, in first procedure step 3 and second procedure step 2
   Change "desired snapshot" to "desired volume snapshot"


Changing the status to assigned.

Opened a bug to add Volume snapshot class description - https://bugzilla.redhat.com/show_bug.cgi?id=1901082

Verified the content. The suggestions are incorporated and the content looks good.
The prerequisite for deleting volume snapshot can be removed when the fix is available for https://bugzilla.redhat.com/show_bug.cgi?id=1893739. Currently this is targeted to OCP4.7. Backport to OCP 4.6.z is not yet planned. A separate doc bug will be created as needed. 

Moving this to verified state.

OCS 4.6.0 GA completed on 17 December 2020