2016-09-08 13:11:39 -04:00
|
|
|
package container
|
|
|
|
|
|
|
|
import (
|
2018-05-03 21:02:44 -04:00
|
|
|
"context"
|
2016-09-08 13:11:39 -04:00
|
|
|
"fmt"
|
|
|
|
"strings"
|
|
|
|
|
2017-04-17 18:07:56 -04:00
|
|
|
"github.com/docker/cli/cli"
|
|
|
|
"github.com/docker/cli/cli/command"
|
2022-03-30 09:27:25 -04:00
|
|
|
"github.com/docker/cli/cli/command/completion"
|
2022-04-29 13:26:50 -04:00
|
|
|
"github.com/docker/docker/api/types/container"
|
2017-03-27 21:21:59 -04:00
|
|
|
"github.com/pkg/errors"
|
2016-09-08 13:11:39 -04:00
|
|
|
"github.com/spf13/cobra"
|
|
|
|
)
|
|
|
|
|
|
|
|
type stopOptions struct {
|
2022-02-18 06:25:17 -05:00
|
|
|
signal string
|
|
|
|
timeout int
|
|
|
|
timeoutChanged bool
|
2016-09-08 13:11:39 -04:00
|
|
|
|
|
|
|
containers []string
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewStopCommand creates a new cobra.Command for `docker stop`
|
2017-10-11 12:18:27 -04:00
|
|
|
func NewStopCommand(dockerCli command.Cli) *cobra.Command {
|
2016-09-08 13:11:39 -04:00
|
|
|
var opts stopOptions
|
|
|
|
|
|
|
|
cmd := &cobra.Command{
|
|
|
|
Use: "stop [OPTIONS] CONTAINER [CONTAINER...]",
|
|
|
|
Short: "Stop one or more running containers",
|
|
|
|
Args: cli.RequiresMinArgs(1),
|
|
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
|
|
opts.containers = args
|
2022-02-18 06:25:17 -05:00
|
|
|
opts.timeoutChanged = cmd.Flags().Changed("time")
|
2023-09-09 18:27:44 -04:00
|
|
|
return runStop(cmd.Context(), dockerCli, &opts)
|
2016-09-08 13:11:39 -04:00
|
|
|
},
|
cli: use custom annotation for aliases
Cobra allows for aliases to be defined for a command, but only allows these
to be defined at the same level (for example, `docker image ls` as alias for
`docker image list`). Our CLI has some commands that are available both as a
top-level shorthand as well as `docker <object> <verb>` subcommands. For example,
`docker ps` is a shorthand for `docker container ps` / `docker container ls`.
This patch introduces a custom "aliases" annotation that can be used to print
all available aliases for a command. While this requires these aliases to be
defined manually, in practice the list of aliases rarely changes, so maintenance
should be minimal.
As a convention, we could consider the first command in this list to be the
canonical command, so that we can use this information to add redirects in
our documentation in future.
Before this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Options:
-a, --all Show all images (default hides intermediate images)
...
With this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Aliases:
docker image ls, docker image list, docker images
Options:
-a, --all Show all images (default hides intermediate images)
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-06-28 04:52:25 -04:00
|
|
|
Annotations: map[string]string{
|
|
|
|
"aliases": "docker container stop, docker stop",
|
|
|
|
},
|
2022-03-30 09:27:25 -04:00
|
|
|
ValidArgsFunction: completion.ContainerNames(dockerCli, false),
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
flags := cmd.Flags()
|
2022-02-18 06:25:17 -05:00
|
|
|
flags.StringVarP(&opts.signal, "signal", "s", "", "Signal to send to the container")
|
|
|
|
flags.IntVarP(&opts.timeout, "time", "t", 0, "Seconds to wait before killing the container")
|
2024-07-05 19:46:47 -04:00
|
|
|
|
|
|
|
_ = cmd.RegisterFlagCompletionFunc("signal", completeSignals)
|
|
|
|
|
2016-09-08 13:11:39 -04:00
|
|
|
return cmd
|
|
|
|
}
|
|
|
|
|
2023-09-09 18:27:44 -04:00
|
|
|
func runStop(ctx context.Context, dockerCli command.Cli, opts *stopOptions) error {
|
2022-04-29 13:26:50 -04:00
|
|
|
var timeout *int
|
2022-02-18 06:25:17 -05:00
|
|
|
if opts.timeoutChanged {
|
|
|
|
timeout = &opts.timeout
|
2016-06-06 23:29:05 -04:00
|
|
|
}
|
2016-09-08 13:11:39 -04:00
|
|
|
|
2023-09-09 18:27:44 -04:00
|
|
|
errChan := parallelOperation(ctx, opts.containers, func(ctx context.Context, id string) error {
|
2022-04-29 13:26:50 -04:00
|
|
|
return dockerCli.Client().ContainerStop(ctx, id, container.StopOptions{
|
2022-02-18 06:25:17 -05:00
|
|
|
Signal: opts.signal,
|
2022-04-29 13:26:50 -04:00
|
|
|
Timeout: timeout,
|
|
|
|
})
|
2016-07-18 12:02:41 -04:00
|
|
|
})
|
2022-04-29 13:26:50 -04:00
|
|
|
var errs []string
|
|
|
|
for _, ctr := range opts.containers {
|
2016-07-18 12:02:41 -04:00
|
|
|
if err := <-errChan; err != nil {
|
2016-09-08 13:11:39 -04:00
|
|
|
errs = append(errs, err.Error())
|
2016-12-24 19:05:37 -05:00
|
|
|
continue
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
2022-04-29 13:26:50 -04:00
|
|
|
_, _ = fmt.Fprintln(dockerCli.Out(), ctr)
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
|
|
|
if len(errs) > 0 {
|
2016-12-24 19:05:37 -05:00
|
|
|
return errors.New(strings.Join(errs, "\n"))
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|