Update hetznercluster_types.go

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

Hide file tree

Showing 4 changed files with 26 additions and 20 deletions.
diff --git a/api/v1beta1/hetznercluster_types.go b/api/v1beta1/hetznercluster_types.go
@@ -27,18 +27,18 @@ const (
 	// apiserver.
 	ClusterFinalizer = "hetznercluster.infrastructure.cluster.x-k8s.io"
 	// AllowEmptyControlPlaneAddressAnnotation allows HetznerCluster Webhook
-	// to skip some validation steps for external managed controle planes.
+	// to skip some validation steps for externally managed control planes.
 	AllowEmptyControlPlaneAddressAnnotation = "capi.syself.com/allow-empty-control-plane-address"
 )
 
 // HetznerClusterSpec defines the desired state of HetznerCluster.
 type HetznerClusterSpec struct {
-	// HCloudNetworkSpec defines the Network for Hetzner Cloud. If left empty no private Network is configured.
+	// HCloudNetworkSpec defines details about the private Network for Hetzner Cloud. If left empty, no private Network is configured.
 	// +optional
 	HCloudNetwork HCloudNetworkSpec `json:"hcloudNetwork"`
 
 	// ControlPlaneRegion consists of a list of HCloud Regions (fsn, nbg, hel). Because HCloud Networks
-	// have a very low latency we could assume in some use-cases that a region is behaving like a zone
+	// have a very low latency we could assume in some use cases that a region is behaving like a zone.
 	// https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone
 	ControlPlaneRegions []Region `json:"controlPlaneRegions"`
 
@@ -48,7 +48,7 @@ type HetznerClusterSpec struct {
 	// +optional
 	ControlPlaneEndpoint *clusterv1.APIEndpoint `json:"controlPlaneEndpoint,omitempty"`
 
-	// ControlPlaneLoadBalancer is optional configuration for customizing control plane behavior. Naming convention is from upstream cluster-api project.
+	// ControlPlaneLoadBalancer is an optional configuration for customizing control plane behavior. The naming convention is from the upstream Cluster API project.
 	ControlPlaneLoadBalancer LoadBalancerSpec `json:"controlPlaneLoadBalancer,omitempty"`
 
 	// +optional

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_hetznerclusters.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerclusters.yaml
@@ -82,9 +82,9 @@ spec:
                 - port
                 type: object
               controlPlaneLoadBalancer:
-                description: ControlPlaneLoadBalancer is optional configuration for
-                  customizing control plane behavior. Naming convention is from upstream
-                  cluster-api project.
+                description: ControlPlaneLoadBalancer is an optional configuration
+                  for customizing control plane behavior. The naming convention is
+                  from the upstream Cluster API project.
                 properties:
                   algorithm:
                     allOf:
@@ -160,8 +160,8 @@ spec:
               controlPlaneRegions:
                 description: ControlPlaneRegion consists of a list of HCloud Regions
                   (fsn, nbg, hel). Because HCloud Networks have a very low latency
-                  we could assume in some use-cases that a region is behaving like
-                  a zone https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone
+                  we could assume in some use cases that a region is behaving like
+                  a zone. https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone
                 items:
                   description: Region is a Hetzner Location
                   enum:
@@ -173,8 +173,8 @@ spec:
                   type: string
                 type: array
               hcloudNetwork:
-                description: HCloudNetworkSpec defines the Network for Hetzner Cloud.
-                  If left empty no private Network is configured.
+                description: HCloudNetworkSpec defines details about the private Network
+                  for Hetzner Cloud. If left empty, no private Network is configured.
                 properties:
                   cidrBlock:
                     default: 10.0.0.0/16

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerclustertemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerclustertemplates.yaml
@@ -103,9 +103,9 @@ spec:
                         - port
                         type: object
                       controlPlaneLoadBalancer:
-                        description: ControlPlaneLoadBalancer is optional configuration
-                          for customizing control plane behavior. Naming convention
-                          is from upstream cluster-api project.
+                        description: ControlPlaneLoadBalancer is an optional configuration
+                          for customizing control plane behavior. The naming convention
+                          is from the upstream Cluster API project.
                         properties:
                           algorithm:
                             allOf:
@@ -182,8 +182,8 @@ spec:
                       controlPlaneRegions:
                         description: ControlPlaneRegion consists of a list of HCloud
                           Regions (fsn, nbg, hel). Because HCloud Networks have a
-                          very low latency we could assume in some use-cases that
-                          a region is behaving like a zone https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone
+                          very low latency we could assume in some use cases that
+                          a region is behaving like a zone. https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone
                         items:
                           description: Region is a Hetzner Location
                           enum:
@@ -195,8 +195,9 @@ spec:
                           type: string
                         type: array
                       hcloudNetwork:
-                        description: HCloudNetworkSpec defines the Network for Hetzner
-                          Cloud. If left empty no private Network is configured.
+                        description: HCloudNetworkSpec defines details about the private
+                          Network for Hetzner Cloud. If left empty, no private Network
+                          is configured.
                         properties:
                           cidrBlock:
                             default: 10.0.0.0/16