kubernetes/ingress-nginx

Distinguish wait-shutdown command from standard k8s SIGTERM

Open

#6,287 opened on Oct 6, 2020

View on GitHub
 (32 comments) (1 reaction) (1 assignee)Go (15,199 stars) (7,888 forks)batch import
good first issuehelp wantedkind/featureneeds-triagepriority/backlog

Description

As of v0.26.0, we can specify /wait-shutdown as a pre-stop hook in our deployment spec. As currently implemented, it sends SIGTERM to the nginx-ingress-controller process. https://github.com/kubernetes/ingress-nginx/blob/59a7f51cd4f0c41f214c520ca8b2a502946ed08e/cmd/waitshutdown/main.go#L29

Since SIGTERM is also what k8s sends when shutting down a pod, there is no way for us to really tell for sure from the logs whether the pre-stop hook was properly configured or not. For this reason, it would be better if wait-shutdown used a different signal.

/kind feature

Contributor guide

Tech stack
go
Domain
devopscloud
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingKubernetes basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The change involves modifying the signal sent in cmd/waitshutdown/main.go at line 29 (link). Consider using a different signal like SIGQUIT or SIGUSR1, and ensure the documentation is updated. The issue has an assignee, so coordinate with them.
Distinguish wait-shutdown command from standard k8s SIGTERM · kubernetes/ingress-nginx#6287 | Good First Issue