From 46acd6b2cdd904145cb87c91fda9c15ca7766d82 Mon Sep 17 00:00:00 2001
From: Mudit Agarwal <muagarwa@redhat.com>
Date: Mon, 10 Aug 2020 08:47:20 +0530
Subject: [PATCH] doc: update e2e README for snapshot operation

Updated e2e README with the prerequisites to run snapshot/clone e2e tests.

Signed-off-by: Mudit Agarwal <muagarwa@redhat.com>
---
 e2e/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/e2e/README.md b/e2e/README.md
index 516f77c47..a826d2924 100644
--- a/e2e/README.md
+++ b/e2e/README.md
@@ -4,6 +4,7 @@
   - [Introduction](#introduction)
   - [Install Kubernetes](#install-kubernetes)
   - [Test parameters](#test-parameters)
+  - [E2E for snapshot](#e2e-for-snapshot)
   - [Running E2E](#running-e2e)
 
 ## Introduction
@@ -88,6 +89,47 @@ are available while running tests:
 | timeout           | Panic test binary after duration d (default 0, timeout disabled)              |
 | v                 | Verbose: print additional output                                              |
 
+## E2E for snapshot
+
+After the support for snapshot/clone has been added to ceph-csi,
+you need to follow these steps before running e2e.
+Please note that the snapshot operation works only if the Kubernetes version
+is greater than or equal to 1.17.0.
+
+- Delete Alpha snapshot CRD created by ceph-csi in rook.
+  - Check if you have any `v1alpha1` CRD created in our Kubernetes cluster
+
+      ```bash
+      [$]kubectl get crd volumesnapshotclasses.snapshot.storage.k8s.io -o yaml |grep v1alpha1
+        - name: v1alpha1
+        - v1alpha1
+      [$]kubectl get crd volumesnapshotcontents.snapshot.storage.k8s.io -o yaml |grep v1alpha1
+        - name: v1alpha1
+        - v1alpha1
+      [$]kubectl get crd volumesnapshots.snapshot.storage.k8s.io -o yaml |grep v1alpha1
+        - name: v1alpha1
+        - v1alpha1
+      ```
+
+  - If you have Alpha CRD, delete it as from Kubernetes 1.17.0+ the snapshot
+    should be `v1beta1`
+
+    ```console
+    $./install-snapshot.sh delete-crd
+    ```
+
+- Install snapshot controller and Beta snapshot CRD
+
+    ```console
+    $./install-snapshot.sh install
+    ```
+
+Once you are done running e2e please perform the cleanup by running following:
+
+```console
+    $./install-snapshot.sh cleanup
+```
+
 ## Running E2E
 
 `