🌱 Update remediation_types.go (#1178)

Update remediation_types.go
syself · Mar 28, 2024 · cdf777a · cdf777a
1 parent b8f6c72
commit cdf777a
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 15 deletions.
diff --git a/api/v1beta1/remediation_types.go b/api/v1beta1/remediation_types.go
@@ -39,15 +39,15 @@ const (
 
 // RemediationStrategy describes how to remediate machines.
 type RemediationStrategy struct {
-	// Type of remediation.
+	// Type represents the type of the remediation strategy. At the moment, only "Reboot" is supported.
 	// +kubebuilder:default=Reboot
 	// +optional
 	Type RemediationType `json:"type,omitempty"`
 
-	// Sets maximum number of remediation retries.
+	// RetryLimit sets the maximum number of remediation retries. Zero retries if not set.
 	// +optional
 	RetryLimit int `json:"retryLimit,omitempty"`
 
-	// Sets the timeout between remediation retries.
+	// Timeout sets the timeout between remediation retries. It should be of the form "10m", or "40s".
 	Timeout *metav1.Duration `json:"timeout"`
 }
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediations.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediations.yaml
@@ -72,14 +72,17 @@ spec:
                 description: Strategy field defines remediation strategy.
                 properties:
                   retryLimit:
-                    description: Sets maximum number of remediation retries.
+                    description: RetryLimit sets the maximum number of remediation
+                      retries. Zero retries if not set.
                     type: integer
                   timeout:
-                    description: Sets the timeout between remediation retries.
+                    description: Timeout sets the timeout between remediation retries.
+                      It should be of the form "10m", or "40s".
                     type: string
                   type:
                     default: Reboot
-                    description: Type of remediation.
+                    description: Type represents the type of the remediation strategy.
+                      At the moment, only "Reboot" is supported.
                     type: string
                 required:
                 - timeout

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediationtemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediationtemplates.yaml
@@ -70,14 +70,17 @@ spec:
                         description: Strategy field defines remediation strategy.
                         properties:
                           retryLimit:
-                            description: Sets maximum number of remediation retries.
+                            description: RetryLimit sets the maximum number of remediation
+                              retries. Zero retries if not set.
                             type: integer
                           timeout:
-                            description: Sets the timeout between remediation retries.
+                            description: Timeout sets the timeout between remediation
+                              retries. It should be of the form "10m", or "40s".
                             type: string
                           type:
                             default: Reboot
-                            description: Type of remediation.
+                            description: Type represents the type of the remediation
+                              strategy. At the moment, only "Reboot" is supported.
                             type: string
                         required:
                         - timeout

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediations.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediations.yaml
@@ -73,14 +73,17 @@ spec:
                   applied.
                 properties:
                   retryLimit:
-                    description: Sets maximum number of remediation retries.
+                    description: RetryLimit sets the maximum number of remediation
+                      retries. Zero retries if not set.
                     type: integer
                   timeout:
-                    description: Sets the timeout between remediation retries.
+                    description: Timeout sets the timeout between remediation retries.
+                      It should be of the form "10m", or "40s".
                     type: string
                   type:
                     default: Reboot
-                    description: Type of remediation.
+                    description: Type represents the type of the remediation strategy.
+                      At the moment, only "Reboot" is supported.
                     type: string
                 required:
                 - timeout

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediationtemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediationtemplates.yaml
@@ -71,14 +71,17 @@ spec:
                           to be applied.
                         properties:
                           retryLimit:
-                            description: Sets maximum number of remediation retries.
+                            description: RetryLimit sets the maximum number of remediation
+                              retries. Zero retries if not set.
                             type: integer
                           timeout:
-                            description: Sets the timeout between remediation retries.
+                            description: Timeout sets the timeout between remediation
+                              retries. It should be of the form "10m", or "40s".
                             type: string
                           type:
                             default: Reboot
-                            description: Type of remediation.
+                            description: Type represents the type of the remediation
+                              strategy. At the moment, only "Reboot" is supported.
                             type: string
                         required:
                         - timeout