fixup! refactor: Add more kubebuilder annotations

Author: jimmidyson

.golangci.yml

@@ -99,7 +99,7 @@ issues:
     - source: "flags.Parse|response.WriteError"
       linters:
         - errcheck
-    - source: "^// \\+kubebuilder:"
+    - source: "// \\+kubebuilder:"
       linters:
         - lll
     # Idiomatic to use init functions to register APIs with scheme

api/v1alpha1/addon_types.go

@@ -40,26 +40,34 @@ type AddonStrategy string
 
 // CNI required for providing CNI configuration.
 type CNI struct {
-	// +optional
-	Provider string `json:"provider,omitempty"`
-	// +optional
-	Strategy AddonStrategy `json:"strategy,omitempty"`
+	// CNI provider to deploy.
+	// +kubebuilder:validation:Enum=Calico;Cilium
+	Provider string `json:"provider"`
+	// Addon strategy used to deploy the CNI provider to the workload cluster.
+	// +kubebuilder:validation:Enum=ClusterResourceSet;HelmAddon
+	Strategy AddonStrategy `json:"strategy"`
 }
 
 // NFD tells us to enable or disable the node feature discovery addon.
 type NFD struct {
-	// +optional
-	Strategy AddonStrategy `json:"strategy,omitempty"`
+	// Addon strategy used to deploy Node Feature Discovery (NFD) to the workload cluster.
+	// +kubebuilder:validation:Enum=ClusterResourceSet;HelmAddon
+	Strategy AddonStrategy `json:"strategy"`
 }
 
 // ClusterAutoscaler tells us to enable or disable the cluster-autoscaler addon.
 type ClusterAutoscaler struct {
-	// +optional
-	Strategy AddonStrategy `json:"strategy,omitempty"`
+	// Addon strategy used to deploy cluster-autoscaler to the management cluster
+	// targeting the workload cluster.
+	// +kubebuilder:validation:Enum=ClusterResourceSet;HelmAddon
+	Strategy AddonStrategy `json:"strategy"`
 }
 
 type DefaultStorage struct {
-	ProviderName           string `json:"providerName"`
+	// Name of the CSI Provider for the default storage class.
+	// +kubebuilder:validation:Enum=aws-ebs;nutanix
+	ProviderName string `json:"providerName"`
+	// Name of storage class config in any of the provider objects.
 	StorageClassConfigName string `json:"storageClassConfigName"`
 }
 
@@ -71,29 +79,42 @@ type CSI struct {
 }
 
 type CSIProvider struct {
+	// Name of the CSI Provider.
+	// +kubebuilder:validation:Enum=aws-ebs;nutanix
 	Name string `json:"name"`
 
 	// +optional
 	StorageClassConfig []StorageClassConfig `json:"storageClassConfig,omitempty"`
 
+	// Addon strategy used to deploy the CSI provider to the workload cluster.
+	// +kubebuilder:validation:Enum=ClusterResourceSet;HelmAddon
 	Strategy AddonStrategy `json:"strategy"`
 
+	// The reference to any secret used by the CSI Provider.
 	// +optional
 	Credentials *corev1.LocalObjectReference `json:"credentials,omitempty"`
 }
 
 type StorageClassConfig struct {
+	// Name of storage class config.
 	Name string `json:"name"`
 
+	// Parameters passed into the storage class object.
 	// +optional
 	Parameters map[string]string `json:"parameters,omitempty"`
 
+	// +kubebuilder:validation:Enum=Delete;Retain;Recycle
+	// +kubebuilder:default=Delete
 	// +optional
 	ReclaimPolicy corev1.PersistentVolumeReclaimPolicy `json:"reclaimPolicy,omitempty"`
 
+	// +kubebuilder:validation:Enum=Immediate;WaitForFirstConsumer
+	// +kubebuilder:default=WaitForFirstConsumer
 	// +optional
 	VolumeBindingMode storagev1.VolumeBindingMode `json:"volumeBindingMode,omitempty"`
 
+	// If the storage class should allow volume expanding
+	// +kubebuilder:default=false
 	// +optional
 	AllowExpansion bool `json:"allowExpansion,omitempty"`
 }

api/v1alpha1/aws_clusterconfig_types.go

@@ -11,6 +11,7 @@ type AWSSpec struct {
 	// AWS region to create cluster in.
 	// +optional
 	Region *Region `json:"region,omitempty"`
+	// AWS network configuration.
 	// +optional
 	Network *AWSNetwork `json:"network,omitempty"`
 	// +optional
@@ -23,26 +24,27 @@ type AWSNetwork struct {
 	// +optional
 	VPC *VPC `json:"vpc,omitempty"`
 
+	// AWS Subnet configuration.
 	// +optional
 	Subnets Subnets `json:"subnets,omitempty"`
 }
 
 type VPC struct {
-	// ID is the vpc-id of the VPC this provider should use to create resources.
-	ID string `json:"id,omitempty"`
+	// Existing VPC ID to use for the cluster.
+	ID string `json:"id"`
 }
 
 type Subnets []SubnetSpec
 
 // SubnetSpec configures an AWS Subnet.
 type SubnetSpec struct {
-	// ID defines a unique identifier to reference this resource.
+	// Existing Subnet ID to use for the cluster.
 	ID string `json:"id"`
 }
 
 // AWSLoadBalancerSpec configures an AWS control-plane LoadBalancer.
 type AWSLoadBalancerSpec struct {
-	// Scheme sets the scheme of the load balancer (defaults to internet-facing)
+	// Scheme sets the scheme of the load balancer.
 	// +kubebuilder:default=internet-facing
 	// +kubebuilder:validation:Enum=internet-facing;internal
 	// +optional

api/v1alpha1/clusterconfig_types.go

@@ -82,6 +82,7 @@ func (s AWSClusterConfig) VariableSchema() clusterv1.VariableSchema { //nolint:g
 
 // AWSClusterConfigSpec defines the desired state of ClusterConfig.
 type AWSClusterConfigSpec struct {
+	// AWS cluster configuration.
 	// +optional
 	AWS *AWSSpec `json:"aws,omitempty"`
 
@@ -160,20 +161,27 @@ func (s GenericClusterConfig) VariableSchema() clusterv1.VariableSchema { //noli
 
 // GenericClusterConfigSpec defines the desired state of GenericClusterConfig.
 type GenericClusterConfigSpec struct {
+	// Sets the Kubernetes image repository used for the KubeadmControlPlane.
+	// +kubebuilder:validation:Pattern=`^((?:[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*|\[(?:[a-fA-F0-9:]+)\])(:[0-9]+)?/)?[a-z0-9]+((?:[._]|__|[-]+)[a-z0-9]+)*(/[a-z0-9]+((?:[._]|__|[-]+)[a-z0-9]+)*)*$`
 	// +optional
-	KubernetesImageRepository *KubernetesImageRepository `json:"kubernetesImageRepository,omitempty"`
+	KubernetesImageRepository *string `json:"kubernetesImageRepository,omitempty"`
 
 	// +optional
 	Etcd *Etcd `json:"etcd,omitempty"`
 
 	// +optional
 	Proxy *HTTPProxy `json:"proxy,omitempty"`
 
+	// Subject Alternative Names for the API Server signing cert.
+	// For Docker  are injected automatically.
+	// For Nutanix  are injected automatically.
+	// +kubebuilder:validation:UniqueItems=true
+	// +kubebuilder:validation:items:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
 	// +optional
-	ExtraAPIServerCertSANs ExtraAPIServerCertSANs `json:"extraAPIServerCertSANs,omitempty"`
+	ExtraAPIServerCertSANs []string `json:"extraAPIServerCertSANs,omitempty"`
 
 	// +optional
-	ImageRegistries ImageRegistries `json:"imageRegistries,omitempty"`
+	ImageRegistries []ImageRegistry `json:"imageRegistries,omitempty"`
 
 	// +optional
 	GlobalImageRegistryMirror *GlobalImageRegistryMirror `json:"globalImageRegistryMirror,omitempty"`
@@ -182,22 +190,17 @@ type GenericClusterConfigSpec struct {
 	Addons *Addons `json:"addons,omitempty"`
 
 	// +optional
-	Users Users `json:"users,omitempty"`
-}
-
-// KubernetesImageRepository required for overriding Kubernetes image repository.
-type KubernetesImageRepository string
-
-func (v KubernetesImageRepository) String() string {
-	return string(v)
+	Users []User `json:"users,omitempty"`
 }
 
 type Image struct {
 	// Repository is used to override the image repository to pull from.
+	// +kubebuilder:validation:Pattern=`^((?:[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*|\[(?:[a-fA-F0-9:]+)\])(:[0-9]+)?/)?[a-z0-9]+((?:[._]|__|[-]+)[a-z0-9]+)*(/[a-z0-9]+((?:[._]|__|[-]+)[a-z0-9]+)*)*$`
 	// +optional
 	Repository string `json:"repository,omitempty"`
 
 	// Tag is used to override the default image tag.
+	// +kubebuilder:validation:Pattern=`^[\w][\w.-]{0,127}$`
 	// +optional
 	Tag string `json:"tag,omitempty"`
 }
@@ -210,10 +213,10 @@ type Etcd struct {
 
 // HTTPProxy required for providing proxy configuration.
 type HTTPProxy struct {
-	// HTTP proxy.
+	// HTTP proxy value.
 	HTTP string `json:"http,omitempty"`
 
-	// HTTPS proxy.
+	// HTTPS proxy value.
 	HTTPS string `json:"https,omitempty"`
 
 	// AdditionalNo Proxy list that will be added to the automatically calculated
@@ -223,9 +226,6 @@ type HTTPProxy struct {
 	AdditionalNo []string `json:"additionalNo"`
 }
 
-// ExtraAPIServerCertSANs required for providing API server cert SANs.
-type ExtraAPIServerCertSANs []string
-
 type RegistryCredentials struct {
 	// A reference to the Secret containing the registry credentials and optional CA certificate
 	// using the keys `username`, `password` and `ca.crt`.
@@ -236,7 +236,9 @@ type RegistryCredentials struct {
 
 // GlobalImageRegistryMirror sets default mirror configuration for all the image registries.
 type GlobalImageRegistryMirror struct {
-	// Registry URL.
+	// Registry mirror URL.
+	// +kubebuilder:validation:Format=`uri`
+	// +kubebuilder:validation:Pattern=`^https?://`
 	URL string `json:"url"`
 
 	// Credentials and CA certificate for the image registry mirror
@@ -246,17 +248,15 @@ type GlobalImageRegistryMirror struct {
 
 type ImageRegistry struct {
 	// Registry URL.
+	// +kubebuilder:validation:Format=`uri`
+	// +kubebuilder:validation:Pattern=`^https?://`
 	URL string `json:"url"`
 
 	// Credentials and CA certificate for the image registry
 	// +optional
 	Credentials *RegistryCredentials `json:"credentials,omitempty"`
 }
 
-type ImageRegistries []ImageRegistry
-
-type Users []User
-
 // User defines the input for a generated user in cloud-init.
 type User struct {
 	// Name specifies the user name.

api/v1alpha1/common_types.go

@@ -3,10 +3,6 @@
 
 package v1alpha1
 
-import (
-	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
-)
-
 const (
 	APIServerPort = 6443
 )
@@ -32,4 +28,13 @@ type ObjectMeta struct {
 	Annotations map[string]string `json:"annotations,omitempty"`
 }
 
-type ControlPlaneEndpointSpec clusterv1.APIEndpoint
+type ControlPlaneEndpointSpec struct {
+	// The hostname on which the API server is serving.
+	// +kubebuilder:validation:MinLength=1
+	Host string `json:"host"`
+
+	// The port on which the API server is serving.
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=65535
+	Port int32 `json:"port"`
+}