From bbf4ad3ecc96a4fbce95d8aea46bebeb7ab1f0a3 Mon Sep 17 00:00:00 2001 From: Sayanta Banerjee <53281158+Sayanta66@users.noreply.github.com> Date: Wed, 21 Feb 2024 16:01:41 +0530 Subject: [PATCH] Update API descriptions for hetznercluster object Co-authored-by: janiskemper <63146658+janiskemper@users.noreply.github.com> Update api/v1beta1/hetznercluster_types.go Co-authored-by: janiskemper <63146658+janiskemper@users.noreply.github.com> --- api/v1beta1/hetznercluster_types.go | 8 ++++---- ...structure.cluster.x-k8s.io_hetznerclusters.yaml | 13 ++++++------- ...e.cluster.x-k8s.io_hetznerclustertemplates.yaml | 14 +++++++------- 3 files changed, 17 insertions(+), 18 deletions(-) diff --git a/api/v1beta1/hetznercluster_types.go b/api/v1beta1/hetznercluster_types.go index c3ddf8f48..9c5929cdf 100644 --- 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. + // HCloudNetwork 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. ControlPlaneLoadBalancer LoadBalancerSpec `json:"controlPlaneLoadBalancer,omitempty"` // +optional diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerclusters.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerclusters.yaml index 65208f3ef..af5352dd0 100644 --- 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,8 @@ 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. properties: algorithm: allOf: @@ -160,8 +159,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 +172,8 @@ spec: type: string type: array hcloudNetwork: - description: HCloudNetworkSpec defines the Network for Hetzner Cloud. - If left empty no private Network is configured. + description: HCloudNetwork 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 index 7deb0d86f..fa73cdc96 100644 --- 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,8 @@ 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. properties: algorithm: allOf: @@ -182,8 +181,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 +194,9 @@ spec: type: string type: array hcloudNetwork: - description: HCloudNetworkSpec defines the Network for Hetzner - Cloud. If left empty no private Network is configured. + description: HCloudNetwork 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