e2e: describes configs used in config.yaml.sample

* Added comments for different options except for pvc properties(self explaining)
* Shows sample clusters, can be uncommented out to make it easy to configure kubeconfig paths.

Signed-off-by: Parikshith <[email protected]>

e2e/config.yaml.sample

@@ -1,11 +1,35 @@
 ---
+# Configuration file for RamenDR E2E testing on Regional DR.
+
+# Name of the channel used for the Channel CR (utilized by Subscription CRs).
 channelname: "ramen-gitops"
+
+# Namespace where the channel CR will be created.
 channelnamespace: "ramen-samples"
+
+# Git repository URL containing application manifests to be
+# deployed on the clusters.
 giturl: "https://github.com/RamenDR/ocm-ramen-samples.git"
+
+# List of PVC specifications for workloads.
+# These define storage configurations, such as 'storageClassName' and
+# 'accessModes', and are used to kustomize workloads.
 pvcspecs:
   - name: rbd
     storageclassname: rook-ceph-block
     accessmodes: ReadWriteOnce
   - name: cephfs
     storageclassname: rook-cephfs
     accessmodes: ReadWriteMany
+
+# Sample cluster configurations (commented out by default):
+# Uncomment and edit the following lines to provide the kubeconfig paths
+# for your test clusters.
+
+# Clusters:
+#   c1:
+#     kubeconfigpath: /path/to/kubeconfig/c1
+#   c2:
+#     kubeconfigpath: /path/to/kubeconfig/c2
+#   hub:
+#     kubeconfigpath: /path/to/kubeconfig/hub