Merge pull request #8071 from sbueringer/pr-deprecate

🌱 Deprecate v1alpha3 & v1alpha4
kubernetes-sigs · Feb 14, 2023 · 9c5fdae · 9c5fdae
2 parents 75b6c47 + 9bee35d
commit 9c5fdae
Show file tree

Hide file tree

Showing 65 changed files with 235 additions and 48 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -227,10 +227,21 @@ issues:
   # changes in PRs and avoid nitpicking.
   exclude-use-default: false
   exclude-rules:
-  # Specific exclude rules for deprecated fields that are still part of the codebase. These should be removed as the referenced deprecated item is removed from the project.
+  # Specific exclude rules for deprecated fields that are still part of the codebase. These
+  # should be removed as the referenced deprecated item is removed from the project.
   - linters:
       - staticcheck
     text: "SA1019: (bootstrapv1.ClusterStatus|scope.Config.Spec.UseExperimentalRetryJoin|DockerMachine.Spec.Bootstrapped|machineStatus.Bootstrapped) is deprecated"
+  # Specific exclude rules for deprecated packages that are still part of the codebase. These
+  # should be removed as the referenced deprecated packages are removed from the project.
+  - linters:
+    - staticcheck
+    text: "SA1019: .* is deprecated: This package will be removed in one of the next releases."
+  # Specific exclude rules for deprecated types that are still part of the codebase. These
+  # should be removed as the referenced deprecated types are removed from the project.
+  - linters:
+    - staticcheck
+    text: "SA1019: (clusterv1alpha3.*|clusterv1alpha4.*) is deprecated: This type will be removed in one of the next releases."
   - linters:
     - revive
     text: "exported: exported method .*\\.(Reconcile|SetupWithManager|SetupWebhookWithManager) should have comment or be unexported"

diff --git a/api/v1alpha3/doc.go b/api/v1alpha3/doc.go
@@ -16,4 +16,6 @@ limitations under the License.
 
 // Package v1alpha3 contains the v1alpha3 API implementation.
 // +k8s:conversion-gen=sigs.k8s.io/cluster-api/api/v1beta1
+//
+// Deprecated: This package will be removed in one of the next releases.
 package v1alpha3
diff --git a/api/v1alpha3/machine_types.go b/api/v1alpha3/machine_types.go
@@ -245,6 +245,8 @@ type Bootstrap struct {
 // +kubebuilder:printcolumn:name="NodeName",type="string",JSONPath=".status.nodeRef.name",description="Node name associated with this machine",priority=1
 
 // Machine is the Schema for the machines API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type Machine struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -266,6 +268,8 @@ func (m *Machine) SetConditions(conditions Conditions) {
 // +kubebuilder:object:root=true
 
 // MachineList contains a list of Machine.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha3/machinedeployment_types.go b/api/v1alpha3/machinedeployment_types.go
@@ -251,6 +251,8 @@ func (md *MachineDeploymentStatus) GetTypedPhase() MachineDeploymentPhase {
 // +kubebuilder:printcolumn:name="Unavailable",type=integer,JSONPath=".status.unavailableReplicas",description="Total number of unavailable machines targeted by this MachineDeployment"
 
 // MachineDeployment is the Schema for the machinedeployments API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineDeployment struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -262,6 +264,8 @@ type MachineDeployment struct {
 // +kubebuilder:object:root=true
 
 // MachineDeploymentList contains a list of MachineDeployment.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineDeploymentList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha3/machinehealthcheck_types.go b/api/v1alpha3/machinehealthcheck_types.go
@@ -121,6 +121,8 @@ type MachineHealthCheckStatus struct {
 // +kubebuilder:printcolumn:name="CurrentHealthy",type="integer",JSONPath=".status.currentHealthy",description="Current observed healthy machines"
 
 // MachineHealthCheck is the Schema for the machinehealthchecks API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineHealthCheck struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -145,6 +147,8 @@ func (m *MachineHealthCheck) SetConditions(conditions Conditions) {
 // +kubebuilder:object:root=true
 
 // MachineHealthCheckList contains a list of MachineHealthCheck.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineHealthCheckList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha3/machineset_types.go b/api/v1alpha3/machineset_types.go
@@ -193,6 +193,8 @@ func (m *MachineSet) Validate() field.ErrorList {
 // +kubebuilder:printcolumn:name="Ready",type="integer",JSONPath=".status.readyReplicas",description="Total number of ready machines targeted by this machineset."
 
 // MachineSet is the Schema for the machinesets API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineSet struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -204,6 +206,8 @@ type MachineSet struct {
 // +kubebuilder:object:root=true
 
 // MachineSetList contains a list of MachineSet.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineSetList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha4/cluster_types.go b/api/v1alpha4/cluster_types.go
@@ -282,6 +282,8 @@ func (v APIEndpoint) String() string {
 // +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Cluster status such as Pending/Provisioning/Provisioned/Deleting/Failed"
 
 // Cluster is the Schema for the clusters API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type Cluster struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -387,6 +389,8 @@ func (f ClusterIPFamily) String() string {
 // +kubebuilder:object:root=true
 
 // ClusterList contains a list of Cluster.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type ClusterList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha4/clusterclass_types.go b/api/v1alpha4/clusterclass_types.go
@@ -26,6 +26,8 @@ import (
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of ClusterClass"
 
 // ClusterClass is a template which can be used to create managed topologies.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type ClusterClass struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -121,6 +123,8 @@ type LocalObjectTemplate struct {
 // +kubebuilder:object:root=true
 
 // ClusterClassList contains a list of Cluster.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type ClusterClassList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha4/doc.go b/api/v1alpha4/doc.go
@@ -16,4 +16,6 @@ limitations under the License.
 
 // Package v1alpha4 contains the v1alpha4 API implementation.
 // +k8s:conversion-gen=sigs.k8s.io/cluster-api/api/v1beta1
+//
+// Deprecated: This package will be removed in one of the next releases.
 package v1alpha4
diff --git a/api/v1alpha4/machine_types.go b/api/v1alpha4/machine_types.go
@@ -244,6 +244,8 @@ type Bootstrap struct {
 // +kubebuilder:printcolumn:name="NodeName",type="string",JSONPath=".status.nodeRef.name",description="Node name associated with this machine",priority=1
 
 // Machine is the Schema for the machines API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type Machine struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -265,6 +267,8 @@ func (m *Machine) SetConditions(conditions Conditions) {
 // +kubebuilder:object:root=true
 
 // MachineList contains a list of Machine.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha4/machinedeployment_types.go b/api/v1alpha4/machinedeployment_types.go
@@ -282,6 +282,8 @@ func (md *MachineDeploymentStatus) GetTypedPhase() MachineDeploymentPhase {
 // +kubebuilder:printcolumn:name="Unavailable",type=integer,JSONPath=".status.unavailableReplicas",description="Total number of unavailable machines targeted by this MachineDeployment"
 
 // MachineDeployment is the Schema for the machinedeployments API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineDeployment struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -293,6 +295,8 @@ type MachineDeployment struct {
 // +kubebuilder:object:root=true
 
 // MachineDeploymentList contains a list of MachineDeployment.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineDeploymentList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha4/machinehealthcheck_types.go b/api/v1alpha4/machinehealthcheck_types.go
@@ -134,6 +134,8 @@ type MachineHealthCheckStatus struct {
 // +kubebuilder:printcolumn:name="CurrentHealthy",type="integer",JSONPath=".status.currentHealthy",description="Current observed healthy machines"
 
 // MachineHealthCheck is the Schema for the machinehealthchecks API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineHealthCheck struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -158,6 +160,8 @@ func (m *MachineHealthCheck) SetConditions(conditions Conditions) {
 // +kubebuilder:object:root=true
 
 // MachineHealthCheckList contains a list of MachineHealthCheck.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineHealthCheckList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha4/machineset_types.go b/api/v1alpha4/machineset_types.go
@@ -205,6 +205,8 @@ func (m *MachineSet) Validate() field.ErrorList {
 // +kubebuilder:printcolumn:name="Ready",type="integer",JSONPath=".status.readyReplicas",description="Total number of ready machines targeted by this machineset."
 
 // MachineSet is the Schema for the machinesets API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineSet struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -216,6 +218,8 @@ type MachineSet struct {
 // +kubebuilder:object:root=true
 
 // MachineSetList contains a list of MachineSet.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type MachineSetList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/bootstrap/kubeadm/api/v1alpha3/doc.go b/bootstrap/kubeadm/api/v1alpha3/doc.go
@@ -16,4 +16,6 @@ limitations under the License.
 
 // Package v1alpha3 contains the v1alpha3 API implementation.
 // +k8s:conversion-gen=sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1
+//
+// Deprecated: This package will be removed in one of the next releases.
 package v1alpha3
diff --git a/bootstrap/kubeadm/api/v1alpha3/kubeadmconfig_types.go b/bootstrap/kubeadm/api/v1alpha3/kubeadmconfig_types.go
@@ -136,6 +136,8 @@ type KubeadmConfigStatus struct {
 // +kubebuilder:subresource:status
 
 // KubeadmConfig is the Schema for the kubeadmconfigs API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type KubeadmConfig struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -157,6 +159,8 @@ func (c *KubeadmConfig) SetConditions(conditions clusterv1alpha3.Conditions) {
 // +kubebuilder:object:root=true
 
 // KubeadmConfigList contains a list of KubeadmConfig.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type KubeadmConfigList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/bootstrap/kubeadm/api/v1alpha3/kubeadmconfigtemplate_types.go b/bootstrap/kubeadm/api/v1alpha3/kubeadmconfigtemplate_types.go
@@ -34,6 +34,8 @@ type KubeadmConfigTemplateResource struct {
 // +kubebuilder:resource:path=kubeadmconfigtemplates,scope=Namespaced,categories=cluster-api
 
 // KubeadmConfigTemplate is the Schema for the kubeadmconfigtemplates API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type KubeadmConfigTemplate struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -44,6 +46,8 @@ type KubeadmConfigTemplate struct {
 // +kubebuilder:object:root=true
 
 // KubeadmConfigTemplateList contains a list of KubeadmConfigTemplate.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type KubeadmConfigTemplateList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/bootstrap/kubeadm/api/v1alpha4/doc.go b/bootstrap/kubeadm/api/v1alpha4/doc.go
@@ -16,4 +16,6 @@ limitations under the License.
 
 // Package v1alpha4 contains the v1alpha4 API implementation.
 // +k8s:conversion-gen=sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1
+//
+// Deprecated: This package will be removed in one of the next releases.
 package v1alpha4
diff --git a/bootstrap/kubeadm/api/v1alpha4/kubeadmconfig_types.go b/bootstrap/kubeadm/api/v1alpha4/kubeadmconfig_types.go
@@ -129,6 +129,8 @@ type KubeadmConfigStatus struct {
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of KubeadmConfig"
 
 // KubeadmConfig is the Schema for the kubeadmconfigs API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type KubeadmConfig struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -150,6 +152,8 @@ func (c *KubeadmConfig) SetConditions(conditions clusterv1alpha4.Conditions) {
 // +kubebuilder:object:root=true
 
 // KubeadmConfigList contains a list of KubeadmConfig.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type KubeadmConfigList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/bootstrap/kubeadm/api/v1alpha4/kubeadmconfigtemplate_types.go b/bootstrap/kubeadm/api/v1alpha4/kubeadmconfigtemplate_types.go
@@ -35,6 +35,8 @@ type KubeadmConfigTemplateResource struct {
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of KubeadmConfigTemplate"
 
 // KubeadmConfigTemplate is the Schema for the kubeadmconfigtemplates API.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type KubeadmConfigTemplate struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -45,6 +47,8 @@ type KubeadmConfigTemplate struct {
 // +kubebuilder:object:root=true
 
 // KubeadmConfigTemplateList contains a list of KubeadmConfigTemplate.
+//
+// Deprecated: This type will be removed in one of the next releases.
 type KubeadmConfigTemplateList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml
diff --git a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml
diff --git a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml
diff --git a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml