CCXDEV-14850: insights add storage spec

config/v1alpha1/tests/insightsdatagathers.config.openshift.io/InsightsConfig.yaml

@@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1 # Hack because controller-gen complains if w
 name: "[TechPreview] InsightsDataGather"
 crdName: insightsdatagathers.config.openshift.io
 featureGates:
-- InsightsConfig
+  - InsightsConfig
 tests:
   onCreate:
     - name: Should be able to create a minimal InsightsDataGather
@@ -14,3 +14,145 @@ tests:
         apiVersion: config.openshift.io/v1alpha1
         kind: InsightsDataGather
         spec: {}
+    - name: Should be able to create InsightsDataGather with a storage and PersistentVolume
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            dataPolicy: None
+            storage:
+              type: PersistentVolume
+              persistentVolume:
+                mountPath: /data
+                claim:
+                  name: test-claim
+      expected: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            dataPolicy: None
+            storage:
+              type: PersistentVolume
+              persistentVolume:
+                mountPath: /data
+                claim:
+                  name: test-claim
+    - name: Should be able to create InsightsDataGather with a storage and Ephemeral
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            dataPolicy: None
+            storage:
+              type: Ephemeral
+      expected: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            dataPolicy: None
+            storage:
+              type: Ephemeral
+    - name: Should be able to create InsightsDataGather with valid DisabledGatherers names
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            disabledGatherers:
+              - gatherer
+              - valid_gatherer
+              - gatherer/function
+              - gatherer_a/function_a
+      expected: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            disabledGatherers:
+              - gatherer
+              - valid_gatherer
+              - gatherer/function
+              - gatherer_a/function_a
+    - name: When storage.type is PersistentVolume then PersistentVolume must be present
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            storage:
+              type: PersistentVolume
+      expectedError: 'spec.gatherConfig.storage: Invalid value: "object": persistentVolume is required when type is PersistentVolume, and forbidden otherwise'
+    - name: When storage.type is not PersistentVolume then PersistentVolume must not be present
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            storage:
+              type: Ephemeral
+              persistentVolume:
+                claim:
+                  name: test-claim
+      expectedError: 'spec.gatherConfig.storage: Invalid value: "object": persistentVolume is required when type is PersistentVolume, and forbidden otherwise'
+    - name: mountPath must not contain colon
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            storage:
+              type: PersistentVolume
+              persistentVolume:
+                mountPath: /data:/data
+                claim:
+                  name: test-claim
+      expectedError: 'spec.gatherConfig.storage.persistentVolume.mountPath: Invalid value: "string": mountPath must not contain a colon'
+    - name: invalid disabledGatherers name
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            disabledGatherers:
+              - invalid_gatherer_1
+      expectedError: 'Invalid value: "string": disabledGatherer must be in the format of {gatherer}/{function} where the gatherer and function are lowercase letters only that may include underscores (_) and are separated by a forward slash (/) if the function is provided'
+    - name: storage.type is required
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            storage:
+              persistentVolume:
+                mountPath: /data
+                claim:
+                  name: test-claim
+      expectedError: "spec.gatherConfig.storage.type: Required value"
+    - name: storage.persistentVolume.claim can not be empty
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            storage:
+              type: PersistentVolume
+              persistentVolume:
+                mountPath: /data
+                claim:
+      expectedError: "spec.gatherConfig.storage.persistentVolume.claim: Required value"
+    - name: claim must follow the naming convention
+      initial: |
+        apiVersion: config.openshift.io/v1alpha1
+        kind: InsightsDataGather
+        spec:
+          gatherConfig:
+            storage:
+              type: PersistentVolume
+              persistentVolume:
+                claim:
+                  name: INVALID_PVC_NAME
+      expectedError: 'Invalid value: "string": a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, ''-'' or ''.'', and must start and end with an alphanumeric character.'

config/v1alpha1/types_insights.go

@@ -32,33 +32,97 @@ type InsightsDataGather struct {
 }
 
 type InsightsDataGatherSpec struct {
-	// gatherConfig spec attribute includes all the configuration options related to
-	// gathering of the Insights data and its uploading to the ingress.
+	// gatherConfig spec attribute includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.
 	// +optional
 	GatherConfig GatherConfig `json:"gatherConfig,omitempty"`
 }
 
-type InsightsDataGatherStatus struct {
-}
+type InsightsDataGatherStatus struct{}
 
 // gatherConfig provides data gathering configuration options.
 type GatherConfig struct {
-	// dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain
-	// in the Insights archive data. Valid values are "None" and "ObfuscateNetworking".
+	// dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain in the Insights archive data.
+	// Valid values are "None" and "ObfuscateNetworking".
 	// When set to None the data is not obfuscated.
 	// When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated.
 	// When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
-	// The current default is None.
 	// +optional
 	DataPolicy DataPolicy `json:"dataPolicy,omitempty"`
 	// disabledGatherers is a list of gatherers to be excluded from the gathering. All the gatherers can be disabled by providing "all" value.
 	// If all the gatherers are disabled, the Insights operator does not gather any data.
+	// The format for the disabledGatherer should be: {gatherer}/{function} where the function is optional.
+	// Gatherer consists of a lowercase letters only that may include underscores (_).
+	// Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/).
 	// The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md.
 	// Run the following command to get the names of last active gatherers:
 	// "oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'"
 	// An example of disabling gatherers looks like this: `disabledGatherers: ["clusterconfig/machine_configs", "workloads/workload_info"]`
+	// +kubebuilder:validation:MaxItems=100
+	// +optional
+	DisabledGatherers []DisabledGatherer `json:"disabledGatherers"`
+	// storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive.
+	// If omitted, the gathering job will use ephemeral storage.
+	// +optional
+	StorageSpec *Storage `json:"storage,omitempty"`
+}
+
+// disabledGatherer is a string that represents a gatherer that should be disabled
+// +kubebuilder:validation:MaxLength=256
+// +kubebuilder:validation:XValidation:rule=`self.matches("^[a-z]+[_a-z]*[a-z]([/a-z][_a-z]*)?[a-z]$")`,message=`disabledGatherer must be in the format of {gatherer}/{function} where the gatherer and function are lowercase letters only that may include underscores (_) and are separated by a forward slash (/) if the function is provided`
+type DisabledGatherer string
+
+// storage provides persistent storage configuration options for gathering jobs.
+// If the type is set to PersistentVolume, then the PersistentVolume must be defined.
+// If the type is set to Ephemeral, then the PersistentVolume must not be defined.
+// +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'PersistentVolume' ?  has(self.persistentVolume) : !has(self.persistentVolume)",message="persistentVolume is required when type is PersistentVolume, and forbidden otherwise"
+type Storage struct {
+	// type is a required field that specifies the type of storage that will be used to store the Insights data archive.
+	// Valid values are "PersistentVolume" and "Ephemeral".
+	// When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job.
+	// When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the persistentVolume field.
+	// +required
+	Type StorageType `json:"type"`
+	// persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive.
+	// The PersistentVolume must be created in the openshift-insights namespace.
 	// +optional
-	DisabledGatherers []string `json:"disabledGatherers"`
+	PersistentVolume *PersistentVolumeConfig `json:"persistentVolume,omitempty"`
+}
+
+// storageType declares valid storage types
+// +kubebuilder:validation:Enum=PersistentVolume;Ephemeral
+type StorageType string
+
+const (
+	// StorageTypePersistentVolume storage type
+	StorageTypePersistentVolume StorageType = "PersistentVolume"
+	// StorageTypeEphemeral storage type
+	StorageTypeEphemeral StorageType = "Ephemeral"
+)
+
+// persistentVolumeConfig provides configuration options for PersistentVolume storage.
+type PersistentVolumeConfig struct {
+	// claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive.
+	// The PersistentVolumeClaim must be created in the openshift-insights namespace.
+	// +required
+	Claim PersistentVolumeClaimReference `json:"claim"`
+	// mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod.
+	// When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
+	// The current default mount path is /var/lib/insights-operator
+	// The path may not exceed 1024 characters and must not contain a colon.
+	// +kubebuilder:validation:MaxLength=1024
+	// +kubebuilder:validation:XValidation:rule="!self.contains(':')",message="mountPath must not contain a colon"
+	// +optional
+	MountPath string `json:"mountPath,omitempty"`
+}
+
+// persistentVolumeClaimReference is a reference to a PersistentVolumeClaim.
+type PersistentVolumeClaimReference struct {
+	// name is a string that follows the DNS1123 subdomain format.
+	// It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.
+	// +kubebuilder:validation:XValidation:rule="!format.dns1123Subdomain().validate(self).hasValue()",message="a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character."
+	// +kubebuilder:validation:MaxLength:=253
+	// +required
+	Name string `json:"name"`
 }
 
 const (