docs: document signal handling #16835
Conversation
Expand documentation about Nomad's signal handling behaviors, including removing incorrect information about graceful client shutdowns.
tgross
added
theme/docs
| When gracefully exiting, clients will update their status to terminal on | ||
| the servers so that tasks can be migrated to healthy agents. Servers |
There was a problem hiding this comment.
The behavior described here for clients has never been the case. Only the node GC job ever calls Node.Deregister and the client calls Node.UpdateStatus only to heartbeat (i.e. status is only ever "ready").
Arguably if we have it documented here that makes the lack of it a bug which we should fix and backport. I'd definitely be open to that idea, seeing as how you have to opt-in to leave_on_interrupt or leave_on_terminate anyways so that's not going to break backwards compatibility unexpectedly. But that'd be a separate PR.
There was a problem hiding this comment.
Sorry I missed the review, but I would be +1 on rewriting this paragraph altogether when your drain PRs land. I find these to be surprising and unhelpful definitions of "graceful" and "forceful." I suspect the only reason these wrong docs lived so long is that they're so wrong and unhelpful it wasn't clear whether they or Nomad needed fixing as you pointed out.
Expand documentation about Nomad's signal handling behaviors, including removing incorrect information about graceful client shutdowns.
Expand documentation about Nomad's signal handling behaviors, including removing incorrect information about graceful client shutdowns.
drain_on_shutdownconfiguration #16827 which changes the behavior because I want these docs backported whereas client: allowdrain_on_shutdownconfiguration #16827 will only land in 1.5.x