80b1285fec
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>
72 lines
1.8 KiB
Go
72 lines
1.8 KiB
Go
package container
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/completion"
|
|
"github.com/docker/docker/api/types/container"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type restartOptions struct {
|
|
signal string
|
|
timeout int
|
|
timeoutChanged bool
|
|
|
|
containers []string
|
|
}
|
|
|
|
// NewRestartCommand creates a new cobra.Command for `docker restart`
|
|
func NewRestartCommand(dockerCli command.Cli) *cobra.Command {
|
|
var opts restartOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "restart [OPTIONS] CONTAINER [CONTAINER...]",
|
|
Short: "Restart one or more containers",
|
|
Args: cli.RequiresMinArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.containers = args
|
|
opts.timeoutChanged = cmd.Flags().Changed("time")
|
|
return runRestart(dockerCli, &opts)
|
|
},
|
|
Annotations: map[string]string{
|
|
"aliases": "docker container restart, docker restart",
|
|
},
|
|
ValidArgsFunction: completion.ContainerNames(dockerCli, true),
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
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")
|
|
return cmd
|
|
}
|
|
|
|
func runRestart(dockerCli command.Cli, opts *restartOptions) error {
|
|
ctx := context.Background()
|
|
var errs []string
|
|
var timeout *int
|
|
if opts.timeoutChanged {
|
|
timeout = &opts.timeout
|
|
}
|
|
for _, name := range opts.containers {
|
|
err := dockerCli.Client().ContainerRestart(ctx, name, container.StopOptions{
|
|
Signal: opts.signal,
|
|
Timeout: timeout,
|
|
})
|
|
if err != nil {
|
|
errs = append(errs, err.Error())
|
|
continue
|
|
}
|
|
_, _ = fmt.Fprintln(dockerCli.Out(), name)
|
|
}
|
|
if len(errs) > 0 {
|
|
return errors.New(strings.Join(errs, "\n"))
|
|
}
|
|
return nil
|
|
}
|