987da09578
This was the only command for which we set the "example" field; while we could consider doing this for other commands, we need to look what's best w.r.t. duplicating the information maintained in markdown. Also remove the intermediate variable used for the long description, as this was also the only location where we used one. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
61 lines
1.4 KiB
Go
61 lines
1.4 KiB
Go
package volume
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/completion"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type removeOptions struct {
|
|
force bool
|
|
|
|
volumes []string
|
|
}
|
|
|
|
func newRemoveCommand(dockerCli command.Cli) *cobra.Command {
|
|
var opts removeOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "rm [OPTIONS] VOLUME [VOLUME...]",
|
|
Aliases: []string{"remove"},
|
|
Short: "Remove one or more volumes",
|
|
Long: "Remove one or more volumes. You cannot remove a volume that is in use by a container.",
|
|
Args: cli.RequiresMinArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.volumes = args
|
|
return runRemove(cmd.Context(), dockerCli, &opts)
|
|
},
|
|
ValidArgsFunction: completion.VolumeNames(dockerCli),
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
flags.BoolVarP(&opts.force, "force", "f", false, "Force the removal of one or more volumes")
|
|
flags.SetAnnotation("force", "version", []string{"1.25"})
|
|
return cmd
|
|
}
|
|
|
|
func runRemove(ctx context.Context, dockerCLI command.Cli, opts *removeOptions) error {
|
|
apiClient := dockerCLI.Client()
|
|
|
|
var errs []string
|
|
|
|
for _, name := range opts.volumes {
|
|
if err := apiClient.VolumeRemove(ctx, name, opts.force); err != nil {
|
|
errs = append(errs, err.Error())
|
|
continue
|
|
}
|
|
_, _ = fmt.Fprintln(dockerCLI.Out(), name)
|
|
}
|
|
|
|
if len(errs) > 0 {
|
|
return errors.Errorf("%s", strings.Join(errs, "\n"))
|
|
}
|
|
return nil
|
|
}
|