From 150017297d1d494c9ead2bea10f2f9c9edde247d Mon Sep 17 00:00:00 2001 From: Parikshith Date: Fri, 24 Jan 2025 08:23:38 -0500 Subject: [PATCH] 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 --- e2e/config.yaml.sample | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/e2e/config.yaml.sample b/e2e/config.yaml.sample index f44ed19c3b..c349b2d582 100644 --- a/e2e/config.yaml.sample +++ b/e2e/config.yaml.sample @@ -1,7 +1,19 @@ --- +# 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 @@ -9,3 +21,15 @@ pvcspecs: - 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