Update hetznerbaremetalremediation_types.go

syself · Feb 29, 2024 · 3225b39 · 3225b39
1 parent ee9da5e
commit 3225b39
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/api/v1beta1/hetznerbaremetalremediation_types.go b/api/v1beta1/hetznerbaremetalremediation_types.go
@@ -31,7 +31,7 @@ const (
 
 // HetznerBareMetalRemediationSpec defines the desired state of HetznerBareMetalRemediation.
 type HetznerBareMetalRemediationSpec struct {
-	// Strategy field defines remediation strategy.
+	// Strategy field defines the remediation strategy to be applied.
 	Strategy *RemediationStrategy `json:"strategy,omitempty"`
 }
 

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalhosts.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalhosts.yaml
@@ -118,7 +118,8 @@ spec:
                 x-kubernetes-map-type: atomic
               description:
                 description: Description is a human-entered text used to help identify
-                  the host
+                  the host. It can be used to store some valuable information about
+                  the host.
                 type: string
               maintenanceMode:
                 description: MaintenanceMode indicates that a machine is supposed
@@ -145,9 +146,13 @@ spec:
                 type: object
               serverID:
                 description: ServerID defines the ID of the server provided by Hetzner.
+                  Find it on your Hetzner robot dashboard.
                 type: integer
               status:
-                description: Status contains all status information. DO NOT EDIT!!!
+                description: Status contains all status information. The controller
+                  writes this status. As some cannot be regenerated during any reconcilement,
+                  the status is in the specs of the object - not the actual status.
+                  DO NOT EDIT!!!
                 properties:
                   conditions:
                     description: Conditions defines current service state of the HetznerBareMetalHost.

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediations.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediations.yaml
@@ -69,7 +69,8 @@ spec:
               of HetznerBareMetalRemediation.
             properties:
               strategy:
-                description: Strategy field defines remediation strategy.
+                description: Strategy field defines the remediation strategy to be
+                  applied.
                 properties:
                   retryLimit:
                     description: Sets maximum number of remediation retries.

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediationtemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediationtemplates.yaml
@@ -67,7 +67,8 @@ spec:
                       of the HetznerBareMetalRemediation.
                     properties:
                       strategy:
-                        description: Strategy field defines remediation strategy.
+                        description: Strategy field defines the remediation strategy
+                          to be applied.
                         properties:
                           retryLimit:
                             description: Sets maximum number of remediation retries.