Updated the comments with proper default values of parameter in sampl…

…e files. (#817) * modify default values in sample files * modify default values in sample files * updated default value of replicas
dell · Dec 9, 2024 · 63c4d8e · 63c4d8e
1 parent 0ac2419
commit 63c4d8e
Show file tree

Hide file tree

Showing 15 changed files with 123 additions and 3 deletions.
diff --git a/samples/storage_csm_powerflex_v2101.yaml b/samples/storage_csm_powerflex_v2101.yaml
@@ -18,6 +18,9 @@ spec:
       #   false: disable storage capacity tracking
       storageCapacity: true
     configVersion: v2.10.1
+    # Controller count
+    # Allowed values: n, where n > 0
+    # Default value: 1
     replicas: 1
     dnsPolicy: ClusterFirstWithHostNet
     forceUpdate: false
@@ -45,6 +48,7 @@ spec:
       # 'k8s' represents a string prepended to each volume created by the CSI driver
       - name: provisioner
         image: registry.k8s.io/sig-storage/csi-provisioner:v4.0.0
+        # Default volume-name-prefix: k8s
         args: ["--volume-name-prefix=k8s"]
       - name: attacher
         image: registry.k8s.io/sig-storage/csi-attacher:v4.5.0
@@ -67,6 +71,7 @@ spec:
             value: "10.xx.xx.xx,10.xx.xx.xx"  # do not add mdm value here if it is present in secret
             # health monitor is disabled by default, refer to driver documentation before enabling it
             # Also set the env variable controller.envs.X_CSI_HEALTH_MONITOR_ENABLED  to "true".
+            # Default monitor-interval: 60s
       - name: csi-external-health-monitor-controller
         enabled: false
         args: ["--monitor-interval=60s"]
@@ -190,26 +195,31 @@ spec:
     # Authorization: enable csm-authorization for RBAC
     - name: authorization
       # enable: Enable/Disable csm-authorization
+      # Default value: false
       enabled: false
       configVersion: v1.10.1
       components:
         - name: karavi-authorization-proxy
           image: docker.io/dellemc/csm-authorization-sidecar:v1.10.1
           envs:
             # proxyHost: hostname of the csm-authorization server
+            # Default value: none
             - name: "PROXY_HOST"
               value: "csm-authorization.com"
             # skipCertificateValidation: Enable/Disable certificate validation of the csm-authorization server
+            # Default value: "true"
             - name: "SKIP_CERTIFICATE_VALIDATION"
               value: "true"
     # observability: allows to configure observability
     - name: observability
       # enabled: Enable/Disable observability
+      # Default value: false
       enabled: false
       configVersion: v1.8.1
       components:
         - name: topology
           # enabled: Enable/Disable topology
+          # Default value: false
           enabled: false
           # image: Defines karavi-topology image. This shouldn't be changed
           # Allowed values: string
@@ -230,6 +240,7 @@ spec:
               value: "INFO"
         - name: otel-collector
           # enabled: Enable/Disable OpenTelemetry Collector
+          # Default value: false
           enabled: false
           # image: Defines otel-collector image. This shouldn't be changed
           # Allowed values: string
@@ -257,6 +268,7 @@ spec:
           enabled: false
         - name: metrics-powerflex
           # enabled: Enable/Disable PowerFlex metrics
+          # Default value: false
           enabled: false
           # image: Defines PowerFlex metrics image. This shouldn't be changed
           image: docker.io/dellemc/csm-metrics-powerflex:v1.8.1

diff --git a/samples/storage_csm_powerflex_v2110.yaml b/samples/storage_csm_powerflex_v2110.yaml
@@ -18,6 +18,9 @@ spec:
       #   false: disable storage capacity tracking
       storageCapacity: true
     configVersion: v2.11.0
+    # Controller count
+    # Allowed values: n, where n > 0
+    # Default value: 1
     replicas: 1
     dnsPolicy: ClusterFirstWithHostNet
     forceUpdate: false
@@ -45,6 +48,7 @@ spec:
       # 'k8s' represents a string prepended to each volume created by the CSI driver
       - name: provisioner
         image: registry.k8s.io/sig-storage/csi-provisioner:v5.0.1
+        # Default volume-name-prefix: k8s
         args: ["--volume-name-prefix=k8s"]
       - name: attacher
         image: registry.k8s.io/sig-storage/csi-attacher:v4.6.1
@@ -67,6 +71,7 @@ spec:
             value: "10.xx.xx.xx,10.xx.xx.xx"  # do not add mdm value here if it is present in secret
             # health monitor is disabled by default, refer to driver documentation before enabling it
             # Also set the env variable controller.envs.X_CSI_HEALTH_MONITOR_ENABLED  to "true".
+            # Default monitor-interval: 60s
       - name: csi-external-health-monitor-controller
         enabled: false
         args: ["--monitor-interval=60s"]
@@ -190,6 +195,7 @@ spec:
     # Authorization: enable csm-authorization for RBAC
     - name: authorization
       # enable: Enable/Disable csm-authorization
+      # Default value: false
       enabled: false
       # For PowerFlex Tech-Preview v2.0.0-alpha use v1.11.0 as configVersion.
       # Do not change the configVersion to v2.0.0-alpha
@@ -200,19 +206,23 @@ spec:
           image: docker.io/dellemc/csm-authorization-sidecar:v1.11.0
           envs:
             # proxyHost: hostname of the csm-authorization server
+            # Default value: none
             - name: "PROXY_HOST"
               value: "csm-authorization.com"
             # skipCertificateValidation: Enable/Disable certificate validation of the csm-authorization server
+            # Default value: "true"
             - name: "SKIP_CERTIFICATE_VALIDATION"
               value: "true"
     # observability: allows to configure observability
     - name: observability
       # enabled: Enable/Disable observability
+      # Default value: false
       enabled: false
       configVersion: v1.9.0
       components:
         - name: topology
           # enabled: Enable/Disable topology
+          # Default value: false
           enabled: false
           # image: Defines karavi-topology image. This shouldn't be changed
           # Allowed values: string
@@ -233,6 +243,7 @@ spec:
               value: "INFO"
         - name: otel-collector
           # enabled: Enable/Disable OpenTelemetry Collector
+          # Default value: false
           enabled: false
           # image: Defines otel-collector image. This shouldn't be changed
           # Allowed values: string
@@ -260,6 +271,7 @@ spec:
           enabled: false
         - name: metrics-powerflex
           # enabled: Enable/Disable PowerFlex metrics
+          # Default value: false
           enabled: false
           # image: Defines PowerFlex metrics image. This shouldn't be changed
           image: docker.io/dellemc/csm-metrics-powerflex:v1.9.0

diff --git a/samples/storage_csm_powerflex_v2120.yaml b/samples/storage_csm_powerflex_v2120.yaml
@@ -18,6 +18,9 @@ spec:
       #   false: disable storage capacity tracking
       storageCapacity: true
     configVersion: v2.12.0
+    # Controller count
+    # Allowed values: n, where n > 0
+    # Default value: 1
     replicas: 1
     dnsPolicy: ClusterFirstWithHostNet
     forceUpdate: false
@@ -52,6 +55,7 @@ spec:
       # 'k8s' represents a string prepended to each volume created by the CSI driver
       - name: provisioner
         image: registry.k8s.io/sig-storage/csi-provisioner:v5.1.0
+        # Default volume-name-prefix: k8s
         args: ["--volume-name-prefix=k8s"]
       - name: attacher
         image: registry.k8s.io/sig-storage/csi-attacher:v4.7.0
@@ -74,6 +78,7 @@ spec:
             value: "10.xx.xx.xx,10.xx.xx.xx"  # do not add mdm value here if it is present in secret
             # health monitor is disabled by default, refer to driver documentation before enabling it
             # Also set the env variable controller.envs.X_CSI_HEALTH_MONITOR_ENABLED  to "true".
+            # Default monitor-interval: 60s
       - name: csi-external-health-monitor-controller
         enabled: false
         args: ["--monitor-interval=60s"]
@@ -204,6 +209,7 @@ spec:
     # Authorization: enable csm-authorization for RBAC
     - name: authorization
       # enabled: Enable/Disable csm-authorization
+      # Default value: false
       enabled: false
       # For PowerFlex Tech-Preview v2.0.0-alpha use v1.11.0 as configVersion.
       # Do not change the configVersion to v2.0.0-alpha
@@ -214,19 +220,23 @@ spec:
           image: quay.io/dell/container-storage-modules/csm-authorization-sidecar:v1.12.0
           envs:
             # proxyHost: hostname of the csm-authorization server
+            # Default value: none
             - name: "PROXY_HOST"
               value: "csm-authorization.com"
             # skipCertificateValidation: Enable/Disable certificate validation of the csm-authorization server
+            # Default value: "true"
             - name: "SKIP_CERTIFICATE_VALIDATION"
               value: "true"
     # observability: allows to configure observability
     - name: observability
       # enabled: Enable/Disable observability
+      # Default value: false
       enabled: false
       configVersion: v1.10.0
       components:
         - name: topology
           # enabled: Enable/Disable topology
+          # Default value: false
           enabled: false
           # image: Defines karavi-topology image. This shouldn't be changed
           # Allowed values: string
@@ -247,6 +257,7 @@ spec:
               value: "INFO"
         - name: otel-collector
           # enabled: Enable/Disable OpenTelemetry Collector
+          # Default value: false
           enabled: false
           # image: Defines otel-collector image. This shouldn't be changed
           # Allowed values: string
@@ -274,6 +285,7 @@ spec:
           enabled: false
         - name: metrics-powerflex
           # enabled: Enable/Disable PowerFlex metrics
+          # Default value: false
           enabled: false
           # image: Defines PowerFlex metrics image. This shouldn't be changed
           image: quay.io/dell/container-storage-modules/csm-metrics-powerflex:v1.10.0

diff --git a/samples/storage_csm_powermax_v2101.yaml b/samples/storage_csm_powermax_v2101.yaml
@@ -36,8 +36,9 @@ spec:
     configVersion: v2.10.1
     # replica: Define the number of PowerMax controller nodes
     # to deploy to the Kubernetes release
+    # Controller count
     # Allowed values: n, where n > 0
-    # Default value: None
+    # Default value: 2
     replicas: 2
     # Default credential secret for Powermax, if not set it to ""
     authSecret: powermax-creds
@@ -223,6 +224,7 @@ spec:
       # 'pmax' represents a string prepended to each volume created by the CSI driver
       - name: provisioner
         image: registry.k8s.io/sig-storage/csi-provisioner:v4.0.0
+        # Default volume-name-prefix: pmax
         args: ["--volume-name-prefix=pmax"]
       - name: attacher
         image: registry.k8s.io/sig-storage/csi-attacher:v4.5.0
@@ -235,6 +237,7 @@ spec:
       - name: csi-metadata-retriever
         image: docker.io/dellemc/csi-metadata-retriever:v1.7.3
       # health monitor is disabled by default, refer to driver documentation before enabling it
+      # Default monitor-interval: 60s
       - name: external-health-monitor
         enabled: false
         args: ["--monitor-interval=60s"]
@@ -276,16 +279,19 @@ spec:
     # Authorization: enable csm-authorization for RBAC
     - name: authorization
       # enabled: Enable/Disable csm-authorization
+      # Default value: false
       enabled: false
       configVersion: v1.10.1
       components:
         - name: karavi-authorization-proxy
           image: docker.io/dellemc/csm-authorization-sidecar:v1.10.1
           envs:
             # proxyHost: hostname of the csm-authorization server
+            # Default value: none
             - name: "PROXY_HOST"
               value: "csm-authorization.com"
             # skipCertificateValidation: Enable/Disable certificate validation of the csm-authorization server
+            # Default value: "true"
             - name: "SKIP_CERTIFICATE_VALIDATION"
               value: "true"
     # Replication: allows configuring replication module
@@ -347,11 +353,13 @@ spec:
     # observability: allows to configure observability
     - name: observability
       # enabled: Enable/Disable observability
+      # Default value: false
       enabled: false
       configVersion: v1.8.1
       components:
         - name: topology
           # enabled: Enable/Disable topology
+          # Default value: false
           enabled: false
           # image: Defines karavi-topology image. This shouldn't be changed
           # Allowed values: string
@@ -372,6 +380,7 @@ spec:
               value: "INFO"
         - name: otel-collector
           # enabled: Enable/Disable OpenTelemetry Collector
+          # Default value: false
           enabled: false
           # image: Defines otel-collector image. This shouldn't be changed
           # Allowed values: string
@@ -399,6 +408,7 @@ spec:
           enabled: false
         - name: metrics-powermax
           # enabled: Enable/Disable PowerMax metrics
+          # Default value: false
           enabled: false
           # image: Defines PowerMax metrics image. This shouldn't be changed
           image: docker.io/dellemc/csm-metrics-powermax:v1.3.1

diff --git a/samples/storage_csm_powermax_v2110.yaml b/samples/storage_csm_powermax_v2110.yaml
@@ -35,8 +35,9 @@ spec:
     configVersion: v2.11.0
     # replica: Define the number of PowerMax controller nodes
     # to deploy to the Kubernetes release
+    # Controller count
     # Allowed values: n, where n > 0
-    # Default value: None
+    # Default value: 2
     replicas: 2
     # Default credential secret for Powermax, if not set it to ""
     authSecret: powermax-creds
@@ -233,6 +234,7 @@ spec:
       # 'pmax' represents a string prepended to each volume created by the CSI driver
       - name: provisioner
         image: registry.k8s.io/sig-storage/csi-provisioner:v5.0.1
+        # Default volume-name-prefix: pmax
         args: ["--volume-name-prefix=pmax"]
       - name: attacher
         image: registry.k8s.io/sig-storage/csi-attacher:v4.6.1
@@ -245,6 +247,7 @@ spec:
       - name: csi-metadata-retriever
         image: docker.io/dellemc/csi-metadata-retriever:v1.8.0
       # health monitor is disabled by default, refer to driver documentation before enabling it
+      # Default monitor-interval: 60s
       - name: external-health-monitor
         enabled: false
         args: ["--monitor-interval=60s"]
@@ -285,16 +288,19 @@ spec:
     # Authorization: enable csm-authorization for RBAC
     - name: authorization
       # enabled: Enable/Disable csm-authorization
+      # Default value: false
       enabled: false
       configVersion: v1.11.0
       components:
         - name: karavi-authorization-proxy
           image: docker.io/dellemc/csm-authorization-sidecar:v1.11.0
           envs:
             # proxyHost: hostname of the csm-authorization server
+            # Default value: none
             - name: "PROXY_HOST"
               value: "csm-authorization.com"
             # skipCertificateValidation: Enable/Disable certificate validation of the csm-authorization server
+            # Default value: "true"
             - name: "SKIP_CERTIFICATE_VALIDATION"
               value: "true"
     # Replication: allows configuring replication module
@@ -356,11 +362,13 @@ spec:
     # observability: allows to configure observability
     - name: observability
       # enabled: Enable/Disable observability
+      # Default value: false
       enabled: false
       configVersion: v1.9.0
       components:
         - name: topology
           # enabled: Enable/Disable topology
+          # Default value: false
           enabled: false
           # image: Defines karavi-topology image. This shouldn't be changed
           # Allowed values: string
@@ -381,6 +389,7 @@ spec:
               value: "INFO"
         - name: otel-collector
           # enabled: Enable/Disable OpenTelemetry Collector
+          # Default value: false
           enabled: false
           # image: Defines otel-collector image. This shouldn't be changed
           # Allowed values: string
@@ -408,6 +417,7 @@ spec:
           enabled: false
         - name: metrics-powermax
           # enabled: Enable/Disable PowerMax metrics
+          # Default value: false
           enabled: false
           # image: Defines PowerMax metrics image. This shouldn't be changed
           image: docker.io/dellemc/csm-metrics-powermax:v1.4.0