Files
my-rook-config/pkg/operator/ceph/cluster/nodedaemon/add.go
T
Joshua Hoblitt 9f1ed201db core: typed watch handlers and predicates
All existing controller runtime watches are converted to use "typed"
handlers and predicates instead of operating on `client.Object`.  The
intent is to be bug for bug equivalent with the existing logic while
replacing run time type assertions and switch statements with compile
time type constraints and type casts. In several cases, functions using
assertions were split up such that each function only handles a single
Kind at a time. It is hoped that this will improve readability and
maintainability while facilitating future refactoring such as migrating
some watches to using IndexFields.

Of particular note is that the massive switch statement in
`WatchControllerPredicate()`  from
`pkg/operator/ceph/controller/predicate.go` has been replaced with
generics, reflection, and splitting the obc logic into its own predicate
function. There are still many helper functions operating on
`client.Object`. These were not updated unless required by the compiler
in order to limit the size of this change. The type safety of these
funcs should be improved as followup work.

 It is strongly suggested that going forward, handlers and predicates
 only handle a single Kind (generic or not) and that switches / type
 assertions are heavily discouraged or forbidden. This PR removed all
 but a single switch statement in a predicate, which should be addressed
 in future work.

Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
2025-04-04 09:40:56 -07:00

179 lines
5.9 KiB
Go

/*
Copyright 2019 The Rook Authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package nodedaemon
import (
"context"
"reflect"
"strings"
"github.com/pkg/errors"
"github.com/rook/rook/pkg/clusterd"
"github.com/rook/rook/pkg/operator/k8sutil"
opcontroller "github.com/rook/rook/pkg/operator/ceph/controller"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
const (
controllerName = "ceph-nodedaemon-controller"
// AppName is the value to the "app" label for the ceph-crash pods
CrashCollectorAppName = "rook-ceph-crashcollector"
cephExporterAppName = "rook-ceph-exporter"
prunerName = "rook-ceph-crashcollector-pruner"
// NodeNameLabel is a node name label
NodeNameLabel = "node_name"
)
// Add adds a new Controller based on nodedrain.ReconcileNode and registers the relevant watches and handlers
func Add(mgr manager.Manager, context *clusterd.Context, opManagerContext context.Context, opConfig opcontroller.OperatorConfig) error {
return add(mgr, newReconciler(mgr, context, opManagerContext, opConfig))
}
// newReconciler returns a new reconcile.Reconciler
func newReconciler(mgr manager.Manager, context *clusterd.Context, opManagerContext context.Context, opConfig opcontroller.OperatorConfig) reconcile.Reconciler {
return &ReconcileNode{
client: mgr.GetClient(),
scheme: mgr.GetScheme(),
context: context,
opManagerContext: opManagerContext,
opConfig: opConfig,
}
}
func add(mgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New(controllerName, mgr, controller.Options{Reconciler: r})
if err != nil {
return errors.Wrapf(err, "failed to create a new %q", controllerName)
}
logger.Info("successfully started")
// Watch for changes to the nodes
specChangePredicate := predicate.TypedFuncs[*corev1.Node]{
UpdateFunc: func(e event.TypedUpdateEvent[*corev1.Node]) bool {
nodeOld := (*corev1.Node)(e.ObjectOld)
nodeNew := (*corev1.Node)(e.ObjectNew)
return !reflect.DeepEqual(nodeOld.Spec, nodeNew.Spec)
},
}
logger.Debugf("watch for changes to the nodes")
err = c.Watch(
source.Kind(
mgr.GetCache(),
&corev1.Node{},
&handler.TypedEnqueueRequestForObject[*corev1.Node]{},
specChangePredicate,
),
)
if err != nil {
return errors.Wrap(err, "failed to watch for node changes")
}
// Watch for changes to the ceph-crash deployments
logger.Debugf("watch for changes to the ceph-crash deployments")
err = c.Watch(
source.Kind(
mgr.GetCache(),
&appsv1.Deployment{},
handler.TypedEnqueueRequestsFromMapFunc(
func(context context.Context, deployment *appsv1.Deployment) []reconcile.Request {
labels := deployment.GetLabels()
appName, ok := labels[k8sutil.AppAttr]
if !ok || appName != CrashCollectorAppName {
return []reconcile.Request{}
}
nodeName, ok := deployment.Spec.Template.ObjectMeta.Labels[NodeNameLabel]
if !ok {
return []reconcile.Request{}
}
req := reconcile.Request{NamespacedName: types.NamespacedName{Name: nodeName}}
return []reconcile.Request{req}
},
),
),
)
if err != nil {
return errors.Wrap(err, "failed to watch for changes on the ceph-crash deployment")
}
// Watch for changes to the ceph pods and enqueue their nodes
logger.Debugf("watch for changes to the ceph pods and enqueue their nodes")
err = c.Watch(
source.Kind(
mgr.GetCache(),
&corev1.Pod{},
handler.TypedEnqueueRequestsFromMapFunc[*corev1.Pod](
func(context context.Context, pod *corev1.Pod) []reconcile.Request {
nodeName := pod.Spec.NodeName
if nodeName == "" {
return []reconcile.Request{}
}
if isCephPod(pod.Labels, pod.Name) {
req := reconcile.Request{NamespacedName: types.NamespacedName{Name: nodeName}}
return []reconcile.Request{req}
}
return []reconcile.Request{}
},
),
// only enqueue the update event if the pod moved nodes
predicate.TypedFuncs[*corev1.Pod]{
UpdateFunc: func(event event.TypedUpdateEvent[*corev1.Pod]) bool {
oldPod := (*corev1.Pod)(event.ObjectOld)
newPod := (*corev1.Pod)(event.ObjectNew)
// only enqueue if the nodename has changed
return oldPod.Spec.NodeName != newPod.Spec.NodeName
},
},
),
)
if err != nil {
return errors.Wrap(err, "failed to watch for changes on the ceph pod nodename and enqueue their nodes")
}
return nil
}
func isCephPod(labels map[string]string, podName string) bool {
_, ok := labels["rook_cluster"]
// canary pods for monitors might stick around during startup
// at that time, the initial monitors haven't been deployed yet.
// If we don't invalidate canary pods,
// the crash collector pod will start and environment variable like 'ROOK_CEPH_MON_HOST'
// will be empty since the monitors don't exist yet
isCanaryPod := strings.Contains(podName, "-canary-")
isCrashCollectorPod := strings.Contains(podName, "-crashcollector-")
isExporterPod := strings.Contains(podName, "-exporter-")
if ok && !isCanaryPod && !isCrashCollectorPod && !isExporterPod {
logger.Debugf("%q is a ceph pod!", podName)
return true
}
return false
}