🌱 Introduce v1beta2 conditions for HCloudRemediation (#1971)

Author: abdullah599

.golangci.yaml

@@ -114,6 +114,8 @@ linters:
           alias: v1beta1patch
         - pkg: sigs.k8s.io/cluster-api/util/deprecated/v1beta1/conditions
           alias: v1beta1conditions
+        - pkg: sigs.k8s.io/cluster-api/util/deprecated/v1beta1/conditions/v1beta2
+          alias: v1beta2conditions
         # Legacy-shadow conditions helper for v1beta2 CAPI core objects.
         # Different package path than v1beta1conditions above — aliasing
         # both distinctly avoids accidental swaps.

api/v1beta1/conditions_const.go

@@ -393,8 +393,17 @@ const (
 	TargetClusterSyncingSecretFailedV1Beta2Reason = "SyncingSecretFailed"
 )
 
-// HetznerBareMetalMachine v1beta2 condition types.
+// HCloudRemediation v1beta2 conditions and reasons.
+const (
+	// HCloudRemediationSkippedV1Beta2Condition reports that remediation was skipped because
+	// the HCloudMachine has a state that makes remediation unnecessary or impossible.
+	HCloudRemediationSkippedV1Beta2Condition = "RemediationSkipped"
+	// IrrecoverableServerCreateFailureV1Beta2Reason indicates remediation was skipped because
+	// the HCloudMachine failed to create with an irrecoverable error (e.g. invalid_input, resource_unavailable).
+	IrrecoverableServerCreateFailureV1Beta2Reason = "IrrecoverableServerCreateFailure"
+)
 
+// HetznerBareMetalMachine v1beta2 condition types.
 const (
 	// HetznerBareMetalMachineHostAssociatedV1Beta2Condition is true when the host is associated.
 	HetznerBareMetalMachineHostAssociatedV1Beta2Condition = "HostAssociated"

api/v1beta1/hcloudremediation_types.go

@@ -19,6 +19,7 @@ package v1beta1
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	clusterv1beta1 "sigs.k8s.io/cluster-api/api/core/v1beta1"
+	v1beta2conditions "sigs.k8s.io/cluster-api/util/deprecated/v1beta1/conditions/v1beta2"
 )
 
 // HCloudRemediationSpec defines the desired state of HCloudRemediation.
@@ -46,6 +47,21 @@ type HCloudRemediationStatus struct {
 	// Conditions defines current service state of the HCloudRemediation.
 	// +optional
 	Conditions clusterv1beta1.Conditions `json:"conditions,omitempty"`
+
+	// v1beta2 groups all the fields that will be added or modified in HCloudRemediation's status with the V1Beta2 version.
+	// +optional
+	V1Beta2 *HCloudRemediationV1Beta2Status `json:"v1beta2,omitempty"`
+}
+
+// HCloudRemediationV1Beta2Status groups all the fields that will be added or modified in HCloudRemediationStatus with the V1Beta2 version.
+type HCloudRemediationV1Beta2Status struct {
+	// conditions represents the observations of a HCloudRemediation's current state.
+	// Known condition types are Ready, HCloudTokenAvailable and HCloudRateLimitExceeded.
+	// +optional
+	// +listType=map
+	// +listMapKey=type
+	// +kubebuilder:validation:MaxItems=32
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -82,6 +98,22 @@ func (r *HCloudRemediation) SetConditions(conditions clusterv1beta1.Conditions)
 	r.Status.Conditions = conditions
 }
 
+// GetV1Beta2Conditions returns the observations of the operational state of the HCloudRemediation resource.
+func (r *HCloudRemediation) GetV1Beta2Conditions() []metav1.Condition {
+	if r.Status.V1Beta2 == nil {
+		return nil
+	}
+	return r.Status.V1Beta2.Conditions
+}
+
+// SetV1Beta2Conditions sets the underlying v1beta2 service state of the HCloudRemediation.
+func (r *HCloudRemediation) SetV1Beta2Conditions(conditions []metav1.Condition) {
+	if r.Status.V1Beta2 == nil {
+		r.Status.V1Beta2 = &HCloudRemediationV1Beta2Status{}
+	}
+	r.Status.V1Beta2.Conditions = conditions
+}
+
 //+kubebuilder:object:root=true
 
 // HCloudRemediationList contains a list of HCloudRemediation.
@@ -92,6 +124,64 @@ type HCloudRemediationList struct {
 	Items           []HCloudRemediation `json:"items"`
 }
 
+// HCloudRemediationV1Beta2SummaryOpts returns the v1beta2 summary options for HCloudRemediation.
+// It is the single source of truth for which conditions contribute to the Ready summary,
+// used both by HCloudRemediationScope.Close() and by early-exit error paths that bypass the scope.
+//
+// The order of conditions in ForConditionTypes defines the priority for the Ready summary:
+// when multiple conditions are unhealthy, the summary lists all of them in priority order
+// (highest-priority first). The ordering reflects operational importance:
+//  1. HCloudTokenAvailable      - invalid credentials block everything.
+//  2. HCloudRateLimitExceeded   - rate-limit issues (negative polarity).
+//  3. RemediationSkipped        - remediation was skipped due to an irrecoverable
+//     machine state; surfaced for visibility (negative polarity).
+func HCloudRemediationV1Beta2SummaryOpts() []v1beta2conditions.SummaryOption {
+	return []v1beta2conditions.SummaryOption{
+		// ForConditionTypes lists every condition that contributes to Ready, in
+		// priority order. When multiple conditions are unhealthy the summary
+		// surfaces them in this order, so the most important issue is listed first.
+		v1beta2conditions.ForConditionTypes{
+			HCloudTokenAvailableV1Beta2Condition,
+			HCloudRateLimitExceededV1Beta2Condition,
+			HCloudRemediationSkippedV1Beta2Condition,
+		},
+		// IgnoreTypesIfMissing tells the summary not to treat the absence of a
+		// listed condition as Unknown. Some reconcile paths exit before every
+		// condition has been set (for example, before the token is checked or
+		// before remediation has been evaluated), and we don't want those early
+		// exits to flip Ready to Unknown.
+		v1beta2conditions.IgnoreTypesIfMissing{
+			HCloudTokenAvailableV1Beta2Condition,
+			HCloudRateLimitExceededV1Beta2Condition,
+			HCloudRemediationSkippedV1Beta2Condition,
+		},
+		// CustomMergeStrategy is used only to override the merge reasons, so
+		// the Ready summary uses CAPI's standard Ready reasons (Ready /
+		// NotReady / ReadyUnknown) instead of the generic merge defaults
+		// (IssuesReported / UnknownReported / InfoReported).
+		//
+		// Negative polarity is passed directly into GetDefaultMergePriorityFunc
+		// here. When a CustomMergeStrategy is provided, NewSummaryCondition
+		// skips the path that wires up the NegativePolarityConditionTypes
+		// SummaryOption into the default strategy, so the negative-polarity
+		// types must be specified explicitly inside the strategy.
+		v1beta2conditions.CustomMergeStrategy{
+			MergeStrategy: v1beta2conditions.DefaultMergeStrategy(
+				v1beta2conditions.GetPriorityFunc(v1beta2conditions.GetDefaultMergePriorityFunc(
+					// conditions with negative polarity
+					HCloudRateLimitExceededV1Beta2Condition,
+					HCloudRemediationSkippedV1Beta2Condition,
+				)),
+				v1beta2conditions.ComputeReasonFunc(v1beta2conditions.GetDefaultComputeMergeReasonFunc(
+					clusterv1beta1.NotReadyV1Beta2Reason,
+					clusterv1beta1.ReadyUnknownV1Beta2Reason,
+					clusterv1beta1.ReadyV1Beta2Reason,
+				)),
+			),
+		},
+	}
+}
+
 func init() {
 	objectTypes = append(objectTypes, &HCloudRemediation{}, &HCloudRemediationList{})
 }

api/v1beta1/zz_generated.deepcopy.go

@@ -172,6 +172,75 @@ spec:
                   RetryCount can be used as a counter during the remediation.
                   Field can hold number of reboots etc.
                 type: integer
+              v1beta2:
+                description: v1beta2 groups all the fields that will be added or modified
+                  in HCloudRemediation's status with the V1Beta2 version.
+                properties:
+                  conditions:
+                    description: |-
+                      conditions represents the observations of a HCloudRemediation's current state.
+                      Known condition types are Ready, HCloudTokenAvailable and HCloudRateLimitExceeded.
+                    items:
+                      description: Condition contains details for one aspect of the
+                        current state of this API Resource.
+                      properties:
+                        lastTransitionTime:
+                          description: |-
+                            lastTransitionTime is the last time the condition transitioned from one status to another.
+                            This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
+                          format: date-time
+                          type: string
+                        message:
+                          description: |-
+                            message is a human readable message indicating details about the transition.
+                            This may be an empty string.
+                          maxLength: 32768
+                          type: string
+                        observedGeneration:
+                          description: |-
+                            observedGeneration represents the .metadata.generation that the condition was set based upon.
+                            For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+                            with respect to the current state of the instance.
+                          format: int64
+                          minimum: 0
+                          type: integer
+                        reason:
+                          description: |-
+                            reason contains a programmatic identifier indicating the reason for the condition's last transition.
+                            Producers of specific condition types may define expected values and meanings for this field,
+                            and whether the values are considered a guaranteed API.
+                            The value should be a CamelCase string.
+                            This field may not be empty.
+                          maxLength: 1024
+                          minLength: 1
+                          pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
+                          type: string
+                        status:
+                          description: status of the condition, one of True, False,
+                            Unknown.
+                          enum:
+                          - "True"
+                          - "False"
+                          - Unknown
+                          type: string
+                        type:
+                          description: type of condition in CamelCase or in foo.example.com/CamelCase.
+                          maxLength: 316
+                          pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
+                          type: string
+                      required:
+                      - lastTransitionTime
+                      - message
+                      - reason
+                      - status
+                      - type
+                      type: object
+                    maxItems: 32
+                    type: array
+                    x-kubernetes-list-map-keys:
+                    - type
+                    x-kubernetes-list-type: map
+                type: object
             type: object
         type: object
     served: true

config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediations.yaml

@@ -180,6 +180,75 @@ spec:
                       RetryCount can be used as a counter during the remediation.
                       Field can hold number of reboots etc.
                     type: integer
+                  v1beta2:
+                    description: v1beta2 groups all the fields that will be added
+                      or modified in HCloudRemediation's status with the V1Beta2 version.
+                    properties:
+                      conditions:
+                        description: |-
+                          conditions represents the observations of a HCloudRemediation's current state.
+                          Known condition types are Ready, HCloudTokenAvailable and HCloudRateLimitExceeded.
+                        items:
+                          description: Condition contains details for one aspect of
+                            the current state of this API Resource.
+                          properties:
+                            lastTransitionTime:
+                              description: |-
+                                lastTransitionTime is the last time the condition transitioned from one status to another.
+                                This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
+                              format: date-time
+                              type: string
+                            message:
+                              description: |-
+                                message is a human readable message indicating details about the transition.
+                                This may be an empty string.
+                              maxLength: 32768
+                              type: string
+                            observedGeneration:
+                              description: |-
+                                observedGeneration represents the .metadata.generation that the condition was set based upon.
+                                For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+                                with respect to the current state of the instance.
+                              format: int64
+                              minimum: 0
+                              type: integer
+                            reason:
+                              description: |-
+                                reason contains a programmatic identifier indicating the reason for the condition's last transition.
+                                Producers of specific condition types may define expected values and meanings for this field,
+                                and whether the values are considered a guaranteed API.
+                                The value should be a CamelCase string.
+                                This field may not be empty.
+                              maxLength: 1024
+                              minLength: 1
+                              pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
+                              type: string
+                            status:
+                              description: status of the condition, one of True, False,
+                                Unknown.
+                              enum:
+                              - "True"
+                              - "False"
+                              - Unknown
+                              type: string
+                            type:
+                              description: type of condition in CamelCase or in foo.example.com/CamelCase.
+                              maxLength: 316
+                              pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
+                              type: string
+                          required:
+                          - lastTransitionTime
+                          - message
+                          - reason
+                          - status
+                          - type
+                          type: object
+                        maxItems: 32
+                        type: array
+                        x-kubernetes-list-map-keys:
+                        - type
+                        x-kubernetes-list-type: map
+                    type: object
                 type: object
             required:
             - status