feat: run make generate

Signed-off-by: Ondrej Pokorny <[email protected]>

Author: opokornyy

config/v1alpha1/types_insights.go

@@ -74,6 +74,8 @@ type GatherConfig struct {
 type DisabledGatherer string
 
 // storageSpec provides persistent storage configuration options for on-demand gathering jobs.
+// If the type is set to PersistentVolumeClaim, 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 == 'PersistentVolumeClaim' ?  has(self.persistentVolume) : !has(self.persistentVolume)",message="persistentVolume is required when type is PersistentVolumeClaim, and forbidden otherwise"
 type StorageSpec struct {
 	// type is a required field that specifies the type of storage that will be used to store the Insights data archive.

config/v1alpha1/zz_generated.deepcopy.go

@@ -165,7 +165,7 @@ tests:
           insightsRequestID: xyz
           startTime: 2023-03-13T12:34:06Z
       expectedStatusError: 'Invalid value: "string": startTime is immutable once set'
-    - name: Status is presentt and insightsRequestID is added
+    - name: Status is present and insightsRequestID is added
       initial: |
         apiVersion: insights.openshift.io/v1alpha1
         kind: DataGather

config/v1alpha1/zz_generated.swagger_doc_generated.go

@@ -45,7 +45,8 @@ type DataGatherSpec struct {
 	// The current default is ClearText.
 	// +optional
 	DataPolicy DataPolicy `json:"dataPolicy"`
-	// gatherers is a list of gatherers configurations.
+	// gatherers is an optional list of gatherers configurations.
+	// The list must not exceed 100 items.
 	// 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'"
@@ -60,6 +61,8 @@ type DataGatherSpec struct {
 }
 
 // storageSpec provides persistent storage configuration options for on-demand gathering jobs.
+// If the type is set to PersistentVolumeClaim, 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 == 'PersistentVolumeClaim' ?  has(self.persistentVolume) : !has(self.persistentVolume)",message="persistentVolume is required when type is PersistentVolumeClaim, and forbidden otherwise"
 type StorageSpec struct {
 	// type is a required field that specifies the type of storage that will be used to store the Insights data archive.
@@ -138,8 +141,14 @@ type GathererState string
 
 // gathererConfig allows to configure specific gatherers
 type GathererConfig struct {
-	// name is the name of specific gatherer
+	// name is the required name of specific gatherer
+	// It must be at most 256 characters in length.
+	// The format for the gatherer name should be: {gatherer}/{function} where the function is optional.
+	// Gatherer consists of a lowercase string that may include underscores (_).
+	// Function consists of a lowercase string that may include underscores (_) and is separated from the gatherer by a forward slash (/).
+	// The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md.
 	// +kubebuilder:validation:MaxLength=256
+	// +kubebuilder:validation:XValidation:rule=`self.matches("^[a-z]+[_a-z]*[a-z]([/a-z][_a-z]*)?[a-z]$")`,message=`gatherer name must be in the format of {gatherer}/{function} where the gatherer and function are lowercase strings that may include underscores (_) and are separated by a forward slash (/) if the function is provided`
 	// +required
 	Name string `json:"name"`
 	// state allows you to configure specific gatherer. Valid values are "Enabled", "Disabled" and omitted.
@@ -247,8 +256,9 @@ type InsightsReport struct {
 	// +kubebuilder:validation:MaxItems=100
 	// +optional
 	HealthChecks []HealthCheck `json:"healthChecks,omitempty"`
-	// uri provides the URL link from which the report was downloaded.
-	// +kubebuilder:validation:Pattern=`^https:\/\/\S+`
+	// uri is optional field that provides the URL link from which the report was downloaded.
+	// The link must be a valid HTTPS URL and the maximum length is 2048 characters.
+	// +kubebuilder:validation:XValidation:rule=`self.matches("^https://[^\\s]+")`,message=`URI must be a valid HTTPS URL (e.g., https://example.com)`
 	// +kubebuilder:validation:MaxLength=2048
 	// +optional
 	URI string `json:"uri,omitempty"`
@@ -268,8 +278,9 @@ type HealthCheck struct {
 	// +kubebuilder:validation:Minimum=1
 	// +kubebuilder:validation:Maximum=4
 	TotalRisk int32 `json:"totalRisk"`
-	// advisorURI provides the URL link to the Insights Advisor.
-	// +kubebuilder:validation:Pattern=`^https:\/\/\S+`
+	// advisorURI is required field that provides the URL link to the Insights Advisor.
+	// The link must be a valid HTTPS URL and the maximum length is 2048 characters.
+	// +kubebuilder:validation:XValidation:rule=`self.matches("^https://[^\\s]+")`,message=`advisorURI must be a valid HTTPS URL (e.g., https://example.com)`
 	// +kubebuilder:validation:MaxLength=2048
 	// +required
 	AdvisorURI string `json:"advisorURI"`
@@ -296,26 +307,30 @@ const (
 type ObjectReference struct {
 	// group is the API Group of the Resource.
 	// Enter empty string for the core group.
-	// This value should consist of only lowercase alphanumeric characters, hyphens and periods.
+	// This value is empty or should follow the DNS1123 subdomain format and it must be at most 253 characters in length.
 	// Example: "", "apps", "build.openshift.io", etc.
-	// +kubebuilder:validation:Pattern:="^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$"
-	// +kubebuilder:validation:MaxLength=512
+	// +kubebuilder:validation:XValidation:rule="self.size() == 0 || !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
 	Group string `json:"group"`
-	// resource is the type that is being referenced.
+	// resource is required field of the type that is being referenced.
 	// It is normally the plural form of the resource kind in lowercase.
 	// This value should consist of only lowercase alphanumeric characters and hyphens.
 	// Example: "deployments", "deploymentconfigs", "pods", etc.
-	// +kubebuilder:validation:Pattern:="^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
+	// +kubebuilder:validation:XValidation:rule=`self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$")`,message=`resource must consist of only lowercase alphanumeric characters and hyphens`
 	// +kubebuilder:validation:MaxLength=512
 	// +required
 	Resource string `json:"resource"`
-	// name of the referent.
+	// name of the referent that follows the DNS1123 subdomain format.
+	// It must be at most 256 characters in length.
+	// +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=256
 	// +required
 	Name string `json:"name"`
-	// namespace of the referent.
-	// +kubebuilder:validation:MaxLength=512
+	// namespace of the referent that follows the DNS1123 subdomain format.
+	// It must be at most 256 characters in length.
+	// +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
 	// +optional
 	Namespace string `json:"namespace,omitempty"`
 }

insights/v1alpha1/tests/datagathers.insights.openshift.io/InsightsOnDemandDataGather.yaml

@@ -73,17 +73,30 @@ spec:
                 type: string
               gatherers:
                 description: |-
-                  gatherers is a list of gatherers configurations.
+                  gatherers is an optional list of gatherers configurations.
+                  The list must not exceed 100 items.
                   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'"
                 items:
                   description: gathererConfig allows to configure specific gatherers
                   properties:
                     name:
-                      description: name is the name of specific gatherer
+                      description: |-
+                        name is the required name of specific gatherer
+                        It must be at most 256 characters in length.
+                        The format for the gatherer name should be: {gatherer}/{function} where the function is optional.
+                        Gatherer consists of a lowercase string that may include underscores (_).
+                        Function consists of a lowercase string that may include underscores (_) and is separated from the gatherer by a forward slash (/).
+                        The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md.
                       maxLength: 256
                       type: string
+                      x-kubernetes-validations:
+                      - message: gatherer name must be in the format of {gatherer}/{function}
+                          where the gatherer and function are lowercase strings that
+                          may include underscores (_) and are separated by a forward
+                          slash (/) if the function is provided
+                        rule: self.matches("^[a-z]+[_a-z]*[a-z]([/a-z][_a-z]*)?[a-z]$")
                     state:
                       description: |-
                         state allows you to configure specific gatherer. Valid values are "Enabled", "Disabled" and omitted.
@@ -366,11 +379,14 @@ spec:
                         attributes.
                       properties:
                         advisorURI:
-                          description: advisorURI provides the URL link to the Insights
-                            Advisor.
+                          description: |-
+                            advisorURI is required field that provides the URL link to the Insights Advisor.
+                            The link must be a valid HTTPS URL and the maximum length is 2048 characters.
                           maxLength: 2048
-                          pattern: ^https:\/\/\S+
                           type: string
+                          x-kubernetes-validations:
+                          - message: advisorURI must be a valid HTTPS URL (e.g., https://example.com)
+                            rule: self.matches("^https://[^\\s]+")
                         description:
                           description: description provides basic description of the
                             healtcheck.
@@ -405,11 +421,14 @@ spec:
                     type: array
                     x-kubernetes-list-type: atomic
                   uri:
-                    description: uri provides the URL link from which the report was
-                      downloaded.
+                    description: |-
+                      uri is optional field that provides the URL link from which the report was downloaded.
+                      The link must be a valid HTTPS URL and the maximum length is 2048 characters.
                     maxLength: 2048
-                    pattern: ^https:\/\/\S+
                     type: string
+                    x-kubernetes-validations:
+                    - message: URI must be a valid HTTPS URL (e.g., https://example.com)
+                      rule: self.matches("^https://[^\\s]+")
                 type: object
               insightsRequestID:
                 description: |-
@@ -432,28 +451,49 @@ spec:
                       description: |-
                         group is the API Group of the Resource.
                         Enter empty string for the core group.
-                        This value should consist of only lowercase alphanumeric characters, hyphens and periods.
+                        This value is empty or should follow the DNS1123 subdomain format and it must be at most 253 characters in length.
                         Example: "", "apps", "build.openshift.io", etc.
-                      maxLength: 512
-                      pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                      maxLength: 253
                       type: string
+                      x-kubernetes-validations:
+                      - message: a lowercase RFC 1123 subdomain must consist of lower
+                          case alphanumeric characters, '-' or '.', and must start
+                          and end with an alphanumeric character.
+                        rule: self.size() == 0 || !format.dns1123Subdomain().validate(self).hasValue()
                     name:
-                      description: name of the referent.
+                      description: |-
+                        name of the referent that follows the DNS1123 subdomain format.
+                        It must be at most 256 characters in length.
                       maxLength: 256
                       type: string
+                      x-kubernetes-validations:
+                      - message: a lowercase RFC 1123 subdomain must consist of lower
+                          case alphanumeric characters, '-' or '.', and must start
+                          and end with an alphanumeric character.
+                        rule: '!format.dns1123Subdomain().validate(self).hasValue()'
                     namespace:
-                      description: namespace of the referent.
-                      maxLength: 512
+                      description: |-
+                        namespace of the referent that follows the DNS1123 subdomain format.
+                        It must be at most 256 characters in length.
+                      maxLength: 253
                       type: string
+                      x-kubernetes-validations:
+                      - message: a lowercase RFC 1123 subdomain must consist of lower
+                          case alphanumeric characters, '-' or '.', and must start
+                          and end with an alphanumeric character.
+                        rule: '!format.dns1123Subdomain().validate(self).hasValue()'
                     resource:
                       description: |-
-                        resource is the type that is being referenced.
+                        resource is required field of the type that is being referenced.
                         It is normally the plural form of the resource kind in lowercase.
                         This value should consist of only lowercase alphanumeric characters and hyphens.
                         Example: "deployments", "deploymentconfigs", "pods", etc.
                       maxLength: 512
-                      pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
                       type: string
+                      x-kubernetes-validations:
+                      - message: resource must consist of only lowercase alphanumeric
+                          characters and hyphens
+                        rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$")
                   required:
                   - group
                   - name