1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

pkg/signal: remove DefaultStopSignal const

This const was previously living in pkg/signal, but with that package
being moved to its own module, it didn't make much sense to put docker's
defaults in a generic module.

The const from the "signal" package is currenlty used *both* by the CLI
and the daemon as a default value when creating containers. This put up
some questions:

a. should the default be non-exported, and private to the container
   package? After all, it's a _default_ (so should be used if _NOT_ set).
b. should the client actually setting a default, or instead just omit
   the value, unless specified by the user? having the client set a
   default also means that the daemon cannot change the default value
   because the client (or older clients) will override it.
c. consider defaults from the client and defaults of the daemon to be
   separate things, and create a default const in the CLI.

This patch implements option "a" (option "b" will be done separately,
as it involves the CLI code). This still leaves "c" open as an option,
if the CLI wants to set its own default.

Unfortunately, this change means we'll have to drop the alias for the
deprecated pkg/signal.DefaultStopSignal const, but a comment was left
instead, which can assist consumers of the const to find why it's no
longer there (a search showed the Docker CLI as the only consumer though).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2021-08-06 18:50:56 +02:00
parent 3b316814f9
commit e53f65a916
No known key found for this signature in database
GPG key ID: 76698F39D527CE8C
5 changed files with 12 additions and 5 deletions

View file

@ -518,7 +518,7 @@ func (container *Container) StopSignal() int {
} }
if int(stopSignal) == 0 { if int(stopSignal) == 0 {
stopSignal, _ = signal.ParseSignal(signal.DefaultStopSignal) stopSignal, _ = signal.ParseSignal(defaultStopSignal)
} }
return int(stopSignal) return int(stopSignal)
} }

View file

@ -19,7 +19,7 @@ func TestContainerStopSignal(t *testing.T) {
Config: &container.Config{}, Config: &container.Config{},
} }
def, err := signal.ParseSignal(signal.DefaultStopSignal) def, err := signal.ParseSignal(defaultStopSignal)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }

View file

@ -23,6 +23,9 @@ import (
) )
const ( const (
// defaultStopSignal is the default syscall signal used to stop a container.
defaultStopSignal = "SIGTERM"
// defaultStopTimeout sets the default time, in seconds, to wait // defaultStopTimeout sets the default time, in seconds, to wait
// for the graceful container stop before forcefully terminating it. // for the graceful container stop before forcefully terminating it.
defaultStopTimeout = 10 defaultStopTimeout = 10

View file

@ -17,6 +17,9 @@ const (
containerInternalSecretMountPath = `C:\ProgramData\Docker\internal\secrets` containerInternalSecretMountPath = `C:\ProgramData\Docker\internal\secrets`
containerInternalConfigsDirPath = `C:\ProgramData\Docker\internal\configs` containerInternalConfigsDirPath = `C:\ProgramData\Docker\internal\configs`
// defaultStopSignal is the default syscall signal used to stop a container.
defaultStopSignal = "SIGTERM"
// defaultStopTimeout is the timeout (in seconds) for the shutdown call on a container // defaultStopTimeout is the timeout (in seconds) for the shutdown call on a container
defaultStopTimeout = 30 defaultStopTimeout = 30
) )

View file

@ -48,7 +48,8 @@ const (
// SIGPIPE is a signal sent to a process when a pipe is written to before the other end is open for reading // SIGPIPE is a signal sent to a process when a pipe is written to before the other end is open for reading
// Deprecated: use github.com/moby/sys/signal.SIGPIPE instead // Deprecated: use github.com/moby/sys/signal.SIGPIPE instead
SIGPIPE = msignal.SIGPIPE SIGPIPE = msignal.SIGPIPE
// DefaultStopSignal is the syscall signal used to stop a container in unix systems.
// Deprecated: use github.com/moby/sys/signal.DefaultStopSignal instead // DefaultStopSignal has been deprecated and removed. The default value is
DefaultStopSignal = msignal.DefaultStopSignal // now defined in github.com/docker/docker/container. Clients should omit
// the container's stop-signal field if the default should be used.
) )