Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions controllers/drain_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import (
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/tools/events"
"k8s.io/client-go/util/workqueue"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
Expand All @@ -48,13 +48,13 @@ import (
type DrainReconcile struct {
client.Client
Scheme *runtime.Scheme
recorder record.EventRecorder
recorder events.EventRecorder
drainer drain.DrainInterface

drainCheckMutex sync.Mutex
}

func NewDrainReconcileController(client client.Client, Scheme *runtime.Scheme, recorder record.EventRecorder, orchestrator orchestrator.Interface) (*DrainReconcile, error) {
func NewDrainReconcileController(client client.Client, Scheme *runtime.Scheme, recorder events.EventRecorder, orchestrator orchestrator.Interface) (*DrainReconcile, error) {
drainer, err := drain.NewDrainer(orchestrator)
if err != nil {
return nil, err
Expand Down
18 changes: 12 additions & 6 deletions controllers/drain_controller_helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,21 @@ func (dr *DrainReconcile) handleNodeIdleNodeStateDrainingOrCompleted(ctx context
completed, err := dr.drainer.CompleteDrainNode(ctx, node)
if err != nil {
reqLogger.Error(err, "failed to complete drain on node")
dr.recorder.Event(nodeNetworkState,
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeWarning,
"DrainController",
"CompleteDrain",
"failed to drain node")
return ctrl.Result{}, err
}

// if we didn't manage to complete the un drain of the node we retry
if !completed {
reqLogger.Info("complete drain was not completed re queueing the request")
dr.recorder.Event(nodeNetworkState,
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeWarning,
"DrainController",
"CompleteDrain",
"node complete drain was not completed")
// TODO: make this time configurable
return reconcile.Result{RequeueAfter: constants.DrainControllerRequeueTime}, nil
Expand All @@ -52,9 +54,10 @@ func (dr *DrainReconcile) handleNodeIdleNodeStateDrainingOrCompleted(ctx context
}

reqLogger.Info("completed the un drain for node")
dr.recorder.Event(nodeNetworkState,
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeWarning,
"DrainController",
"CompleteDrain",
"node un drain completed")
Comment on lines +57 to 61

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using corev1.EventTypeNormal for successful operations like this one improves observability. It helps operators distinguish between normal operational events and actual warnings that might require attention.

Suggested change
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeWarning,
"DrainController",
"CompleteDrain",
"node un drain completed")
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeNormal,
"DrainController",
"CompleteDrain",
"node un drain completed")

return ctrl.Result{}, nil
}
Expand Down Expand Up @@ -105,19 +108,21 @@ func (dr *DrainReconcile) handleNodeDrainOrReboot(ctx context.Context,
drained, err := dr.drainer.DrainNode(ctx, node, fullNodeDrain, singleNode)
if err != nil {
reqLogger.Error(err, "error trying to drain the node")
dr.recorder.Event(nodeNetworkState,
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeWarning,
"DrainController",
"DrainNode",
"failed to drain node")
return reconcile.Result{}, err
}

// if we didn't manage to complete the drain of the node we retry
if !drained {
reqLogger.Info("the nodes was not drained re queueing the request")
dr.recorder.Event(nodeNetworkState,
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeWarning,
"DrainController",
"DrainNode",
"node drain operation was not completed")
return reconcile.Result{RequeueAfter: constants.DrainControllerRequeueTime}, nil
}
Expand All @@ -130,9 +135,10 @@ func (dr *DrainReconcile) handleNodeDrainOrReboot(ctx context.Context,
}

reqLogger.Info("node drained successfully")
dr.recorder.Event(nodeNetworkState,
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeWarning,
"DrainController",
"DrainNode",
"node drain completed")
Comment on lines +138 to 142

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To maintain clear and actionable event logs, successful operations should generate corev1.EventTypeNormal events. Using corev1.EventTypeWarning here could create unnecessary noise for monitoring systems.

Suggested change
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeWarning,
"DrainController",
"DrainNode",
"node drain completed")
dr.recorder.Eventf(nodeNetworkState, nil,
corev1.EventTypeNormal,
"DrainController",
"DrainNode",
"node drain completed")

return ctrl.Result{}, nil
}
Expand Down
2 changes: 1 addition & 1 deletion controllers/drain_controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ var _ = Describe("Drain Controller", Ordered, func() {

drainController, err := NewDrainReconcileController(drainKClient,
k8sManager.GetScheme(),
k8sManager.GetEventRecorderFor("operator"),
k8sManager.GetEventRecorder("operator"),
orchestrator)
Expect(err).ToNot(HaveOccurred())
err = drainController.SetupWithManager(k8sManager)
Expand Down
56 changes: 27 additions & 29 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,29 @@ require (
github.com/blang/semver v3.5.1+incompatible
github.com/cenkalti/backoff v2.2.1+incompatible
github.com/coreos/fcct v0.5.0
github.com/coreos/go-systemd/v22 v22.6.0
github.com/coreos/go-systemd/v22 v22.7.0
github.com/coreos/ignition/v2 v2.25.1
github.com/fsnotify/fsnotify v1.9.0
github.com/go-logr/logr v1.4.3
github.com/go-logr/stdr v1.2.2
github.com/google/go-cmp v0.7.0
github.com/google/renameio/v2 v2.0.1
github.com/google/renameio/v2 v2.0.2
github.com/google/uuid v1.6.0
github.com/hashicorp/go-retryablehttp v0.7.8
github.com/jaypipes/ghw v0.21.2
github.com/jaypipes/ghw v0.22.0
github.com/jaypipes/pcidb v1.1.1
github.com/k8snetworkplumbingwg/network-attachment-definition-client v1.7.7
github.com/k8snetworkplumbingwg/sriov-network-device-plugin v0.0.0-20221127172732-a5a7395122e3
github.com/k8snetworkplumbingwg/sriovnet v1.2.0
github.com/onsi/ginkgo/v2 v2.27.3
github.com/onsi/gomega v1.38.3
github.com/onsi/ginkgo/v2 v2.28.1
github.com/onsi/gomega v1.39.0
github.com/openshift-kni/k8sreporter v1.0.7
github.com/openshift/api v0.0.0-20251202143230-02f6733e651c
github.com/openshift/client-go v0.0.0-20251202151200-fb4471581cf8
github.com/ovn-kubernetes/libovsdb v0.8.1
github.com/pkg/errors v0.9.1
github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring v0.87.1
github.com/prometheus-operator/prometheus-operator/pkg/client v0.87.1
github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring v0.89.0
github.com/prometheus-operator/prometheus-operator/pkg/client v0.89.0
github.com/prometheus/client_model v0.6.2
github.com/prometheus/common v0.67.5
github.com/safchain/ethtool v0.7.0
Expand All @@ -41,15 +41,15 @@ require (
go.uber.org/zap v1.27.1
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c
gopkg.in/yaml.v3 v3.0.1
k8s.io/api v0.34.3
k8s.io/apiextensions-apiserver v0.34.3
k8s.io/apimachinery v0.34.3
k8s.io/client-go v0.34.3
k8s.io/code-generator v0.34.3
k8s.io/api v0.35.0
k8s.io/apiextensions-apiserver v0.35.0
k8s.io/apimachinery v0.35.0
k8s.io/client-go v0.35.0
k8s.io/code-generator v0.35.0
k8s.io/klog/v2 v2.130.1
k8s.io/kubectl v0.34.3
k8s.io/utils v0.0.0-20251002143259-bc988d571ff4
sigs.k8s.io/controller-runtime v0.22.4
sigs.k8s.io/controller-runtime v0.23.1
sigs.k8s.io/yaml v1.6.0
)

Expand Down Expand Up @@ -99,11 +99,10 @@ require (
github.com/go-playground/universal-translator v0.18.1 // indirect
github.com/go-playground/validator/v10 v10.26.0 // indirect
github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/golang/glog v1.2.5 // indirect
github.com/google/btree v1.1.3 // indirect
github.com/google/gnostic-models v0.7.0 // indirect
github.com/google/pprof v0.0.0-20250403155104-27863c87afa6 // indirect
github.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83 // indirect
github.com/gorilla/websocket v1.5.4-0.20250319132907-e064f32e3674 // indirect
github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
Expand All @@ -128,9 +127,9 @@ require (
github.com/nxadm/tail v1.4.11 // indirect
github.com/peterbourgon/diskv v2.0.1+incompatible // indirect
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
github.com/prometheus/client_golang v1.22.0 // indirect
github.com/prometheus/procfs v0.15.1 // indirect
github.com/rogpeppe/go-internal v1.13.1 // indirect
github.com/prometheus/client_golang v1.23.2 // indirect
github.com/prometheus/procfs v0.16.1 // indirect
github.com/rogpeppe/go-internal v1.14.1 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
github.com/shopspring/decimal v1.4.0 // indirect
Expand All @@ -145,17 +144,16 @@ require (
go.uber.org/multierr v1.11.0 // indirect
go.yaml.in/yaml/v2 v2.4.3 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/crypto v0.46.0 // indirect
golang.org/x/mod v0.30.0 // indirect
golang.org/x/net v0.48.0 // indirect
golang.org/x/crypto v0.47.0 // indirect
golang.org/x/mod v0.32.0 // indirect
golang.org/x/net v0.49.0 // indirect
golang.org/x/oauth2 v0.34.0 // indirect
golang.org/x/sync v0.19.0 // indirect
golang.org/x/sys v0.39.0 // indirect
golang.org/x/term v0.38.0 // indirect
golang.org/x/text v0.32.0 // indirect
golang.org/x/sys v0.40.0 // indirect
golang.org/x/term v0.39.0 // indirect
golang.org/x/text v0.33.0 // indirect
golang.org/x/time v0.14.0 // indirect
golang.org/x/tools v0.39.0 // indirect
golang.org/x/tools/go/expect v0.1.1-deprecated // indirect
golang.org/x/tools v0.41.0 // indirect
gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20251124214823-79d6a2a48846 // indirect
google.golang.org/grpc v1.77.0 // indirect
Expand All @@ -164,13 +162,13 @@ require (
gopkg.in/inf.v0 v0.9.1 // indirect
howett.net/plist v1.0.2-0.20250314012144-ee69052608d9 // indirect
k8s.io/cli-runtime v0.34.3 // indirect
k8s.io/component-base v0.34.3 // indirect
k8s.io/gengo/v2 v2.0.0-20250604051438-85fd79dbfd9f // indirect
k8s.io/component-base v0.35.0 // indirect
k8s.io/gengo/v2 v2.0.0-20250922181213-ec3ebc5fd46b // indirect
k8s.io/kube-openapi v0.0.0-20250910181357-589584f1c912 // indirect
k8s.io/kubelet v0.34.1 // indirect
sigs.k8s.io/json v0.0.0-20250730193827-2d320260d730 // indirect
sigs.k8s.io/kustomize/api v0.20.1 // indirect
sigs.k8s.io/kustomize/kyaml v0.20.1 // indirect
sigs.k8s.io/randfill v1.0.0 // indirect
sigs.k8s.io/structured-merge-diff/v6 v6.3.0 // indirect
sigs.k8s.io/structured-merge-diff/v6 v6.3.2-0.20260122202528-d9cc6641c482 // indirect
)
Loading