api: deprecate FailureMessage and FailureReason

kubernetes-sigs · Oct 22, 2024 · 9331dcc · 9331dcc
1 parent 7ac4c86
commit 9331dcc
Show file tree

Hide file tree

Showing 11 changed files with 56 additions and 1 deletion.
diff --git a/.golangci.yml b/.golangci.yml
@@ -241,10 +241,14 @@ issues:
   - linters:
       - staticcheck
     text: "SA1019: ((deployment|m|md).Spec.RevisionHistoryLimit|clusterv1.RevisionHistoryAnnotation|c.RolloutUndo) is deprecated"
-    # Deprecations for MHC MaxUnhealthy, UnhealthyRange
+  # Deprecations for MHC MaxUnhealthy, UnhealthyRange
   - linters:
       - staticcheck
     text: "SA1019: (mhc|m)(.Spec.MaxUnhealthy|.Spec.UnhealthyRange) is deprecated"
+  # Deprecations for FailureMessage and FailureReason
+  - linters:
+      - staticcheck
+    text: "SA1019: .*\\.Status\\.(FailureMessage|FailureReason) is deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details."
   # 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:

diff --git a/api/v1beta1/cluster_types.go b/api/v1beta1/cluster_types.go
@@ -440,11 +440,17 @@ type ClusterStatus struct {
 	// FailureReason indicates that there is a fatal problem reconciling the
 	// state, and will be set to a token value suitable for
 	// programmatic interpretation.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureReason *capierrors.ClusterStatusError `json:"failureReason,omitempty"`
 
 	// FailureMessage indicates that there is a fatal problem reconciling the
 	// state, and will be set to a descriptive error message.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureMessage *string `json:"failureMessage,omitempty"`
 

diff --git a/api/v1beta1/machine_types.go b/api/v1beta1/machine_types.go
@@ -465,6 +465,9 @@ type MachineStatus struct {
 	// Any transient errors that occur during the reconciliation of Machines
 	// can be added as events to the Machine object and/or logged in the
 	// controller's output.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureReason *capierrors.MachineStatusError `json:"failureReason,omitempty"`
 
@@ -484,6 +487,9 @@ type MachineStatus struct {
 	// Any transient errors that occur during the reconciliation of Machines
 	// can be added as events to the Machine object and/or logged in the
 	// controller's output.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureMessage *string `json:"failureMessage,omitempty"`
 

diff --git a/api/v1beta1/machineset_types.go b/api/v1beta1/machineset_types.go
@@ -181,8 +181,13 @@ type MachineSetStatus struct {
 	// Any transient errors that occur during the reconciliation of Machines
 	// can be added as events to the MachineSet object and/or logged in the
 	// controller's output.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureReason *capierrors.MachineSetStatusError `json:"failureReason,omitempty"`
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureMessage *string `json:"failureMessage,omitempty"`
 	// Conditions defines current service state of the MachineSet.

diff --git a/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go b/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go
@@ -427,10 +427,16 @@ type KubeadmConfigStatus struct {
 	DataSecretName *string `json:"dataSecretName,omitempty"`
 
 	// FailureReason will be set on non-retryable errors
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureReason string `json:"failureReason,omitempty"`
 
 	// FailureMessage will be set on non-retryable errors
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureMessage string `json:"failureMessage,omitempty"`
 

diff --git a/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go b/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go
@@ -290,11 +290,17 @@ type KubeadmControlPlaneStatus struct {
 	// FailureReason indicates that there is a terminal problem reconciling the
 	// state, and will be set to a token value suitable for
 	// programmatic interpretation.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureReason errors.KubeadmControlPlaneStatusError `json:"failureReason,omitempty"`
 
 	// ErrorMessage indicates that there is a terminal problem reconciling the
 	// state, and will be set to a descriptive error message.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureMessage *string `json:"failureMessage,omitempty"`
 

diff --git a/exp/api/v1beta1/machinepool_types.go b/exp/api/v1beta1/machinepool_types.go
@@ -94,11 +94,17 @@ type MachinePoolStatus struct {
 
 	// FailureReason indicates that there is a problem reconciling the state, and
 	// will be set to a token value suitable for programmatic interpretation.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureReason *capierrors.MachinePoolStatusFailure `json:"failureReason,omitempty"`
 
 	// FailureMessage indicates that there is a problem reconciling the state,
 	// and will be set to a descriptive error message.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
+	//
 	// +optional
 	FailureMessage *string `json:"failureMessage,omitempty"`
 

diff --git a/internal/contract/bootstrap.go b/internal/contract/bootstrap.go
@@ -52,13 +52,17 @@ func (b *BootstrapContract) DataSecretName() *String {
 }
 
 // FailureReason provides access to the status.failureReason field in an bootstrap object. Note that this field is optional.
+//
+// Deprecated: This function is deprecated and is going to be removed. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 func (b *BootstrapContract) FailureReason() *String {
 	return &String{
 		path: []string{"status", "failureReason"},
 	}
 }
 
 // FailureMessage provides access to the status.failureMessage field in an bootstrap object. Note that this field is optional.
+//
+// Deprecated: This function is deprecated and is going to be removed. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 func (b *BootstrapContract) FailureMessage() *String {
 	return &String{
 		path: []string{"status", "failureMessage"},

diff --git a/internal/contract/controlplane.go b/internal/contract/controlplane.go
@@ -127,13 +127,17 @@ func (c *ControlPlaneContract) Selector() *String {
 }
 
 // FailureReason provides access to the status.failureReason field in an ControlPlane object. Note that this field is optional.
+//
+// Deprecated: This function is deprecated and is going to be removed. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 func (c *ControlPlaneContract) FailureReason() *String {
 	return &String{
 		path: []string{"status", "failureReason"},
 	}
 }
 
 // FailureMessage provides access to the status.failureMessage field in an ControlPlane object. Note that this field is optional.
+//
+// Deprecated: This function is deprecated and is going to be removed. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 func (c *ControlPlaneContract) FailureMessage() *String {
 	return &String{
 		path: []string{"status", "failureMessage"},

diff --git a/internal/contract/infrastructure_cluster.go b/internal/contract/infrastructure_cluster.go
@@ -73,13 +73,17 @@ func (c *InfrastructureClusterContract) Ready() *Bool {
 }
 
 // FailureReason provides access to the status.failureReason field in an InfrastructureCluster object. Note that this field is optional.
+//
+// Deprecated: This function is deprecated and is going to be removed. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 func (c *InfrastructureClusterContract) FailureReason() *String {
 	return &String{
 		path: []string{"status", "failureReason"},
 	}
 }
 
 // FailureMessage provides access to the status.failureMessage field in an InfrastructureCluster object. Note that this field is optional.
+//
+// Deprecated: This function is deprecated and is going to be removed. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 func (c *InfrastructureClusterContract) FailureMessage() *String {
 	return &String{
 		path: []string{"status", "failureMessage"},

diff --git a/internal/contract/infrastructure_machine.go b/internal/contract/infrastructure_machine.go
@@ -55,13 +55,17 @@ func (m *InfrastructureMachineContract) ReadyConditionType() string {
 }
 
 // FailureReason provides access to the status.failureReason field in an InfrastructureMachine object. Note that this field is optional.
+//
+// Deprecated: This function is deprecated and is going to be removed. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 func (m *InfrastructureMachineContract) FailureReason() *String {
 	return &String{
 		path: []string{"status", "failureReason"},
 	}
 }
 
 // FailureMessage provides access to the status.failureMessage field in an InfrastructureMachine object. Note that this field is optional.
+//
+// Deprecated: This function is deprecated and is going to be removed. Please see docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 func (m *InfrastructureMachineContract) FailureMessage() *String {
 	return &String{
 		path: []string{"status", "failureMessage"},