Signal to stop a container. #15307

calavera · 2015-08-04T20:54:38Z

Allow to set the signal to stop a container in docker run. Use --stop-signal with docker-run to set the default signal the container will use to exit.
Add STOP command to the builder to allow image creator to set the default exit signal for their programs.

TODO:

Tests
More docs
Shell completions

Closes #6711

Signed-off-by: David Calavera [email protected]

cpuguy83 · 2015-08-05T15:18:51Z

Seems ok to me.

phemmer · 2015-08-05T16:46:53Z

man/docker-run.1.md

Here it's --stop-signal, but everywhere else it's --kill-signal.

Also, personally I prefer --stop-signal over --kill-signal. Since docker sends a SIGKILL after the 10 second timeout, calling this "kill-signal" makes it confusing which signal this is controlling.

I actually prefer stop-signal too, that was the first implementation and that's why the doc still mentions it. For other conversations it seemed better to call it kill-signal, but I'm open to change it back.

/cc @crosbymichael

also wondering if we need a short-hand (-s) flag for this; will this be a frequently enough used option? (we're running out of letters fast :-))

we don't need it

rhatdan · 2015-08-06T14:19:49Z

Not sure we should be checking for proper signals on this. Since the signal table seems to be often out of date.

calavera · 2015-08-06T20:05:44Z

Not sure we should be checking for proper signals on this. Since the signal table seems to be often out of date.

I think we could support both. I agree that we might not include all the signals in our table, but remembering a signal name is easier than remembering a number in some cases. I think we should check if the flag is a number and pass it through in that case.

rhatdan · 2015-08-07T10:28:38Z

Ok, as long as we support numbers.

icecrime · 2015-08-08T00:38:17Z

Design LGTM.

icecrime · 2015-08-08T00:38:39Z

daemon/container.go

Why not syscall.SIGTERM here?

Allow to set the signal to stop a container in `docker run`: - Use `--stop-signal` with docker-run to set the default signal the container will use to exit. Signed-off-by: David Calavera <[email protected]>

This way, images creators can set the exit signal their programs use. Signed-off-by: David Calavera <[email protected]>

calavera · 2015-09-10T23:56:35Z

@SvenDowideit, @moxiegirl Please, take a look.

thaJeztah · 2015-09-10T23:59:59Z

@calavera given the addition to the Dockerfile syntax, does this need wider approval before merging? I saw some concerns raised on the build-ARGS PR (which was approved before the freeze on builder)

calavera · 2015-09-11T00:23:02Z

@thaJeztah we already went through that

moxiegirl · 2015-09-11T15:55:22Z

LGTM

Signal to stop a container.

SamSaffron · 2015-09-25T00:30:39Z

Nice one!

JadeQin · 2016-01-14T03:56:32Z

Can I use a custom command replace signal ?
for example use ./bin/solr stop to stop a solr container

rhatdan · 2016-01-14T13:40:53Z

You could docker exec into the container to execute this.

docker exec CONTAINID solr stop

rhatdan · 2016-01-14T13:41:35Z

Using the atomic command you can add a STOP label which would execute this command

JadeQin · 2016-01-15T00:38:18Z

@rhatdan yes,I know I can use exec to do it. Docker has a default start command,why not have a default stop command?

How can I use STOP label ?Can you give me a example?Thanks

cpuguy83 · 2016-01-15T01:11:44Z

@loveai88 Docker starts a process, it interacts with that process by using standard unix signals.
I'd recommend using something like runit (or even a custom bash script, really) which allow you to specify these things.

rhatdan · 2016-01-15T13:09:24Z

atomic command is a wrapper around docker that uses LABEL embedded in the container image to tell it how to start, stop, install, uninstall, scan, verify ... the images.
https://github.com/projectatomic/atomic

Here are the generic Labels that atomic command and others can use.
https://github.com/projectatomic/ContainerApplicationGenericLabels

Basically you could add a label in your dockerfile.

LABEL STOP docker exec ${NAME} solr stop

Then users could execute

atomic stop CONTAINERID
atomic would execute this command.

Similarly if you wanted a special

JadeQin · 2016-01-15T13:12:48Z

@rhatdan 👍

KostyaSha · 2016-02-22T13:39:19Z

contrib/completion/fish/docker.fish

 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l rm -d 'Automatically remove the container when it exits (incompatible with -d)'
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l security-opt -d 'Security Options'
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l sig-proxy -d 'Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.'
+complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l stop-signal 'Signal to kill a container'


to kill or stop?

thaJeztah · 2025-02-15T18:04:52Z

daemon/container.go

+		stopSignal, _ = signal.ParseSignal(container.Config.StopSignal)
+	}
+
+	if int(stopSignal) == 0 {
+		stopSignal, _ = signal.ParseSignal(signal.DefaultStopSignal)


🙈 signal.ParseSignal returns -1 if the signal is invalid; the branch above doesn't check the error, and this branch only checks for 0, so this can return -1 as signal;

container: Container.StopSignal: fix handling of invalid signals and cleanup tests #49471

GordonTheTurtle added the status/0-triage label Aug 4, 2015

calavera closed this Aug 4, 2015

calavera reopened this Aug 4, 2015

calavera changed the title ~~Stop signal to kill a container.~~ [WIP] Stop signal to kill a container. Aug 4, 2015

calavera force-pushed the stop_signal branch from c846e4f to 1344ba6 Compare August 4, 2015 22:41

calavera changed the title ~~[WIP] Stop signal to kill a container.~~ [WIP] Signal to kill a container. Aug 4, 2015

calavera force-pushed the stop_signal branch 2 times, most recently from c62a252 to 5acf54d Compare August 4, 2015 22:53

calavera added status/1-design-review and removed status/0-triage labels Aug 4, 2015

phemmer reviewed Aug 5, 2015
View reviewed changes

calavera force-pushed the stop_signal branch from 5acf54d to 7a1737e Compare August 6, 2015 20:56

calavera changed the title ~~[WIP] Signal to kill a container.~~ [WIP] Signal to stop a container. Aug 6, 2015

calavera force-pushed the stop_signal branch 2 times, most recently from 3fd6d37 to 6781c4b Compare August 6, 2015 21:13

icecrime added status/2-code-review and removed status/1-design-review labels Aug 8, 2015

icecrime reviewed Aug 8, 2015
View reviewed changes

daemon/container.go Outdated

Copy link

Contributor

icecrime Aug 8, 2015

Choose a reason for hiding this comment

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

Why not syscall.SIGTERM here?

calavera force-pushed the stop_signal branch 3 times, most recently from ad648b1 to 1064d35 Compare August 10, 2015 15:16

calavera mentioned this pull request Aug 10, 2015

Patch set to support systemd as PID1 in container #13525

Closed

calavera force-pushed the stop_signal branch 2 times, most recently from 9adc7c6 to 4ceb9e1 Compare August 11, 2015 01:12

calavera mentioned this pull request Sep 9, 2015

Inspect should include terminating signal #6711

Closed

calavera added 2 commits September 10, 2015 19:56

Signal to stop a container.

0e50d94

Allow to set the signal to stop a container in `docker run`: - Use `--stop-signal` with docker-run to set the default signal the container will use to exit. Signed-off-by: David Calavera <[email protected]>

Add STOPSIGNAL instruction to dockerfiles.

3781cde

This way, images creators can set the exit signal their programs use. Signed-off-by: David Calavera <[email protected]>

calavera force-pushed the stop_signal branch from 3c2ab44 to 3781cde Compare September 10, 2015 23:56

calavera added a commit that referenced this pull request Sep 11, 2015

Merge pull request #15307 from calavera/stop_signal

db54c79

Signal to stop a container.

calavera merged commit db54c79 into moby:master Sep 11, 2015

calavera deleted the stop_signal branch September 11, 2015 16:25

lowenna mentioned this pull request Sep 11, 2015

Windows: Nice error on stopsignal #16240

Merged

phemmer mentioned this pull request Sep 22, 2015

TTL for containers #16478

Closed

icecrime mentioned this pull request Sep 24, 2015

Allow Dockerfile to specify stop signal #8485

Closed

thaJeztah added the impact/cli label Oct 13, 2015

so0k mentioned this pull request Oct 21, 2015

Define default stop signal in Dockerfile or update Documentation nginx/docker-nginx#46

Closed

thaJeztah added the impact/api label Oct 28, 2015

KostyaSha reviewed Feb 22, 2016
View reviewed changes

runcom mentioned this pull request Feb 16, 2017

config: add StopSignal opencontainers/image-spec#544

Merged

unshare mentioned this pull request Feb 6, 2018

Graceful shutdown and kill with SIGRTMIN..SIGRTMAX don't work #36219

Closed

thaJeztah mentioned this pull request Feb 15, 2025

container: Container.StopSignal: fix handling of invalid signals and cleanup tests #49471

Merged

thaJeztah reviewed Feb 15, 2025

View reviewed changes

Signal to stop a container. #15307

Signal to stop a container. #15307

Uh oh!

Conversation

calavera commented Aug 4, 2015

Uh oh!

cpuguy83 commented Aug 5, 2015

Uh oh!

phemmer Aug 5, 2015

Choose a reason for hiding this comment

Uh oh!

calavera Aug 5, 2015

Choose a reason for hiding this comment

Uh oh!

thaJeztah Aug 5, 2015

Choose a reason for hiding this comment

Uh oh!

calavera Aug 5, 2015

Choose a reason for hiding this comment

Uh oh!

rhatdan commented Aug 6, 2015

Uh oh!

calavera commented Aug 6, 2015

Uh oh!

rhatdan commented Aug 7, 2015

Uh oh!

icecrime commented Aug 8, 2015

Uh oh!

icecrime Aug 8, 2015

Choose a reason for hiding this comment

Uh oh!

calavera commented Sep 10, 2015

Uh oh!

thaJeztah commented Sep 10, 2015

Uh oh!

calavera commented Sep 11, 2015

Uh oh!

moxiegirl commented Sep 11, 2015

Uh oh!

SamSaffron commented Sep 25, 2015

Uh oh!

JadeQin commented Jan 14, 2016

Uh oh!

rhatdan commented Jan 14, 2016

Uh oh!

rhatdan commented Jan 14, 2016

Uh oh!

JadeQin commented Jan 15, 2016

Uh oh!

cpuguy83 commented Jan 15, 2016

Uh oh!

rhatdan commented Jan 15, 2016

Uh oh!

JadeQin commented Jan 15, 2016

Uh oh!

KostyaSha Feb 22, 2016

Choose a reason for hiding this comment

Uh oh!

thaJeztah Feb 15, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

14 participants