|
| 1 | +/* |
| 2 | +Copyright 2025 The Kubernetes Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +// Package capiutils contains utility functions for working with Cluster API resources. |
| 18 | +// These have mostly been inlined as part of the CAPI 1.10 -> 1.11 upgrade, |
| 19 | +// and should be removed when we switch to reading CAPI v1beta2 objects. |
| 20 | +// |
| 21 | +// Deprecated: This package is deprecated and is going to be removed when support for v1beta1 will be dropped. |
| 22 | +package capiutils |
| 23 | + |
| 24 | +import ( |
| 25 | + "fmt" |
| 26 | + |
| 27 | + "github.com/go-logr/logr" |
| 28 | + "k8s.io/apimachinery/pkg/runtime" |
| 29 | + "k8s.io/klog/v2" |
| 30 | + "sigs.k8s.io/controller-runtime/pkg/client/apiutil" |
| 31 | + "sigs.k8s.io/controller-runtime/pkg/event" |
| 32 | + "sigs.k8s.io/controller-runtime/pkg/predicate" |
| 33 | + |
| 34 | + "sigs.k8s.io/cluster-api/util/predicates" |
| 35 | + |
| 36 | + clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta1" |
| 37 | +) |
| 38 | + |
| 39 | +// ClusterUpdateInfraReady returns a predicate that returns true for an update event when a cluster has Status.InfrastructureReady changed from false to true |
| 40 | +// it also returns true if the resource provided is not a Cluster to allow for use with controller-runtime NewControllerManagedBy. |
| 41 | +func ClusterUpdateInfraReady(scheme *runtime.Scheme, logger logr.Logger) predicate.Funcs { |
| 42 | + return predicate.Funcs{ |
| 43 | + UpdateFunc: func(e event.UpdateEvent) bool { |
| 44 | + log := logger.WithValues("predicate", "ClusterUpdateInfraReady", "eventType", "update") |
| 45 | + if gvk, err := apiutil.GVKForObject(e.ObjectOld, scheme); err == nil { |
| 46 | + log = log.WithValues(gvk.Kind, klog.KObj(e.ObjectOld)) |
| 47 | + } |
| 48 | + |
| 49 | + oldCluster, ok := e.ObjectOld.(*clusterv1.Cluster) |
| 50 | + if !ok { |
| 51 | + log.V(4).Info("Expected Cluster", "type", fmt.Sprintf("%T", e.ObjectOld)) |
| 52 | + return false |
| 53 | + } |
| 54 | + |
| 55 | + newCluster := e.ObjectNew.(*clusterv1.Cluster) |
| 56 | + |
| 57 | + if !oldCluster.Status.InfrastructureReady && newCluster.Status.InfrastructureReady { |
| 58 | + log.V(6).Info("Cluster infrastructure became ready, allowing further processing") |
| 59 | + return true |
| 60 | + } |
| 61 | + |
| 62 | + log.V(4).Info("Cluster infrastructure did not become ready, blocking further processing") |
| 63 | + return false |
| 64 | + }, |
| 65 | + CreateFunc: func(event.CreateEvent) bool { return false }, |
| 66 | + DeleteFunc: func(event.DeleteEvent) bool { return false }, |
| 67 | + GenericFunc: func(event.GenericEvent) bool { return false }, |
| 68 | + } |
| 69 | +} |
| 70 | + |
| 71 | +// ClusterPausedTransitions returns a predicate that returns true for an update event when a cluster has Spec.Paused changed. |
| 72 | +func ClusterPausedTransitions(scheme *runtime.Scheme, logger logr.Logger) predicate.Funcs { |
| 73 | + return predicate.Funcs{ |
| 74 | + UpdateFunc: func(e event.UpdateEvent) bool { |
| 75 | + log := logger.WithValues("predicate", "ClusterPausedTransitions", "eventType", "update") |
| 76 | + if gvk, err := apiutil.GVKForObject(e.ObjectOld, scheme); err == nil { |
| 77 | + log = log.WithValues(gvk.Kind, klog.KObj(e.ObjectOld)) |
| 78 | + } |
| 79 | + |
| 80 | + oldCluster, ok := e.ObjectOld.(*clusterv1.Cluster) |
| 81 | + if !ok { |
| 82 | + log.V(4).Info("Expected Cluster", "type", fmt.Sprintf("%T", e.ObjectOld)) |
| 83 | + return false |
| 84 | + } |
| 85 | + |
| 86 | + newCluster := e.ObjectNew.(*clusterv1.Cluster) |
| 87 | + |
| 88 | + if oldCluster.Spec.Paused && !newCluster.Spec.Paused { |
| 89 | + log.V(6).Info("Cluster unpausing, allowing further processing") |
| 90 | + return true |
| 91 | + } |
| 92 | + |
| 93 | + if !oldCluster.Spec.Paused && newCluster.Spec.Paused { |
| 94 | + log.V(6).Info("Cluster pausing, allowing further processing") |
| 95 | + return true |
| 96 | + } |
| 97 | + |
| 98 | + // This predicate always work in "or" with Paused predicates |
| 99 | + // so the logs are adjusted to not provide false negatives/verbosity at V<=5. |
| 100 | + log.V(6).Info("Cluster paused state was not changed, blocking further processing") |
| 101 | + return false |
| 102 | + }, |
| 103 | + CreateFunc: func(event.CreateEvent) bool { return false }, |
| 104 | + DeleteFunc: func(event.DeleteEvent) bool { return false }, |
| 105 | + GenericFunc: func(event.GenericEvent) bool { return false }, |
| 106 | + } |
| 107 | +} |
| 108 | + |
| 109 | +// ClusterPausedTransitionsOrInfrastructureReady returns a Predicate that returns true on Cluster Update events where |
| 110 | +// either Cluster.Spec.Paused transitions or Cluster.Status.InfrastructureReady transitions to true. |
| 111 | +// This implements a common requirement for some cluster-api and provider controllers (such as Machine Infrastructure |
| 112 | +// controllers) to resume reconciliation when the Cluster gets paused or unpaused and when the infrastructure becomes ready. |
| 113 | +// Example use: |
| 114 | +// |
| 115 | +// err := controller.Watch( |
| 116 | +// source.Kind(cache, &clusterv1.Cluster{}), |
| 117 | +// handler.EnqueueRequestsFromMapFunc(clusterToMachines) |
| 118 | +// predicates.ClusterPausedTransitionsOrInfrastructureReady(mgr.GetScheme(), r.Log), |
| 119 | +// ) |
| 120 | +func ClusterPausedTransitionsOrInfrastructureReady(scheme *runtime.Scheme, logger logr.Logger) predicate.Funcs { |
| 121 | + log := logger.WithValues("predicate", "ClusterPausedTransitionsOrInfrastructureReady") |
| 122 | + |
| 123 | + return predicates.Any(scheme, log, ClusterPausedTransitions(scheme, log), ClusterUpdateInfraReady(scheme, log)) |
| 124 | +} |
0 commit comments