Skip to content

Add cordon reason in log messages for cordon operations #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 13, 2021
Merged

Add cordon reason in log messages for cordon operations #490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
223af9b
Add cordon reason in log messages for cordon operations (actual or dr…
Sep 10, 2021
2d12732
Use drainEvent.Description instead of Kind
Sep 13, 2021
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
12 changes: 6 additions & 6 deletions cmd/node-termination-handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ func drainOrCordonIfNecessary(interruptionEventStore *interruptioneventstore.Sto
if nthConfig.CordonOnly || (!nthConfig.EnableSQSTerminationDraining && drainEvent.IsRebalanceRecommendation() && !nthConfig.EnableRebalanceDraining) {
err = cordonNode(node, nodeName, drainEvent, metrics, recorder)
} else {
err = cordonAndDrainNode(node, nodeName, metrics, recorder, nthConfig.EnableSQSTerminationDraining)
err = cordonAndDrainNode(node, nodeName, drainEvent, metrics, recorder, nthConfig.EnableSQSTerminationDraining)
}

if nthConfig.WebhookURL != "" {
Expand Down Expand Up @@ -362,7 +362,7 @@ func runPreDrainTask(node node.Node, nodeName string, drainEvent *monitor.Interr
}

func cordonNode(node node.Node, nodeName string, drainEvent *monitor.InterruptionEvent, metrics observability.Metrics, recorder observability.K8sEventRecorder) error {
err := node.Cordon(nodeName)
err := node.Cordon(nodeName, drainEvent.Description)
if err != nil {
if errors.IsNotFound(err) {
log.Err(err).Msgf("node '%s' not found in the cluster", nodeName)
Expand All @@ -373,15 +373,15 @@ func cordonNode(node node.Node, nodeName string, drainEvent *monitor.Interruptio
}
return err
} else {
log.Info().Str("node_name", nodeName).Msg("Node successfully cordoned")
log.Info().Str("node_name", nodeName).Str("reason", drainEvent.Description).Msg("Node successfully cordoned")
metrics.NodeActionsInc("cordon", nodeName, err)
recorder.Emit(nodeName, observability.Normal, observability.CordonReason, observability.CordonMsg)
}
return nil
}

func cordonAndDrainNode(node node.Node, nodeName string, metrics observability.Metrics, recorder observability.K8sEventRecorder, sqsTerminationDraining bool) error {
err := node.CordonAndDrain(nodeName)
func cordonAndDrainNode(node node.Node, nodeName string, drainEvent *monitor.InterruptionEvent, metrics observability.Metrics, recorder observability.K8sEventRecorder, sqsTerminationDraining bool) error {
err := node.CordonAndDrain(nodeName, drainEvent.Description)
if err != nil {
if errors.IsNotFound(err) {
log.Err(err).Msgf("node '%s' not found in the cluster", nodeName)
Expand All @@ -395,7 +395,7 @@ func cordonAndDrainNode(node node.Node, nodeName string, metrics observability.M
}
return err
} else {
log.Info().Str("node_name", nodeName).Msg("Node successfully cordoned and drained")
log.Info().Str("node_name", nodeName).Str("reason", drainEvent.Description).Msg("Node successfully cordoned and drained")
metrics.NodeActionsInc("cordon-and-drain", nodeName, err)
recorder.Emit(nodeName, observability.Normal, observability.CordonAndDrainReason, observability.CordonAndDrainMsg)
}
Expand Down
11 changes: 5 additions & 6 deletions pkg/node/node.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,12 @@ func NewWithValues(nthConfig config.Config, drainHelper *drain.Helper, uptime up
}

// CordonAndDrain will cordon the node and evict pods based on the config
func (n Node) CordonAndDrain(nodeName string) error {
func (n Node) CordonAndDrain(nodeName string, reason string) error {
if n.nthConfig.DryRun {
log.Info().Str("node_name", nodeName).Msg("Node would have been cordoned and drained, but dry-run flag was set")
log.Info().Str("node_name", nodeName).Str("reason", reason).Msg("Node would have been cordoned and drained, but dry-run flag was set.")
return nil
}
log.Info().Msg("Cordoning the node")
err := n.Cordon(nodeName)
err := n.Cordon(nodeName, reason)
if err != nil {
return err
}
Expand All @@ -114,9 +113,9 @@ func (n Node) CordonAndDrain(nodeName string) error {
}

// Cordon will add a NoSchedule on the node
func (n Node) Cordon(nodeName string) error {
func (n Node) Cordon(nodeName string, reason string) error {
if n.nthConfig.DryRun {
log.Info().Str("node_name", nodeName).Msg("Node would have been cordoned, but dry-run flag was set")
log.Info().Str("node_name", nodeName).Str("reason", reason).Msgf("Node would have been cordoned, but dry-run flag was set")
return nil
}
node, err := n.fetchKubernetesNode(nodeName)
Expand Down
8 changes: 4 additions & 4 deletions pkg/node/node_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ func TestDryRun(t *testing.T) {
tNode, err := node.New(config.Config{DryRun: true})
h.Ok(t, err)

err = tNode.CordonAndDrain(nodeName)
err = tNode.CordonAndDrain(nodeName, "cordonReason")
h.Ok(t, err)

err = tNode.Cordon(nodeName)
err = tNode.Cordon(nodeName, "cordonReason")
h.Ok(t, err)

err = tNode.Uncordon(nodeName)
Expand Down Expand Up @@ -107,13 +107,13 @@ func TestDrainSuccess(t *testing.T) {
metav1.CreateOptions{})
h.Ok(t, err)
tNode := getNode(t, getDrainHelper(client))
err = tNode.CordonAndDrain(nodeName)
err = tNode.CordonAndDrain(nodeName, "cordonReason")
h.Ok(t, err)
}

func TestDrainCordonNodeFailure(t *testing.T) {
tNode := getNode(t, getDrainHelper(fake.NewSimpleClientset()))
err := tNode.CordonAndDrain(nodeName)
err := tNode.CordonAndDrain(nodeName, "cordonReason")
h.Assert(t, true, "Failed to return error on CordonAndDrain failing to cordon node", err != nil)
}

Expand Down