Add field for enabling EFS volume metrics

openshift · Apr 11, 2024 · c0f376b · c0f376b
1 parent 3c04614
commit c0f376b
Show file tree

Hide file tree

Showing 6 changed files with 101 additions and 2 deletions.
diff --git a/openapi/generated_openapi/zz_generated.openapi.go b/openapi/generated_openapi/zz_generated.openapi.go
diff --git a/openapi/openapi.json b/openapi/openapi.json
@@ -25791,6 +25791,20 @@
       "description": "AWSCSIDriverConfigSpec defines properties that can be configured for the AWS CSI driver.",
       "type": "object",
       "properties": {
+        "efsVolumeMetricsFSRateLimit": {
+          "description": "efsVolumeMetricsFSRateLimit defines the rate limit, in goroutines per file system, for processing volume metrics. Requires efsVolumeMetricsOptIn to be enabled. The default rate limit set by the EFS CSI driver is 240 goroutines per file system.",
+          "type": "integer",
+          "format": "int32"
+        },
+        "efsVolumeMetricsOptIn": {
+          "description": "efsVolumeMetricsOptIn enables metrics for EFS CSI Driver volumes. When enabled, the CSI driver traverses the entire volume to calculate and return metrics. This operation can significantly impact system performance due to the extensive volume walk required. Use with caution in performance-sensitive environments.",
+          "type": "boolean"
+        },
+        "efsVolumeMetricsRefreshPeriod": {
+          "description": "efsVolumeMetricsRefreshPeriod specifies the frequency, in minutes, at which volume metrics are refreshed. Requires efsVolumeMetricsOptIn to be enabled to take effect. The default refresh period in the EFS CSI driver is 240 minutes.",
+          "type": "integer",
+          "format": "int32"
+        },
         "kmsKeyARN": {
           "description": "kmsKeyARN sets the cluster default storage class to encrypt volumes with a user-defined KMS key, rather than the default KMS key used by AWS. The value may be either the ARN or Alias ARN of a KMS key.",
           "type": "string"

diff --git a/operator/v1/types_csi_cluster_driver.go b/operator/v1/types_csi_cluster_driver.go
@@ -168,6 +168,25 @@ type AWSCSIDriverConfigSpec struct {
 	// +kubebuilder:validation:Pattern:=`^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-e|aws-iso-f):kms:[a-z0-9-]+:[0-9]{12}:(key|alias)\/.*$`
 	// +optional
 	KMSKeyARN string `json:"kmsKeyARN,omitempty"`
+
+	// efsVolumeMetricsOptIn enables metrics for EFS CSI Driver volumes.
+	// When enabled, the CSI driver traverses the entire volume to calculate and return metrics.
+	// This operation can significantly impact system performance due to the extensive volume walk required.
+	// Use with caution in performance-sensitive environments.
+	// +optional
+	EFSVolumeMetricsOptIn bool `json:"efsVolumeMetricsOptIn,omitempty"`
+
+	// efsVolumeMetricsRefreshPeriod specifies the frequency, in minutes, at which volume metrics are refreshed.
+	// Requires efsVolumeMetricsOptIn to be enabled to take effect.
+	// The default refresh period in the EFS CSI driver is 240 minutes.
+	// +optional
+	EFSVolumeMetricsRefreshPeriod int `json:"efsVolumeMetricsRefreshPeriod,omitempty"`
+
+	// efsVolumeMetricsFSRateLimit defines the rate limit, in goroutines per file system, for processing volume metrics.
+	// Requires efsVolumeMetricsOptIn to be enabled.
+	// The default rate limit set by the EFS CSI driver is 240 goroutines per file system.
+	// +optional
+	EFSVolumeMetricsFSRateLimit int `json:"efsVolumeMetricsFSRateLimit,omitempty"`
 }
 
 // AzureDiskEncryptionSet defines the configuration for a disk encryption set.

diff --git a/operator/v1/zz_generated.crd-manifests/0000_90_csi-driver_01_clustercsidrivers.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_90_csi-driver_01_clustercsidrivers.crd.yaml
@@ -70,6 +70,27 @@ spec:
                   aws:
                     description: aws is used to configure the AWS CSI driver.
                     properties:
+                      efsVolumeMetricsFSRateLimit:
+                        description: efsVolumeMetricsFSRateLimit defines the rate
+                          limit, in goroutines per file system, for processing volume
+                          metrics. Requires efsVolumeMetricsOptIn to be enabled. The
+                          default rate limit set by the EFS CSI driver is 240 goroutines
+                          per file system.
+                        type: integer
+                      efsVolumeMetricsOptIn:
+                        description: efsVolumeMetricsOptIn enables metrics for EFS
+                          CSI Driver volumes. When enabled, the CSI driver traverses
+                          the entire volume to calculate and return metrics. This
+                          operation can significantly impact system performance due
+                          to the extensive volume walk required. Use with caution
+                          in performance-sensitive environments.
+                        type: boolean
+                      efsVolumeMetricsRefreshPeriod:
+                        description: efsVolumeMetricsRefreshPeriod specifies the frequency,
+                          in minutes, at which volume metrics are refreshed. Requires
+                          efsVolumeMetricsOptIn to be enabled to take effect. The
+                          default refresh period in the EFS CSI driver is 240 minutes.
+                        type: integer
                       kmsKeyARN:
                         description: kmsKeyARN sets the cluster default storage class
                           to encrypt volumes with a user-defined KMS key, rather than

diff --git a/...rated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AAA_ungated.yaml b/...rated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AAA_ungated.yaml
@@ -50,6 +50,27 @@ spec:
                   aws:
                     description: aws is used to configure the AWS CSI driver.
                     properties:
+                      efsVolumeMetricsFSRateLimit:
+                        description: efsVolumeMetricsFSRateLimit defines the rate
+                          limit, in goroutines per file system, for processing volume
+                          metrics. Requires efsVolumeMetricsOptIn to be enabled. The
+                          default rate limit set by the EFS CSI driver is 240 goroutines
+                          per file system.
+                        type: integer
+                      efsVolumeMetricsOptIn:
+                        description: efsVolumeMetricsOptIn enables metrics for EFS
+                          CSI Driver volumes. When enabled, the CSI driver traverses
+                          the entire volume to calculate and return metrics. This
+                          operation can significantly impact system performance due
+                          to the extensive volume walk required. Use with caution
+                          in performance-sensitive environments.
+                        type: boolean
+                      efsVolumeMetricsRefreshPeriod:
+                        description: efsVolumeMetricsRefreshPeriod specifies the frequency,
+                          in minutes, at which volume metrics are refreshed. Requires
+                          efsVolumeMetricsOptIn to be enabled to take effect. The
+                          default refresh period in the EFS CSI driver is 240 minutes.
+                        type: integer
                       kmsKeyARN:
                         description: kmsKeyARN sets the cluster default storage class
                           to encrypt volumes with a user-defined KMS key, rather than

diff --git a/operator/v1/zz_generated.swagger_doc_generated.go b/operator/v1/zz_generated.swagger_doc_generated.go