package main import ( "context" "fmt" "os" "reflect" "regexp" "sort" "strings" "github.com/containers/buildah" "github.com/containers/libpod/libpod" "github.com/containers/libpod/pkg/rootless" "github.com/containers/storage" "github.com/fatih/camelcase" "github.com/pkg/errors" "github.com/urfave/cli" ) var ( stores = make(map[storage.Store]struct{}) LatestFlag = cli.BoolFlag{ Name: "latest, l", 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", } WorkDirFlag = cli.StringFlag{ Name: "workdir, w", Usage: "Working directory inside the container", } ) const ( idTruncLength = 12 ) func splitCamelCase(src string) string { entries := camelcase.Split(src) return strings.Join(entries, " ") } func shortID(id string) string { if len(id) > idTruncLength { return id[:idTruncLength] } return id } func usageErrorHandler(context *cli.Context, err error, _ bool) error { cmd := context.App.Name if len(context.Command.Name) > 0 { cmd = cmd + " " + context.Command.Name } return fmt.Errorf("%s\nSee '%s --help'.", err, cmd) } func commandNotFoundHandler(context *cli.Context, command string) { fmt.Fprintf(os.Stderr, "Command %q not found.\nSee `%s --help`.\n", command, context.App.Name) os.Exit(exitCode) } // validateFlags searches for StringFlags or StringSlice flags that never had // a value set. This commonly occurs when the CLI mistakenly takes the next // option and uses it as a value. func validateFlags(c *cli.Context, flags []cli.Flag) error { for _, flag := range flags { switch reflect.TypeOf(flag).String() { case "cli.StringSliceFlag": { f := flag.(cli.StringSliceFlag) name := strings.Split(f.Name, ",") val := c.StringSlice(name[0]) for _, v := range val { if ok, _ := regexp.MatchString("^-.+", v); ok { return errors.Errorf("option --%s requires a value", name[0]) } } } case "cli.StringFlag": { f := flag.(cli.StringFlag) name := strings.Split(f.Name, ",") val := c.String(name[0]) if ok, _ := regexp.MatchString("^-.+", val); ok { return errors.Errorf("option --%s requires a value", name[0]) } } } } return nil } // checkAllAndLatest checks that --all and --latest are used correctly func checkAllAndLatest(c *cli.Context) error { argLen := len(c.Args()) if (c.Bool("all") || c.Bool("latest")) && argLen > 0 { return errors.Errorf("no arguments are needed with --all or --latest") } if c.Bool("all") && c.Bool("latest") { return errors.Errorf("--all and --latest cannot be used together") } if argLen < 1 && !c.Bool("all") && !c.Bool("latest") { return errors.Errorf("you must provide at least one pod name or id") } return nil } // getAllOrLatestContainers tries to return the correct list of containers // depending if --all, --latest or is used. // It requires the Context (c) and the Runtime (runtime). As different // commands are using different container state for the --all option // the desired state has to be specified in filterState. If no filter // is desired a -1 can be used to get all containers. For a better // error message, if the filter fails, a corresponding verb can be // specified which will then appear in the error message. func getAllOrLatestContainers(c *cli.Context, runtime *libpod.Runtime, filterState libpod.ContainerStatus, verb string) ([]*libpod.Container, error) { var containers []*libpod.Container var lastError error var err error if c.Bool("all") { if filterState != -1 { var filterFuncs []libpod.ContainerFilter filterFuncs = append(filterFuncs, func(c *libpod.Container) bool { state, _ := c.State() return state == filterState }) containers, err = runtime.GetContainers(filterFuncs...) } else { containers, err = runtime.GetContainers() } if err != nil { return nil, errors.Wrapf(err, "unable to get %s containers", verb) } } else if c.Bool("latest") { lastCtr, err := runtime.GetLatestContainer() if err != nil { return nil, errors.Wrapf(err, "unable to get latest container") } containers = append(containers, lastCtr) } else { args := c.Args() for _, i := range args { container, err := runtime.LookupContainer(i) if err != nil { if lastError != nil { fmt.Fprintln(os.Stderr, lastError) } lastError = errors.Wrapf(err, "unable to find container %s", i) } if container != nil { // This is here to make sure this does not return [] but only nil containers = append(containers, container) } } } return containers, lastError } // getContext returns a non-nil, empty context func getContext() context.Context { return context.TODO() } func getDefaultNetwork() string { if rootless.IsRootless() { return "slirp4netns" } return "bridge" } // Common flags shared between commands var createFlags = []cli.Flag{ cli.StringSliceFlag{ Name: "add-host", Usage: "Add a custom host-to-IP mapping (host:ip) (default [])", }, cli.StringSliceFlag{ Name: "annotation", Usage: "Add annotations to container (key:value) (default [])", }, cli.StringSliceFlag{ Name: "attach, a", Usage: "Attach to STDIN, STDOUT or STDERR (default [])", }, cli.StringFlag{ Name: "blkio-weight", Usage: "Block IO weight (relative weight) accepts a weight value between 10 and 1000.", }, cli.StringSliceFlag{ Name: "blkio-weight-device", Usage: "Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`)", }, cli.StringSliceFlag{ Name: "cap-add", Usage: "Add capabilities to the container", }, cli.StringSliceFlag{ Name: "cap-drop", Usage: "Drop capabilities from the container", }, cli.StringFlag{ Name: "cgroup-parent", Usage: "Optional parent cgroup for the container", }, cli.StringFlag{ Name: "cidfile", Usage: "Write the container ID to the file", }, cli.StringFlag{ Name: "conmon-pidfile", Usage: "Path to the file that will receive the PID of conmon", }, cli.Uint64Flag{ Name: "cpu-period", Usage: "Limit the CPU CFS (Completely Fair Scheduler) period", }, cli.Int64Flag{ Name: "cpu-quota", Usage: "Limit the CPU CFS (Completely Fair Scheduler) quota", }, cli.Uint64Flag{ Name: "cpu-rt-period", Usage: "Limit the CPU real-time period in microseconds", }, cli.Int64Flag{ Name: "cpu-rt-runtime", Usage: "Limit the CPU real-time runtime in microseconds", }, cli.Uint64Flag{ Name: "cpu-shares", Usage: "CPU shares (relative weight)", }, cli.Float64Flag{ Name: "cpus", Usage: "Number of CPUs. The default is 0.000 which means no limit", }, cli.StringFlag{ Name: "cpuset-cpus", Usage: "CPUs in which to allow execution (0-3, 0,1)", }, cli.StringFlag{ Name: "cpuset-mems", Usage: "Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.", }, cli.BoolFlag{ Name: "detach, d", Usage: "Run container in background and print container ID", }, cli.StringFlag{ Name: "detach-keys", Usage: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`", }, cli.StringSliceFlag{ Name: "device", Usage: "Add a host device to the container (default [])", }, cli.StringSliceFlag{ Name: "device-read-bps", Usage: "Limit read rate (bytes per second) from a device (e.g. --device-read-bps=/dev/sda:1mb)", }, cli.StringSliceFlag{ Name: "device-read-iops", Usage: "Limit read rate (IO per second) from a device (e.g. --device-read-iops=/dev/sda:1000)", }, cli.StringSliceFlag{ Name: "device-write-bps", Usage: "Limit write rate (bytes per second) to a device (e.g. --device-write-bps=/dev/sda:1mb)", }, cli.StringSliceFlag{ Name: "device-write-iops", Usage: "Limit write rate (IO per second) to a device (e.g. --device-write-iops=/dev/sda:1000)", }, cli.StringSliceFlag{ Name: "dns", Usage: "Set custom DNS servers", }, cli.StringSliceFlag{ Name: "dns-opt", Usage: "Set custom DNS options", }, cli.StringSliceFlag{ Name: "dns-search", Usage: "Set custom DNS search domains", }, cli.StringFlag{ Name: "entrypoint", Usage: "Overwrite the default ENTRYPOINT of the image", }, cli.StringSliceFlag{ Name: "env, e", Usage: "Set environment variables in container", }, cli.StringSliceFlag{ Name: "env-file", Usage: "Read in a file of environment variables", }, cli.StringSliceFlag{ Name: "expose", Usage: "Expose a port or a range of ports (default [])", }, cli.StringSliceFlag{ Name: "gidmap", Usage: "GID map to use for the user namespace", }, cli.StringSliceFlag{ Name: "group-add", Usage: "Add additional groups to join (default [])", }, cli.BoolFlag{ Name: "help", Hidden: true, }, cli.StringFlag{ Name: "hostname, h", Usage: "Set container hostname", }, cli.StringFlag{ Name: "image-volume, builtin-volume", Usage: "Tells podman how to handle the builtin image volumes. The options are: 'bind', 'tmpfs', or 'ignore' (default 'bind')", Value: "bind", }, cli.BoolFlag{ Name: "init", Usage: "Run an init binary inside the container that forwards signals and reaps processes", }, cli.StringFlag{ Name: "init-path", // Do not use the Value field for setting the default value to determine user input (i.e., non-empty string) Usage: fmt.Sprintf("Path to the container-init binary (default: %q)", libpod.DefaultInitPath), }, cli.BoolFlag{ Name: "interactive, i", Usage: "Keep STDIN open even if not attached", }, cli.StringFlag{ Name: "ip", Usage: "Specify a static IPv4 address for the container", }, cli.StringFlag{ Name: "ipc", Usage: "IPC namespace to use", }, cli.StringFlag{ Name: "kernel-memory", Usage: "Kernel memory limit (format: `[]`, where unit = b, k, m or g)", }, cli.StringSliceFlag{ Name: "label", Usage: "Set metadata on container (default [])", }, cli.StringSliceFlag{ Name: "label-file", Usage: "Read in a line delimited file of labels (default [])", }, cli.StringFlag{ Name: "log-driver", Usage: "Logging driver for the container", }, cli.StringSliceFlag{ Name: "log-opt", Usage: "Logging driver options (default [])", }, cli.StringFlag{ Name: "mac-address", Usage: "Container MAC address (e.g. 92:d0:c6:0a:29:33), not currently supported", }, cli.StringFlag{ Name: "memory, m", Usage: "Memory limit (format: [], where unit = b, k, m or g)", }, cli.StringFlag{ Name: "memory-reservation", Usage: "Memory soft limit (format: [], where unit = b, k, m or g)", }, cli.StringFlag{ Name: "memory-swap", Usage: "Swap limit equal to memory plus swap: '-1' to enable unlimited swap", }, cli.Int64Flag{ Name: "memory-swappiness", Usage: "Tune container memory swappiness (0 to 100) (default -1)", Value: -1, }, cli.StringFlag{ Name: "name", Usage: "Assign a name to the container", }, cli.StringFlag{ Name: "net, network", Usage: "Connect a container to a network", Value: getDefaultNetwork(), }, cli.BoolFlag{ Name: "oom-kill-disable", Usage: "Disable OOM Killer", }, cli.StringFlag{ Name: "oom-score-adj", Usage: "Tune the host's OOM preferences (-1000 to 1000)", }, cli.StringFlag{ Name: "pid", Usage: "PID namespace to use", }, cli.Int64Flag{ Name: "pids-limit", Usage: "Tune container pids limit (set -1 for unlimited)", }, cli.StringFlag{ Name: "pod", Usage: "Run container in an existing pod", }, cli.BoolFlag{ Name: "privileged", Usage: "Give extended privileges to container", }, cli.StringSliceFlag{ Name: "publish, p", Usage: "Publish a container's port, or a range of ports, to the host (default [])", }, cli.BoolFlag{ Name: "publish-all, P", Usage: "Publish all exposed ports to random ports on the host interface", }, cli.BoolFlag{ Name: "quiet, q", Usage: "Suppress output information when pulling images", }, cli.BoolFlag{ Name: "read-only", Usage: "Make containers root filesystem read-only", }, cli.StringFlag{ Name: "restart", Usage: "Restart is not supported. Please use a systemd unit file for restart", }, cli.BoolFlag{ Name: "rm", Usage: "Remove container (and pod if created) after exit", }, cli.BoolFlag{ Name: "rootfs", Usage: "The first argument is not an image but the rootfs to the exploded container", }, cli.StringSliceFlag{ Name: "security-opt", Usage: "Security Options (default [])", }, cli.StringFlag{ Name: "shm-size", Usage: "Size of `/dev/shm`. The format is ``.", Value: "65536k", }, cli.StringFlag{ Name: "stop-signal", Usage: "Signal to stop a container. Default is SIGTERM", }, cli.IntFlag{ Name: "stop-timeout", Usage: "Timeout (in seconds) to stop a container. Default is 10", Value: libpod.CtrRemoveTimeout, }, cli.StringSliceFlag{ Name: "storage-opt", Usage: "Storage driver options per container (default [])", }, cli.StringFlag{ Name: "subgidname", Usage: "Name of range listed in /etc/subgid for use in user namespace", }, cli.StringFlag{ Name: "subuidname", Usage: "Name of range listed in /etc/subuid for use in user namespace", }, cli.StringSliceFlag{ Name: "sysctl", Usage: "Sysctl options (default [])", }, cli.BoolTFlag{ Name: "systemd", Usage: "Run container in systemd mode if the command executable is systemd or init", }, cli.StringSliceFlag{ Name: "tmpfs", Usage: "Mount a temporary filesystem (`tmpfs`) into a container (default [])", }, cli.BoolFlag{ Name: "tty, t", Usage: "Allocate a pseudo-TTY for container", }, cli.StringSliceFlag{ Name: "uidmap", Usage: "UID map to use for the user namespace", }, cli.StringSliceFlag{ Name: "ulimit", Usage: "Ulimit options (default [])", }, cli.StringFlag{ Name: "user, u", Usage: "Username or UID (format: [:])", }, cli.StringFlag{ Name: "userns", Usage: "User namespace to use", }, cli.StringFlag{ Name: "uts", Usage: "UTS namespace to use", }, cli.StringSliceFlag{ Name: "mount", Usage: "Attach a filesystem mount to the container (default [])", }, cli.StringSliceFlag{ Name: "volume, v", Usage: "Bind mount a volume into the container (default [])", }, cli.StringSliceFlag{ Name: "volumes-from", Usage: "Mount volumes from the specified container(s) (default [])", }, WorkDirFlag, } func getFormat(c *cli.Context) (string, error) { format := strings.ToLower(c.String("format")) if strings.HasPrefix(format, buildah.OCI) { return buildah.OCIv1ImageManifest, nil } if strings.HasPrefix(format, buildah.DOCKER) { return buildah.Dockerv2ImageManifest, nil } return "", errors.Errorf("unrecognized image type %q", format) } func sortFlags(flags []cli.Flag) []cli.Flag { sort.Slice(flags, func(i, j int) bool { return strings.Compare(flags[i].GetName(), flags[j].GetName()) < 0 }) return flags } func getAuthFile(authfile string) string { if authfile != "" { return authfile } return os.Getenv("REGISTRY_AUTH_FILE") } // scrubServer removes 'http://' or 'https://' from the front of the // server/registry string if either is there. This will be mostly used // for user input from 'podman login' and 'podman logout'. func scrubServer(server string) string { server = strings.TrimPrefix(server, "https://") return strings.TrimPrefix(server, "http://") }