docs: update description of successfulScansHistoryLimit and failedSca…

…nsHistoryLimit clusterscan fields
undistro · Sep 4, 2023 · 1f6889a · 1f6889a
1 parent 4329d87
commit 1f6889a
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 18 deletions.
diff --git a/api/zora/v1alpha1/clusterscan_types.go b/api/zora/v1alpha1/clusterscan_types.go
@@ -39,16 +39,14 @@ type ClusterScanSpec struct {
 	// The list of Plugin references that are used to scan the referenced Cluster.  Defaults to 'popeye'
 	Plugins []PluginReference `json:"plugins,omitempty"`
 
-	// SuccessfulScansHistoryLimit specifies the amount of successfully
-	// completed scan Jobs to be kept in the cluster. This field is analogous
-	// to <Cronjob.Spec.SuccessfulJobsHistoryLimit> from the <batch> package.
+	// The number of successful finished scans and their issues to retain. Value must be non-negative integer.
+	// Defaults to 3.
 	// +kubebuilder:validation:Minimum=0
 	// +kubebuilder:default=3
 	SuccessfulScansHistoryLimit *int32 `json:"successfulScansHistoryLimit,omitempty"`
 
-	// FailedScansHistoryLimit specifies the amount of failed scan Jobs to be
-	// kept in the cluster. This field is analogous to
-	// <Cronjob.Spec.FailedScansHistoryLimit> from the <batch> package.
+	// The number of failed finished scans to retain. Value must be non-negative integer.
+	// Defaults to 1.
 	// +kubebuilder:validation:Minimum=0
 	// +kubebuilder:default=1
 	FailedScansHistoryLimit *int32 `json:"failedScansHistoryLimit,omitempty"`

diff --git a/charts/zora/crds/zora.undistro.io_clusterscans.yaml b/charts/zora/crds/zora.undistro.io_clusterscans.yaml
@@ -99,9 +99,8 @@ spec:
                 x-kubernetes-map-type: atomic
               failedScansHistoryLimit:
                 default: 1
-                description: FailedScansHistoryLimit specifies the amount of failed
-                  scan Jobs to be kept in the cluster. This field is analogous to
-                  <Cronjob.Spec.FailedScansHistoryLimit> from the <batch> package.
+                description: The number of failed finished scans to retain. Value
+                  must be non-negative integer. Defaults to 1.
                 format: int32
                 minimum: 0
                 type: integer
@@ -246,9 +245,8 @@ spec:
                 type: string
               successfulScansHistoryLimit:
                 default: 3
-                description: SuccessfulScansHistoryLimit specifies the amount of successfully
-                  completed scan Jobs to be kept in the cluster. This field is analogous
-                  to <Cronjob.Spec.SuccessfulJobsHistoryLimit> from the <batch> package.
+                description: The number of successful finished scans and their issues
+                  to retain. Value must be non-negative integer. Defaults to 3.
                 format: int32
                 minimum: 0
                 type: integer

diff --git a/config/crd/bases/zora.undistro.io_clusterscans.yaml b/config/crd/bases/zora.undistro.io_clusterscans.yaml
@@ -85,9 +85,8 @@ spec:
                 x-kubernetes-map-type: atomic
               failedScansHistoryLimit:
                 default: 1
-                description: FailedScansHistoryLimit specifies the amount of failed
-                  scan Jobs to be kept in the cluster. This field is analogous to
-                  <Cronjob.Spec.FailedScansHistoryLimit> from the <batch> package.
+                description: The number of failed finished scans to retain. Value
+                  must be non-negative integer. Defaults to 1.
                 format: int32
                 minimum: 0
                 type: integer
@@ -232,9 +231,8 @@ spec:
                 type: string
               successfulScansHistoryLimit:
                 default: 3
-                description: SuccessfulScansHistoryLimit specifies the amount of successfully
-                  completed scan Jobs to be kept in the cluster. This field is analogous
-                  to <Cronjob.Spec.SuccessfulJobsHistoryLimit> from the <batch> package.
+                description: The number of successful finished scans and their issues
+                  to retain. Value must be non-negative integer. Defaults to 3.
                 format: int32
                 minimum: 0
                 type: integer