From 74d984e0560b2cb421287395b025687e3aabe118 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Tue, 5 Feb 2019 10:41:55 -0800 Subject: Add podman system prune and info commands We are missing the equivalence of the docker system commands This patch set adds `podman system prune` and `podman system info` Signed-off-by: Daniel J Walsh --- cmd/podman/commands.go | 4 ++ cmd/podman/commands_remoteclient.go | 4 ++ cmd/podman/containers_prune.go | 37 +++++++------ cmd/podman/images_prune.go | 1 + cmd/podman/main.go | 1 + cmd/podman/run.go | 1 + cmd/podman/system.go | 29 ++++++++++ cmd/podman/system_prune.go | 107 ++++++++++++++++++++++++++++++++++++ cmd/podman/volume_prune.go | 48 ++++++++-------- 9 files changed, 193 insertions(+), 39 deletions(-) create mode 100644 cmd/podman/system.go create mode 100644 cmd/podman/system_prune.go (limited to 'cmd') diff --git a/cmd/podman/commands.go b/cmd/podman/commands.go index d8fdd556f..2efcab695 100644 --- a/cmd/podman/commands.go +++ b/cmd/podman/commands.go @@ -53,6 +53,10 @@ func getImageSubCommands() []cli.Command { } } +func getSystemSubCommands() []cli.Command { + return []cli.Command{infoCommand} +} + func getContainerSubCommands() []cli.Command { return []cli.Command{ attachCommand, diff --git a/cmd/podman/commands_remoteclient.go b/cmd/podman/commands_remoteclient.go index 6701e14a1..0adbd7b4c 100644 --- a/cmd/podman/commands_remoteclient.go +++ b/cmd/podman/commands_remoteclient.go @@ -16,6 +16,10 @@ func getContainerSubCommands() []cli.Command { return []cli.Command{} } +func getSystemSubCommands() []cli.Command { + return []cli.Command{} +} + func getMainAppFlags() []cli.Flag { return []cli.Flag{} } diff --git a/cmd/podman/containers_prune.go b/cmd/podman/containers_prune.go index 92604e82f..09141e9a3 100644 --- a/cmd/podman/containers_prune.go +++ b/cmd/podman/containers_prune.go @@ -1,9 +1,11 @@ package main import ( - "github.com/containers/libpod/cmd/podman/libpodruntime" + "context" + "github.com/containers/libpod/cmd/podman/shared" "github.com/containers/libpod/libpod" + "github.com/containers/libpod/libpod/adapter" "github.com/pkg/errors" "github.com/sirupsen/logrus" "github.com/urfave/cli" @@ -25,20 +27,11 @@ var ( } ) -func pruneContainersCmd(c *cli.Context) error { - var ( - deleteFuncs []shared.ParallelWorkerInput - ) - - ctx := getContext() - runtime, err := libpodruntime.GetRuntime(c) - if err != nil { - return errors.Wrapf(err, "could not get runtime") - } - defer runtime.Shutdown(false) +func pruneContainers(runtime *adapter.LocalRuntime, ctx context.Context, maxWorkers int, force bool) error { + var deleteFuncs []shared.ParallelWorkerInput filter := func(c *libpod.Container) bool { - state, _ := c.State() + state, err := c.State() if state == libpod.ContainerStateStopped || (state == libpod.ContainerStateExited && err == nil && c.PodID() == "") { return true } @@ -54,7 +47,7 @@ func pruneContainersCmd(c *cli.Context) error { for _, container := range delContainers { con := container f := func() error { - return runtime.RemoveContainer(ctx, con, c.Bool("force")) + return runtime.RemoveContainer(ctx, con, force) } deleteFuncs = append(deleteFuncs, shared.ParallelWorkerInput{ @@ -62,13 +55,23 @@ func pruneContainersCmd(c *cli.Context) error { ParallelFunc: f, }) } + // Run the parallel funcs + deleteErrors, errCount := shared.ParallelExecuteWorkerPool(maxWorkers, deleteFuncs) + return printParallelOutput(deleteErrors, errCount) +} + +func pruneContainersCmd(c *cli.Context) error { + runtime, err := adapter.GetRuntime(c) + if err != nil { + return errors.Wrapf(err, "could not get runtime") + } + defer runtime.Shutdown(false) + maxWorkers := shared.Parallelize("rm") if c.GlobalIsSet("max-workers") { maxWorkers = c.GlobalInt("max-workers") } logrus.Debugf("Setting maximum workers to %d", maxWorkers) - // Run the parallel funcs - deleteErrors, errCount := shared.ParallelExecuteWorkerPool(maxWorkers, deleteFuncs) - return printParallelOutput(deleteErrors, errCount) + return pruneContainers(runtime, getContext(), maxWorkers, c.Bool("force")) } diff --git a/cmd/podman/images_prune.go b/cmd/podman/images_prune.go index aef387732..baef813e5 100644 --- a/cmd/podman/images_prune.go +++ b/cmd/podman/images_prune.go @@ -2,6 +2,7 @@ package main import ( "fmt" + "github.com/containers/libpod/libpod/adapter" "github.com/pkg/errors" "github.com/urfave/cli" diff --git a/cmd/podman/main.go b/cmd/podman/main.go index 1ca8882eb..d90df8222 100644 --- a/cmd/podman/main.go +++ b/cmd/podman/main.go @@ -97,6 +97,7 @@ func main() { inspectCommand, pullCommand, rmiCommand, + systemCommand, tagCommand, versionCommand, } diff --git a/cmd/podman/run.go b/cmd/podman/run.go index 20cb85347..662aed900 100644 --- a/cmd/podman/run.go +++ b/cmd/podman/run.go @@ -131,6 +131,7 @@ func runCmd(c *cli.Context) error { ctrExitCode, err := readExitFile(runtime.GetConfig().TmpDir, ctr.ID()) if err != nil { logrus.Errorf("Cannot get exit code: %v", err) + exitCode = 127 } else { exitCode = ctrExitCode } diff --git a/cmd/podman/system.go b/cmd/podman/system.go new file mode 100644 index 000000000..9596252ad --- /dev/null +++ b/cmd/podman/system.go @@ -0,0 +1,29 @@ +package main + +import ( + "sort" + + "github.com/urfave/cli" +) + +var ( + systemSubCommands = []cli.Command{ + pruneSystemCommand, + } + systemDescription = "Manage podman" + systemCommand = cli.Command{ + Name: "system", + Usage: "Manage podman", + Description: systemDescription, + ArgsUsage: "", + Subcommands: getSystemSubCommandsSorted(), + UseShortOptionHandling: true, + OnUsageError: usageErrorHandler, + } +) + +func getSystemSubCommandsSorted() []cli.Command { + systemSubCommands = append(systemSubCommands, getSystemSubCommands()...) + sort.Sort(commandSortedAlpha{systemSubCommands}) + return systemSubCommands +} diff --git a/cmd/podman/system_prune.go b/cmd/podman/system_prune.go new file mode 100644 index 000000000..145fb4c94 --- /dev/null +++ b/cmd/podman/system_prune.go @@ -0,0 +1,107 @@ +package main + +import ( + "bufio" + "fmt" + "os" + "strings" + + "github.com/containers/libpod/cmd/podman/shared" + "github.com/containers/libpod/libpod/adapter" + "github.com/pkg/errors" + "github.com/sirupsen/logrus" + "github.com/urfave/cli" +) + +var ( + pruneSystemDescription = ` + podman system prune + + Remove unused data +` + pruneSystemFlags = []cli.Flag{ + cli.BoolFlag{ + Name: "all, a", + Usage: "remove all unused data", + }, + cli.BoolFlag{ + Name: "force, f", + Usage: "Do not prompt for confirmation", + }, + cli.BoolFlag{ + Name: "volumes", + Usage: "Prune volumes", + }, + } + pruneSystemCommand = cli.Command{ + Name: "prune", + Usage: "Remove unused data", + Description: pruneSystemDescription, + Action: pruneSystemCmd, + OnUsageError: usageErrorHandler, + Flags: pruneSystemFlags, + } +) + +func pruneSystemCmd(c *cli.Context) error { + + // Prompt for confirmation if --force is not set + if !c.Bool("force") { + reader := bufio.NewReader(os.Stdin) + volumeString := "" + if c.Bool("volumes") { + volumeString = ` + - all volumes not used by at least one container` + } + fmt.Printf(` +WARNING! This will remove: + - all stopped containers%s + - all dangling images + - all build cache +Are you sure you want to continue? [y/N] `, volumeString) + ans, err := reader.ReadString('\n') + if err != nil { + return errors.Wrapf(err, "error reading input") + } + if strings.ToLower(ans)[0] != 'y' { + return nil + } + } + + runtime, err := adapter.GetRuntime(c) + if err != nil { + return errors.Wrapf(err, "could not get runtime") + } + defer runtime.Shutdown(false) + + ctx := getContext() + fmt.Println("Deleted Containers") + lasterr := pruneContainers(runtime, ctx, shared.Parallelize("rm"), false) + if c.Bool("volumes") { + fmt.Println("Deleted Volumes") + err := volumePrune(runtime, getContext()) + if err != nil { + if lasterr != nil { + logrus.Errorf("%q", lasterr) + } + lasterr = err + } + } + + // Call prune; if any cids are returned, print them and then + // return err in case an error also came up + pruneCids, err := runtime.PruneImages(c.Bool("all")) + if len(pruneCids) > 0 { + fmt.Println("Deleted Images") + for _, cid := range pruneCids { + fmt.Println(cid) + } + } + if err != nil { + if lasterr != nil { + logrus.Errorf("%q", lasterr) + } + lasterr = err + } + return lasterr +} diff --git a/cmd/podman/volume_prune.go b/cmd/podman/volume_prune.go index 652c50f42..41d95f9c7 100644 --- a/cmd/podman/volume_prune.go +++ b/cmd/podman/volume_prune.go @@ -2,12 +2,13 @@ package main import ( "bufio" + "context" "fmt" "os" "strings" - "github.com/containers/libpod/cmd/podman/libpodruntime" "github.com/containers/libpod/libpod" + "github.com/containers/libpod/libpod/adapter" "github.com/pkg/errors" "github.com/sirupsen/logrus" "github.com/urfave/cli" @@ -37,21 +38,40 @@ var volumePruneCommand = cli.Command{ UseShortOptionHandling: true, } -func volumePruneCmd(c *cli.Context) error { +func volumePrune(runtime *adapter.LocalRuntime, ctx context.Context) error { var lastError error + volumes, err := runtime.GetAllVolumes() + if err != nil { + return err + } + + for _, vol := range volumes { + err = runtime.RemoveVolume(ctx, vol, false, true) + if err == nil { + fmt.Println(vol.Name()) + } else if err != libpod.ErrVolumeBeingUsed { + if lastError != nil { + logrus.Errorf("%q", lastError) + } + lastError = errors.Wrapf(err, "failed to remove volume %q", vol.Name()) + } + } + return lastError +} + +func volumePruneCmd(c *cli.Context) error { + if err := validateFlags(c, volumePruneFlags); err != nil { return err } - runtime, err := libpodruntime.GetRuntime(c) + runtime, err := adapter.GetRuntime(c) if err != nil { return errors.Wrapf(err, "error creating libpod runtime") } defer runtime.Shutdown(false) - ctx := getContext() - // Prompt for confirmation if --force is not set if !c.Bool("force") { reader := bufio.NewReader(os.Stdin) @@ -66,21 +86,5 @@ func volumePruneCmd(c *cli.Context) error { } } - volumes, err := runtime.GetAllVolumes() - if err != nil { - return err - } - - for _, vol := range volumes { - err = runtime.RemoveVolume(ctx, vol, false, true) - if err == nil { - fmt.Println(vol.Name()) - } else if err != libpod.ErrVolumeBeingUsed { - if lastError != nil { - logrus.Errorf("%q", lastError) - } - lastError = errors.Wrapf(err, "failed to remove volume %q", vol.Name()) - } - } - return lastError + return volumePrune(runtime, getContext()) } -- cgit v1.2.3-54-g00ecf From 0830bb9035a9ee35810e358a32b8011da2dc1be6 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Mon, 4 Feb 2019 13:44:16 -0500 Subject: Capatilize all usage and descriptions We have no consistancy in out option usages and descritions on whether or not the first letter should be capatalized. This patch forces them all to be capatilized. Signed-off-by: Daniel J Walsh --- cmd/podman/attach.go | 2 +- cmd/podman/build.go | 2 +- cmd/podman/checkpoint.go | 8 ++++---- cmd/podman/commands.go | 26 +++++++++++++------------- cmd/podman/common.go | 6 +++--- cmd/podman/generate.go | 4 ++-- cmd/podman/generate_kube.go | 2 +- cmd/podman/images.go | 14 +++++++------- cmd/podman/images_prune.go | 2 +- cmd/podman/info.go | 2 +- cmd/podman/main.go | 8 ++++---- cmd/podman/mount.go | 2 +- cmd/podman/pause.go | 2 +- cmd/podman/play.go | 2 +- cmd/podman/play_kube.go | 10 +++++----- cmd/podman/pod_inspect.go | 4 ++-- cmd/podman/pod_pause.go | 2 +- cmd/podman/pod_restart.go | 2 +- cmd/podman/pod_start.go | 2 +- cmd/podman/pod_stats.go | 10 +++++----- cmd/podman/pod_stop.go | 2 +- cmd/podman/pod_unpause.go | 2 +- cmd/podman/port.go | 2 +- cmd/podman/pull.go | 2 +- cmd/podman/push.go | 18 +++++++++--------- cmd/podman/restart.go | 4 ++-- cmd/podman/restore.go | 6 +++--- cmd/podman/rmi.go | 6 +++--- cmd/podman/run.go | 2 +- cmd/podman/runlabel.go | 12 ++++++------ cmd/podman/save.go | 2 +- cmd/podman/search.go | 10 +++++----- cmd/podman/start.go | 2 +- cmd/podman/stats.go | 10 +++++----- cmd/podman/stop.go | 2 +- cmd/podman/system_prune.go | 2 +- cmd/podman/umount.go | 4 ++-- cmd/podman/unpause.go | 2 +- cmd/podman/varlink.go | 2 +- 39 files changed, 102 insertions(+), 102 deletions(-) (limited to 'cmd') diff --git a/cmd/podman/attach.go b/cmd/podman/attach.go index dc0563a94..bcfee6891 100644 --- a/cmd/podman/attach.go +++ b/cmd/podman/attach.go @@ -21,7 +21,7 @@ var ( }, cli.BoolTFlag{ Name: "sig-proxy", - Usage: "proxy received signals to the process (default true)", + Usage: "Proxy received signals to the process (default true)", }, LatestFlag, } diff --git a/cmd/podman/build.go b/cmd/podman/build.go index 02a125aab..0cd1bfbe3 100644 --- a/cmd/podman/build.go +++ b/cmd/podman/build.go @@ -25,7 +25,7 @@ var ( }, cli.BoolTFlag{ Name: "layers", - Usage: "cache intermediate layers during build. Use BUILDAH_LAYERS environment variable to override. ", + Usage: "Cache intermediate layers during build. Use BUILDAH_LAYERS environment variable to override. ", }, } buildDescription = "Builds an OCI or Docker image using instructions from one\n" + diff --git a/cmd/podman/checkpoint.go b/cmd/podman/checkpoint.go index 824c97662..5c3363147 100644 --- a/cmd/podman/checkpoint.go +++ b/cmd/podman/checkpoint.go @@ -21,19 +21,19 @@ var ( checkpointFlags = []cli.Flag{ cli.BoolFlag{ Name: "keep, k", - Usage: "keep all temporary checkpoint files", + Usage: "Keep all temporary checkpoint files", }, cli.BoolFlag{ Name: "leave-running, R", - Usage: "leave the container running after writing checkpoint to disk", + Usage: "Leave the container running after writing checkpoint to disk", }, cli.BoolFlag{ Name: "tcp-established", - Usage: "checkpoint a container with established TCP connections", + Usage: "Checkpoint a container with established TCP connections", }, cli.BoolFlag{ Name: "all, a", - Usage: "checkpoint all running containers", + Usage: "Checkpoint all running containers", }, LatestFlag, } diff --git a/cmd/podman/commands.go b/cmd/podman/commands.go index 2efcab695..57126da4a 100644 --- a/cmd/podman/commands.go +++ b/cmd/podman/commands.go @@ -95,58 +95,58 @@ func getMainAppFlags() []cli.Flag { return []cli.Flag{ cli.StringFlag{ Name: "cgroup-manager", - Usage: "cgroup manager to use (cgroupfs or systemd, default systemd)", + Usage: "Cgroup manager to use (cgroupfs or systemd, default systemd)", }, cli.StringFlag{ Name: "cni-config-dir", - Usage: "path of the configuration directory for CNI networks", + Usage: "Path of the configuration directory for CNI networks", }, cli.StringFlag{ Name: "conmon", - Usage: "path of the conmon binary", + Usage: "Path of the conmon binary", }, cli.StringFlag{ Name: "default-mounts-file", - Usage: "path to default mounts file", + Usage: "Path to default mounts file", Hidden: true, }, cli.StringSliceFlag{ Name: "hooks-dir", - Usage: "set the OCI hooks directory path (may be set multiple times)", + Usage: "Set the OCI hooks directory path (may be set multiple times)", }, cli.IntFlag{ Name: "max-workers", - Usage: "the maximum number of workers for parallel operations", + Usage: "The maximum number of workers for parallel operations", Hidden: true, }, cli.StringFlag{ Name: "namespace", - Usage: "set the libpod namespace, used to create separate views of the containers and pods on the system", + Usage: "Set the libpod namespace, used to create separate views of the containers and pods on the system", Value: "", }, cli.StringFlag{ Name: "root", - Usage: "path to the root directory in which data, including images, is stored", + Usage: "Path to the root directory in which data, including images, is stored", }, cli.StringFlag{ Name: "runroot", - Usage: "path to the 'run directory' where all state information is stored", + Usage: "Path to the 'run directory' where all state information is stored", }, cli.StringFlag{ Name: "runtime", - Usage: "path to the OCI-compatible binary used to run containers, default is /usr/bin/runc", + Usage: "Path to the OCI-compatible binary used to run containers, default is /usr/bin/runc", }, cli.StringFlag{ Name: "storage-driver, s", - Usage: "select which storage driver is used to manage storage of images and containers (default is overlay)", + Usage: "Select which storage driver is used to manage storage of images and containers (default is overlay)", }, cli.StringSliceFlag{ Name: "storage-opt", - Usage: "used to pass an option to the storage driver", + Usage: "Used to pass an option to the storage driver", }, cli.BoolFlag{ Name: "syslog", - Usage: "output logging information to syslog as well as the console", + Usage: "Output logging information to syslog as well as the console", }, } } diff --git a/cmd/podman/common.go b/cmd/podman/common.go index d934c8699..82d60d62e 100644 --- a/cmd/podman/common.go +++ b/cmd/podman/common.go @@ -22,11 +22,11 @@ var ( stores = make(map[storage.Store]struct{}) LatestFlag = cli.BoolFlag{ Name: "latest, l", - Usage: "act on the latest container podman is aware of", + Usage: "Act on the latest container podman is aware of", } LatestPodFlag = cli.BoolFlag{ Name: "latest, l", - Usage: "act on the latest pod podman is aware of", + Usage: "Act on the latest pod podman is aware of", } WorkDirFlag = cli.StringFlag{ Name: "workdir, w", @@ -213,7 +213,7 @@ var createFlags = []cli.Flag{ }, cli.StringFlag{ Name: "conmon-pidfile", - Usage: "path to the file that will receive the PID of conmon", + Usage: "Path to the file that will receive the PID of conmon", }, cli.Uint64Flag{ Name: "cpu-period", diff --git a/cmd/podman/generate.go b/cmd/podman/generate.go index 765d0ee70..20a4a61ab 100644 --- a/cmd/podman/generate.go +++ b/cmd/podman/generate.go @@ -9,10 +9,10 @@ var ( containerKubeCommand, } - generateDescription = "generate structured data based for a containers and pods" + generateDescription = "Generate structured data based for a containers and pods" kubeCommand = cli.Command{ Name: "generate", - Usage: "generated structured data", + Usage: "Generate structured data", Description: generateDescription, ArgsUsage: "", Subcommands: generateSubCommands, diff --git a/cmd/podman/generate_kube.go b/cmd/podman/generate_kube.go index f63bd431b..fc667fb5b 100644 --- a/cmd/podman/generate_kube.go +++ b/cmd/podman/generate_kube.go @@ -17,7 +17,7 @@ var ( containerKubeFlags = []cli.Flag{ cli.BoolFlag{ Name: "service, s", - Usage: "generate YAML for kubernetes service object", + Usage: "Generate YAML for kubernetes service object", }, } containerKubeDescription = "Generate Kubernetes Pod YAML" diff --git a/cmd/podman/images.go b/cmd/podman/images.go index d4f405975..9fdf0a780 100644 --- a/cmd/podman/images.go +++ b/cmd/podman/images.go @@ -90,11 +90,11 @@ var ( }, cli.BoolFlag{ Name: "digests", - Usage: "show digests", + Usage: "Show digests", }, cli.StringSliceFlag{ Name: "filter, f", - Usage: "filter output based on conditions provided (default [])", + Usage: "Filter output based on conditions provided (default [])", }, cli.StringFlag{ Name: "format", @@ -102,20 +102,20 @@ var ( }, cli.BoolFlag{ Name: "noheading, n", - Usage: "do not print column headings", + Usage: "Do not print column headings", }, cli.BoolFlag{ Name: "no-trunc, notruncate", - Usage: "do not truncate output", + Usage: "Do not truncate output", }, cli.BoolFlag{ Name: "quiet, q", - Usage: "display only image IDs", + Usage: "Display only image IDs", }, cli.StringFlag{ Name: "sort", Usage: "Sort by created, id, repository, size, or tag", - Value: "created", + Value: "Created", }, } @@ -133,7 +133,7 @@ var ( lsImagesCommand = cli.Command{ Name: "list", Aliases: []string{"ls"}, - Usage: "list images in local storage", + Usage: "List images in local storage", Description: imagesDescription, Flags: imagesFlags, Action: imagesCmd, diff --git a/cmd/podman/images_prune.go b/cmd/podman/images_prune.go index baef813e5..844984bb9 100644 --- a/cmd/podman/images_prune.go +++ b/cmd/podman/images_prune.go @@ -17,7 +17,7 @@ var ( pruneImageFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "remove all unused images, not just dangling ones", + Usage: "Remove all unused images, not just dangling ones", }, } pruneImagesCommand = cli.Command{ diff --git a/cmd/podman/info.go b/cmd/podman/info.go index f5f91b603..19078cea5 100644 --- a/cmd/podman/info.go +++ b/cmd/podman/info.go @@ -26,7 +26,7 @@ var ( infoFlags = []cli.Flag{ cli.BoolFlag{ Name: "debug, D", - Usage: "display additional debug information", + Usage: "Display additional debug information", }, cli.StringFlag{ Name: "format, f", diff --git a/cmd/podman/main.go b/cmd/podman/main.go index d90df8222..8c08b2bfb 100644 --- a/cmd/podman/main.go +++ b/cmd/podman/main.go @@ -188,21 +188,21 @@ func main() { app.Flags = []cli.Flag{ cli.StringFlag{ Name: "config, c", - Usage: "path of a libpod config file detailing container server configuration options", + Usage: "Path of a libpod config file detailing container server configuration options", Hidden: true, }, cli.StringFlag{ Name: "cpu-profile", - Usage: "path for the cpu profiling results", + Usage: "Path for the cpu profiling results", }, cli.StringFlag{ Name: "log-level", - Usage: "log messages above specified level: debug, info, warn, error (default), fatal or panic", + Usage: "Log messages above specified level: debug, info, warn, error (default), fatal or panic", Value: "error", }, cli.StringFlag{ Name: "tmpdir", - Usage: "path to the tmp directory", + Usage: "Path to the tmp directory", }, } diff --git a/cmd/podman/mount.go b/cmd/podman/mount.go index 86a6b2ad1..f71d47434 100644 --- a/cmd/podman/mount.go +++ b/cmd/podman/mount.go @@ -33,7 +33,7 @@ var ( }, cli.BoolFlag{ Name: "notruncate", - Usage: "do not truncate output", + Usage: "Do not truncate output", }, LatestFlag, } diff --git a/cmd/podman/pause.go b/cmd/podman/pause.go index 9da6abf4b..2e7182871 100644 --- a/cmd/podman/pause.go +++ b/cmd/podman/pause.go @@ -15,7 +15,7 @@ var ( pauseFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "pause all running containers", + Usage: "Pause all running containers", }, } pauseDescription = ` diff --git a/cmd/podman/play.go b/cmd/podman/play.go index adbab3480..4e09b2689 100644 --- a/cmd/podman/play.go +++ b/cmd/podman/play.go @@ -12,7 +12,7 @@ var ( playDescription = "Play a pod and its containers from a structured file." playCommand = cli.Command{ Name: "play", - Usage: "play a container or pod", + Usage: "Play a container or pod", Description: playDescription, ArgsUsage: "", Subcommands: playSubCommands, diff --git a/cmd/podman/play_kube.go b/cmd/podman/play_kube.go index 4753dd0a6..2d97e0e95 100644 --- a/cmd/podman/play_kube.go +++ b/cmd/podman/play_kube.go @@ -32,11 +32,11 @@ var ( }, cli.StringFlag{ Name: "cert-dir", - Usage: "`pathname` of a directory containing TLS certificates and keys", + Usage: "`Pathname` of a directory containing TLS certificates and keys", }, cli.StringFlag{ Name: "creds", - Usage: "`credentials` (USERNAME:PASSWORD) to use for authenticating to a registry", + Usage: "`Credentials` (USERNAME:PASSWORD) to use for authenticating to a registry", }, cli.BoolFlag{ Name: "quiet, q", @@ -44,11 +44,11 @@ var ( }, cli.StringFlag{ Name: "signature-policy", - Usage: "`pathname` of signature policy file (not usually used)", + Usage: "`Pathname` of signature policy file (not usually used)", }, cli.BoolTFlag{ Name: "tls-verify", - Usage: "require HTTPS and verify certificates when contacting registries (default: true)", + Usage: "Require HTTPS and verify certificates when contacting registries (default: true)", }, } playKubeDescription = "Play a Pod and its containers based on a Kubrernetes YAML" @@ -58,7 +58,7 @@ var ( Description: playKubeDescription, Action: playKubeYAMLCmd, Flags: sortFlags(playKubeFlags), - ArgsUsage: "kubernetes YAML file", + ArgsUsage: "Kubernetes YAML file", UseShortOptionHandling: true, OnUsageError: usageErrorHandler, } diff --git a/cmd/podman/pod_inspect.go b/cmd/podman/pod_inspect.go index 77178b14d..c7bbf31cd 100644 --- a/cmd/podman/pod_inspect.go +++ b/cmd/podman/pod_inspect.go @@ -14,10 +14,10 @@ var ( podInspectFlags = []cli.Flag{ LatestPodFlag, } - podInspectDescription = "display the configuration for a pod by name or id" + podInspectDescription = "Display the configuration for a pod by name or id" podInspectCommand = cli.Command{ Name: "inspect", - Usage: "displays a pod configuration", + Usage: "Displays a pod configuration", Description: podInspectDescription, Flags: sortFlags(podInspectFlags), Action: podInspectCmd, diff --git a/cmd/podman/pod_pause.go b/cmd/podman/pod_pause.go index e8de0debc..f29a0b8d1 100644 --- a/cmd/podman/pod_pause.go +++ b/cmd/podman/pod_pause.go @@ -13,7 +13,7 @@ var ( podPauseFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "pause all running pods", + Usage: "Pause all running pods", }, LatestPodFlag, } diff --git a/cmd/podman/pod_restart.go b/cmd/podman/pod_restart.go index e956b2f70..d9800cbf7 100644 --- a/cmd/podman/pod_restart.go +++ b/cmd/podman/pod_restart.go @@ -13,7 +13,7 @@ var ( podRestartFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "restart all pods", + Usage: "Restart all pods", }, LatestPodFlag, } diff --git a/cmd/podman/pod_start.go b/cmd/podman/pod_start.go index f0a7926c9..2178340a4 100644 --- a/cmd/podman/pod_start.go +++ b/cmd/podman/pod_start.go @@ -13,7 +13,7 @@ var ( podStartFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "start all running pods", + Usage: "Start all running pods", }, LatestPodFlag, } diff --git a/cmd/podman/pod_stats.go b/cmd/podman/pod_stats.go index 2e29445b4..0f0e215e6 100644 --- a/cmd/podman/pod_stats.go +++ b/cmd/podman/pod_stats.go @@ -19,22 +19,22 @@ var ( podStatsFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "show stats for all pods. Only running pods are shown by default.", + Usage: "Show stats for all pods. Only running pods are shown by default.", }, cli.BoolFlag{ Name: "no-stream", - Usage: "disable streaming stats and only pull the first result, default setting is false", + Usage: "Disable streaming stats and only pull the first result, default setting is false", }, cli.BoolFlag{ Name: "no-reset", - Usage: "disable resetting the screen between intervals", + Usage: "Disable resetting the screen between intervals", }, cli.StringFlag{ Name: "format", - Usage: "pretty-print container statistics to JSON or using a Go template", + Usage: "Pretty-print container statistics to JSON or using a Go template", }, LatestPodFlag, } - podStatsDescription = "display a live stream of resource usage statistics for the containers in or more pods" + podStatsDescription = "Display a live stream of resource usage statistics for the containers in or more pods" podStatsCommand = cli.Command{ Name: "stats", Usage: "Display percentage of CPU, memory, network I/O, block I/O and PIDs for containers in one or more pods", diff --git a/cmd/podman/pod_stop.go b/cmd/podman/pod_stop.go index d49ba8a00..148b4d518 100644 --- a/cmd/podman/pod_stop.go +++ b/cmd/podman/pod_stop.go @@ -12,7 +12,7 @@ var ( podStopFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "stop all running pods", + Usage: "Stop all running pods", }, LatestPodFlag, cli.UintFlag{ diff --git a/cmd/podman/pod_unpause.go b/cmd/podman/pod_unpause.go index 5256f680c..ed1a00cf8 100644 --- a/cmd/podman/pod_unpause.go +++ b/cmd/podman/pod_unpause.go @@ -13,7 +13,7 @@ var ( podUnpauseFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "unpause all paused pods", + Usage: "Unpause all paused pods", }, LatestPodFlag, } diff --git a/cmd/podman/port.go b/cmd/podman/port.go index 3355e751b..6875c648a 100644 --- a/cmd/podman/port.go +++ b/cmd/podman/port.go @@ -15,7 +15,7 @@ var ( portFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "display port information for all containers", + Usage: "Display port information for all containers", }, LatestFlag, } diff --git a/cmd/podman/pull.go b/cmd/podman/pull.go index f70e5cded..2349265d0 100644 --- a/cmd/podman/pull.go +++ b/cmd/podman/pull.go @@ -41,7 +41,7 @@ var ( }, cli.BoolTFlag{ Name: "tls-verify", - Usage: "require HTTPS and verify certificates when contacting registries (default: true)", + Usage: "Require HTTPS and verify certificates when contacting registries (default: true)", }, } diff --git a/cmd/podman/push.go b/cmd/podman/push.go index 82589f3f1..361a25e35 100644 --- a/cmd/podman/push.go +++ b/cmd/podman/push.go @@ -21,40 +21,40 @@ var ( pushFlags = []cli.Flag{ cli.StringFlag{ Name: "signature-policy", - Usage: "`pathname` of signature policy file (not usually used)", + Usage: "`Pathname` of signature policy file (not usually used)", Hidden: true, }, cli.StringFlag{ Name: "creds", - Usage: "`credentials` (USERNAME:PASSWORD) to use for authenticating to a registry", + Usage: "`Credentials` (USERNAME:PASSWORD) to use for authenticating to a registry", }, cli.StringFlag{ Name: "cert-dir", - Usage: "`pathname` of a directory containing TLS certificates and keys", + Usage: "`Pathname` of a directory containing TLS certificates and keys", }, cli.BoolFlag{ Name: "compress", - Usage: "compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type as source)", + Usage: "Compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type as source)", }, cli.StringFlag{ Name: "format, f", - Usage: "manifest type (oci, v2s1, or v2s2) to use when pushing an image using the 'dir:' transport (default is manifest type of source)", + Usage: "Manifest type (oci, v2s1, or v2s2) to use when pushing an image using the 'dir:' transport (default is manifest type of source)", }, cli.BoolTFlag{ Name: "tls-verify", - Usage: "require HTTPS and verify certificates when contacting registries (default: true)", + Usage: "Require HTTPS and verify certificates when contacting registries (default: true)", }, cli.BoolFlag{ Name: "remove-signatures", - Usage: "discard any pre-existing signatures in the image", + Usage: "Discard any pre-existing signatures in the image", }, cli.StringFlag{ Name: "sign-by", - Usage: "add a signature at the destination using the specified key", + Usage: "Add a signature at the destination using the specified key", }, cli.BoolFlag{ Name: "quiet, q", - Usage: "don't output progress information when pushing images", + Usage: "Don't output progress information when pushing images", }, cli.StringFlag{ Name: "authfile", diff --git a/cmd/podman/restart.go b/cmd/podman/restart.go index c6fe1025a..2e52ce5e4 100644 --- a/cmd/podman/restart.go +++ b/cmd/podman/restart.go @@ -17,11 +17,11 @@ var ( restartFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "restart all non-running containers", + Usage: "Restart all non-running containers", }, cli.BoolFlag{ Name: "running", - Usage: "restart only running containers when --all is used", + Usage: "Restart only running containers when --all is used", }, cli.UintFlag{ Name: "timeout, time, t", diff --git a/cmd/podman/restore.go b/cmd/podman/restore.go index bc2a71ba0..664475e22 100644 --- a/cmd/podman/restore.go +++ b/cmd/podman/restore.go @@ -21,18 +21,18 @@ var ( restoreFlags = []cli.Flag{ cli.BoolFlag{ Name: "keep, k", - Usage: "keep all temporary checkpoint files", + Usage: "Keep all temporary checkpoint files", }, // restore --all would make more sense if there would be // dedicated state for container which are checkpointed. // TODO: add ContainerStateCheckpointed cli.BoolFlag{ Name: "tcp-established", - Usage: "checkpoint a container with established TCP connections", + Usage: "Checkpoint a container with established TCP connections", }, cli.BoolFlag{ Name: "all, a", - Usage: "restore all checkpointed containers", + Usage: "Restore all checkpointed containers", }, LatestFlag, } diff --git a/cmd/podman/rmi.go b/cmd/podman/rmi.go index c904f2f92..39757272e 100644 --- a/cmd/podman/rmi.go +++ b/cmd/podman/rmi.go @@ -15,11 +15,11 @@ var ( rmiFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "remove all images", + Usage: "Remove all images", }, cli.BoolFlag{ Name: "force, f", - Usage: "force removal of the image", + Usage: "Force removal of the image", }, } rmiCommand = cli.Command{ @@ -34,7 +34,7 @@ var ( } rmImageCommand = cli.Command{ Name: "rm", - Usage: "removes one or more images from local storage", + Usage: "Removes one or more images from local storage", Description: rmiDescription, Action: rmiCmd, ArgsUsage: "IMAGE-NAME-OR-ID [...]", diff --git a/cmd/podman/run.go b/cmd/podman/run.go index 662aed900..3ef546940 100644 --- a/cmd/podman/run.go +++ b/cmd/podman/run.go @@ -20,7 +20,7 @@ var runDescription = "Runs a command in a new container from the given image" var runFlags []cli.Flag = append(createFlags, cli.BoolTFlag{ Name: "sig-proxy", - Usage: "proxy received signals to the process (default true)", + Usage: "Proxy received signals to the process (default true)", }) var runCommand = cli.Command{ diff --git a/cmd/podman/runlabel.go b/cmd/podman/runlabel.go index b16a93fd9..38905b5ca 100644 --- a/cmd/podman/runlabel.go +++ b/cmd/podman/runlabel.go @@ -24,15 +24,15 @@ var ( }, cli.BoolFlag{ Name: "display", - Usage: "preview the command that the label would run", + Usage: "Preview the command that the label would run", }, cli.StringFlag{ Name: "cert-dir", - Usage: "`pathname` of a directory containing TLS certificates and keys", + Usage: "`Pathname` of a directory containing TLS certificates and keys", }, cli.StringFlag{ Name: "creds", - Usage: "`credentials` (USERNAME:PASSWORD) to use for authenticating to a registry", + Usage: "`Credentials` (USERNAME:PASSWORD) to use for authenticating to a registry", }, cli.StringFlag{ Name: "name", @@ -59,15 +59,15 @@ var ( }, cli.BoolFlag{ Name: "pull, p", - Usage: "pull the image if it does not exist locally prior to executing the label contents", + Usage: "Pull the image if it does not exist locally prior to executing the label contents", }, cli.StringFlag{ Name: "signature-policy", - Usage: "`pathname` of signature policy file (not usually used)", + Usage: "`Pathname` of signature policy file (not usually used)", }, cli.BoolTFlag{ Name: "tls-verify", - Usage: "require HTTPS and verify certificates when contacting registries (default: true)", + Usage: "Require HTTPS and verify certificates when contacting registries (default: true)", }, } diff --git a/cmd/podman/save.go b/cmd/podman/save.go index 139f3918a..325140b76 100644 --- a/cmd/podman/save.go +++ b/cmd/podman/save.go @@ -29,7 +29,7 @@ var ( saveFlags = []cli.Flag{ cli.BoolFlag{ Name: "compress", - Usage: "compress tarball image layers when saving to a directory using the 'dir' transport. (default is same compression type as source)", + Usage: "Compress tarball image layers when saving to a directory using the 'dir' transport. (default is same compression type as source)", }, cli.StringFlag{ Name: "output, o", diff --git a/cmd/podman/search.go b/cmd/podman/search.go index 442ebb57f..81469a0f8 100644 --- a/cmd/podman/search.go +++ b/cmd/podman/search.go @@ -30,23 +30,23 @@ var ( }, cli.StringSliceFlag{ Name: "filter, f", - Usage: "filter output based on conditions provided (default [])", + Usage: "Filter output based on conditions provided (default [])", }, cli.StringFlag{ Name: "format", - Usage: "change the output format to a Go template", + Usage: "Change the output format to a Go template", }, cli.IntFlag{ Name: "limit", - Usage: "limit the number of results", + Usage: "Limit the number of results", }, cli.BoolFlag{ Name: "no-trunc", - Usage: "do not truncate the output", + Usage: "Do not truncate the output", }, cli.BoolTFlag{ Name: "tls-verify", - Usage: "require HTTPS and verify certificates when contacting registries (default: true)", + Usage: "Require HTTPS and verify certificates when contacting registries (default: true)", }, } searchDescription = ` diff --git a/cmd/podman/start.go b/cmd/podman/start.go index df34deec2..f6e1d9882 100644 --- a/cmd/podman/start.go +++ b/cmd/podman/start.go @@ -29,7 +29,7 @@ var ( }, cli.BoolTFlag{ Name: "sig-proxy", - Usage: "proxy received signals to the process (default true if attaching, false otherwise)", + Usage: "Proxy received signals to the process (default true if attaching, false otherwise)", }, LatestFlag, } diff --git a/cmd/podman/stats.go b/cmd/podman/stats.go index f6beac1a8..769354b23 100644 --- a/cmd/podman/stats.go +++ b/cmd/podman/stats.go @@ -31,23 +31,23 @@ var ( statsFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "show all containers. Only running containers are shown by default. The default is false", + Usage: "Show all containers. Only running containers are shown by default. The default is false", }, cli.BoolFlag{ Name: "no-stream", - Usage: "disable streaming stats and only pull the first result, default setting is false", + Usage: "Disable streaming stats and only pull the first result, default setting is false", }, cli.StringFlag{ Name: "format", - Usage: "pretty-print container statistics to JSON or using a Go template", + Usage: "Pretty-print container statistics to JSON or using a Go template", }, cli.BoolFlag{ Name: "no-reset", - Usage: "disable resetting the screen between intervals", + Usage: "Disable resetting the screen between intervals", }, LatestFlag, } - statsDescription = "display a live stream of one or more containers' resource usage statistics" + statsDescription = "Display a live stream of one or more containers' resource usage statistics" statsCommand = cli.Command{ Name: "stats", Usage: "Display percentage of CPU, memory, network I/O, block I/O and PIDs for one or more containers", diff --git a/cmd/podman/stop.go b/cmd/podman/stop.go index ade51705e..204515c70 100644 --- a/cmd/podman/stop.go +++ b/cmd/podman/stop.go @@ -21,7 +21,7 @@ var ( }, cli.BoolFlag{ Name: "all, a", - Usage: "stop all running containers", + Usage: "Stop all running containers", }, LatestFlag, } stopDescription = ` diff --git a/cmd/podman/system_prune.go b/cmd/podman/system_prune.go index 145fb4c94..64d291560 100644 --- a/cmd/podman/system_prune.go +++ b/cmd/podman/system_prune.go @@ -22,7 +22,7 @@ var ( pruneSystemFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "remove all unused data", + Usage: "Remove all unused data", }, cli.BoolFlag{ Name: "force, f", diff --git a/cmd/podman/umount.go b/cmd/podman/umount.go index 42f169228..ab6925e65 100644 --- a/cmd/podman/umount.go +++ b/cmd/podman/umount.go @@ -15,11 +15,11 @@ var ( umountFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "umount all of the currently mounted containers", + Usage: "Umount all of the currently mounted containers", }, cli.BoolFlag{ Name: "force, f", - Usage: "force the complete umount all of the currently mounted containers", + Usage: "Force the complete umount all of the currently mounted containers", }, LatestFlag, } diff --git a/cmd/podman/unpause.go b/cmd/podman/unpause.go index d77e056f8..91b5fda33 100644 --- a/cmd/podman/unpause.go +++ b/cmd/podman/unpause.go @@ -15,7 +15,7 @@ var ( unpauseFlags = []cli.Flag{ cli.BoolFlag{ Name: "all, a", - Usage: "unpause all paused containers", + Usage: "Unpause all paused containers", }, } unpauseDescription = ` diff --git a/cmd/podman/varlink.go b/cmd/podman/varlink.go index a7c195041..38ce77415 100644 --- a/cmd/podman/varlink.go +++ b/cmd/podman/varlink.go @@ -24,7 +24,7 @@ var ( varlinkFlags = []cli.Flag{ cli.IntFlag{ Name: "timeout, t", - Usage: "time until the varlink session expires in milliseconds. Use 0 to disable the timeout.", + Usage: "Time until the varlink session expires in milliseconds. Use 0 to disable the timeout.", Value: 1000, }, } -- cgit v1.2.3-54-g00ecf