aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--cmd/kpod/common.go319
-rw-r--r--cmd/kpod/create.go343
-rw-r--r--cmd/kpod/create_cli.go52
-rw-r--r--cmd/kpod/main.go6
-rw-r--r--cmd/kpod/parse.go886
-rw-r--r--cmd/kpod/run.go103
-rw-r--r--cmd/kpod/spec.go490
-rw-r--r--cmd/kpod/user.go121
-rw-r--r--completions/bash/kpod916
-rw-r--r--docs/kpod-create.1.md594
-rw-r--r--docs/kpod-run.1.md847
-rw-r--r--docs/kpod.1.md6
-rw-r--r--libpod/container.go31
-rw-r--r--libpod/container_attach.go142
-rw-r--r--libpod/runtime_ctr.go1
-rw-r--r--libpod/runtime_img.go259
-rw-r--r--libpod/storage.go2
-rw-r--r--libpod/util.go34
-rw-r--r--test/helpers.bash2
-rw-r--r--test/kpod_create.bats24
-rw-r--r--test/kpod_run.bats20
-rw-r--r--transfer.md4
22 files changed, 5194 insertions, 8 deletions
diff --git a/cmd/kpod/common.go b/cmd/kpod/common.go
index 338aee8ea..24f20f7ed 100644
--- a/cmd/kpod/common.go
+++ b/cmd/kpod/common.go
@@ -50,7 +50,7 @@ func getRuntime(c *cli.Context) (*libpod.Runtime, error) {
options.GraphDriverName = config.Storage
options.GraphDriverOptions = config.StorageOptions
- return libpod.NewRuntime(libpod.WithStorageConfig(options))
+ return libpod.NewRuntime(libpod.WithStorageConfig(options), libpod.WithConmonPath(config.Conmon), libpod.WithOCIRuntime(config.Runtime))
}
func shutdownStores() {
@@ -83,7 +83,9 @@ func getConfig(c *cli.Context) (*libkpod.Config, error) {
if c.GlobalIsSet("runroot") {
config.RunRoot = c.GlobalString("runroot")
}
-
+ if c.GlobalIsSet("conmon") {
+ config.Conmon = c.GlobalString("conmon")
+ }
if c.GlobalIsSet("storage-driver") {
config.Storage = c.GlobalString("storage-driver")
}
@@ -134,3 +136,316 @@ func validateFlags(c *cli.Context, flags []cli.Flag) error {
}
return nil
}
+
+// 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: "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.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.StringFlag{
+ 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-<value>` where `<value>` 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: "group-add",
+ Usage: "Add additional groups to join (default [])",
+ },
+ cli.StringFlag{
+ Name: "hostname",
+ Usage: "Set container hostname",
+ },
+ cli.BoolFlag{
+ Name: "interactive, i",
+ Usage: "Keep STDIN open even if not attached",
+ },
+ cli.StringFlag{
+ Name: "ip",
+ Usage: "Container IPv4 address (e.g. 172.23.0.9)",
+ },
+ cli.StringFlag{
+ Name: "ip6",
+ Usage: "Container IPv6 address (e.g. 2001:db8::1b99)",
+ },
+ cli.StringFlag{
+ Name: "ipc",
+ Usage: "IPC Namespace to use",
+ },
+ cli.StringFlag{
+ Name: "kernel-memory",
+ Usage: "Kernel memory limit (format: `<number>[<unit>]`, 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.StringSliceFlag{
+ Name: "link-local-ip",
+ Usage: "Container IPv4/IPv6 link-local addresses (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)",
+ },
+ cli.StringFlag{
+ Name: "memory, m",
+ Usage: "Memory limit (format: <number>[<unit>], where unit = b, k, m or g)",
+ },
+ cli.StringFlag{
+ Name: "memory-reservation",
+ Usage: "Memory soft limit (format: <number>[<unit>], 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)",
+ },
+ cli.StringFlag{
+ Name: "name",
+ Usage: "Assign a name to the container",
+ },
+ cli.StringFlag{
+ Name: "net",
+ Usage: "Setup the network namespace",
+ },
+ cli.StringFlag{
+ Name: "network",
+ Usage: "Connect a container to a network (default 'default')",
+ },
+ cli.StringSliceFlag{
+ Name: "network-alias",
+ Usage: "Add network-scoped alias for the container (default [])",
+ },
+ 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: "read-only",
+ Usage: "Make containers root filesystem read-only",
+ },
+ cli.BoolFlag{
+ Name: "rm",
+ Usage: "Remove container (and pod if created) after exit",
+ },
+ cli.StringSliceFlag{
+ Name: "security-opt",
+ Usage: "Security Options (default [])",
+ },
+ cli.StringFlag{
+ Name: "shm-size",
+ Usage: "Size of `/dev/shm`. The format is `<number><unit>`. default is 64 MB",
+ },
+ cli.BoolFlag{
+ Name: "sig-proxy",
+ Usage: "Proxy received signals to the process (default true)",
+ },
+ 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",
+ },
+ cli.StringSliceFlag{
+ Name: "storage-opt",
+ Usage: "Storage driver options per container (default [])",
+ },
+ cli.StringSliceFlag{
+ Name: "sysctl",
+ Usage: "Sysctl options (default [])",
+ },
+ 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: "ulimit",
+ Usage: "Ulimit options (default [])",
+ },
+ cli.StringFlag{
+ Name: "user, u",
+ Usage: "Username or UID (format: <name|uid>[:<group|gid>])",
+ },
+ cli.StringFlag{
+ Name: "userns",
+ Usage: "User namespace to use",
+ },
+ cli.StringFlag{
+ Name: "uts",
+ Usage: "UTS namespace to use",
+ },
+ 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 [])",
+ },
+ cli.StringFlag{
+ Name: "workdir, w",
+ Usage: "Working `directory inside the container",
+ Value: "/",
+ },
+}
diff --git a/cmd/kpod/create.go b/cmd/kpod/create.go
new file mode 100644
index 000000000..2e79c883e
--- /dev/null
+++ b/cmd/kpod/create.go
@@ -0,0 +1,343 @@
+package main
+
+import (
+ "fmt"
+ "strconv"
+
+ "github.com/docker/go-units"
+ "github.com/projectatomic/libpod/libpod"
+ "github.com/pkg/errors"
+ "github.com/urfave/cli"
+ pb "k8s.io/kubernetes/pkg/kubelet/apis/cri/v1alpha1/runtime"
+)
+
+type mountType string
+
+// Type constants
+const (
+ // TypeBind is the type for mounting host dir
+ TypeBind mountType = "bind"
+ // TypeVolume is the type for remote storage volumes
+ // TypeVolume mountType = "volume" // re-enable upon use
+ // TypeTmpfs is the type for mounting tmpfs
+ TypeTmpfs mountType = "tmpfs"
+)
+
+var (
+ defaultEnvVariables = []string{"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", "TERM=xterm"}
+)
+
+type createResourceConfig struct {
+ blkioDevice []string // blkio-weight-device
+ blkioWeight uint16 // blkio-weight
+ cpuPeriod uint64 // cpu-period
+ cpuQuota int64 // cpu-quota
+ cpuRtPeriod uint64 // cpu-rt-period
+ cpuRtRuntime int64 // cpu-rt-runtime
+ cpuShares uint64 // cpu-shares
+ cpus string // cpus
+ cpusetCpus string
+ cpusetMems string // cpuset-mems
+ deviceReadBps []string // device-read-bps
+ deviceReadIops []string // device-read-iops
+ deviceWriteBps []string // device-write-bps
+ deviceWriteIops []string // device-write-iops
+ disableOomKiller bool // oom-kill-disable
+ kernelMemory int64 // kernel-memory
+ memory int64 //memory
+ memoryReservation int64 // memory-reservation
+ memorySwap int64 //memory-swap
+ memorySwapiness uint64 // memory-swappiness
+ oomScoreAdj int //oom-score-adj
+ pidsLimit int64 // pids-limit
+ shmSize string
+ ulimit []string //ulimit
+}
+
+type createConfig struct {
+ args []string
+ capAdd []string // cap-add
+ capDrop []string // cap-drop
+ cidFile string
+ cgroupParent string // cgroup-parent
+ command []string
+ detach bool // detach
+ devices []*pb.Device // device
+ dnsOpt []string //dns-opt
+ dnsSearch []string //dns-search
+ dnsServers []string //dns
+ entrypoint string //entrypoint
+ env []string //env
+ expose []string //expose
+ groupAdd []uint32 // group-add
+ hostname string //hostname
+ image string
+ interactive bool //interactive
+ ip6Address string //ipv6
+ ipAddress string //ip
+ labels map[string]string //label
+ linkLocalIP []string // link-local-ip
+ logDriver string // log-driver
+ logDriverOpt []string // log-opt
+ macAddress string //mac-address
+ name string //name
+ network string //network
+ networkAlias []string //network-alias
+ nsIPC string // ipc
+ nsNet string //net
+ nsPID string //pid
+ nsUser string
+ pod string //pod
+ privileged bool //privileged
+ publish []string //publish
+ publishAll bool //publish-all
+ readOnlyRootfs bool //read-only
+ resources createResourceConfig
+ rm bool //rm
+ securityOpts []string //security-opt
+ sigProxy bool //sig-proxy
+ stopSignal string // stop-signal
+ stopTimeout int64 // stop-timeout
+ storageOpts []string //storage-opt
+ sysctl map[string]string //sysctl
+ tmpfs []string // tmpfs
+ tty bool //tty
+ user uint32 //user
+ group uint32 // group
+ volumes []string //volume
+ volumesFrom []string //volumes-from
+ workDir string //workdir
+}
+
+var createDescription = "Creates a new container from the given image or" +
+ " storage and prepares it for running the specified command. The" +
+ " container ID is then printed to stdout. You can then start it at" +
+ " any time with the kpod start <container_id> command. The container" +
+ " will be created with the initial state 'created'."
+
+var createCommand = cli.Command{
+ Name: "create",
+ Usage: "create but do not start a container",
+ Description: createDescription,
+ Flags: createFlags,
+ Action: createCmd,
+ ArgsUsage: "IMAGE [COMMAND [ARG...]]",
+}
+
+func createCmd(c *cli.Context) error {
+ // TODO should allow user to create based off a directory on the host not just image
+ // Need CLI support for this
+ if err := validateFlags(c, createFlags); err != nil {
+ return err
+ }
+
+ runtime, err := getRuntime(c)
+ if err != nil {
+ return errors.Wrapf(err, "error creating libpod runtime")
+ }
+
+ createConfig, err := parseCreateOpts(c, runtime)
+ if err != nil {
+ return err
+ }
+
+ // Deal with the image after all the args have been checked
+ createImage := runtime.NewImage(createConfig.image)
+ if !createImage.HasImageLocal() {
+ // The image wasnt found by the user input'd name or its fqname
+ // Pull the image
+ fmt.Printf("Trying to pull %s...", createImage.PullName)
+ createImage.Pull()
+ }
+
+ runtimeSpec, err := createConfigToOCISpec(createConfig)
+ if err != nil {
+ return err
+ }
+ defer runtime.Shutdown(false)
+ imageName, err := createImage.GetFQName()
+ if err != nil {
+ return err
+ }
+ imageID, err := createImage.GetImageID()
+ if err != nil {
+ return err
+ }
+ options, err := createConfig.GetContainerCreateOptions(c)
+ if err != nil {
+ return errors.Wrapf(err, "unable to parse new container options")
+ }
+ // Gather up the options for NewContainer which consist of With... funcs
+ options = append(options, libpod.WithRootFSFromImage(imageID, imageName, false))
+ ctr, err := runtime.NewContainer(runtimeSpec, options...)
+ if err != nil {
+ return err
+ }
+
+ if c.String("cidfile") != "" {
+ libpod.WriteFile(ctr.ID(), c.String("cidfile"))
+ } else {
+ fmt.Printf("%s\n", ctr.ID())
+ }
+
+ return nil
+}
+
+// Parses CLI options related to container creation into a config which can be
+// parsed into an OCI runtime spec
+func parseCreateOpts(c *cli.Context, runtime *libpod.Runtime) (*createConfig, error) {
+ var command []string
+ var memoryLimit, memoryReservation, memorySwap, memoryKernel int64
+ var blkioWeight uint16
+ var uid, gid uint32
+
+ image := c.Args()[0]
+
+ if len(c.Args()) < 1 {
+ return nil, errors.Errorf("image name or ID is required")
+ }
+ if len(c.Args()) > 1 {
+ command = c.Args()[1:]
+ }
+
+ // LABEL VARIABLES
+ labels, err := getAllLabels(c)
+ if err != nil {
+ return &createConfig{}, errors.Wrapf(err, "unable to process labels")
+ }
+ // ENVIRONMENT VARIABLES
+ // TODO where should env variables be verified to be x=y format
+ env, err := getAllEnvironmentVariables(c)
+ if err != nil {
+ return &createConfig{}, errors.Wrapf(err, "unable to process environment variables")
+ }
+
+ sysctl, err := convertStringSliceToMap(c.StringSlice("sysctl"), "=")
+ if err != nil {
+ return &createConfig{}, errors.Wrapf(err, "sysctl values must be in the form of KEY=VALUE")
+ }
+
+ groupAdd, err := stringSlicetoUint32Slice(c.StringSlice("group-add"))
+ if err != nil {
+ return &createConfig{}, errors.Wrapf(err, "invalid value for groups provided")
+ }
+
+ if c.String("user") != "" {
+ // TODO
+ // We need to mount the imagefs and get the uid/gid
+ // For now, user zeros
+ uid = 0
+ gid = 0
+ }
+
+ if c.String("memory") != "" {
+ memoryLimit, err = units.RAMInBytes(c.String("memory"))
+ if err != nil {
+ return nil, errors.Wrapf(err, "invalid value for memory")
+ }
+ }
+ if c.String("memory-reservation") != "" {
+ memoryReservation, err = units.RAMInBytes(c.String("memory-reservation"))
+ if err != nil {
+ return nil, errors.Wrapf(err, "invalid value for memory-reservation")
+ }
+ }
+ if c.String("memory-swap") != "" {
+ memorySwap, err = units.RAMInBytes(c.String("memory-swap"))
+ if err != nil {
+ return nil, errors.Wrapf(err, "invalid value for memory-swap")
+ }
+ }
+ if c.String("kernel-memory") != "" {
+ memoryKernel, err = units.RAMInBytes(c.String("kernel-memory"))
+ if err != nil {
+ return nil, errors.Wrapf(err, "invalid value for kernel-memory")
+ }
+ }
+ if c.String("blkio-weight") != "" {
+ u, err := strconv.ParseUint(c.String("blkio-weight"), 10, 16)
+ if err != nil {
+ return nil, errors.Wrapf(err, "invalid value for blkio-weight")
+ }
+ blkioWeight = uint16(u)
+ }
+
+ config := &createConfig{
+ capAdd: c.StringSlice("cap-add"),
+ capDrop: c.StringSlice("cap-drop"),
+ cgroupParent: c.String("cgroup-parent"),
+ command: command,
+ detach: c.Bool("detach"),
+ dnsOpt: c.StringSlice("dns-opt"),
+ dnsSearch: c.StringSlice("dns-search"),
+ dnsServers: c.StringSlice("dns"),
+ entrypoint: c.String("entrypoint"),
+ env: env,
+ expose: c.StringSlice("env"),
+ groupAdd: groupAdd,
+ hostname: c.String("hostname"),
+ image: image,
+ interactive: c.Bool("interactive"),
+ ip6Address: c.String("ipv6"),
+ ipAddress: c.String("ip"),
+ labels: labels,
+ linkLocalIP: c.StringSlice("link-local-ip"),
+ logDriver: c.String("log-driver"),
+ logDriverOpt: c.StringSlice("log-opt"),
+ macAddress: c.String("mac-address"),
+ name: c.String("name"),
+ network: c.String("network"),
+ networkAlias: c.StringSlice("network-alias"),
+ nsIPC: c.String("ipc"),
+ nsNet: c.String("net"),
+ nsPID: c.String("pid"),
+ pod: c.String("pod"),
+ privileged: c.Bool("privileged"),
+ publish: c.StringSlice("publish"),
+ publishAll: c.Bool("publish-all"),
+ readOnlyRootfs: c.Bool("read-only"),
+ resources: createResourceConfig{
+ blkioWeight: blkioWeight,
+ blkioDevice: c.StringSlice("blkio-weight-device"),
+ cpuShares: c.Uint64("cpu-shares"),
+ cpuPeriod: c.Uint64("cpu-period"),
+ cpusetCpus: c.String("cpu-period"),
+ cpusetMems: c.String("cpuset-mems"),
+ cpuQuota: c.Int64("cpu-quota"),
+ cpuRtPeriod: c.Uint64("cpu-rt-period"),
+ cpuRtRuntime: c.Int64("cpu-rt-runtime"),
+ cpus: c.String("cpus"),
+ deviceReadBps: c.StringSlice("device-read-bps"),
+ deviceReadIops: c.StringSlice("device-read-iops"),
+ deviceWriteBps: c.StringSlice("device-write-bps"),
+ deviceWriteIops: c.StringSlice("device-write-iops"),
+ disableOomKiller: c.Bool("oom-kill-disable"),
+ shmSize: c.String("shm-size"),
+ memory: memoryLimit,
+ memoryReservation: memoryReservation,
+ memorySwap: memorySwap,
+ memorySwapiness: c.Uint64("memory-swapiness"),
+ kernelMemory: memoryKernel,
+ oomScoreAdj: c.Int("oom-score-adj"),
+
+ pidsLimit: c.Int64("pids-limit"),
+ ulimit: c.StringSlice("ulimit"),
+ },
+ rm: c.Bool("rm"),
+ securityOpts: c.StringSlice("security-opt"),
+ sigProxy: c.Bool("sig-proxy"),
+ stopSignal: c.String("stop-signal"),
+ stopTimeout: c.Int64("stop-timeout"),
+ storageOpts: c.StringSlice("storage-opt"),
+ sysctl: sysctl,
+ tmpfs: c.StringSlice("tmpfs"),
+ tty: c.Bool("tty"),
+ user: uid,
+ group: gid,
+ volumes: c.StringSlice("volume"),
+ volumesFrom: c.StringSlice("volumes-from"),
+ workDir: c.String("workdir"),
+ }
+
+ return config, nil
+}
diff --git a/cmd/kpod/create_cli.go b/cmd/kpod/create_cli.go
new file mode 100644
index 000000000..996155ba0
--- /dev/null
+++ b/cmd/kpod/create_cli.go
@@ -0,0 +1,52 @@
+package main
+
+import (
+ "strings"
+
+ "github.com/pkg/errors"
+ "github.com/urfave/cli"
+)
+
+func getAllLabels(cli *cli.Context) (map[string]string, error) {
+ var labelValues []string
+ labels := make(map[string]string)
+ labelValues, labelErr := readKVStrings(cli.StringSlice("label-file"), cli.StringSlice("label"))
+ if labelErr != nil {
+ return labels, errors.Wrapf(labelErr, "unable to process labels from --label and label-file")
+ }
+ // Process KEY=VALUE stringslice in string map for WithLabels func
+ if len(labelValues) > 0 {
+ for _, i := range labelValues {
+ spliti := strings.Split(i, "=")
+ if len(spliti) > 1 {
+ return labels, errors.Errorf("labels must be in KEY=VALUE format: %s is invalid", i)
+ }
+ labels[spliti[0]] = spliti[1]
+ }
+ }
+ return labels, nil
+}
+
+func getAllEnvironmentVariables(cli *cli.Context) ([]string, error) {
+ env, err := readKVStrings(cli.StringSlice("env-file"), cli.StringSlice("env"))
+ if err != nil {
+ return []string{}, errors.Wrapf(err, "unable to process variables from --env and --env-file")
+ }
+ // Add default environment variables if nothing defined
+ if len(env) == 0 {
+ env = append(env, defaultEnvVariables...)
+ }
+ return env, nil
+}
+
+func convertStringSliceToMap(strSlice []string, delimiter string) (map[string]string, error) {
+ sysctl := make(map[string]string)
+ for _, inputSysctl := range strSlice {
+ values := strings.Split(inputSysctl, delimiter)
+ if len(values) < 2 {
+ return sysctl, errors.Errorf("%s in an invalid sysctl value", inputSysctl)
+ }
+ sysctl[values[0]] = values[1]
+ }
+ return sysctl, nil
+}
diff --git a/cmd/kpod/main.go b/cmd/kpod/main.go
index 7745fbf3d..b8a7b0cb5 100644
--- a/cmd/kpod/main.go
+++ b/cmd/kpod/main.go
@@ -31,6 +31,7 @@ func main() {
app.Version = v
app.Commands = []cli.Command{
+ createCommand,
diffCommand,
exportCommand,
historyCommand,
@@ -50,6 +51,7 @@ func main() {
renameCommand,
rmCommand,
rmiCommand,
+ runCommand,
saveCommand,
statsCommand,
stopCommand,
@@ -93,6 +95,10 @@ func main() {
Usage: "path of a config file detailing container server configuration options",
},
cli.StringFlag{
+ Name: "conmon",
+ Usage: "path of the conmon binary",
+ },
+ cli.StringFlag{
Name: "log-level",
Usage: "log messages above specified level: debug, info, warn, error (default), fatal or panic",
Value: "error",
diff --git a/cmd/kpod/parse.go b/cmd/kpod/parse.go
new file mode 100644
index 000000000..e3143a793
--- /dev/null
+++ b/cmd/kpod/parse.go
@@ -0,0 +1,886 @@
+//nolint
+// most of these validate and parse functions have been taken from projectatomic/docker
+// and modified for cri-o
+package main
+
+import (
+ "bufio"
+ "bytes"
+ "encoding/json"
+ "fmt"
+ "io/ioutil"
+ "net"
+ "os"
+ "os/user"
+ "path"
+ "regexp"
+ "strconv"
+ "strings"
+
+ units "github.com/docker/go-units"
+ specs "github.com/opencontainers/runtime-spec/specs-go"
+ "github.com/pkg/errors"
+ pb "k8s.io/kubernetes/pkg/kubelet/apis/cri/v1alpha1/runtime"
+)
+
+// Note: for flags that are in the form <number><unit>, use the RAMInBytes function
+// from the units package in docker/go-units/size.go
+
+var (
+ whiteSpaces = " \t"
+ alphaRegexp = regexp.MustCompile(`[a-zA-Z]`)
+ domainRegexp = regexp.MustCompile(`^(:?(:?[a-zA-Z0-9]|(:?[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]))(:?\.(:?[a-zA-Z0-9]|(:?[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])))*)\.?\s*$`)
+)
+
+// validateExtraHost validates that the specified string is a valid extrahost and returns it.
+// ExtraHost is in the form of name:ip where the ip has to be a valid ip (ipv4 or ipv6).
+// for add-host flag
+func validateExtraHost(val string) (string, error) { //nolint
+ // allow for IPv6 addresses in extra hosts by only splitting on first ":"
+ arr := strings.SplitN(val, ":", 2)
+ if len(arr) != 2 || len(arr[0]) == 0 {
+ return "", fmt.Errorf("bad format for add-host: %q", val)
+ }
+ if _, err := validateIPAddress(arr[1]); err != nil {
+ return "", fmt.Errorf("invalid IP address in add-host: %q", arr[1])
+ }
+ return val, nil
+}
+
+// validateIPAddress validates an Ip address.
+// for dns, ip, and ip6 flags also
+func validateIPAddress(val string) (string, error) {
+ var ip = net.ParseIP(strings.TrimSpace(val))
+ if ip != nil {
+ return ip.String(), nil
+ }
+ return "", fmt.Errorf("%s is not an ip address", val)
+}
+
+// validateAttach validates that the specified string is a valid attach option.
+// for attach flag
+func validateAttach(val string) (string, error) { //nolint
+ s := strings.ToLower(val)
+ for _, str := range []string{"stdin", "stdout", "stderr"} {
+ if s == str {
+ return s, nil
+ }
+ }
+ return val, fmt.Errorf("valid streams are STDIN, STDOUT and STDERR")
+}
+
+// validate the blkioWeight falls in the range of 10 to 1000
+// for blkio-weight flag
+func validateBlkioWeight(val int64) (int64, error) { //nolint
+ if val >= 10 && val <= 1000 {
+ return val, nil
+ }
+ return -1, errors.Errorf("invalid blkio weight %q, should be between 10 and 1000", val)
+}
+
+// weightDevice is a structure that holds device:weight pair
+type weightDevice struct {
+ path string
+ weight uint16
+}
+
+func (w *weightDevice) String() string {
+ return fmt.Sprintf("%s:%d", w.path, w.weight)
+}
+
+// validateweightDevice validates that the specified string has a valid device-weight format
+// for blkio-weight-device flag
+func validateweightDevice(val string) (*weightDevice, error) {
+ split := strings.SplitN(val, ":", 2)
+ if len(split) != 2 {
+ return nil, fmt.Errorf("bad format: %s", val)
+ }
+ if !strings.HasPrefix(split[0], "/dev/") {
+ return nil, fmt.Errorf("bad format for device path: %s", val)
+ }
+ weight, err := strconv.ParseUint(split[1], 10, 0)
+ if err != nil {
+ return nil, fmt.Errorf("invalid weight for device: %s", val)
+ }
+ if weight > 0 && (weight < 10 || weight > 1000) {
+ return nil, fmt.Errorf("invalid weight for device: %s", val)
+ }
+
+ return &weightDevice{
+ path: split[0],
+ weight: uint16(weight),
+ }, nil
+}
+
+// parseDevice parses a device mapping string to a container.DeviceMapping struct
+// for device flag
+func parseDevice(device string) (*pb.Device, error) { //nolint
+ _, err := validateDevice(device)
+ if err != nil {
+ return nil, errors.Wrapf(err, "device string not valid %q", device)
+ }
+
+ src := ""
+ dst := ""
+ permissions := "rwm"
+ arr := strings.Split(device, ":")
+ switch len(arr) {
+ case 3:
+ permissions = arr[2]
+ fallthrough
+ case 2:
+ if validDeviceMode(arr[1]) {
+ permissions = arr[1]
+ } else {
+ dst = arr[1]
+ }
+ fallthrough
+ case 1:
+ src = arr[0]
+ default:
+ return nil, fmt.Errorf("invalid device specification: %s", device)
+ }
+
+ if dst == "" {
+ dst = src
+ }
+
+ deviceMapping := &pb.Device{
+ ContainerPath: dst,
+ HostPath: src,
+ Permissions: permissions,
+ }
+ return deviceMapping, nil
+}
+
+// validDeviceMode checks if the mode for device is valid or not.
+// Valid mode is a composition of r (read), w (write), and m (mknod).
+func validDeviceMode(mode string) bool {
+ var legalDeviceMode = map[rune]bool{
+ 'r': true,
+ 'w': true,
+ 'm': true,
+ }
+ if mode == "" {
+ return false
+ }
+ for _, c := range mode {
+ if !legalDeviceMode[c] {
+ return false
+ }
+ legalDeviceMode[c] = false
+ }
+ return true
+}
+
+// validateDevice validates a path for devices
+// It will make sure 'val' is in the form:
+// [host-dir:]container-path[:mode]
+// It also validates the device mode.
+func validateDevice(val string) (string, error) {
+ return validatePath(val, validDeviceMode)
+}
+
+func validatePath(val string, validator func(string) bool) (string, error) {
+ var containerPath string
+ var mode string
+
+ if strings.Count(val, ":") > 2 {
+ return val, fmt.Errorf("bad format for path: %s", val)
+ }
+
+ split := strings.SplitN(val, ":", 3)
+ if split[0] == "" {
+ return val, fmt.Errorf("bad format for path: %s", val)
+ }
+ switch len(split) {
+ case 1:
+ containerPath = split[0]
+ val = path.Clean(containerPath)
+ case 2:
+ if isValid := validator(split[1]); isValid {
+ containerPath = split[0]
+ mode = split[1]
+ val = fmt.Sprintf("%s:%s", path.Clean(containerPath), mode)
+ } else {
+ containerPath = split[1]
+ val = fmt.Sprintf("%s:%s", split[0], path.Clean(containerPath))
+ }
+ case 3:
+ containerPath = split[1]
+ mode = split[2]
+ if isValid := validator(split[2]); !isValid {
+ return val, fmt.Errorf("bad mode specified: %s", mode)
+ }
+ val = fmt.Sprintf("%s:%s:%s", split[0], containerPath, mode)
+ }
+
+ if !path.IsAbs(containerPath) {
+ return val, fmt.Errorf("%s is not an absolute path", containerPath)
+ }
+ return val, nil
+}
+
+// throttleDevice is a structure that holds device:rate_per_second pair
+type throttleDevice struct {
+ path string
+ rate uint64
+}
+
+func (t *throttleDevice) String() string {
+ return fmt.Sprintf("%s:%d", t.path, t.rate)
+}
+
+// validateBpsDevice validates that the specified string has a valid device-rate format
+// for device-read-bps and device-write-bps flags
+func validateBpsDevice(val string) (*throttleDevice, error) {
+ split := strings.SplitN(val, ":", 2)
+ if len(split) != 2 {
+ return nil, fmt.Errorf("bad format: %s", val)
+ }
+ if !strings.HasPrefix(split[0], "/dev/") {
+ return nil, fmt.Errorf("bad format for device path: %s", val)
+ }
+ rate, err := units.RAMInBytes(split[1])
+ if err != nil {
+ return nil, fmt.Errorf("invalid rate for device: %s. The correct format is <device-path>:<number>[<unit>]. Number must be a positive integer. Unit is optional and can be kb, mb, or gb", val)
+ }
+ if rate < 0 {
+ return nil, fmt.Errorf("invalid rate for device: %s. The correct format is <device-path>:<number>[<unit>]. Number must be a positive integer. Unit is optional and can be kb, mb, or gb", val)
+ }
+
+ return &throttleDevice{
+ path: split[0],
+ rate: uint64(rate),
+ }, nil
+}
+
+// validateIOpsDevice validates that the specified string has a valid device-rate format
+// for device-write-iops and device-read-iops flags
+func validateIOpsDevice(val string) (*throttleDevice, error) { //nolint
+ split := strings.SplitN(val, ":", 2)
+ if len(split) != 2 {
+ return nil, fmt.Errorf("bad format: %s", val)
+ }
+ if !strings.HasPrefix(split[0], "/dev/") {
+ return nil, fmt.Errorf("bad format for device path: %s", val)
+ }
+ rate, err := strconv.ParseUint(split[1], 10, 64)
+ if err != nil {
+ return nil, fmt.Errorf("invalid rate for device: %s. The correct format is <device-path>:<number>. Number must be a positive integer", val)
+ }
+ if rate < 0 {
+ return nil, fmt.Errorf("invalid rate for device: %s. The correct format is <device-path>:<number>. Number must be a positive integer", val)
+ }
+
+ return &throttleDevice{
+ path: split[0],
+ rate: uint64(rate),
+ }, nil
+}
+
+// validateDNSSearch validates domain for resolvconf search configuration.
+// A zero length domain is represented by a dot (.).
+// for dns-search flag
+func validateDNSSearch(val string) (string, error) { //nolint
+ if val = strings.Trim(val, " "); val == "." {
+ return val, nil
+ }
+ return validateDomain(val)
+}
+
+func validateDomain(val string) (string, error) {
+ if alphaRegexp.FindString(val) == "" {
+ return "", fmt.Errorf("%s is not a valid domain", val)
+ }
+ ns := domainRegexp.FindSubmatch([]byte(val))
+ if len(ns) > 0 && len(ns[1]) < 255 {
+ return string(ns[1]), nil
+ }
+ return "", fmt.Errorf("%s is not a valid domain", val)
+}
+
+// validateEnv validates an environment variable and returns it.
+// If no value is specified, it returns the current value using os.Getenv.
+// for env flag
+func validateEnv(val string) (string, error) { //nolint
+ arr := strings.Split(val, "=")
+ if len(arr) > 1 {
+ return val, nil
+ }
+ if !doesEnvExist(val) {
+ return val, nil
+ }
+ return fmt.Sprintf("%s=%s", val, os.Getenv(val)), nil
+}
+
+func doesEnvExist(name string) bool {
+ for _, entry := range os.Environ() {
+ parts := strings.SplitN(entry, "=", 2)
+ if parts[0] == name {
+ return true
+ }
+ }
+ return false
+}
+
+// reads a file of line terminated key=value pairs, and overrides any keys
+// present in the file with additional pairs specified in the override parameter
+// for env-file and labels-file flags
+func readKVStrings(files []string, override []string) ([]string, error) {
+ envVariables := []string{}
+ for _, ef := range files {
+ parsedVars, err := parseEnvFile(ef)
+ if err != nil {
+ return nil, err
+ }
+ envVariables = append(envVariables, parsedVars...)
+ }
+ // parse the '-e' and '--env' after, to allow override
+ envVariables = append(envVariables, override...)
+
+ return envVariables, nil
+}
+
+// parseEnvFile reads a file with environment variables enumerated by lines
+func parseEnvFile(filename string) ([]string, error) {
+ fh, err := os.Open(filename)
+ if err != nil {
+ return []string{}, err
+ }
+ defer fh.Close()
+
+ lines := []string{}
+ scanner := bufio.NewScanner(fh)
+ for scanner.Scan() {
+ // trim the line from all leading whitespace first
+ line := strings.TrimLeft(scanner.Text(), whiteSpaces)
+ // line is not empty, and not starting with '#'
+ if len(line) > 0 && !strings.HasPrefix(line, "#") {
+ data := strings.SplitN(line, "=", 2)
+
+ // trim the front of a variable, but nothing else
+ variable := strings.TrimLeft(data[0], whiteSpaces)
+ if strings.ContainsAny(variable, whiteSpaces) {
+ return []string{}, errors.Errorf("variable %q has white spaces, poorly formatted environment", variable)
+ }
+
+ if len(data) > 1 {
+
+ // pass the value through, no trimming
+ lines = append(lines, fmt.Sprintf("%s=%s", variable, data[1]))
+ } else {
+ // if only a pass-through variable is given, clean it up.
+ lines = append(lines, fmt.Sprintf("%s=%s", strings.TrimSpace(line), os.Getenv(line)))
+ }
+ }
+ }
+ return lines, scanner.Err()
+}
+
+// NsIpc represents the container ipc stack.
+// for ipc flag
+type NsIpc string
+
+// IsPrivate indicates whether the container uses its private ipc stack.
+func (n NsIpc) IsPrivate() bool {
+ return !(n.IsHost() || n.IsContainer())
+}
+
+// IsHost indicates whether the container uses the host's ipc stack.
+func (n NsIpc) IsHost() bool {
+ return n == "host"
+}
+
+// IsContainer indicates whether the container uses a container's ipc stack.
+func (n NsIpc) IsContainer() bool {
+ parts := strings.SplitN(string(n), ":", 2)
+ return len(parts) > 1 && parts[0] == "container"
+}
+
+// Valid indicates whether the ipc stack is valid.
+func (n NsIpc) Valid() bool {
+ parts := strings.Split(string(n), ":")
+ switch mode := parts[0]; mode {
+ case "", "host":
+ case "container":
+ if len(parts) != 2 || parts[1] == "" {
+ return false
+ }
+ default:
+ return false
+ }
+ return true
+}
+
+// Container returns the name of the container ipc stack is going to be used.
+func (n NsIpc) Container() string {
+ parts := strings.SplitN(string(n), ":", 2)
+ if len(parts) > 1 {
+ return parts[1]
+ }
+ return ""
+}
+
+// validateLabel validates that the specified string is a valid label, and returns it.
+// Labels are in the form on key=value.
+// for label flag
+func validateLabel(val string) (string, error) { //nolint
+ if strings.Count(val, "=") < 1 {
+ return "", fmt.Errorf("bad attribute format: %s", val)
+ }
+ return val, nil
+}
+
+// validateMACAddress validates a MAC address.
+// for mac-address flag
+func validateMACAddress(val string) (string, error) { //nolint
+ _, err := net.ParseMAC(strings.TrimSpace(val))
+ if err != nil {
+ return "", err
+ }
+ return val, nil
+}
+
+// validateLink validates that the specified string has a valid link format (containerName:alias).
+func validateLink(val string) (string, error) { //nolint
+ if _, _, err := parseLink(val); err != nil {
+ return val, err
+ }
+ return val, nil
+}
+
+// parseLink parses and validates the specified string as a link format (name:alias)
+func parseLink(val string) (string, string, error) {
+ if val == "" {
+ return "", "", fmt.Errorf("empty string specified for links")
+ }
+ arr := strings.Split(val, ":")
+ if len(arr) > 2 {
+ return "", "", fmt.Errorf("bad format for links: %s", val)
+ }
+ if len(arr) == 1 {
+ return val, val, nil
+ }
+ // This is kept because we can actually get a HostConfig with links
+ // from an already created container and the format is not `foo:bar`
+ // but `/foo:/c1/bar`
+ if strings.HasPrefix(arr[0], "/") {
+ _, alias := path.Split(arr[1])
+ return arr[0][1:], alias, nil
+ }
+ return arr[0], arr[1], nil
+}
+
+// parseLoggingOpts validates the logDriver and logDriverOpts
+// for log-opt and log-driver flags
+func parseLoggingOpts(logDriver string, logDriverOpt []string) (map[string]string, error) { //nolint
+ logOptsMap := convertKVStringsToMap(logDriverOpt)
+ if logDriver == "none" && len(logDriverOpt) > 0 {
+ return map[string]string{}, errors.Errorf("invalid logging opts for driver %s", logDriver)
+ }
+ return logOptsMap, nil
+}
+
+// NsPid represents the pid namespace of the container.
+//for pid flag
+type NsPid string
+
+// IsPrivate indicates whether the container uses its own new pid namespace.
+func (n NsPid) IsPrivate() bool {
+ return !(n.IsHost() || n.IsContainer())
+}
+
+// IsHost indicates whether the container uses the host's pid namespace.
+func (n NsPid) IsHost() bool {
+ return n == "host"
+}
+
+// IsContainer indicates whether the container uses a container's pid namespace.
+func (n NsPid) IsContainer() bool {
+ parts := strings.SplitN(string(n), ":", 2)
+ return len(parts) > 1 && parts[0] == "container"
+}
+
+// Valid indicates whether the pid namespace is valid.
+func (n NsPid) Valid() bool {
+ parts := strings.Split(string(n), ":")
+ switch mode := parts[0]; mode {
+ case "", "host":
+ case "container":
+ if len(parts) != 2 || parts[1] == "" {
+ return false
+ }
+ default:
+ return false
+ }
+ return true
+}
+
+// Container returns the name of the container whose pid namespace is going to be used.
+func (n NsPid) Container() string {
+ parts := strings.SplitN(string(n), ":", 2)
+ if len(parts) > 1 {
+ return parts[1]
+ }
+ return ""
+}
+
+// parsePortSpecs receives port specs in the format of ip:public:private/proto and parses
+// these in to the internal types
+// for publish, publish-all, and expose flags
+func parsePortSpecs(ports []string) ([]*pb.PortMapping, error) { //nolint
+ var portMappings []*pb.PortMapping
+ for _, rawPort := range ports {
+ portMapping, err := parsePortSpec(rawPort)
+ if err != nil {
+ return nil, err
+ }
+
+ portMappings = append(portMappings, portMapping...)
+ }
+ return portMappings, nil
+}
+
+func validateProto(proto string) bool {
+ for _, availableProto := range []string{"tcp", "udp"} {
+ if availableProto == proto {
+ return true
+ }
+ }
+ return false
+}
+
+// parsePortSpec parses a port specification string into a slice of PortMappings
+func parsePortSpec(rawPort string) ([]*pb.PortMapping, error) {
+ var proto string
+ rawIP, hostPort, containerPort := splitParts(rawPort)
+ proto, containerPort = splitProtoPort(containerPort)
+
+ // Strip [] from IPV6 addresses
+ ip, _, err := net.SplitHostPort(rawIP + ":")
+ if err != nil {
+ return nil, fmt.Errorf("Invalid ip address %v: %s", rawIP, err)
+ }
+ if ip != "" && net.ParseIP(ip) == nil {
+ return nil, fmt.Errorf("Invalid ip address: %s", ip)
+ }
+ if containerPort == "" {
+ return nil, fmt.Errorf("No port specified: %s<empty>", rawPort)
+ }
+
+ startPort, endPort, err := parsePortRange(containerPort)
+ if err != nil {
+ return nil, fmt.Errorf("Invalid containerPort: %s", containerPort)
+ }
+
+ var startHostPort, endHostPort uint64 = 0, 0
+ if len(hostPort) > 0 {
+ startHostPort, endHostPort, err = parsePortRange(hostPort)
+ if err != nil {
+ return nil, fmt.Errorf("Invalid hostPort: %s", hostPort)
+ }
+ }
+
+ if hostPort != "" && (endPort-startPort) != (endHostPort-startHostPort) {
+ // Allow host port range iff containerPort is not a range.
+ // In this case, use the host port range as the dynamic
+ // host port range to allocate into.
+ if endPort != startPort {
+ return nil, fmt.Errorf("Invalid ranges specified for container and host Ports: %s and %s", containerPort, hostPort)
+ }
+ }
+
+ if !validateProto(strings.ToLower(proto)) {
+ return nil, fmt.Errorf("invalid proto: %s", proto)
+ }
+
+ protocol := pb.Protocol_TCP
+ if strings.ToLower(proto) == "udp" {
+ protocol = pb.Protocol_UDP
+ }
+
+ var ports []*pb.PortMapping
+ for i := uint64(0); i <= (endPort - startPort); i++ {
+ containerPort = strconv.FormatUint(startPort+i, 10)
+ if len(hostPort) > 0 {
+ hostPort = strconv.FormatUint(startHostPort+i, 10)
+ }
+ // Set hostPort to a range only if there is a single container port
+ // and a dynamic host port.
+ if startPort == endPort && startHostPort != endHostPort {
+ hostPort = fmt.Sprintf("%s-%s", hostPort, strconv.FormatUint(endHostPort, 10))
+ }
+
+ ctrPort, err := strconv.ParseInt(containerPort, 10, 32)
+ if err != nil {
+ return nil, err
+ }
+ hPort, err := strconv.ParseInt(hostPort, 10, 32)
+ if err != nil {
+ return nil, err
+ }
+
+ port := &pb.PortMapping{
+ Protocol: protocol,
+ ContainerPort: int32(ctrPort),
+ HostPort: int32(hPort),
+ HostIp: ip,
+ }
+
+ ports = append(ports, port)
+ }
+ return ports, nil
+}
+
+// parsePortRange parses and validates the specified string as a port-range (8000-9000)
+func parsePortRange(ports string) (uint64, uint64, error) {
+ if ports == "" {
+ return 0, 0, fmt.Errorf("empty string specified for ports")
+ }
+ if !strings.Contains(ports, "-") {
+ start, err := strconv.ParseUint(ports, 10, 16)
+ end := start
+ return start, end, err
+ }
+
+ parts := strings.Split(ports, "-")
+ start, err := strconv.ParseUint(parts[0], 10, 16)
+ if err != nil {
+ return 0, 0, err
+ }
+ end, err := strconv.ParseUint(parts[1], 10, 16)
+ if err != nil {
+ return 0, 0, err
+ }
+ if end < start {
+ return 0, 0, fmt.Errorf("Invalid range specified for the Port: %s", ports)
+ }
+ return start, end, nil
+}
+
+// splitParts separates the different parts of rawPort
+func splitParts(rawport string) (string, string, string) {
+ parts := strings.Split(rawport, ":")
+ n := len(parts)
+ containerport := parts[n-1]
+
+ switch n {
+ case 1:
+ return "", "", containerport
+ case 2:
+ return "", parts[0], containerport
+ case 3:
+ return parts[0], parts[1], containerport
+ default:
+ return strings.Join(parts[:n-2], ":"), parts[n-2], containerport
+ }
+}
+
+// splitProtoPort splits a port in the format of port/proto
+func splitProtoPort(rawPort string) (string, string) {
+ parts := strings.Split(rawPort, "/")
+ l := len(parts)
+ if len(rawPort) == 0 || l == 0 || len(parts[0]) == 0 {
+ return "", ""
+ }
+ if l == 1 {
+ return "tcp", rawPort
+ }
+ if len(parts[1]) == 0 {
+ return "tcp", parts[0]
+ }
+ return parts[1], parts[0]
+}
+
+// takes a local seccomp file and reads its file contents
+// for security-opt flag
+func parseSecurityOpts(securityOpts []string) ([]string, error) { //nolint
+ for key, opt := range securityOpts {
+ con := strings.SplitN(opt, "=", 2)
+ if len(con) == 1 && con[0] != "no-new-privileges" {
+ if strings.Index(opt, ":") != -1 {
+ con = strings.SplitN(opt, ":", 2)
+ } else {
+ return securityOpts, fmt.Errorf("Invalid --security-opt: %q", opt)
+ }
+ }
+ if con[0] == "seccomp" && con[1] != "unconfined" {
+ f, err := ioutil.ReadFile(con[1])
+ if err != nil {
+ return securityOpts, fmt.Errorf("opening seccomp profile (%s) failed: %v", con[1], err)
+ }
+ b := bytes.NewBuffer(nil)
+ if err := json.Compact(b, f); err != nil {
+ return securityOpts, fmt.Errorf("compacting json for seccomp profile (%s) failed: %v", con[1], err)
+ }
+ securityOpts[key] = fmt.Sprintf("seccomp=%s", b.Bytes())
+ }
+ }
+
+ return securityOpts, nil
+}
+
+// parses storage options per container into a map
+// for storage-opt flag
+func parseStorageOpts(storageOpts []string) (map[string]string, error) { //nolint
+ m := make(map[string]string)
+ for _, option := range storageOpts {
+ if strings.Contains(option, "=") {
+ opt := strings.SplitN(option, "=", 2)
+ m[opt[0]] = opt[1]
+ } else {
+ return nil, errors.Errorf("invalid storage option %q", option)
+ }
+ }
+ return m, nil
+}
+
+// parseUser parses the the uid and gid in the format <name|uid>[:<group|gid>]
+// for user flag
+// FIXME: Issue from https://github.com/projectatomic/buildah/issues/66
+func parseUser(rootdir, userspec string) (specs.User, error) { //nolint
+ var gid64 uint64
+ var gerr error = user.UnknownGroupError("error looking up group")
+
+ spec := strings.SplitN(userspec, ":", 2)
+ userspec = spec[0]
+ groupspec := ""
+ if userspec == "" {
+ return specs.User{}, nil
+ }
+ if len(spec) > 1 {
+ groupspec = spec[1]
+ }
+
+ uid64, uerr := strconv.ParseUint(userspec, 10, 32)
+ if uerr == nil && groupspec == "" {
+ // We parsed the user name as a number, and there's no group
+ // component, so we need to look up the user's primary GID.
+ var name string
+ name, gid64, gerr = lookupGroupForUIDInContainer(rootdir, uid64)
+ if gerr == nil {
+ userspec = name
+ } else {
+ if userrec, err := user.LookupId(userspec); err == nil {
+ gid64, gerr = strconv.ParseUint(userrec.Gid, 10, 32)
+ userspec = userrec.Name
+ }
+ }
+ }
+ if uerr != nil {
+ uid64, gid64, uerr = lookupUserInContainer(rootdir, userspec)
+ gerr = uerr
+ }
+ if uerr != nil {
+ if userrec, err := user.Lookup(userspec); err == nil {
+ uid64, uerr = strconv.ParseUint(userrec.Uid, 10, 32)
+ gid64, gerr = strconv.ParseUint(userrec.Gid, 10, 32)
+ }
+ }
+
+ if groupspec != "" {
+ gid64, gerr = strconv.ParseUint(groupspec, 10, 32)
+ if gerr != nil {
+ gid64, gerr = lookupGroupInContainer(rootdir, groupspec)
+ }
+ if gerr != nil {
+ if group, err := user.LookupGroup(groupspec); err == nil {
+ gid64, gerr = strconv.ParseUint(group.Gid, 10, 32)
+ }
+ }
+ }
+
+ if uerr == nil && gerr == nil {
+ u := specs.User{
+ UID: uint32(uid64),
+ GID: uint32(gid64),
+ Username: userspec,
+ }
+ return u, nil
+ }
+
+ err := errors.Wrapf(uerr, "error determining run uid")
+ if uerr == nil {
+ err = errors.Wrapf(gerr, "error determining run gid")
+ }
+ return specs.User{}, err
+}
+
+// convertKVStringsToMap converts ["key=value"] to {"key":"value"}
+func convertKVStringsToMap(values []string) map[string]string {
+ result := make(map[string]string, len(values))
+ for _, value := range values {
+ kv := strings.SplitN(value, "=", 2)
+ if len(kv) == 1 {
+ result[kv[0]] = ""
+ } else {
+ result[kv[0]] = kv[1]
+ }
+ }
+
+ return result
+}
+
+// NsUser represents userns mode in the container.
+// for userns flag
+type NsUser string
+
+// IsHost indicates whether the container uses the host's userns.
+func (n NsUser) IsHost() bool {
+ return n == "host"
+}
+
+// IsPrivate indicates whether the container uses the a private userns.
+func (n NsUser) IsPrivate() bool {
+ return !(n.IsHost())
+}
+
+// Valid indicates whether the userns is valid.
+func (n NsUser) Valid() bool {
+ parts := strings.Split(string(n), ":")
+ switch mode := parts[0]; mode {
+ case "", "host":
+ default:
+ return false
+ }
+ return true
+}
+
+// NsUts represents the UTS namespace of the container.
+// for uts flag
+type NsUts string
+
+// IsPrivate indicates whether the container uses its private UTS namespace.
+func (n NsUts) IsPrivate() bool {
+ return !(n.IsHost())
+}
+
+// IsHost indicates whether the container uses the host's UTS namespace.
+func (n NsUts) IsHost() bool {
+ return n == "host"
+}
+
+// Valid indicates whether the UTS namespace is valid.
+func (n NsUts) Valid() bool {
+ parts := strings.Split(string(n), ":")
+ switch mode := parts[0]; mode {
+ case "", "host":
+ default:
+ return false
+ }
+ return true
+}
+
+// Takes a stringslice and converts to a uint32slice
+func stringSlicetoUint32Slice(inputSlice []string) ([]uint32, error) {
+ var outputSlice []uint32
+ for _, v := range inputSlice {
+ u, err := strconv.ParseUint(v, 10, 32)
+ if err != nil {
+ return outputSlice, err
+ }
+ outputSlice = append(outputSlice, uint32(u))
+ }
+ return outputSlice, nil
+}
diff --git a/cmd/kpod/run.go b/cmd/kpod/run.go
new file mode 100644
index 000000000..bf9375d95
--- /dev/null
+++ b/cmd/kpod/run.go
@@ -0,0 +1,103 @@
+package main
+
+import (
+ "fmt"
+
+ "github.com/projectatomic/libpod/libpod"
+ "github.com/pkg/errors"
+ "github.com/sirupsen/logrus"
+ "github.com/urfave/cli"
+)
+
+var runDescription = "Runs a command in a new container from the given image"
+
+var runCommand = cli.Command{
+ Name: "run",
+ Usage: "run a command in a new container",
+ Description: runDescription,
+ Flags: createFlags,
+ Action: runCmd,
+ ArgsUsage: "IMAGE [COMMAND [ARG...]]",
+}
+
+func runCmd(c *cli.Context) error {
+ if err := validateFlags(c, createFlags); err != nil {
+ return err
+ }
+ runtime, err := getRuntime(c)
+
+ if err != nil {
+ return errors.Wrapf(err, "error creating libpod runtime")
+ }
+
+ createConfig, err := parseCreateOpts(c, runtime)
+ if err != nil {
+ return err
+ }
+
+ createImage := runtime.NewImage(createConfig.image)
+
+ if !createImage.HasImageLocal() {
+ // The image wasnt found by the user input'd name or its fqname
+ // Pull the image
+ fmt.Printf("Trying to pull %s...", createImage.PullName)
+ createImage.Pull()
+ }
+
+ runtimeSpec, err := createConfigToOCISpec(createConfig)
+ if err != nil {
+ return err
+ }
+ defer runtime.Shutdown(false)
+ logrus.Debug("spec is ", runtimeSpec)
+
+ imageName, err := createImage.GetFQName()
+ if err != nil {
+ return err
+ }
+ logrus.Debug("imageName is ", imageName)
+
+ imageID, err := createImage.GetImageID()
+ if err != nil {
+ return err
+ }
+ logrus.Debug("imageID is ", imageID)
+
+ options, err := createConfig.GetContainerCreateOptions(c)
+ if err != nil {
+ return errors.Wrapf(err, "unable to parse new container options")
+ }
+ // Gather up the options for NewContainer which consist of With... funcs
+ options = append(options, libpod.WithRootFSFromImage(imageID, imageName, false))
+ ctr, err := runtime.NewContainer(runtimeSpec, options...)
+ if err != nil {
+ return err
+ }
+
+ logrus.Debug("new container created ", ctr.ID())
+ if err := ctr.Create(); err != nil {
+ return err
+ }
+ logrus.Debug("container storage created for %q", ctr.ID())
+
+ if c.String("cidfile") != "" {
+ libpod.WriteFile(ctr.ID(), c.String("cidfile"))
+ return nil
+ }
+ // Start the container
+ if err := ctr.Start(); err != nil {
+ return errors.Wrapf(err, "unable to start container %q", ctr.ID())
+ }
+ logrus.Debug("started container ", ctr.ID())
+ if createConfig.tty {
+ // Attach to the running container
+ logrus.Debug("trying to attach to the container %s", ctr.ID())
+ if err := ctr.Attach(false, c.String("detach-keys")); err != nil {
+ return errors.Wrapf(err, "unable to attach to container %s", ctr.ID())
+ }
+ } else {
+ fmt.Printf("%s\n", ctr.ID())
+ }
+
+ return nil
+}
diff --git a/cmd/kpod/spec.go b/cmd/kpod/spec.go
new file mode 100644
index 000000000..4b05005bd
--- /dev/null
+++ b/cmd/kpod/spec.go
@@ -0,0 +1,490 @@
+package main
+
+import (
+ "fmt"
+ "strings"
+
+ "github.com/projectatomic/libpod/libpod"
+ ann "github.com/projectatomic/libpod/pkg/annotations"
+ spec "github.com/opencontainers/runtime-spec/specs-go"
+ "github.com/pkg/errors"
+ "github.com/sirupsen/logrus"
+ "github.com/urfave/cli"
+ "golang.org/x/sys/unix"
+)
+
+// Parses information needed to create a container into an OCI runtime spec
+func createConfigToOCISpec(config *createConfig) (*spec.Spec, error) {
+ spec := config.GetDefaultLinuxSpec()
+ spec.Process.Cwd = config.workDir
+ spec.Process.Args = config.command
+
+ spec.Process.Terminal = config.tty
+
+ // User and Group must go together
+ spec.Process.User.UID = config.user
+ spec.Process.User.GID = config.group
+ spec.Process.User.AdditionalGids = config.groupAdd
+
+ spec.Process.Env = config.env
+
+ //TODO
+ // Need examples of capacity additions so I can load that properly
+
+ spec.Root.Readonly = config.readOnlyRootfs
+ spec.Hostname = config.hostname
+
+ // BIND MOUNTS
+ spec.Mounts = append(spec.Mounts, config.GetVolumeMounts()...)
+
+ // TMPFS MOUNTS
+ spec.Mounts = append(spec.Mounts, config.GetTmpfsMounts()...)
+
+ // RESOURCES - MEMORY
+ spec.Linux.Sysctl = config.sysctl
+
+ if config.resources.memory != 0 {
+ spec.Linux.Resources.Memory.Limit = &config.resources.memory
+ }
+ if config.resources.memoryReservation != 0 {
+ spec.Linux.Resources.Memory.Reservation = &config.resources.memoryReservation
+ }
+ if config.resources.memorySwap != 0 {
+ spec.Linux.Resources.Memory.Swap = &config.resources.memorySwap
+ }
+ if config.resources.kernelMemory != 0 {
+ spec.Linux.Resources.Memory.Kernel = &config.resources.kernelMemory
+ }
+ if config.resources.memorySwapiness != 0 {
+ spec.Linux.Resources.Memory.Swappiness = &config.resources.memorySwapiness
+ }
+ if config.resources.disableOomKiller {
+ spec.Linux.Resources.Memory.DisableOOMKiller = &config.resources.disableOomKiller
+ }
+
+ // RESOURCES - CPU
+
+ if config.resources.cpuShares != 0 {
+ spec.Linux.Resources.CPU.Shares = &config.resources.cpuShares
+ }
+ if config.resources.cpuQuota != 0 {
+ spec.Linux.Resources.CPU.Quota = &config.resources.cpuQuota
+ }
+ if config.resources.cpuPeriod != 0 {
+ spec.Linux.Resources.CPU.Period = &config.resources.cpuPeriod
+ }
+ if config.resources.cpuRtRuntime != 0 {
+ spec.Linux.Resources.CPU.RealtimeRuntime = &config.resources.cpuRtRuntime
+ }
+ if config.resources.cpuRtPeriod != 0 {
+ spec.Linux.Resources.CPU.RealtimePeriod = &config.resources.cpuRtPeriod
+ }
+ if config.resources.cpus != "" {
+ spec.Linux.Resources.CPU.Cpus = config.resources.cpus
+ }
+ if config.resources.cpusetMems != "" {
+ spec.Linux.Resources.CPU.Mems = config.resources.cpusetMems
+ }
+
+ // RESOURCES - PIDS
+ if config.resources.pidsLimit != 0 {
+ spec.Linux.Resources.Pids.Limit = config.resources.pidsLimit
+ }
+
+ /*
+ Capabilities: &spec.LinuxCapabilities{
+ // Rlimits []PosixRlimit // Where does this come from
+ // Type string
+ // Hard uint64
+ // Limit uint64
+ // NoNewPrivileges bool // No user input for this
+ // ApparmorProfile string // No user input for this
+ OOMScoreAdj: &config.resources.oomScoreAdj,
+ // Selinuxlabel
+ },
+ Hooks: &spec.Hooks{},
+ //Annotations
+ Resources: &spec.LinuxResources{
+ Devices: config.GetDefaultDevices(),
+ BlockIO: &blkio,
+ //HugepageLimits:
+ Network: &spec.LinuxNetwork{
+ // ClassID *uint32
+ // Priorites []LinuxInterfacePriority
+ },
+ },
+ //CgroupsPath:
+ //Namespaces: []LinuxNamespace
+ //Devices
+ Seccomp: &spec.LinuxSeccomp{
+ // DefaultAction:
+ // Architectures
+ // Syscalls:
+ },
+ // RootfsPropagation
+ // MaskedPaths
+ // ReadonlyPaths:
+ // MountLabel
+ // IntelRdt
+ },
+ }
+ */
+ return &spec, nil
+}
+
+func (c *createConfig) CreateBlockIO() (spec.LinuxBlockIO, error) {
+ bio := spec.LinuxBlockIO{}
+ bio.Weight = &c.resources.blkioWeight
+ if len(c.resources.blkioDevice) > 0 {
+ var lwds []spec.LinuxWeightDevice
+ for _, i := range c.resources.blkioDevice {
+ wd, err := validateweightDevice(i)
+ if err != nil {
+ return bio, errors.Wrapf(err, "invalid values for blkio-weight-device")
+ }
+ wdStat := getStatFromPath(wd.path)
+ lwd := spec.LinuxWeightDevice{
+ Weight: &wd.weight,
+ }
+ lwd.Major = int64(unix.Major(wdStat.Rdev))
+ lwd.Minor = int64(unix.Minor(wdStat.Rdev))
+ lwds = append(lwds, lwd)
+ }
+ }
+ if len(c.resources.deviceReadBps) > 0 {
+ readBps, err := makeThrottleArray(c.resources.deviceReadBps)
+ if err != nil {
+ return bio, err
+ }
+ bio.ThrottleReadBpsDevice = readBps
+ }
+ if len(c.resources.deviceWriteBps) > 0 {
+ writeBpds, err := makeThrottleArray(c.resources.deviceWriteBps)
+ if err != nil {
+ return bio, err
+ }
+ bio.ThrottleWriteBpsDevice = writeBpds
+ }
+ if len(c.resources.deviceReadIops) > 0 {
+ readIops, err := makeThrottleArray(c.resources.deviceReadIops)
+ if err != nil {
+ return bio, err
+ }
+ bio.ThrottleReadIOPSDevice = readIops
+ }
+ if len(c.resources.deviceWriteIops) > 0 {
+ writeIops, err := makeThrottleArray(c.resources.deviceWriteIops)
+ if err != nil {
+ return bio, err
+ }
+ bio.ThrottleWriteIOPSDevice = writeIops
+ }
+
+ return bio, nil
+}
+
+func (c *createConfig) GetDefaultMounts() []spec.Mount {
+ // Default to 64K default per man page
+ shmSize := "65536k"
+ if c.resources.shmSize != "" {
+ shmSize = c.resources.shmSize
+ }
+ return []spec.Mount{
+ {
+ Destination: "/proc",
+ Type: "proc",
+ Source: "proc",
+ Options: []string{"nosuid", "noexec", "nodev"},
+ },
+ {
+ Destination: "/dev",
+ Type: "tmpfs",
+ Source: "tmpfs",
+ Options: []string{"nosuid", "strictatime", "mode=755", "size=65536k"},
+ },
+ {
+ Destination: "/dev/pts",
+ Type: "devpts",
+ Source: "devpts",
+ Options: []string{"nosuid", "noexec", "newinstance", "ptmxmode=0666", "mode=0620", "gid=5"},
+ },
+ {
+ Destination: "/sys",
+ Type: "sysfs",
+ Source: "sysfs",
+ Options: []string{"nosuid", "noexec", "nodev", "ro"},
+ },
+ {
+ Destination: "/sys/fs/cgroup",
+ Type: "cgroup",
+ Source: "cgroup",
+ Options: []string{"ro", "nosuid", "noexec", "nodev"},
+ },
+ {
+ Destination: "/dev/mqueue",
+ Type: "mqueue",
+ Source: "mqueue",
+ Options: []string{"nosuid", "noexec", "nodev"},
+ },
+ {
+ Destination: "/dev/shm",
+ Type: "tmpfs",
+ Source: "shm",
+ Options: []string{"nosuid", "noexec", "nodev", "mode=1777", fmt.Sprintf("size=%s", shmSize)},
+ },
+ }
+}
+
+func iPtr(i int64) *int64 { return &i }
+
+func (c *createConfig) GetDefaultDevices() []spec.LinuxDeviceCgroup {
+ return []spec.LinuxDeviceCgroup{
+ {
+ Allow: false,
+ Access: "rwm",
+ },
+ {
+ Allow: true,
+ Type: "c",
+ Major: iPtr(1),
+ Minor: iPtr(5),
+ Access: "rwm",
+ },
+ {
+ Allow: true,
+ Type: "c",
+ Major: iPtr(1),
+ Minor: iPtr(3),
+ Access: "rwm",
+ },
+ {
+ Allow: true,
+ Type: "c",
+ Major: iPtr(1),
+ Minor: iPtr(9),
+ Access: "rwm",
+ },
+ {
+ Allow: true,
+ Type: "c",
+ Major: iPtr(1),
+ Minor: iPtr(8),
+ Access: "rwm",
+ },
+ {
+ Allow: true,
+ Type: "c",
+ Major: iPtr(5),
+ Minor: iPtr(0),
+ Access: "rwm",
+ },
+ {
+ Allow: true,
+ Type: "c",
+ Major: iPtr(5),
+ Minor: iPtr(1),
+ Access: "rwm",
+ },
+ {
+ Allow: false,
+ Type: "c",
+ Major: iPtr(10),
+ Minor: iPtr(229),
+ Access: "rwm",
+ },
+ }
+}
+
+func defaultCapabilities() []string {
+ return []string{
+ "CAP_CHOWN",
+ "CAP_DAC_OVERRIDE",
+ "CAP_FSETID",
+ "CAP_FOWNER",
+ "CAP_MKNOD",
+ "CAP_NET_RAW",
+ "CAP_SETGID",
+ "CAP_SETUID",
+ "CAP_SETFCAP",
+ "CAP_SETPCAP",
+ "CAP_NET_BIND_SERVICE",
+ "CAP_SYS_CHROOT",
+ "CAP_KILL",
+ "CAP_AUDIT_WRITE",
+ }
+}
+
+func (c *createConfig) GetDefaultLinuxSpec() spec.Spec {
+ s := spec.Spec{
+ Version: spec.Version,
+ Root: &spec.Root{},
+ }
+ s.Annotations = c.GetAnnotations()
+ s.Mounts = c.GetDefaultMounts()
+ s.Process = &spec.Process{
+ Capabilities: &spec.LinuxCapabilities{
+ Bounding: defaultCapabilities(),
+ Permitted: defaultCapabilities(),
+ Inheritable: defaultCapabilities(),
+ Effective: defaultCapabilities(),
+ },
+ }
+ s.Linux = &spec.Linux{
+ MaskedPaths: []string{
+ "/proc/kcore",
+ "/proc/latency_stats",
+ "/proc/timer_list",
+ "/proc/timer_stats",
+ "/proc/sched_debug",
+ },
+ ReadonlyPaths: []string{
+ "/proc/asound",
+ "/proc/bus",
+ "/proc/fs",
+ "/proc/irq",
+ "/proc/sys",
+ "/proc/sysrq-trigger",
+ },
+ Namespaces: []spec.LinuxNamespace{
+ {Type: "mount"},
+ {Type: "network"},
+ {Type: "uts"},
+ {Type: "pid"},
+ {Type: "ipc"},
+ },
+ Devices: []spec.LinuxDevice{},
+ Resources: &spec.LinuxResources{
+ Devices: c.GetDefaultDevices(),
+ },
+ }
+
+ return s
+}
+
+// GetAnnotations returns the all the annotations for the container
+func (c *createConfig) GetAnnotations() map[string]string {
+ a := getDefaultAnnotations()
+ // TODO
+ // Which annotations do we want added by default
+ if c.tty {
+ a["io.kubernetes.cri-o.TTY"] = "true"
+ }
+ return a
+}
+
+func getDefaultAnnotations() map[string]string {
+ var annotations map[string]string
+ annotations = make(map[string]string)
+ annotations[ann.Annotations] = ""
+ annotations[ann.ContainerID] = ""
+ annotations[ann.ContainerName] = ""
+ annotations[ann.ContainerType] = ""
+ annotations[ann.Created] = ""
+ annotations[ann.HostName] = ""
+ annotations[ann.IP] = ""
+ annotations[ann.Image] = ""
+ annotations[ann.ImageName] = ""
+ annotations[ann.ImageRef] = ""
+ annotations[ann.KubeName] = ""
+ annotations[ann.Labels] = ""
+ annotations[ann.LogPath] = ""
+ annotations[ann.Metadata] = ""
+ annotations[ann.Name] = ""
+ annotations[ann.PrivilegedRuntime] = ""
+ annotations[ann.ResolvPath] = ""
+ annotations[ann.HostnamePath] = ""
+ annotations[ann.SandboxID] = ""
+ annotations[ann.SandboxName] = ""
+ annotations[ann.ShmPath] = ""
+ annotations[ann.MountPoint] = ""
+ annotations[ann.TrustedSandbox] = ""
+ annotations[ann.TTY] = "false"
+ annotations[ann.Stdin] = ""
+ annotations[ann.StdinOnce] = ""
+ annotations[ann.Volumes] = ""
+
+ return annotations
+}
+
+//GetVolumeMounts takes user provided input for bind mounts and creates Mount structs
+func (c *createConfig) GetVolumeMounts() []spec.Mount {
+ var m []spec.Mount
+ var options []string
+ for _, i := range c.volumes {
+ // We need to handle SELinux options better here, specifically :Z
+ spliti := strings.Split(i, ":")
+ if len(spliti) > 2 {
+ options = strings.Split(spliti[2], ",")
+ }
+ // always add rbind bc mount ignores the bind filesystem when mounting
+ options = append(options, "rbind")
+ m = append(m, spec.Mount{
+ Destination: spliti[1],
+ Type: string(TypeBind),
+ Source: spliti[0],
+ Options: options,
+ })
+ }
+ return m
+}
+
+//GetTmpfsMounts takes user provided input for tmpfs mounts and creates Mount structs
+func (c *createConfig) GetTmpfsMounts() []spec.Mount {
+ var m []spec.Mount
+ for _, i := range c.tmpfs {
+ // Default options if nothing passed
+ options := []string{"rw", "noexec", "nosuid", "nodev", "size=65536k"}
+ spliti := strings.Split(i, ":")
+ destPath := spliti[0]
+ if len(spliti) > 1 {
+ options = strings.Split(spliti[1], ",")
+ }
+ m = append(m, spec.Mount{
+ Destination: destPath,
+ Type: string(TypeTmpfs),
+ Options: options,
+ Source: string(TypeTmpfs),
+ })
+ }
+ return m
+}
+
+func (c *createConfig) GetContainerCreateOptions(cli *cli.Context) ([]libpod.CtrCreateOption, error) {
+ var options []libpod.CtrCreateOption
+
+ // Uncomment after talking to mheon about unimplemented funcs
+ // options = append(options, libpod.WithLabels(c.labels))
+
+ if c.interactive {
+ options = append(options, libpod.WithStdin())
+ }
+ if c.name != "" {
+ logrus.Debug("appending name %s", c.name)
+ options = append(options, libpod.WithName(c.name))
+ }
+
+ return options, nil
+}
+
+func getStatFromPath(path string) unix.Stat_t {
+ s := unix.Stat_t{}
+ _ = unix.Stat(path, &s)
+ return s
+}
+
+func makeThrottleArray(throttleInput []string) ([]spec.LinuxThrottleDevice, error) {
+ var ltds []spec.LinuxThrottleDevice
+ for _, i := range throttleInput {
+ t, err := validateBpsDevice(i)
+ if err != nil {
+ return []spec.LinuxThrottleDevice{}, err
+ }
+ ltd := spec.LinuxThrottleDevice{}
+ ltd.Rate = t.rate
+ ltdStat := getStatFromPath(t.path)
+ ltd.Major = int64(unix.Major(ltdStat.Rdev))
+ ltd.Minor = int64(unix.Major(ltdStat.Rdev))
+ ltds = append(ltds, ltd)
+ }
+ return ltds, nil
+}
diff --git a/cmd/kpod/user.go b/cmd/kpod/user.go
new file mode 100644
index 000000000..3e2e308c5
--- /dev/null
+++ b/cmd/kpod/user.go
@@ -0,0 +1,121 @@
+package main
+
+// #include <sys/types.h>
+// #include <grp.h>
+// #include <pwd.h>
+// #include <stdlib.h>
+// #include <stdio.h>
+// #include <string.h>
+// typedef FILE * pFILE;
+import "C"
+
+import (
+ "fmt"
+ "os/user"
+ "path/filepath"
+ "sync"
+ "syscall"
+ "unsafe"
+
+ "github.com/pkg/errors"
+)
+
+func fopenContainerFile(rootdir, filename string) (C.pFILE, error) {
+ var st, lst syscall.Stat_t
+
+ ctrfile := filepath.Join(rootdir, filename)
+ cctrfile := C.CString(ctrfile)
+ defer C.free(unsafe.Pointer(cctrfile))
+ mode := C.CString("r")
+ defer C.free(unsafe.Pointer(mode))
+ f, err := C.fopen(cctrfile, mode)
+ if f == nil || err != nil {
+ return nil, errors.Wrapf(err, "error opening %q", ctrfile)
+ }
+ if err = syscall.Fstat(int(C.fileno(f)), &st); err != nil {
+ return nil, errors.Wrapf(err, "fstat(%q)", ctrfile)
+ }
+ if err = syscall.Lstat(ctrfile, &lst); err != nil {
+ return nil, errors.Wrapf(err, "lstat(%q)", ctrfile)
+ }
+ if st.Dev != lst.Dev || st.Ino != lst.Ino {
+ return nil, errors.Errorf("%q is not a regular file", ctrfile)
+ }
+ return f, nil
+}
+
+var (
+ lookupUser, lookupGroup sync.Mutex
+)
+
+func lookupUserInContainer(rootdir, username string) (uint64, uint64, error) {
+ name := C.CString(username)
+ defer C.free(unsafe.Pointer(name))
+
+ f, err := fopenContainerFile(rootdir, "/etc/passwd")
+ if err != nil {
+ return 0, 0, err
+ }
+ defer C.fclose(f)
+
+ lookupUser.Lock()
+ defer lookupUser.Unlock()
+
+ pwd := C.fgetpwent(f)
+ for pwd != nil {
+ if C.strcmp(pwd.pw_name, name) != 0 {
+ pwd = C.fgetpwent(f)
+ continue
+ }
+ return uint64(pwd.pw_uid), uint64(pwd.pw_gid), nil
+ }
+
+ return 0, 0, user.UnknownUserError(fmt.Sprintf("error looking up user %q", username))
+}
+
+func lookupGroupForUIDInContainer(rootdir string, userid uint64) (string, uint64, error) {
+ f, err := fopenContainerFile(rootdir, "/etc/passwd")
+ if err != nil {
+ return "", 0, err
+ }
+ defer C.fclose(f)
+
+ lookupUser.Lock()
+ defer lookupUser.Unlock()
+
+ pwd := C.fgetpwent(f)
+ for pwd != nil {
+ if uint64(pwd.pw_uid) != userid {
+ pwd = C.fgetpwent(f)
+ continue
+ }
+ return C.GoString(pwd.pw_name), uint64(pwd.pw_gid), nil
+ }
+
+ return "", 0, user.UnknownUserError(fmt.Sprintf("error looking up user with UID %d", userid))
+}
+
+func lookupGroupInContainer(rootdir, groupname string) (uint64, error) {
+ name := C.CString(groupname)
+ defer C.free(unsafe.Pointer(name))
+
+ f, err := fopenContainerFile(rootdir, "/etc/group")
+ if err != nil {
+ return 0, err
+ }
+ defer C.fclose(f)
+
+ lookupGroup.Lock()
+ defer lookupGroup.Unlock()
+
+ grp := C.fgetgrent(f)
+ for grp != nil {
+ if C.strcmp(grp.gr_name, name) != 0 {
+ grp = C.fgetgrent(f)
+ continue
+ }
+ return uint64(grp.gr_gid), nil
+ }
+
+ return 0, user.UnknownGroupError(fmt.Sprintf("error looking up group %q", groupname))
+}
diff --git a/completions/bash/kpod b/completions/bash/kpod
index 2c33166a8..88edbee6f 100644
--- a/completions/bash/kpod
+++ b/completions/bash/kpod
@@ -2,6 +2,617 @@
: ${PROG:=$(basename ${BASH_SOURCE})}
+__kpod_previous_extglob_setting=$(shopt -p extglob)
+shopt -s extglob
+
+__kpod_q() {
+ kpod ${host:+-H "$host"} ${config:+--config "$config"} 2>/dev/null "$@"
+}
+
+# __kpod_containers returns a list of containers. Additional options to
+# `kpod ps` may be specified in order to filter the list, e.g.
+# `__kpod_containers --filter status=running`
+# By default, only names are returned.
+# Set KPOD_COMPLETION_SHOW_CONTAINER_IDS=yes to also complete IDs.
+# An optional first option `--id|--name` may be used to limit the
+# output to the IDs or names of matching items. This setting takes
+# precedence over the environment setting.
+__kpod_containers() {
+ local format
+ if [ "$1" = "--id" ] ; then
+ format='{{.ID}}'
+ shift
+ elif [ "$1" = "--name" ] ; then
+ format='{{.Names}}'
+ shift
+ elif [ "${KPOD_COMPLETION_SHOW_CONTAINER_IDS}" = yes ] ; then
+ format='{{.ID}} {{.Names}}'
+ else
+ format='{{.Names}}'
+ fi
+ __kpod_q ps --format "$format" "$@"
+}
+
+# __kpod_complete_containers applies completion of containers based on the current
+# value of `$cur` or the value of the optional first option `--cur`, if given.
+# Additional filters may be appended, see `__kpod_containers`.
+__kpod_complete_containers() {
+ local current="$cur"
+ if [ "$1" = "--cur" ] ; then
+ current="$2"
+ shift 2
+ fi
+ COMPREPLY=( $(compgen -W "$(__kpod_containers "$@")" -- "$current") )
+}
+
+__kpod_complete_containers_all() {
+ __kpod_complete_containers "$@" --all
+}
+
+__kpod_complete_containers_running() {
+ __kpod_complete_containers "$@" --filter status=running
+}
+
+__kpod_complete_containers_stopped() {
+ __kpod_complete_containers "$@" --filter status=exited
+}
+
+__kpod_complete_containers_unpauseable() {
+ __kpod_complete_containers "$@" --filter status=paused
+}
+
+__kpod_complete_container_names() {
+ local containers=( $(__kpod_q ps -aq --no-trunc) )
+ local names=( $(__kpod_q inspect --format '{{.Name}}' "${containers[@]}") )
+ names=( "${names[@]#/}" ) # trim off the leading "/" from the container names
+ COMPREPLY=( $(compgen -W "${names[*]}" -- "$cur") )
+}
+
+__kpod_complete_container_ids() {
+ local containers=( $(__kpod_q ps -aq) )
+ COMPREPLY=( $(compgen -W "${containers[*]}" -- "$cur") )
+}
+
+__kpod_images() {
+ local images_args=""
+
+ case "$KPOD_COMPLETION_SHOW_IMAGE_IDS" in
+ all)
+ images_args="--no-trunc -a"
+ ;;
+ non-intermediate)
+ images_args="--no-trunc"
+ ;;
+ esac
+
+ local repo_print_command
+ if [ "${KPOD_COMPLETION_SHOW_TAGS:-yes}" = "yes" ]; then
+ repo_print_command='print $1; print $1":"$2'
+ else
+ repo_print_command='print $1'
+ fi
+
+ local awk_script
+ case "$KPOD_COMPLETION_SHOW_IMAGE_IDS" in
+ all|non-intermediate)
+ awk_script='NR>1 { print $3; if ($1 != "<none>") { '"$repo_print_command"' } }'
+ ;;
+ none|*)
+ awk_script='NR>1 && $1 != "<none>" { '"$repo_print_command"' }'
+ ;;
+ esac
+
+ __kpod_q images $images_args | awk "$awk_script" | grep -v '<none>$'
+}
+
+__kpod_complete_images() {
+ COMPREPLY=( $(compgen -W "$(__kpod_images)" -- "$cur") )
+ __ltrim_colon_completions "$cur"
+}
+
+__kpod_complete_image_repos() {
+ local repos="$(__kpod_q images | awk 'NR>1 && $1 != "<none>" { print $1 }')"
+ COMPREPLY=( $(compgen -W "$repos" -- "$cur") )
+}
+
+__kpod_complete_image_repos_and_tags() {
+ local reposAndTags="$(__kpod_q images | awk 'NR>1 && $1 != "<none>" { print $1; print $1":"$2 }')"
+ COMPREPLY=( $(compgen -W "$reposAndTags" -- "$cur") )
+ __ltrim_colon_completions "$cur"
+}
+
+# __kpod_networks returns a list of all networks. Additional options to
+# `kpod network ls` may be specified in order to filter the list, e.g.
+# `__kpod_networks --filter type=custom`
+# By default, only names are returned.
+# Set KPOD_COMPLETION_SHOW_NETWORK_IDS=yes to also complete IDs.
+# An optional first option `--id|--name` may be used to limit the
+# output to the IDs or names of matching items. This setting takes
+# precedence over the environment setting.
+__kpod_networks() {
+ local format
+ if [ "$1" = "--id" ] ; then
+ format='{{.ID}}'
+ shift
+ elif [ "$1" = "--name" ] ; then
+ format='{{.Name}}'
+ shift
+ elif [ "${KPOD_COMPLETION_SHOW_NETWORK_IDS}" = yes ] ; then
+ format='{{.ID}} {{.Name}}'
+ else
+ format='{{.Name}}'
+ fi
+ __kpod_q network ls --format "$format" "$@"
+}
+
+# __kpod_complete_networks applies completion of networks based on the current
+# value of `$cur` or the value of the optional first option `--cur`, if given.
+# Additional filters may be appended, see `__kpod_networks`.
+__kpod_complete_networks() {
+ local current="$cur"
+ if [ "$1" = "--cur" ] ; then
+ current="$2"
+ shift 2
+ fi
+ COMPREPLY=( $(compgen -W "$(__kpod_networks "$@")" -- "$current") )
+}
+
+__kpod_complete_containers_in_network() {
+ local containers=$(__kpod_q network inspect -f '{{range $i, $c := .Containers}}{{$i}} {{$c.Name}} {{end}}' "$1")
+ COMPREPLY=( $(compgen -W "$containers" -- "$cur") )
+}
+
+__kpod_runtimes() {
+ __kpod_q info | sed -n 's/^Runtimes: \(.*\)/\1/p'
+}
+
+__kpod_complete_runtimes() {
+ COMPREPLY=( $(compgen -W "$(__kpod_runtimes)" -- "$cur") )
+}
+
+# __kpod_services returns a list of all services. Additional options to
+# `kpod service ls` may be specified in order to filter the list, e.g.
+# `__kpod_services --filter name=xxx`
+# By default, only node names are returned.
+# Set KPOD_COMPLETION_SHOW_SERVICE_IDS=yes to also complete IDs.
+# An optional first option `--id|--name` may be used to limit the
+# output to the IDs or names of matching items. This setting takes
+# precedence over the environment setting.
+__kpod_services() {
+ local fields='$2' # default: service name only
+ [ "${KPOD_COMPLETION_SHOW_SERVICE_IDS}" = yes ] && fields='$1,$2' # ID & name
+
+ if [ "$1" = "--id" ] ; then
+ fields='$1' # IDs only
+ shift
+ elif [ "$1" = "--name" ] ; then
+ fields='$2' # names only
+ shift
+ fi
+ __kpod_q service ls "$@" | awk "NR>1 {print $fields}"
+}
+
+# __kpod_complete_services applies completion of services based on the current
+# value of `$cur` or the value of the optional first option `--cur`, if given.
+# Additional filters may be appended, see `__kpod_services`.
+__kpod_complete_services() {
+ local current="$cur"
+ if [ "$1" = "--cur" ] ; then
+ current="$2"
+ shift 2
+ fi
+ COMPREPLY=( $(compgen -W "$(__kpod_services "$@")" -- "$current") )
+}
+
+# __kpod_append_to_completions appends the word passed as an argument to every
+# word in `$COMPREPLY`.
+# Normally you do this with `compgen -S` while generating the completions.
+# This function allows you to append a suffix later. It allows you to use
+# the __kpod_complete_XXX functions in cases where you need a suffix.
+__kpod_append_to_completions() {
+ COMPREPLY=( ${COMPREPLY[@]/%/"$1"} )
+}
+
+# __kpod_is_experimental tests whether the currently configured Kpod daemon
+# runs in experimental mode. If so, the function exits with 0 (true).
+# Otherwise, or if the result cannot be determined, the exit value is 1 (false).
+__kpod_is_experimental() {
+ [ "$(__kpod_q version -f '{{.Server.Experimental}}')" = "true" ]
+}
+
+# __kpod_pos_first_nonflag finds the position of the first word that is neither
+# option nor an option's argument. If there are options that require arguments,
+# you should pass a glob describing those options, e.g. "--option1|-o|--option2"
+# Use this function to restrict completions to exact positions after the argument list.
+__kpod_pos_first_nonflag() {
+ local argument_flags=$1
+
+ local counter=$((${subcommand_pos:-${command_pos}} + 1))
+ while [ $counter -le $cword ]; do
+ if [ -n "$argument_flags" ] && eval "case '${words[$counter]}' in $argument_flags) true ;; *) false ;; esac"; then
+ (( counter++ ))
+ # eat "=" in case of --option=arg syntax
+ [ "${words[$counter]}" = "=" ] && (( counter++ ))
+ else
+ case "${words[$counter]}" in
+ -*)
+ ;;
+ *)
+ break
+ ;;
+ esac
+ fi
+
+ # Bash splits words at "=", retaining "=" as a word, examples:
+ # "--debug=false" => 3 words, "--log-opt syslog-facility=daemon" => 4 words
+ while [ "${words[$counter + 1]}" = "=" ] ; do
+ counter=$(( counter + 2))
+ done
+
+ (( counter++ ))
+ done
+
+ echo $counter
+}
+
+# __kpod_map_key_of_current_option returns `key` if we are currently completing the
+# value of a map option (`key=value`) which matches the extglob given as an argument.
+# This function is needed for key-specific completions.
+__kpod_map_key_of_current_option() {
+ local glob="$1"
+
+ local key glob_pos
+ if [ "$cur" = "=" ] ; then # key= case
+ key="$prev"
+ glob_pos=$((cword - 2))
+ elif [[ $cur == *=* ]] ; then # key=value case (OSX)
+ key=${cur%=*}
+ glob_pos=$((cword - 1))
+ elif [ "$prev" = "=" ] ; then
+ key=${words[$cword - 2]} # key=value case
+ glob_pos=$((cword - 3))
+ else
+ return
+ fi
+
+ [ "${words[$glob_pos]}" = "=" ] && ((glob_pos--)) # --option=key=value syntax
+
+ [[ ${words[$glob_pos]} == @($glob) ]] && echo "$key"
+}
+
+# __kpod_value_of_option returns the value of the first option matching `option_glob`.
+# Valid values for `option_glob` are option names like `--log-level` and globs like
+# `--log-level|-l`
+# Only positions between the command and the current word are considered.
+__kpod_value_of_option() {
+ local option_extglob=$(__kpod_to_extglob "$1")
+
+ local counter=$((command_pos + 1))
+ while [ $counter -lt $cword ]; do
+ case ${words[$counter]} in
+ $option_extglob )
+ echo ${words[$counter + 1]}
+ break
+ ;;
+ esac
+ (( counter++ ))
+ done
+}
+
+# __kpod_to_alternatives transforms a multiline list of strings into a single line
+# string with the words separated by `|`.
+# This is used to prepare arguments to __kpod_pos_first_nonflag().
+__kpod_to_alternatives() {
+ local parts=( $1 )
+ local IFS='|'
+ echo "${parts[*]}"
+}
+
+# __kpod_to_extglob transforms a multiline list of options into an extglob pattern
+# suitable for use in case statements.
+__kpod_to_extglob() {
+ local extglob=$( __kpod_to_alternatives "$1" )
+ echo "@($extglob)"
+}
+
+# __kpod_subcommands processes subcommands
+# Locates the first occurrence of any of the subcommands contained in the
+# first argument. In case of a match, calls the corresponding completion
+# function and returns 0.
+# If no match is found, 1 is returned. The calling function can then
+# continue processing its completion.
+#
+# TODO if the preceding command has options that accept arguments and an
+# argument is equal ot one of the subcommands, this is falsely detected as
+# a match.
+__kpod_subcommands() {
+ local subcommands="$1"
+
+ local counter=$(($command_pos + 1))
+ while [ $counter -lt $cword ]; do
+ case "${words[$counter]}" in
+ $(__kpod_to_extglob "$subcommands") )
+ subcommand_pos=$counter
+ local subcommand=${words[$counter]}
+ local completions_func=_kpod_${command}_${subcommand}
+ declare -F $completions_func >/dev/null && $completions_func
+ return 0
+ ;;
+ esac
+ (( counter++ ))
+ done
+ return 1
+}
+
+# __kpod_nospace suppresses trailing whitespace
+__kpod_nospace() {
+ # compopt is not available in ancient bash versions
+ type compopt &>/dev/null && compopt -o nospace
+}
+
+__kpod_complete_resolved_hostname() {
+ command -v host >/dev/null 2>&1 || return
+ COMPREPLY=( $(host 2>/dev/null "${cur%:}" | awk '/has address/ {print $4}') )
+}
+
+__kpod_local_interfaces() {
+ command -v ip >/dev/null 2>&1 || return
+ ip addr show scope global 2>/dev/null | sed -n 's| \+inet \([0-9.]\+\).* \([^ ]\+\)|\1 \2|p'
+}
+
+__kpod_complete_local_interfaces() {
+ local additional_interface
+ if [ "$1" = "--add" ] ; then
+ additional_interface="$2"
+ fi
+
+ COMPREPLY=( $( compgen -W "$(__kpod_local_interfaces) $additional_interface" -- "$cur" ) )
+}
+
+__kpod_complete_capabilities() {
+ # The list of capabilities is defined in types.go, ALL was added manually.
+ COMPREPLY=( $( compgen -W "
+ ALL
+ AUDIT_CONTROL
+ AUDIT_WRITE
+ AUDIT_READ
+ BLOCK_SUSPEND
+ CHOWN
+ DAC_OVERRIDE
+ DAC_READ_SEARCH
+ FOWNER
+ FSETID
+ IPC_LOCK
+ IPC_OWNER
+ KILL
+ LEASE
+ LINUX_IMMUTABLE
+ MAC_ADMIN
+ MAC_OVERRIDE
+ MKNOD
+ NET_ADMIN
+ NET_BIND_SERVICE
+ NET_BROADCAST
+ NET_RAW
+ SETFCAP
+ SETGID
+ SETPCAP
+ SETUID
+ SYS_ADMIN
+ SYS_BOOT
+ SYS_CHROOT
+ SYSLOG
+ SYS_MODULE
+ SYS_NICE
+ SYS_PACCT
+ SYS_PTRACE
+ SYS_RAWIO
+ SYS_RESOURCE
+ SYS_TIME
+ SYS_TTY_CONFIG
+ WAKE_ALARM
+ " -- "$cur" ) )
+}
+
+__kpod_complete_detach-keys() {
+ case "$prev" in
+ --detach-keys)
+ case "$cur" in
+ *,)
+ COMPREPLY=( $( compgen -W "${cur}ctrl-" -- "$cur" ) )
+ ;;
+ *)
+ COMPREPLY=( $( compgen -W "ctrl-" -- "$cur" ) )
+ ;;
+ esac
+
+ __kpod_nospace
+ return
+ ;;
+ esac
+ return 1
+}
+
+__kpod_complete_log_drivers() {
+ COMPREPLY=( $( compgen -W "
+ awslogs
+ etwlogs
+ fluentd
+ gcplogs
+ gelf
+ journald
+ json-file
+ logentries
+ none
+ splunk
+ syslog
+ " -- "$cur" ) )
+}
+
+__kpod_complete_log_options() {
+ # see docs/reference/logging/index.md
+ local awslogs_options="awslogs-region awslogs-group awslogs-stream"
+ local fluentd_options="env fluentd-address fluentd-async-connect fluentd-buffer-limit fluentd-retry-wait fluentd-max-retries labels tag"
+ local gcplogs_options="env gcp-log-cmd gcp-project labels"
+ local gelf_options="env gelf-address gelf-compression-level gelf-compression-type labels tag"
+ local journald_options="env labels tag"
+ local json_file_options="env labels max-file max-size"
+ local logentries_options="logentries-token"
+ local syslog_options="env labels syslog-address syslog-facility syslog-format syslog-tls-ca-cert syslog-tls-cert syslog-tls-key syslog-tls-skip-verify tag"
+ local splunk_options="env labels splunk-caname splunk-capath splunk-format splunk-gzip splunk-gzip-level splunk-index splunk-insecureskipverify splunk-source splunk-sourcetype splunk-token splunk-url splunk-verify-connection tag"
+
+ local all_options="$fluentd_options $gcplogs_options $gelf_options $journald_options $logentries_options $json_file_options $syslog_options $splunk_options"
+
+ case $(__kpod_value_of_option --log-driver) in
+ '')
+ COMPREPLY=( $( compgen -W "$all_options" -S = -- "$cur" ) )
+ ;;
+ awslogs)
+ COMPREPLY=( $( compgen -W "$awslogs_options" -S = -- "$cur" ) )
+ ;;
+ fluentd)
+ COMPREPLY=( $( compgen -W "$fluentd_options" -S = -- "$cur" ) )
+ ;;
+ gcplogs)
+ COMPREPLY=( $( compgen -W "$gcplogs_options" -S = -- "$cur" ) )
+ ;;
+ gelf)
+ COMPREPLY=( $( compgen -W "$gelf_options" -S = -- "$cur" ) )
+ ;;
+ journald)
+ COMPREPLY=( $( compgen -W "$journald_options" -S = -- "$cur" ) )
+ ;;
+ json-file)
+ COMPREPLY=( $( compgen -W "$json_file_options" -S = -- "$cur" ) )
+ ;;
+ logentries)
+ COMPREPLY=( $( compgen -W "$logentries_options" -S = -- "$cur" ) )
+ ;;
+ syslog)
+ COMPREPLY=( $( compgen -W "$syslog_options" -S = -- "$cur" ) )
+ ;;
+ splunk)
+ COMPREPLY=( $( compgen -W "$splunk_options" -S = -- "$cur" ) )
+ ;;
+ *)
+ return
+ ;;
+ esac
+
+ __kpod_nospace
+}
+
+__kpod_complete_log_driver_options() {
+ local key=$(__kpod_map_key_of_current_option '--log-opt')
+ case "$key" in
+ fluentd-async-connect)
+ COMPREPLY=( $( compgen -W "false true" -- "${cur##*=}" ) )
+ return
+ ;;
+ gelf-address)
+ COMPREPLY=( $( compgen -W "udp" -S "://" -- "${cur##*=}" ) )
+ __kpod_nospace
+ return
+ ;;
+ gelf-compression-level)
+ COMPREPLY=( $( compgen -W "1 2 3 4 5 6 7 8 9" -- "${cur##*=}" ) )
+ return
+ ;;
+ gelf-compression-type)
+ COMPREPLY=( $( compgen -W "gzip none zlib" -- "${cur##*=}" ) )
+ return
+ ;;
+ syslog-address)
+ COMPREPLY=( $( compgen -W "tcp:// tcp+tls:// udp:// unix://" -- "${cur##*=}" ) )
+ __kpod_nospace
+ __ltrim_colon_completions "${cur}"
+ return
+ ;;
+ syslog-facility)
+ COMPREPLY=( $( compgen -W "
+ auth
+ authpriv
+ cron
+ daemon
+ ftp
+ kern
+ local0
+ local1
+ local2
+ local3
+ local4
+ local5
+ local6
+ local7
+ lpr
+ mail
+ news
+ syslog
+ user
+ uucp
+ " -- "${cur##*=}" ) )
+ return
+ ;;
+ syslog-format)
+ COMPREPLY=( $( compgen -W "rfc3164 rfc5424 rfc5424micro" -- "${cur##*=}" ) )
+ return
+ ;;
+ syslog-tls-ca-cert|syslog-tls-cert|syslog-tls-key)
+ _filedir
+ return
+ ;;
+ syslog-tls-skip-verify)
+ COMPREPLY=( $( compgen -W "true" -- "${cur##*=}" ) )
+ return
+ ;;
+ splunk-url)
+ COMPREPLY=( $( compgen -W "http:// https://" -- "${cur##*=}" ) )
+ __kpod_nospace
+ __ltrim_colon_completions "${cur}"
+ return
+ ;;
+ splunk-gzip|splunk-insecureskipverify|splunk-verify-connection)
+ COMPREPLY=( $( compgen -W "false true" -- "${cur##*=}" ) )
+ return
+ ;;
+ splunk-format)
+ COMPREPLY=( $( compgen -W "inline json raw" -- "${cur##*=}" ) )
+ return
+ ;;
+ esac
+ return 1
+}
+
+__kpod_complete_log_levels() {
+ COMPREPLY=( $( compgen -W "debug info warn error fatal" -- "$cur" ) )
+}
+
+# __kpod_complete_signals returns a subset of the available signals that is most likely
+# relevant in the context of kpod containers
+__kpod_complete_signals() {
+ local signals=(
+ SIGCONT
+ SIGHUP
+ SIGINT
+ SIGKILL
+ SIGQUIT
+ SIGSTOP
+ SIGTERM
+ SIGUSR1
+ SIGUSR2
+ )
+ COMPREPLY=( $( compgen -W "${signals[*]} ${signals[*]#SIG}" -- "$( echo $cur | tr '[:lower:]' '[:upper:]')" ) )
+}
+
+__kpod_complete_user_group() {
+ if [[ $cur == *:* ]] ; then
+ COMPREPLY=( $(compgen -g -- "${cur#*:}") )
+ else
+ COMPREPLY=( $(compgen -u -S : -- "$cur") )
+ __kpod_nospace
+ fi
+}
+
__kpod_list_images() {
COMPREPLY=($(compgen -W "$(kpod images -q)" -- $cur))
}
@@ -10,6 +621,38 @@ __kpod_list_containers() {
COMPREPLY=($(compgen -W "$(kpod ps -aq)" -- $cur))
}
+__kpod_images() {
+ local images_args=""
+
+ case "$KPOD_COMPLETION_SHOW_IMAGE_IDS" in
+ all)
+ images_args="--no-trunc -a"
+ ;;
+ non-intermediate)
+ images_args="--no-trunc"
+ ;;
+ esac
+
+ local repo_print_command
+ if [ "${KPOD_COMPLETION_SHOW_TAGS:-yes}" = "yes" ]; then
+ repo_print_command='print $1; print $1":"$2'
+ else
+ repo_print_command='print $1'
+ fi
+
+ local awk_script
+ case "$KPOD_COMPLETION_SHOW_IMAGE_IDS" in
+ all|non-intermediate)
+ awk_script='NR>1 { print $3; if ($1 != "<none>") { '"$repo_print_command"' } }'
+ ;;
+ none|*)
+ awk_script='NR>1 && $1 != "<none>" { '"$repo_print_command"' }'
+ ;;
+ esac
+
+ __kpod_q images $images_args | awk "$awk_script" | grep -v '<none>$'
+}
+
_kpod_diff() {
local options_with_args="
--format
@@ -273,6 +916,277 @@ _kpod_rename() {
esac
}
+_kpod_container_run() {
+ local options_with_args="
+ --add-host
+ --attach -a
+ --blkio-weight
+ --blkio-weight-device
+ --cap-add
+ --cap-drop
+ --cgroup-parent
+ --cidfile
+ --cpu-period
+ --cpu-quota
+ --cpu-rt-period
+ --cpu-rt-runtime
+ --cpuset-cpus
+ --cpus
+ --cpuset-mems
+ --cpu-shares -c
+ --device
+ --device-read-bps
+ --device-read-iops
+ --device-write-bps
+ --device-write-iops
+ --dns
+ --dns-option
+ --dns-search
+ --entrypoint
+ --env -e
+ --env-file
+ --expose
+ --group-add
+ --hostname -h
+ --init-path
+ --ip
+ --ip6
+ --ipc
+ --kernel-memory
+ --label-file
+ --label -l
+ --link-local-ip
+ --log-driver
+ --log-opt
+ --mac-address
+ --memory -m
+ --memory-swap
+ --memory-swappiness
+ --memory-reservation
+ --name
+ --network
+ --network-alias
+ --oom-score-adj
+ --pid
+ --pids-limit
+ --publish -p
+ --runtime
+ --security-opt
+ --shm-size
+ --stop-signal
+ --stop-timeout
+ --storage-opt
+ --tmpfs
+ --sysctl
+ --ulimit
+ --user -u
+ --userns
+ --uts
+ --volumes-from
+ --volume -v
+ --workdir -w
+ "
+
+ local boolean_options="
+ --disable-content-trust=false
+ --help
+ --init
+ --interactive -i
+ --oom-kill-disable
+ --privileged
+ --publish-all -P
+ --read-only
+ --tty -t
+ "
+
+ if [ "$command" = "run" -o "$subcommand" = "run" ] ; then
+ options_with_args="$options_with_args
+ --detach-keys
+ --health-cmd
+ --health-interval
+ --health-retries
+ --health-timeout
+ "
+ boolean_options="$boolean_options
+ --detach -d
+ --no-healthcheck
+ --rm
+ --sig-proxy=false
+ "
+ __kpod_complete_detach-keys && return
+ fi
+
+ local all_options="$options_with_args $boolean_options"
+
+
+ __kpod_complete_log_driver_options && return
+
+ local key=$(__kpod_map_key_of_current_option '--security-opt')
+ case "$key" in
+ label)
+ [[ $cur == *: ]] && return
+ COMPREPLY=( $( compgen -W "user: role: type: level: disable" -- "${cur##*=}") )
+ if [ "${COMPREPLY[*]}" != "disable" ] ; then
+ __kpod_nospace
+ fi
+ return
+ ;;
+ seccomp)
+ local cur=${cur##*=}
+ _filedir
+ COMPREPLY+=( $( compgen -W "unconfined" -- "$cur" ) )
+ return
+ ;;
+ esac
+
+ case "$prev" in
+ --add-host)
+ case "$cur" in
+ *:)
+ __kpod_complete_resolved_hostname
+ return
+ ;;
+ esac
+ ;;
+ --attach|-a)
+ COMPREPLY=( $( compgen -W 'stdin stdout stderr' -- "$cur" ) )
+ return
+ ;;
+ --cap-add|--cap-drop)
+ __kpod_complete_capabilities
+ return
+ ;;
+ --cidfile|--env-file|--init-path|--label-file)
+ _filedir
+ return
+ ;;
+ --device|--tmpfs|--volume|-v)
+ case "$cur" in
+ *:*)
+ # TODO somehow do _filedir for stuff inside the image, if it's already specified (which is also somewhat difficult to determine)
+ ;;
+ '')
+ COMPREPLY=( $( compgen -W '/' -- "$cur" ) )
+ __kpod_nospace
+ ;;
+ /*)
+ _filedir
+ __kpod_nospace
+ ;;
+ esac
+ return
+ ;;
+ --env|-e)
+ # we do not append a "=" here because "-e VARNAME" is legal systax, too
+ COMPREPLY=( $( compgen -e -- "$cur" ) )
+ __kpod_nospace
+ return
+ ;;
+ --ipc)
+ case "$cur" in
+ *:*)
+ cur="${cur#*:}"
+ __kpod_complete_containers_running
+ ;;
+ *)
+ COMPREPLY=( $( compgen -W 'host container:' -- "$cur" ) )
+ if [ "$COMPREPLY" = "container:" ]; then
+ __kpod_nospace
+ fi
+ ;;
+ esac
+ return
+ ;;
+ --log-driver)
+ __kpod_complete_log_drivers
+ return
+ ;;
+ --log-opt)
+ __kpod_complete_log_options
+ return
+ ;;
+ --network)
+ case "$cur" in
+ container:*)
+ __kpod_complete_containers_all --cur "${cur#*:}"
+ ;;
+ *)
+ COMPREPLY=( $( compgen -W "$(__kpod_plugins_bundled --type Network) $(__kpod_networks) container:" -- "$cur") )
+ if [ "${COMPREPLY[*]}" = "container:" ] ; then
+ __kpod_nospace
+ fi
+ ;;
+ esac
+ return
+ ;;
+ --pid)
+ case "$cur" in
+ *:*)
+ __kpod_complete_containers_running --cur "${cur#*:}"
+ ;;
+ *)
+ COMPREPLY=( $( compgen -W 'host container:' -- "$cur" ) )
+ if [ "$COMPREPLY" = "container:" ]; then
+ __kpod_nospace
+ fi
+ ;;
+ esac
+ return
+ ;;
+ --runtime)
+ __kpod_complete_runtimes
+ return
+ ;;
+ --security-opt)
+ COMPREPLY=( $( compgen -W "apparmor= label= no-new-privileges seccomp=" -- "$cur") )
+ if [ "${COMPREPLY[*]}" != "no-new-privileges" ] ; then
+ __kpod_nospace
+ fi
+ return
+ ;;
+ --storage-opt)
+ COMPREPLY=( $( compgen -W "size" -S = -- "$cur") )
+ __kpod_nospace
+ return
+ ;;
+ --user|-u)
+ __kpod_complete_user_group
+ return
+ ;;
+ --userns)
+ COMPREPLY=( $( compgen -W "host" -- "$cur" ) )
+ return
+ ;;
+ --volumes-from)
+ __kpod_complete_containers_all
+ return
+ ;;
+ $(__kpod_to_extglob "$options_with_args") )
+ return
+ ;;
+ esac
+
+ case "$cur" in
+ -*)
+ COMPREPLY=( $( compgen -W "$all_options" -- "$cur" ) )
+ ;;
+ *)
+ local counter=$( __kpod_pos_first_nonflag $( __kpod_to_alternatives "$options_with_args" ) )
+ if [ $cword -eq $counter ]; then
+ __kpod_complete_images
+ fi
+ ;;
+ esac
+}
+
+_kpod_create() {
+ _kpod_container_run
+}
+
+_kpod_run() {
+ _kpod_container_run
+}
+
_kpod_rm() {
local boolean_options="
--force
@@ -483,6 +1397,7 @@ _kpod_kpod() {
--version -v
"
commands="
+ create
diff
export
history
@@ -502,6 +1417,7 @@ _kpod_kpod() {
rename
rm
rmi
+ run
save
stats
stop
diff --git a/docs/kpod-create.1.md b/docs/kpod-create.1.md
new file mode 100644
index 000000000..8b58fa612
--- /dev/null
+++ b/docs/kpod-create.1.md
@@ -0,0 +1,594 @@
+% kpod(1) kpod-create - Create a new container
+% Dan Walsh
+kpod-create - Create a new container
+
+# SYNOPSIS
+**kpod create** [*options* [...]] IMAGE [COMMAND] [ARG...]
+
+# DESCRIPTION
+
+Creates a writeable container layer over the specified image and prepares it for
+running the specified command. The container ID is then printed to STDOUT. This
+is similar to **kpod run -d** except the container is never started. You can
+then use the **kpod start <container_id>** command to start the container at
+any point.
+
+The initial status of the container created with **kpod create** is 'created'.
+
+# OPTIONS
+**--add-host**=[]
+ Add a custom host-to-IP mapping (host:ip)
+
+ Add a line to /etc/hosts. The format is hostname:ip. The **--add-host**
+option can be set multiple times.
+
+**-a**, **--attach**=[]
+ Attach to STDIN, STDOUT or STDERR.
+
+ In foreground mode (the default when **-d**
+is not specified), **kpod run** can start the process in the container
+and attach the console to the process's standard input, output, and standard
+error. It can even pretend to be a TTY (this is what most commandline
+executables expect) and pass along signals. The **-a** option can be set for
+each of stdin, stdout, and stderr.
+
+**--blkio-weight**=*0*
+ Block IO weight (relative weight) accepts a weight value between 10 and 1000.
+
+**--blkio-weight-device**=[]
+ Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`).
+
+**--cap-add**=[]
+ Add Linux capabilities
+
+**--cap-drop**=[]
+ Drop Linux capabilities
+
+**--cgroup-parent**=""
+ Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
+
+**--cidfile**=""
+ Write the container ID to the file
+
+**--cpu-count**=*0*
+ Limit the number of CPUs available for execution by the container.
+
+ On Windows Server containers, this is approximated as a percentage of total CPU usage.
+
+ On Windows Server containers, the processor resource controls are mutually exclusive, the order of precedence is CPUCount first, then CPUShares, and CPUPercent last.
+
+**--cpu-period**=*0*
+ Limit the CPU CFS (Completely Fair Scheduler) period
+
+ Limit the container's CPU usage. This flag tell the kernel to restrict the container's CPU usage to the period you specify.
+
+**--cpu-quota**=*0*
+ Limit the CPU CFS (Completely Fair Scheduler) quota
+
+ Limit the container's CPU usage. By default, containers run with the full
+CPU resource. This flag tell the kernel to restrict the container's CPU usage
+to the quota you specify.
+
+**--cpu-rt-period**=0
+ Limit the CPU real-time period in microseconds
+
+ Limit the container's Real Time CPU usage. This flag tell the kernel to restrict the container's Real Time CPU usage to the period you specify.
+
+**--cpu-rt-runtime**=0
+ Limit the CPU real-time runtime in microseconds
+
+ Limit the containers Real Time CPU usage. This flag tells the kernel to limit the amount of time in a given CPU period Real Time tasks may consume. Ex:
+ Period of 1,000,000us and Runtime of 950,000us means that this container could consume 95% of available CPU and leave the remaining 5% to normal priority tasks.
+
+ The sum of all runtimes across containers cannot exceed the amount allotted to the parent cgroup.
+
+**--cpu-shares**=*0*
+ CPU shares (relative weight)
+
+ By default, all containers get the same proportion of CPU cycles. This proportion
+can be modified by changing the container's CPU share weighting relative
+to the weighting of all other running containers.
+
+To modify the proportion from the default of 1024, use the **--cpu-shares**
+flag to set the weighting to 2 or higher.
+
+The proportion will only apply when CPU-intensive processes are running.
+When tasks in one container are idle, other containers can use the
+left-over CPU time. The actual amount of CPU time will vary depending on
+the number of containers running on the system.
+
+For example, consider three containers, one has a cpu-share of 1024 and
+two others have a cpu-share setting of 512. When processes in all three
+containers attempt to use 100% of CPU, the first container would receive
+50% of the total CPU time. If you add a fourth container with a cpu-share
+of 1024, the first container only gets 33% of the CPU. The remaining containers
+receive 16.5%, 16.5% and 33% of the CPU.
+
+On a multi-core system, the shares of CPU time are distributed over all CPU
+cores. Even if a container is limited to less than 100% of CPU time, it can
+use 100% of each individual CPU core.
+
+For example, consider a system with more than three cores. If you start one
+container **{C0}** with **-c=512** running one process, and another container
+**{C1}** with **-c=1024** running two processes, this can result in the following
+division of CPU shares:
+
+ PID container CPU CPU share
+ 100 {C0} 0 100% of CPU0
+ 101 {C1} 1 100% of CPU1
+ 102 {C1} 2 100% of CPU2
+
+**--cpus**=0.0
+ Number of CPUs. The default is *0.0* which means no limit.
+
+**--cpuset-cpus**=""
+ CPUs in which to allow execution (0-3, 0,1)
+
+**--cpuset-mems**=""
+ Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
+
+ If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
+then processes in your container will only use memory from the first
+two memory nodes.
+
+**-d**, **--detach**=*true*|*false*
+ Detached mode: run the container in the background and print the new container ID. The default is *false*.
+
+ At any time you can run **kpod ps** in
+the other shell to view a list of the running containers. You can reattach to a
+detached container with **kpod attach**. If you choose to run a container in
+the detached mode, then you cannot use the **-rm** option.
+
+ When attached in the tty mode, you can detach from the container (and leave it
+running) using a configurable key sequence. The default sequence is `CTRL-p CTRL-q`.
+You configure the key sequence using the **--detach-keys** option or a configuration file.
+See **config-json(5)** for documentation on using a configuration file.
+
+**--detach-keys**=""
+ Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.
+
+**--device**=[]
+ Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
+
+**--device-read-bps**=[]
+ Limit read rate (bytes per second) from a device (e.g. --device-read-bps=/dev/sda:1mb)
+
+**--device-read-iops**=[]
+ Limit read rate (IO per second) from a device (e.g. --device-read-iops=/dev/sda:1000)
+
+**--device-write-bps**=[]
+ Limit write rate (bytes per second) to a device (e.g. --device-write-bps=/dev/sda:1mb)
+
+**--device-write-iops**=[]
+ Limit write rate (IO per second) to a device (e.g. --device-write-iops=/dev/sda:1000)
+
+**--dns**=[]
+ Set custom DNS servers
+
+ This option can be used to override the DNS
+configuration passed to the container. Typically this is necessary when the
+host DNS configuration is invalid for the container (e.g., 127.0.0.1). When this
+is the case the **--dns** flags is necessary for every run.
+
+**--dns-option**=[]
+ Set custom DNS options
+
+**--dns-search**=[]
+ Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
+
+**--entrypoint**=""
+ Overwrite the default ENTRYPOINT of the image
+
+ This option allows you to overwrite the default entrypoint of the image.
+ The ENTRYPOINT of an image is similar to a COMMAND
+because it specifies what executable to run when the container starts, but it is
+(purposely) more difficult to override. The ENTRYPOINT gives a container its
+default nature or behavior, so that when you set an ENTRYPOINT you can run the
+container as if it were that binary, complete with default options, and you can
+pass in more options via the COMMAND. But, sometimes an operator may want to run
+something else inside the container, so you can override the default ENTRYPOINT
+at runtime by using a **--entrypoint** and a string to specify the new
+ENTRYPOINT.
+
+**-e**, **--env**=[]
+ Set environment variables
+
+ This option allows you to specify arbitrary
+environment variables that are available for the process that will be launched
+inside of the container.
+
+**--env-file**=[]
+ Read in a line delimited file of environment variables
+
+**--expose**=[]
+ Expose a port, or a range of ports (e.g. --expose=3300-3310) to set up port redirection
+ on the host system.
+
+**--group-add**=[]
+ Add additional groups to run as
+
+**--hostname**=""
+ Container host name
+
+ Sets the container host name that is available inside the container.
+
+**--help**
+ Print usage statement
+
+**-i**, **--interactive**=*true*|*false*
+ Keep STDIN open even if not attached. The default is *false*.
+
+**--ip**=""
+ Sets the container's interface IPv4 address (e.g. 172.23.0.9)
+
+ It can only be used in conjunction with **--network** for user-defined networks
+
+**--ip6**=""
+ Sets the container's interface IPv6 address (e.g. 2001:db8::1b99)
+
+ It can only be used in conjunction with **--network** for user-defined networks
+
+**--ipc**=""
+ Default is to create a private IPC namespace (POSIX SysV IPC) for the container
+ 'container:<name|id>': reuses another container shared memory, semaphores and message queues
+ 'host': use the host shared memory,semaphores and message queues inside the container. Note: the host mode gives the container full access to local shared memory and is therefore considered insecure.
+
+**--kernel-memory**=""
+ Kernel memory limit (format: `<number>[<unit>]`, where unit = b, k, m or g)
+
+ Constrains the kernel memory available to a container. If a limit of 0
+is specified (not using `--kernel-memory`), the container's kernel memory
+is not limited. If you specify a limit, it may be rounded up to a multiple
+of the operating system's page size and the value can be very large,
+millions of trillions.
+
+**-l**, **--label**=[]
+ Add metadata to a container (e.g., --label com.example.key=value)
+
+**--label-file**=[]
+ Read in a line delimited file of labels
+
+**--link-local-ip**=[]
+ Add one or more link-local IPv4/IPv6 addresses to the container's interface
+
+**--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*"
+ Logging driver for the container. Default is defined by daemon `--log-driver` flag.
+ **Warning**: the `kpod logs` command works only for the `json-file` and
+ `journald` logging drivers.
+
+**--log-opt**=[]
+ Logging driver specific options.
+
+**--mac-address**=""
+ Container MAC address (e.g. 92:d0:c6:0a:29:33)
+
+ Remember that the MAC address in an Ethernet network must be unique.
+The IPv6 link-local address will be based on the device's MAC address
+according to RFC4862.
+
+**-m**, **--memory**=""
+ Memory limit (format: <number>[<unit>], where unit = b, k, m or g)
+
+ Allows you to constrain the memory available to a container. If the host
+supports swap memory, then the **-m** memory setting can be larger than physical
+RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
+not limited. The actual limit may be rounded up to a multiple of the operating
+system's page size (the value would be very large, that's millions of trillions).
+
+**--memory-reservation**=""
+ Memory soft limit (format: <number>[<unit>], where unit = b, k, m or g)
+
+ After setting memory reservation, when the system detects memory contention
+or low memory, containers are forced to restrict their consumption to their
+reservation. So you should always set the value below **--memory**, otherwise the
+hard limit will take precedence. By default, memory reservation will be the same
+as memory limit.
+
+**--memory-swap**="LIMIT"
+ A limit value equal to memory plus swap. Must be used with the **-m**
+(**--memory**) flag. The swap `LIMIT` should always be larger than **-m**
+(**--memory**) value. By default, the swap `LIMIT` will be set to double
+the value of --memory.
+
+ The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes),
+`k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a
+unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
+
+**--memory-swappiness**=""
+ Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
+
+**--name**=""
+ Assign a name to the container
+
+ The operator can identify a container in three ways:
+ UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
+ UUID short identifier (“f78375b1c487”)
+ Name (“jonah”)
+
+ kpod generates a UUID for each container, and if a name is not assigned
+to the container with **--name** then the daemon will also generate a random
+string name. The name is useful when defining links (see **--link**) (or any
+other place you need to identify a container). This works for both background
+and foreground containers.
+
+**--network**="*bridge*"
+ Set the Network mode for the container
+ 'bridge': create a network stack on the default bridge
+ 'none': no networking
+ 'container:<name|id>': reuse another container's network stack
+ 'host': use the kpod host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
+ '<network-name>|<network-id>': connect to a user-defined network
+
+**--network-alias**=[]
+ Add network-scoped alias for the container
+
+**--oom-kill-disable**=*true*|*false*
+ Whether to disable OOM Killer for the container or not.
+
+**--oom-score-adj**=""
+ Tune the host's OOM preferences for containers (accepts -1000 to 1000)
+
+**--pid**=""
+ Set the PID mode for the container
+ Default is to create a private PID namespace for the container
+ 'container:<name|id>': join another container's PID namespace
+ 'host': use the host's PID namespace for the container. Note: the host mode gives the container full access to local PID and is therefore considered insecure.
+
+**--pids-limit**=""
+ Tune the container's pids limit. Set `-1` to have unlimited pids for the container.
+
+**--pod**=""
+ Run container in an existing pod
+
+**--privileged**=*true*|*false*
+ Give extended privileges to this container. The default is *false*.
+
+ By default, kpod containers are
+“unprivileged” (=false) and cannot, for example, modify parts of the kernel.
+This is because by default a container is not allowed to access any devices.
+A “privileged” container is given access to all devices.
+
+ When the operator executes **kpod run --privileged**, kpod enables access
+to all devices on the host as well as set turn off most of the security messurs
+protecting the host from the container.
+
+**-p**, **--publish**=[]
+ Publish a container's port, or range of ports, to the host
+
+ Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort`
+Both hostPort and containerPort can be specified as a range of ports.
+When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range.
+(e.g., `kpod run -p 1234-1236:1222-1224 --name thisWorks -t busybox`
+but not `kpod run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`)
+With ip: `kpod run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
+Use `kpod port` to see the actual mapping: `kpod port CONTAINER $CONTAINERPORT`
+
+**-P**, **--publish-all**=*true*|*false*
+ Publish all exposed ports to random ports on the host interfaces. The default is *false*.
+
+ When set to true publish all exposed ports to the host interfaces. The
+default is false. If the operator uses -P (or -p) then kpod will make the
+exposed port accessible on the host and the ports will be available to any
+client that can reach the host. When using -P, kpod will bind any exposed
+port to a random port on the host within an *ephemeral port range* defined by
+`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
+ports and the exposed ports, use `kpod port`.
+
+**--read-only**=*true*|*false*
+ Mount the container's root filesystem as read only.
+
+ By default a container will have its root filesystem writable allowing processes
+to write files anywhere. By specifying the `--read-only` flag the container will have
+its root filesystem mounted as read only prohibiting any writes.
+
+**--rm**=*true*|*false*
+ Automatically remove the container when it exits. The default is *false*.
+ `--rm` flag can work together with `-d`, and auto-removal will be done on daemon side. Note that it's
+incompatible with any restart policy other than `none`.
+
+**--security-opt**=[]
+ Security Options
+
+
+ "label=user:USER" : Set the label user for the container
+ "label=role:ROLE" : Set the label role for the container
+ "label=type:TYPE" : Set the label type for the container
+ "label=level:LEVEL" : Set the label level for the container
+ "label=disable" : Turn off label confinement for the container
+ "no-new-privileges" : Disable container processes from gaining additional privileges
+
+ "seccomp=unconfined" : Turn off seccomp confinement for the container
+ "seccomp=profile.json : White listed syscalls seccomp Json file to be used as a seccomp filter
+
+ "apparmor=unconfined" : Turn off apparmor confinement for the container
+ "apparmor=your-profile" : Set the apparmor confinement profile for the container
+
+**--shm-size**=""
+ Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`.
+ Unit is optional and can be `b` (bytes), `k` (kilobytes), `m`(megabytes), or `g` (gigabytes).
+ If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`.
+
+**--sig-proxy**=*true*|*false*
+ Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
+
+**--stop-signal**=*SIGTERM*
+ Signal to stop a container. Default is SIGTERM.
+
+**--stop-timeout**=*10*
+ Timeout (in seconds) to stop a container. Default is 10.
+
+**--storage-opt**=[]
+ Storage driver options per container
+
+ $ kpod create -it --storage-opt size=120G fedora /bin/bash
+
+ This (size) will allow to set the container rootfs size to 120G at creation time.
+ This option is only available for the `devicemapper`, `btrfs`, `overlay2` and `zfs` graph drivers.
+ For the `devicemapper`, `btrfs` and `zfs` storage drivers, user cannot pass a size less than the Default BaseFS Size.
+ For the `overlay2` storage driver, the size option is only available if the backing fs is `xfs` and mounted with the `pquota` mount option.
+ Under these conditions, user can pass any size less then the backing fs size.
+
+**--sysctl**=SYSCTL
+ Configure namespaced kernel parameters at runtime
+
+ IPC Namespace - current sysctls allowed:
+
+ kernel.msgmax, kernel.msgmnb, kernel.msgmni, kernel.sem, kernel.shmall, kernel.shmmax, kernel.shmmni, kernel.shm_rmid_forced
+ Sysctls beginning with fs.mqueue.*
+
+ Note: if you use the --ipc=host option these sysctls will not be allowed.
+
+ Network Namespace - current sysctls allowed:
+ Sysctls beginning with net.*
+
+ Note: if you use the --network=host option these sysctls will not be allowed.
+
+**--tmpfs**=[] Create a tmpfs mount
+
+ Mount a temporary filesystem (`tmpfs`) mount into a container, for example:
+
+ $ kpod run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image
+
+ This command mounts a `tmpfs` at `/tmp` within the container. The supported mount
+options are the same as the Linux default `mount` flags. If you do not specify
+any options, the systems uses the following options:
+`rw,noexec,nosuid,nodev,size=65536k`.
+
+**-t**, **--tty**=*true*|*false*
+ Allocate a pseudo-TTY. The default is *false*.
+
+ When set to true kpod will allocate a pseudo-tty and attach to the standard
+input of the container. This can be used, for example, to run a throwaway
+interactive shell. The default is false.
+
+Note: The **-t** option is incompatible with a redirection of the kpod client
+standard input.
+
+**--ulimit**=[]
+ Ulimit options
+
+**-u**, **--user**=""
+ Sets the username or UID used and optionally the groupname or GID for the specified command.
+
+ The followings examples are all valid:
+ --user [user | user:group | uid | uid:gid | user:gid | uid:group ]
+
+ Without this argument the command will be run as root in the container.
+
+**--userns**=""
+ Set the usernamespace mode for the container when `userns-remap` option is enabled.
+ **host**: use the host usernamespace and enable all privileged options (e.g., `pid=host` or `--privileged`).
+
+**--uts**=*host*
+ Set the UTS mode for the container
+ **host**: use the host's UTS namespace inside the container.
+ Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
+
+**-v**|**--volume**[=*[[HOST-DIR:]CONTAINER-DIR[:OPTIONS]]*]
+ Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, kpod
+ bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the kpod
+ container. If 'HOST-DIR' is omitted, kpod automatically creates the new
+ volume on the host. The `OPTIONS` are a comma delimited list and can be:
+
+ * [rw|ro]
+ * [z|Z]
+ * [`[r]shared`|`[r]slave`|`[r]private`]
+
+The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The `HOST-DIR`
+can be an absolute path or a `name` value. A `name` value must start with an
+alphanumeric character, followed by `a-z0-9`, `_` (underscore), `.` (period) or
+`-` (hyphen). An absolute path starts with a `/` (forward slash).
+
+If you supply a `HOST-DIR` that is an absolute path, kpod bind-mounts to the
+path you specify. If you supply a `name`, kpod creates a named volume by that
+`name`. For example, you can specify either `/foo` or `foo` for a `HOST-DIR`
+value. If you supply the `/foo` value, kpod creates a bind-mount. If you
+supply the `foo` specification, kpod creates a named volume.
+
+You can specify multiple **-v** options to mount one or more mounts to a
+container. To use these same mounts in other containers, specify the
+**--volumes-from** option also.
+
+You can add `:ro` or `:rw` suffix to a volume to mount it read-only or
+read-write mode, respectively. By default, the volumes are mounted read-write.
+See examples.
+
+Labeling systems like SELinux require that proper labels are placed on volume
+content mounted into a container. Without a label, the security system might
+prevent the processes running inside the container from using the content. By
+default, kpod does not change the labels set by the OS.
+
+To change a label in the container context, you can add either of two suffixes
+`:z` or `:Z` to the volume mount. These suffixes tell kpod to relabel file
+objects on the shared volumes. The `z` option tells kpod that two containers
+share the volume content. As a result, kpod labels the content with a shared
+content label. Shared volume labels allow all containers to read/write content.
+The `Z` option tells kpod to label the content with a private unshared label.
+Only the current container can use a private volume.
+
+By default bind mounted volumes are `private`. That means any mounts done
+inside container will not be visible on host and vice-a-versa. One can change
+this behavior by specifying a volume mount propagation property. Making a
+volume `shared` mounts done under that volume inside container will be
+visible on host and vice-a-versa. Making a volume `slave` enables only one
+way mount propagation and that is mounts done on host under that volume
+will be visible inside container but not the other way around.
+
+To control mount propagation property of volume one can use `:[r]shared`,
+`:[r]slave` or `:[r]private` propagation flag. Propagation property can
+be specified only for bind mounted volumes and not for internal volumes or
+named volumes. For mount propagation to work source mount point (mount point
+where source dir is mounted on) has to have right propagation properties. For
+shared volumes, source mount point has to be shared. And for slave volumes,
+source mount has to be either shared or slave.
+
+Use `df <source-dir>` to figure out the source mount and then use
+`findmnt -o TARGET,PROPAGATION <source-mount-dir>` to figure out propagation
+properties of source mount. If `findmnt` utility is not available, then one
+can look at mount entry for source mount point in `/proc/self/mountinfo`. Look
+at `optional fields` and see if any propagaion properties are specified.
+`shared:X` means mount is `shared`, `master:X` means mount is `slave` and if
+nothing is there that means mount is `private`.
+
+To change propagation properties of a mount point use `mount` command. For
+example, if one wants to bind mount source directory `/foo` one can do
+`mount --bind /foo /foo` and `mount --make-private --make-shared /foo`. This
+will convert /foo into a `shared` mount point. Alternatively one can directly
+change propagation properties of source mount. Say `/` is source mount for
+`/foo`, then use `mount --make-shared /` to convert `/` into a `shared` mount.
+
+To disable automatic copying of data from the container path to the volume, use
+the `nocopy` flag. The `nocopy` flag can be set on bind mounts and named volumes.
+
+**--volumes-from**=[]
+ Mount volumes from the specified container(s)
+
+ Mounts already mounted volumes from a source container onto another
+ container. You must supply the source's container-id. To share
+ a volume, use the **--volumes-from** option when running
+ the target container. You can share volumes even if the source container
+ is not running.
+
+ By default, kpod mounts the volumes in the same mode (read-write or
+ read-only) as it is mounted in the source container. Optionally, you
+ can change this by suffixing the container-id with either the `:ro` or
+ `:rw ` keyword.
+
+ If the location of the volume from the source container overlaps with
+ data residing on a target container, then the volume hides
+ that data on the target.
+
+**-w**, **--workdir**=""
+ Working directory inside the container
+
+ The default working directory for running binaries within a container is the root directory (/).
+The image developer can set a different default with the WORKDIR instruction. The operator
+can override the working directory by using the **-w** option.
+
+# EXAMPLES
+
+# HISTORY
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+October 2017, converted from Docker documentation to kpod by Dan Walsh for kpod <dwalsh@redhat.com>
diff --git a/docs/kpod-run.1.md b/docs/kpod-run.1.md
new file mode 100644
index 000000000..b5214c7d8
--- /dev/null
+++ b/docs/kpod-run.1.md
@@ -0,0 +1,847 @@
+% kpod(1) kpod-run - Run a command in a container
+% Dan Walsh
+kpod-run - Run a command in a new container
+
+# SYNOPSIS
+**kpod run** [*options* [...]] IMAGE [COMMAND] [ARG...]
+
+# DESCRIPTION
+
+Run a process in a new container. **kpod run** starts a process with its own
+file system, its own networking, and its own isolated process tree. The IMAGE
+which starts the process may define defaults related to the process that will be
+run in the container, the networking to expose, and more, but **kpod run**
+gives final control to the operator or administrator who starts the container
+from the image. For that reason **kpod run** has more options than any other
+kpod command.
+
+If the IMAGE is not already loaded then **kpod run** will pull the IMAGE, and
+all image dependencies, from the repository in the same way running **kpod
+pull** IMAGE, before it starts the container from that image.
+
+# OPTIONS
+**--add-host**=[]
+ Add a custom host-to-IP mapping (host:ip)
+
+ Add a line to /etc/hosts. The format is hostname:ip. The **--add-host**
+option can be set multiple times.
+
+**-a**, **--attach**=[]
+ Attach to STDIN, STDOUT or STDERR.
+
+ In foreground mode (the default when **-d**
+is not specified), **kpod run** can start the process in the container
+and attach the console to the process's standard input, output, and standard
+error. It can even pretend to be a TTY (this is what most commandline
+executables expect) and pass along signals. The **-a** option can be set for
+each of stdin, stdout, and stderr.
+
+**--blkio-weight**=*0*
+ Block IO weight (relative weight) accepts a weight value between 10 and 1000.
+
+**--blkio-weight-device**=[]
+ Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`).
+
+**--cap-add**=[]
+ Add Linux capabilities
+
+**--cap-drop**=[]
+ Drop Linux capabilities
+
+**--cgroup-parent**=""
+ Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
+
+**--cidfile**=""
+ Write the container ID to the file
+
+**--cpu-count**=*0*
+ Limit the number of CPUs available for execution by the container.
+
+ On Windows Server containers, this is approximated as a percentage of total CPU usage.
+
+ On Windows Server containers, the processor resource controls are mutually exclusive, the order of precedence is CPUCount first, then CPUShares, and CPUPercent last.
+
+**--cpu-period**=*0*
+ Limit the CPU CFS (Completely Fair Scheduler) period
+
+ Limit the container's CPU usage. This flag tell the kernel to restrict the container's CPU usage to the period you specify.
+
+**--cpu-quota**=*0*
+ Limit the CPU CFS (Completely Fair Scheduler) quota
+
+ Limit the container's CPU usage. By default, containers run with the full
+CPU resource. This flag tell the kernel to restrict the container's CPU usage
+to the quota you specify.
+
+**--cpu-rt-period**=0
+ Limit the CPU real-time period in microseconds
+
+ Limit the container's Real Time CPU usage. This flag tell the kernel to restrict the container's Real Time CPU usage to the period you specify.
+
+**--cpu-rt-runtime**=0
+ Limit the CPU real-time runtime in microseconds
+
+ Limit the containers Real Time CPU usage. This flag tells the kernel to limit the amount of time in a given CPU period Real Time tasks may consume. Ex:
+ Period of 1,000,000us and Runtime of 950,000us means that this container could consume 95% of available CPU and leave the remaining 5% to normal priority tasks.
+
+ The sum of all runtimes across containers cannot exceed the amount allotted to the parent cgroup.
+
+**--cpu-shares**=*0*
+ CPU shares (relative weight)
+
+ By default, all containers get the same proportion of CPU cycles. This proportion
+can be modified by changing the container's CPU share weighting relative
+to the weighting of all other running containers.
+
+To modify the proportion from the default of 1024, use the **--cpu-shares**
+flag to set the weighting to 2 or higher.
+
+The proportion will only apply when CPU-intensive processes are running.
+When tasks in one container are idle, other containers can use the
+left-over CPU time. The actual amount of CPU time will vary depending on
+the number of containers running on the system.
+
+For example, consider three containers, one has a cpu-share of 1024 and
+two others have a cpu-share setting of 512. When processes in all three
+containers attempt to use 100% of CPU, the first container would receive
+50% of the total CPU time. If you add a fourth container with a cpu-share
+of 1024, the first container only gets 33% of the CPU. The remaining containers
+receive 16.5%, 16.5% and 33% of the CPU.
+
+On a multi-core system, the shares of CPU time are distributed over all CPU
+cores. Even if a container is limited to less than 100% of CPU time, it can
+use 100% of each individual CPU core.
+
+For example, consider a system with more than three cores. If you start one
+container **{C0}** with **-c=512** running one process, and another container
+**{C1}** with **-c=1024** running two processes, this can result in the following
+division of CPU shares:
+
+ PID container CPU CPU share
+ 100 {C0} 0 100% of CPU0
+ 101 {C1} 1 100% of CPU1
+ 102 {C1} 2 100% of CPU2
+
+**--cpus**=0.0
+ Number of CPUs. The default is *0.0* which means no limit.
+
+**--cpuset-cpus**=""
+ CPUs in which to allow execution (0-3, 0,1)
+
+**--cpuset-mems**=""
+ Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
+
+ If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
+then processes in your container will only use memory from the first
+two memory nodes.
+
+**-d**, **--detach**=*true*|*false*
+ Detached mode: run the container in the background and print the new container ID. The default is *false*.
+
+ At any time you can run **kpod ps** in
+the other shell to view a list of the running containers. You can reattach to a
+detached container with **kpod attach**. If you choose to run a container in
+the detached mode, then you cannot use the **-rm** option.
+
+ When attached in the tty mode, you can detach from the container (and leave it
+running) using a configurable key sequence. The default sequence is `CTRL-p CTRL-q`.
+You configure the key sequence using the **--detach-keys** option or a configuration file.
+See **config-json(5)** for documentation on using a configuration file.
+
+**--detach-keys**=""
+ Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.
+
+**--device**=[]
+ Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
+
+**--device-read-bps**=[]
+ Limit read rate (bytes per second) from a device (e.g. --device-read-bps=/dev/sda:1mb)
+
+**--device-read-iops**=[]
+ Limit read rate (IO per second) from a device (e.g. --device-read-iops=/dev/sda:1000)
+
+**--device-write-bps**=[]
+ Limit write rate (bytes per second) to a device (e.g. --device-write-bps=/dev/sda:1mb)
+
+**--device-write-iops**=[]
+ Limit write rate (IO per second) to a device (e.g. --device-write-iops=/dev/sda:1000)
+
+**--dns**=[]
+ Set custom DNS servers
+
+ This option can be used to override the DNS
+configuration passed to the container. Typically this is necessary when the
+host DNS configuration is invalid for the container (e.g., 127.0.0.1). When this
+is the case the **--dns** flags is necessary for every run.
+
+**--dns-option**=[]
+ Set custom DNS options
+
+**--dns-search**=[]
+ Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
+
+**--entrypoint**=""
+ Overwrite the default ENTRYPOINT of the image
+
+ This option allows you to overwrite the default entrypoint of the image.
+ The ENTRYPOINT of an image is similar to a COMMAND
+because it specifies what executable to run when the container starts, but it is
+(purposely) more difficult to override. The ENTRYPOINT gives a container its
+default nature or behavior, so that when you set an ENTRYPOINT you can run the
+container as if it were that binary, complete with default options, and you can
+pass in more options via the COMMAND. But, sometimes an operator may want to run
+something else inside the container, so you can override the default ENTRYPOINT
+at runtime by using a **--entrypoint** and a string to specify the new
+ENTRYPOINT.
+
+**-e**, **--env**=[]
+ Set environment variables
+
+ This option allows you to specify arbitrary
+environment variables that are available for the process that will be launched
+inside of the container.
+
+**--env-file**=[]
+ Read in a line delimited file of environment variables
+
+**--expose**=[]
+ Expose a port, or a range of ports (e.g. --expose=3300-3310) to set up port redirection
+ on the host system.
+
+**--group-add**=[]
+ Add additional groups to run as
+
+**--hostname**=""
+ Container host name
+
+ Sets the container host name that is available inside the container.
+
+**--help**
+ Print usage statement
+
+**-i**, **--interactive**=*true*|*false*
+ Keep STDIN open even if not attached. The default is *false*.
+
+ When set to true, keep stdin open even if not attached. The default is false.
+
+**--ip**=""
+ Sets the container's interface IPv4 address (e.g. 172.23.0.9)
+
+ It can only be used in conjunction with **--network** for user-defined networks
+
+**--ip6**=""
+ Sets the container's interface IPv6 address (e.g. 2001:db8::1b99)
+
+ It can only be used in conjunction with **--network** for user-defined networks
+
+**--ipc**=""
+ Default is to create a private IPC namespace (POSIX SysV IPC) for the container
+ 'container:<name|id>': reuses another container shared memory, semaphores and message queues
+ 'host': use the host shared memory,semaphores and message queues inside the container. Note: the host mode gives the container full access to local shared memory and is therefore considered insecure.
+
+**--kernel-memory**=""
+ Kernel memory limit (format: `<number>[<unit>]`, where unit = b, k, m or g)
+
+ Constrains the kernel memory available to a container. If a limit of 0
+is specified (not using `--kernel-memory`), the container's kernel memory
+is not limited. If you specify a limit, it may be rounded up to a multiple
+of the operating system's page size and the value can be very large,
+millions of trillions.
+
+**-l**, **--label**=[]
+ Add metadata to a container (e.g., --label com.example.key=value)
+
+**--label-file**=[]
+ Read in a line delimited file of labels
+
+**--link-local-ip**=[]
+ Add one or more link-local IPv4/IPv6 addresses to the container's interface
+
+**--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*"
+ Logging driver for the container. Default is defined by daemon `--log-driver` flag.
+ **Warning**: the `kpod logs` command works only for the `json-file` and
+ `journald` logging drivers.
+
+**--log-opt**=[]
+ Logging driver specific options.
+
+**--mac-address**=""
+ Container MAC address (e.g. 92:d0:c6:0a:29:33)
+
+ Remember that the MAC address in an Ethernet network must be unique.
+The IPv6 link-local address will be based on the device's MAC address
+according to RFC4862.
+
+**-m**, **--memory**=""
+ Memory limit (format: <number>[<unit>], where unit = b, k, m or g)
+
+ Allows you to constrain the memory available to a container. If the host
+supports swap memory, then the **-m** memory setting can be larger than physical
+RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
+not limited. The actual limit may be rounded up to a multiple of the operating
+system's page size (the value would be very large, that's millions of trillions).
+
+**--memory-reservation**=""
+ Memory soft limit (format: <number>[<unit>], where unit = b, k, m or g)
+
+ After setting memory reservation, when the system detects memory contention
+or low memory, containers are forced to restrict their consumption to their
+reservation. So you should always set the value below **--memory**, otherwise the
+hard limit will take precedence. By default, memory reservation will be the same
+as memory limit.
+
+**--memory-swap**="LIMIT"
+ A limit value equal to memory plus swap. Must be used with the **-m**
+(**--memory**) flag. The swap `LIMIT` should always be larger than **-m**
+(**--memory**) value. By default, the swap `LIMIT` will be set to double
+the value of --memory.
+
+ The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes),
+`k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a
+unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
+
+**--memory-swappiness**=""
+ Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
+
+**--name**=""
+ Assign a name to the container
+
+ The operator can identify a container in three ways:
+ UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
+ UUID short identifier (“f78375b1c487”)
+ Name (“jonah”)
+
+ kpod generates a UUID for each container, and if a name is not assigned
+to the container with **--name** then the daemon will also generate a random
+string name. The name is useful when defining links (see **--link**) (or any
+other place you need to identify a container). This works for both background
+and foreground containers.
+
+**--network**="*bridge*"
+ Set the Network mode for the container
+ 'bridge': create a network stack on the default bridge
+ 'none': no networking
+ 'container:<name|id>': reuse another container's network stack
+ 'host': use the kpod host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
+ '<network-name>|<network-id>': connect to a user-defined network
+
+**--network-alias**=[]
+ Add network-scoped alias for the container
+
+**--oom-kill-disable**=*true*|*false*
+ Whether to disable OOM Killer for the container or not.
+
+**--oom-score-adj**=""
+ Tune the host's OOM preferences for containers (accepts -1000 to 1000)
+
+**--pid**=""
+ Set the PID mode for the container
+ Default is to create a private PID namespace for the container
+ 'container:<name|id>': join another container's PID namespace
+ 'host': use the host's PID namespace for the container. Note: the host mode gives the container full access to local PID and is therefore considered insecure.
+
+**--pids-limit**=""
+ Tune the container's pids limit. Set `-1` to have unlimited pids for the container.
+
+**--pod**=""
+ Run container in an existing pod
+
+**--privileged**=*true*|*false*
+ Give extended privileges to this container. The default is *false*.
+
+ By default, kpod containers are
+“unprivileged” (=false) and cannot, for example, modify parts of the kernel.
+This is because by default a container is not allowed to access any devices.
+A “privileged” container is given access to all devices.
+
+ When the operator executes **kpod run --privileged**, kpod enables access
+to all devices on the host as well as set turn off most of the security messurs
+protecting the host from the container.
+
+**-p**, **--publish**=[]
+ Publish a container's port, or range of ports, to the host
+
+ Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort`
+Both hostPort and containerPort can be specified as a range of ports.
+When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range.
+(e.g., `kpod run -p 1234-1236:1222-1224 --name thisWorks -t busybox`
+but not `kpod run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`)
+With ip: `kpod run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
+Use `kpod port` to see the actual mapping: `kpod port CONTAINER $CONTAINERPORT`
+
+**-P**, **--publish-all**=*true*|*false*
+ Publish all exposed ports to random ports on the host interfaces. The default is *false*.
+
+ When set to true publish all exposed ports to the host interfaces. The
+default is false. If the operator uses -P (or -p) then kpod will make the
+exposed port accessible on the host and the ports will be available to any
+client that can reach the host. When using -P, kpod will bind any exposed
+port to a random port on the host within an *ephemeral port range* defined by
+`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
+ports and the exposed ports, use `kpod port`.
+
+**--read-only**=*true*|*false*
+ Mount the container's root filesystem as read only.
+
+ By default a container will have its root filesystem writable allowing processes
+to write files anywhere. By specifying the `--read-only` flag the container will have
+its root filesystem mounted as read only prohibiting any writes.
+
+**--rm**=*true*|*false*
+ Automatically remove the container when it exits. The default is *false*.
+ `--rm` flag can work together with `-d`, and auto-removal will be done on daemon side. Note that it's
+incompatible with any restart policy other than `none`.
+
+**--security-opt**=[]
+ Security Options
+
+ "label=user:USER" : Set the label user for the container
+ "label=role:ROLE" : Set the label role for the container
+ "label=type:TYPE" : Set the label type for the container
+ "label=level:LEVEL" : Set the label level for the container
+ "label=disable" : Turn off label confinement for the container
+ "no-new-privileges" : Disable container processes from gaining additional privileges
+
+ "seccomp=unconfined" : Turn off seccomp confinement for the container
+ "seccomp=profile.json : White listed syscalls seccomp Json file to be used as a seccomp filter
+
+ "apparmor=unconfined" : Turn off apparmor confinement for the container
+ "apparmor=your-profile" : Set the apparmor confinement profile for the container
+
+**--shm-size**=""
+ Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`.
+ Unit is optional and can be `b` (bytes), `k` (kilobytes), `m`(megabytes), or `g` (gigabytes).
+ If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`.
+
+**--sig-proxy**=*true*|*false*
+ Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
+
+**--stop-signal**=*SIGTERM*
+ Signal to stop a container. Default is SIGTERM.
+
+**--stop-timeout**=*10*
+ Timeout (in seconds) to stop a container. Default is 10.
+
+**--storage-opt**=[]
+ Storage driver options per container
+
+ $ kpod run -it --storage-opt size=120G fedora /bin/bash
+
+ This (size) will allow to set the container rootfs size to 120G at creation time.
+ This option is only available for the `devicemapper`, `btrfs`, `overlay2` and `zfs` graph drivers.
+ For the `devicemapper`, `btrfs` and `zfs` storage drivers, user cannot pass a size less than the Default BaseFS Size.
+ For the `overlay2` storage driver, the size option is only available if the backing fs is `xfs` and mounted with the `pquota` mount option.
+ Under these conditions, user can pass any size less then the backing fs size.
+
+**--sysctl**=SYSCTL
+ Configure namespaced kernel parameters at runtime
+
+ IPC Namespace - current sysctls allowed:
+
+ kernel.msgmax, kernel.msgmnb, kernel.msgmni, kernel.sem, kernel.shmall, kernel.shmmax, kernel.shmmni, kernel.shm_rmid_forced
+ Sysctls beginning with fs.mqueue.*
+
+ Note: if you use the `--ipc=host` option these sysctls will not be allowed.
+
+ Network Namespace - current sysctls allowed:
+ Sysctls beginning with net.*
+
+ Note: if you use the `--network=host` option these sysctls will not be allowed.
+
+**--tmpfs**=[] Create a tmpfs mount
+
+ Mount a temporary filesystem (`tmpfs`) mount into a container, for example:
+
+ $ kpod run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image
+
+ This command mounts a `tmpfs` at `/tmp` within the container. The supported mount
+options are the same as the Linux default `mount` flags. If you do not specify
+any options, the systems uses the following options:
+`rw,noexec,nosuid,nodev,size=65536k`.
+
+**-t**, **--tty**=*true*|*false*
+ Allocate a pseudo-TTY. The default is *false*.
+
+ When set to true kpod will allocate a pseudo-tty and attach to the standard
+input of the container. This can be used, for example, to run a throwaway
+interactive shell. The default is false.
+
+Note: The **-t** option is incompatible with a redirection of the kpod client
+standard input.
+
+**--ulimit**=[]
+ Ulimit options
+
+**-u**, **--user**=""
+ Sets the username or UID used and optionally the groupname or GID for the specified command.
+
+ The followings examples are all valid:
+ --user [user | user:group | uid | uid:gid | user:gid | uid:group ]
+
+ Without this argument the command will be run as root in the container.
+
+**--userns**=""
+ Set the usernamespace mode for the container when `userns-remap` option is enabled.
+ **host**: use the host usernamespace and enable all privileged options (e.g., `pid=host` or `--privileged`).
+
+**--uts**=*host*
+ Set the UTS mode for the container
+ **host**: use the host's UTS namespace inside the container.
+ Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
+
+**-v**|**--volume**[=*[[HOST-DIR:]CONTAINER-DIR[:OPTIONS]]*]
+ Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, kpod
+ bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the kpod
+ container. If 'HOST-DIR' is omitted, kpod automatically creates the new
+ volume on the host. The `OPTIONS` are a comma delimited list and can be:
+
+ * [rw|ro]
+ * [z|Z]
+ * [`[r]shared`|`[r]slave`|`[r]private`]
+ * [nocopy]
+
+The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The `HOST-DIR`
+can be an absolute path or a `name` value. A `name` value must start with an
+alphanumeric character, followed by `a-z0-9`, `_` (underscore), `.` (period) or
+`-` (hyphen). An absolute path starts with a `/` (forward slash).
+
+If you supply a `HOST-DIR` that is an absolute path, kpod bind-mounts to the
+path you specify. If you supply a `name`, kpod creates a named volume by that
+`name`. For example, you can specify either `/foo` or `foo` for a `HOST-DIR`
+value. If you supply the `/foo` value, kpod creates a bind-mount. If you
+supply the `foo` specification, kpod creates a named volume.
+
+You can specify multiple **-v** options to mount one or more mounts to a
+container. To use these same mounts in other containers, specify the
+**--volumes-from** option also.
+
+You can add `:ro` or `:rw` suffix to a volume to mount it read-only or
+read-write mode, respectively. By default, the volumes are mounted read-write.
+See examples.
+
+Labeling systems like SELinux require that proper labels are placed on volume
+content mounted into a container. Without a label, the security system might
+prevent the processes running inside the container from using the content. By
+default, kpod does not change the labels set by the OS.
+
+To change a label in the container context, you can add either of two suffixes
+`:z` or `:Z` to the volume mount. These suffixes tell kpod to relabel file
+objects on the shared volumes. The `z` option tells kpod that two containers
+share the volume content. As a result, kpod labels the content with a shared
+content label. Shared volume labels allow all containers to read/write content.
+The `Z` option tells kpod to label the content with a private unshared label.
+Only the current container can use a private volume.
+
+By default bind mounted volumes are `private`. That means any mounts done
+inside container will not be visible on host and vice-a-versa. One can change
+this behavior by specifying a volume mount propagation property. Making a
+volume `shared` mounts done under that volume inside container will be
+visible on host and vice-a-versa. Making a volume `slave` enables only one
+way mount propagation and that is mounts done on host under that volume
+will be visible inside container but not the other way around.
+
+To control mount propagation property of volume one can use `:[r]shared`,
+`:[r]slave` or `:[r]private` propagation flag. Propagation property can
+be specified only for bind mounted volumes and not for internal volumes or
+named volumes. For mount propagation to work source mount point (mount point
+where source dir is mounted on) has to have right propagation properties. For
+shared volumes, source mount point has to be shared. And for slave volumes,
+source mount has to be either shared or slave.
+
+Use `df <source-dir>` to figure out the source mount and then use
+`findmnt -o TARGET,PROPAGATION <source-mount-dir>` to figure out propagation
+properties of source mount. If `findmnt` utility is not available, then one
+can look at mount entry for source mount point in `/proc/self/mountinfo`. Look
+at `optional fields` and see if any propagaion properties are specified.
+`shared:X` means mount is `shared`, `master:X` means mount is `slave` and if
+nothing is there that means mount is `private`.
+
+To change propagation properties of a mount point use `mount` command. For
+example, if one wants to bind mount source directory `/foo` one can do
+`mount --bind /foo /foo` and `mount --make-private --make-shared /foo`. This
+will convert /foo into a `shared` mount point. Alternatively one can directly
+change propagation properties of source mount. Say `/` is source mount for
+`/foo`, then use `mount --make-shared /` to convert `/` into a `shared` mount.
+
+To disable automatic copying of data from the container path to the volume, use
+the `nocopy` flag. The `nocopy` flag can be set on bind mounts and named volumes.
+
+**--volumes-from**=[]
+ Mount volumes from the specified container(s)
+
+ Mounts already mounted volumes from a source container onto another
+ container. You must supply the source's container-id. To share
+ a volume, use the **--volumes-from** option when running
+ the target container. You can share volumes even if the source container
+ is not running.
+
+ By default, kpod mounts the volumes in the same mode (read-write or
+ read-only) as it is mounted in the source container. Optionally, you
+ can change this by suffixing the container-id with either the `:ro` or
+ `:rw ` keyword.
+
+ If the location of the volume from the source container overlaps with
+ data residing on a target container, then the volume hides
+ that data on the target.
+
+**-w**, **--workdir**=""
+ Working directory inside the container
+
+ The default working directory for running binaries within a container is the root directory (/).
+The image developer can set a different default with the WORKDIR instruction. The operator
+can override the working directory by using the **-w** option.
+
+# Exit Status
+
+The exit code from `kpod run` gives information about why the container
+failed to run or why it exited. When `kpod run` exits with a non-zero code,
+the exit codes follow the `chroot` standard, see below:
+
+**_125_** if the error is with kpod **_itself_**
+
+ $ kpod run --foo busybox; echo $?
+ # flag provided but not defined: --foo
+ See 'kpod run --help'.
+ 125
+
+**_126_** if the **_contained command_** cannot be invoked
+
+ $ kpod run busybox /etc; echo $?
+ # exec: "/etc": permission denied
+ kpod: Error response from daemon: Contained command could not be invoked
+ 126
+
+**_127_** if the **_contained command_** cannot be found
+
+ $ kpod run busybox foo; echo $?
+ # exec: "foo": executable file not found in $PATH
+ kpod: Error response from daemon: Contained command not found or does not exist
+ 127
+
+**_Exit code_** of **_contained command_** otherwise
+
+ $ kpod run busybox /bin/sh -c 'exit 3'
+ # 3
+
+# EXAMPLES
+
+## Running container in read-only mode
+
+During container image development, containers often need to write to the image
+content. Installing packages into /usr, for example. In production,
+applications seldom need to write to the image. Container applications write
+to volumes if they need to write to file systems at all. Applications can be
+made more secure by running them in read-only mode using the - -read-only switch.
+This protects the containers image from modification. Read only containers may
+still need to write temporary data. The best way to handle this is to mount
+tmpfs directories on /run and /tmp.
+
+ # kpod run --read-only --tmpfs /run --tmpfs /tmp -i -t fedora /bin/bash
+
+## Exposing log messages from the container to the host's log
+
+If you want messages that are logged in your container to show up in the host's
+syslog/journal then you should bind mount the /dev/log directory as follows.
+
+ # kpod run -v /dev/log:/dev/log -i -t fedora /bin/bash
+
+From inside the container you can test this by sending a message to the log.
+
+ (bash)# logger "Hello from my container"
+
+Then exit and check the journal.
+
+ # exit
+
+ # journalctl -b | grep Hello
+
+This should list the message sent to logger.
+
+## Attaching to one or more from STDIN, STDOUT, STDERR
+
+If you do not specify -a then kpod will attach everything (stdin,stdout,stderr)
+. You can specify to which of the three standard streams (stdin, stdout, stderr)
+you'd like to connect instead, as in:
+
+ # kpod run -a stdin -a stdout -i -t fedora /bin/bash
+
+## Sharing IPC between containers
+
+Using shm_server.c available here: https://www.cs.cf.ac.uk/Dave/C/node27.html
+
+Testing `--ipc=host` mode:
+
+Host shows a shared memory segment with 7 pids attached, happens to be from httpd:
+
+```
+ $ sudo ipcs -m
+
+ ------ Shared Memory Segments --------
+ key shmid owner perms bytes nattch status
+ 0x01128e25 0 root 600 1000 7
+```
+
+Now run a regular container, and it correctly does NOT see the shared memory segment from the host:
+
+```
+ $ kpod run -it shm ipcs -m
+
+ ------ Shared Memory Segments --------
+ key shmid owner perms bytes nattch status
+```
+
+Run a container with the new `--ipc=host` option, and it now sees the shared memory segment from the host httpd:
+
+ ```
+ $ kpod run -it --ipc=host shm ipcs -m
+
+ ------ Shared Memory Segments --------
+ key shmid owner perms bytes nattch status
+ 0x01128e25 0 root 600 1000 7
+```
+Testing `--ipc=container:CONTAINERID` mode:
+
+Start a container with a program to create a shared memory segment:
+```
+ $ kpod run -it shm bash
+ $ sudo shm/shm_server &
+ $ sudo ipcs -m
+
+ ------ Shared Memory Segments --------
+ key shmid owner perms bytes nattch status
+ 0x0000162e 0 root 666 27 1
+```
+Create a 2nd container correctly shows no shared memory segment from 1st container:
+```
+ $ kpod run shm ipcs -m
+
+ ------ Shared Memory Segments --------
+ key shmid owner perms bytes nattch status
+```
+
+Create a 3rd container using the new --ipc=container:CONTAINERID option, now it shows the shared memory segment from the first:
+
+```
+ $ kpod run -it --ipc=container:ed735b2264ac shm ipcs -m
+ $ sudo ipcs -m
+
+ ------ Shared Memory Segments --------
+ key shmid owner perms bytes nattch status
+ 0x0000162e 0 root 666 27 1
+```
+
+## Mapping Ports for External Usage
+
+The exposed port of an application can be mapped to a host port using the **-p**
+flag. For example, an httpd port 80 can be mapped to the host port 8080 using the
+following:
+
+ # kpod run -p 8080:80 -d -i -t fedora/httpd
+
+## Creating and Mounting a Data Volume Container
+
+Many applications require the sharing of persistent data across several
+containers. kpod allows you to create a Data Volume Container that other
+containers can mount from. For example, create a named container that contains
+directories /var/volume1 and /tmp/volume2. The image will need to contain these
+directories so a couple of RUN mkdir instructions might be required for you
+fedora-data image:
+
+ # kpod run --name=data -v /var/volume1 -v /tmp/volume2 -i -t fedora-data true
+ # kpod run --volumes-from=data --name=fedora-container1 -i -t fedora bash
+
+Multiple --volumes-from parameters will bring together multiple data volumes from
+multiple containers. And it's possible to mount the volumes that came from the
+DATA container in yet another container via the fedora-container1 intermediary
+container, allowing to abstract the actual data source from users of that data:
+
+ # kpod run --volumes-from=fedora-container1 --name=fedora-container2 -i -t fedora bash
+
+## Mounting External Volumes
+
+To mount a host directory as a container volume, specify the absolute path to
+the directory and the absolute path for the container directory separated by a
+colon:
+
+ # kpod run -v /var/db:/data1 -i -t fedora bash
+
+When using SELinux, be aware that the host has no knowledge of container SELinux
+policy. Therefore, in the above example, if SELinux policy is enforced, the
+`/var/db` directory is not writable to the container. A "Permission Denied"
+message will occur and an avc: message in the host's syslog.
+
+
+To work around this, at time of writing this man page, the following command
+needs to be run in order for the proper SELinux policy type label to be attached
+to the host directory:
+
+ # chcon -Rt svirt_sandbox_file_t /var/db
+
+
+Now, writing to the /data1 volume in the container will be allowed and the
+changes will also be reflected on the host in /var/db.
+
+## Using alternative security labeling
+
+You can override the default labeling scheme for each container by specifying
+the `--security-opt` flag. For example, you can specify the MCS/MLS level, a
+requirement for MLS systems. Specifying the level in the following command
+allows you to share the same content between containers.
+
+ # kpod run --security-opt label=level:s0:c100,c200 -i -t fedora bash
+
+An MLS example might be:
+
+ # kpod run --security-opt label=level:TopSecret -i -t rhel7 bash
+
+To disable the security labeling for this container versus running with the
+`--permissive` flag, use the following command:
+
+ # kpod run --security-opt label=disable -i -t fedora bash
+
+If you want a tighter security policy on the processes within a container,
+you can specify an alternate type for the container. You could run a container
+that is only allowed to listen on Apache ports by executing the following
+command:
+
+ # kpod run --security-opt label=type:svirt_apache_t -i -t centos bash
+
+Note:
+
+You would have to write policy defining a `svirt_apache_t` type.
+
+## Setting device weight
+
+If you want to set `/dev/sda` device weight to `200`, you can specify the device
+weight by `--blkio-weight-device` flag. Use the following command:
+
+ # kpod run -it --blkio-weight-device "/dev/sda:200" ubuntu
+
+```
+$ kpod run -d busybox top
+```
+
+## Setting Namespaced Kernel Parameters (Sysctls)
+
+The `--sysctl` sets namespaced kernel parameters (sysctls) in the
+container. For example, to turn on IP forwarding in the containers
+network namespace, run this command:
+
+ $ kpod run --sysctl net.ipv4.ip_forward=1 someimage
+
+Note:
+
+Not all sysctls are namespaced. kpod does not support changing sysctls
+inside of a container that also modify the host system. As the kernel
+evolves we expect to see more sysctls become namespaced.
+
+See the definition of the `--sysctl` option above for the current list of
+supported sysctls.
+
+# HISTORY
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
+based on docker.com source material and internal work.
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+November 2015, updated by Sally O'Malley <somalley@redhat.com>
+October 2017, converted from Docker documentation to kpod by Dan Walsh for kpod <dwalsh@redhat.com>
diff --git a/docs/kpod.1.md b/docs/kpod.1.md
index 27de1ca55..408ad3877 100644
--- a/docs/kpod.1.md
+++ b/docs/kpod.1.md
@@ -49,6 +49,9 @@ has the capability to debug pods/images created by crio.
## COMMANDS
+### create
+create a new container
+
### diff
Inspect changes on a container or image's filesystem
@@ -106,6 +109,9 @@ Remove one or more containers
### rmi
Removes one or more locally stored images
+### run
+Run a command in a new container
+
### save
Save an image to docker-archive or oci
diff --git a/libpod/container.go b/libpod/container.go
index 1f5be9477..50fe18939 100644
--- a/libpod/container.go
+++ b/libpod/container.go
@@ -15,6 +15,9 @@ import (
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/ulule/deepcopier"
+ "github.com/docker/docker/pkg/term"
+ "k8s.io/client-go/tools/remotecommand"
+
)
// ContainerState represents the current state of a container
@@ -391,8 +394,32 @@ func (c *Container) Exec(cmd []string, tty bool, stdin bool) (string, error) {
// Attach attaches to a container
// Returns fully qualified URL of streaming server for the container
-func (c *Container) Attach(stdin, tty bool) (string, error) {
- return "", ErrNotImplemented
+func (c *Container) Attach(noStdin bool, keys string) error {
+ // Check the validity of the provided keys first
+ var err error
+ detachKeys := []byte{}
+ if len(keys) > 0 {
+ detachKeys, err = term.ToBytes(keys)
+ if err != nil {
+ return errors.Wrapf(err, "invalid detach keys")
+ }
+ }
+ cStatus := c.state.State
+
+ if !(cStatus == ContainerStateRunning || cStatus == ContainerStateCreated) {
+ return errors.Errorf("%s is not created or running", c.Name())
+ }
+ resize := make(chan remotecommand.TerminalSize)
+ defer close(resize)
+ err = c.attachContainerSocket(resize, noStdin, detachKeys)
+ if err != nil {
+ return err
+ }
+ // TODO
+ // Re-enable this when mheon is done wth it
+ //c.ContainerStateToDisk(c)
+
+ return nil
}
// Mount mounts a container's filesystem on the host
diff --git a/libpod/container_attach.go b/libpod/container_attach.go
new file mode 100644
index 000000000..b2a407027
--- /dev/null
+++ b/libpod/container_attach.go
@@ -0,0 +1,142 @@
+package libpod
+
+import (
+ "fmt"
+ "io"
+ "net"
+ "os"
+ "path/filepath"
+ "strconv"
+
+ "github.com/docker/docker/pkg/term"
+ "github.com/kubernetes-incubator/cri-o/utils"
+ "github.com/pkg/errors"
+ "github.com/sirupsen/logrus"
+ "golang.org/x/sys/unix"
+ "k8s.io/client-go/tools/remotecommand"
+ kubecontainer "k8s.io/kubernetes/pkg/kubelet/container"
+)
+
+/* Sync with stdpipe_t in conmon.c */
+const (
+ AttachPipeStdin = 1
+ AttachPipeStdout = 2
+ AttachPipeStderr = 3
+)
+
+// attachContainerSocket connects to the container's attach socket and deals with the IO
+func (c *Container) attachContainerSocket(resize <-chan remotecommand.TerminalSize, noStdIn bool, detachKeys []byte) error {
+ inputStream := os.Stdin
+ outputStream := os.Stdout
+ errorStream := os.Stderr
+ defer inputStream.Close()
+ tty, err := strconv.ParseBool(c.runningSpec.Annotations["io.kubernetes.cri-o.TTY"])
+ if err != nil {
+ return errors.Wrapf(err, "unable to parse annotations in %s", c.ID)
+ }
+ if !tty {
+ return errors.Errorf("no tty available for %s", c.ID())
+ }
+
+ oldTermState, err := term.SaveState(inputStream.Fd())
+ if err != nil {
+ return errors.Wrapf(err, "unable to save terminal state")
+ }
+
+ defer term.RestoreTerminal(inputStream.Fd(), oldTermState)
+
+ // Put both input and output into raw
+ if !noStdIn {
+ term.SetRawTerminal(inputStream.Fd())
+ }
+
+ controlPath := filepath.Join(c.state.RunDir, "ctl")
+ controlFile, err := os.OpenFile(controlPath, unix.O_WRONLY, 0)
+ if err != nil {
+ return errors.Wrapf(err, "failed to open container ctl file: %v")
+ }
+
+ kubecontainer.HandleResizing(resize, func(size remotecommand.TerminalSize) {
+ logrus.Debugf("Received a resize event: %+v", size)
+ _, err := fmt.Fprintf(controlFile, "%d %d %d\n", 1, size.Height, size.Width)
+ if err != nil {
+ logrus.Warnf("Failed to write to control file to resize terminal: %v", err)
+ }
+ })
+ logrus.Debug("connecting to socket ", c.attachSocketPath())
+
+ conn, err := net.DialUnix("unixpacket", nil, &net.UnixAddr{Name: c.attachSocketPath(), Net: "unixpacket"})
+ if err != nil {
+ return errors.Wrapf(err, "failed to connect to container's attach socket: %v")
+ }
+ defer conn.Close()
+
+ receiveStdoutError := make(chan error)
+ if outputStream != nil || errorStream != nil {
+ go func() {
+ receiveStdoutError <- redirectResponseToOutputStreams(outputStream, errorStream, conn)
+ }()
+ }
+
+ stdinDone := make(chan error)
+ go func() {
+ var err error
+ if inputStream != nil && !noStdIn {
+ _, err = utils.CopyDetachable(conn, inputStream, detachKeys)
+ conn.CloseWrite()
+ }
+ stdinDone <- err
+ }()
+
+ select {
+ case err := <-receiveStdoutError:
+ return err
+ case err := <-stdinDone:
+ if _, ok := err.(utils.DetachError); ok {
+ return nil
+ }
+ if outputStream != nil || errorStream != nil {
+ return <-receiveStdoutError
+ }
+ }
+ return nil
+}
+
+func redirectResponseToOutputStreams(outputStream, errorStream io.Writer, conn io.Reader) error {
+ var err error
+ buf := make([]byte, 8192+1) /* Sync with conmon STDIO_BUF_SIZE */
+ for {
+ nr, er := conn.Read(buf)
+ if nr > 0 {
+ var dst io.Writer
+ switch buf[0] {
+ case AttachPipeStdout:
+ dst = outputStream
+ case AttachPipeStderr:
+ dst = errorStream
+ default:
+ logrus.Infof("Received unexpected attach type %+d", buf[0])
+ }
+
+ if dst != nil {
+ nw, ew := dst.Write(buf[1:nr])
+ if ew != nil {
+ err = ew
+ break
+ }
+ if nr != nw+1 {
+ err = io.ErrShortWrite
+ break
+ }
+ }
+ }
+ if er == io.EOF {
+ break
+ }
+ if er != nil {
+ err = er
+ break
+ }
+ }
+ return err
+}
diff --git a/libpod/runtime_ctr.go b/libpod/runtime_ctr.go
index 45990d2db..a1351e1d7 100644
--- a/libpod/runtime_ctr.go
+++ b/libpod/runtime_ctr.go
@@ -22,7 +22,6 @@ type ContainerFilter func(*Container) bool
func (r *Runtime) NewContainer(spec *spec.Spec, options ...CtrCreateOption) (ctr *Container, err error) {
r.lock.Lock()
defer r.lock.Unlock()
-
if !r.valid {
return nil, ErrRuntimeStopped
}
diff --git a/libpod/runtime_img.go b/libpod/runtime_img.go
index 278f0c186..a058380a1 100644
--- a/libpod/runtime_img.go
+++ b/libpod/runtime_img.go
@@ -4,6 +4,7 @@ import (
"encoding/json"
"fmt"
"io"
+ "net"
"os"
"strings"
"syscall"
@@ -46,6 +47,8 @@ var (
// DirTransport is the transport for pushing and pulling
// images to and from a directory
DirTransport = "dir"
+ // TransportNames are the supported transports in string form
+ TransportNames = [...]string{DefaultRegistry, DockerArchive, OCIArchive, "ostree:", "dir:"}
)
// CopyOptions contains the options given when pushing or pulling images
@@ -94,6 +97,262 @@ type imageDecomposeStruct struct {
transport string
}
+func (k *Image) assembleFqName() string {
+ return fmt.Sprintf("%s/%s:%s", k.Registry, k.ImageName, k.Tag)
+}
+
+func (k *Image) assembleFqNameTransport() string {
+ return fmt.Sprintf("%s%s/%s:%s", k.Transport, k.Registry, k.ImageName, k.Tag)
+}
+
+//Image describes basic attributes of an image
+type Image struct {
+ Name string
+ ID string
+ fqname string
+ hasImageLocal bool
+ runtime *Runtime
+ Registry string
+ ImageName string
+ Tag string
+ HasRegistry bool
+ Transport string
+ beenDecomposed bool
+ PullName string
+}
+
+// NewImage creates a new image object based on its name
+func (r *Runtime) NewImage(name string) Image {
+ return Image{
+ Name: name,
+ runtime: r,
+ }
+}
+
+// GetImageID returns the image ID of the image
+func (k *Image) GetImageID() (string, error) {
+ if k.ID != "" {
+ return k.ID, nil
+ }
+ image, _ := k.GetFQName()
+ img, err := k.runtime.GetImage(image)
+ if err != nil {
+ return "", err
+ }
+ return img.ID, nil
+}
+
+// GetFQName returns the fully qualified image name if it can be determined
+func (k *Image) GetFQName() (string, error) {
+ // Check if the fqname has already been found
+ if k.fqname != "" {
+ return k.fqname, nil
+ }
+ if err := k.Decompose(); err != nil {
+ return "", err
+ }
+ k.fqname = k.assembleFqName()
+ return k.fqname, nil
+}
+
+func (k *Image) findImageOnRegistry() error {
+ searchRegistries, err := GetRegistries()
+
+ if err != nil {
+ return errors.Wrapf(err, " the image name '%s' is incomplete.", k.Name)
+ }
+
+ for _, searchRegistry := range searchRegistries {
+ k.Registry = searchRegistry
+ err = k.GetManifest()
+ if err == nil {
+ k.fqname = k.assembleFqName()
+ return nil
+
+ }
+ }
+ return errors.Errorf("unable to find image on any configured registries")
+
+}
+
+// GetManifest tries to GET an images manifest, returns nil on success and err on failure
+func (k *Image) GetManifest() error {
+ pullRef, err := alltransports.ParseImageName(k.assembleFqNameTransport())
+ if err != nil {
+ return errors.Errorf("unable to parse1 '%s'", k.assembleFqName())
+ }
+ imageSource, err := pullRef.NewImageSource(nil)
+ if err != nil {
+ return errors.Wrapf(err, "unable to create new image source")
+ }
+ _, _, err = imageSource.GetManifest()
+ if err == nil {
+ return nil
+ }
+ return err
+}
+
+//Decompose breaks up an image name into its parts
+func (k *Image) Decompose() error {
+ if k.beenDecomposed {
+ return nil
+ }
+ k.beenDecomposed = true
+ k.Transport = "docker://"
+ decomposeName := k.Name
+ for _, transport := range TransportNames {
+ if strings.HasPrefix(k.Name, transport) {
+ k.Transport = transport
+ decomposeName = strings.Replace(k.Name, transport, "", -1)
+ break
+ }
+ }
+ if k.Transport == "dir:" {
+ return nil
+ }
+ var imageError = fmt.Sprintf("unable to parse '%s'\n", decomposeName)
+ imgRef, err := reference.Parse(decomposeName)
+ if err != nil {
+ return errors.Wrapf(err, imageError)
+ }
+ tagged, isTagged := imgRef.(reference.NamedTagged)
+ k.Tag = "latest"
+ if isTagged {
+ k.Tag = tagged.Tag()
+ }
+ k.HasRegistry = true
+ registry := reference.Domain(imgRef.(reference.Named))
+ if registry == "" {
+ k.HasRegistry = false
+ }
+ k.ImageName = reference.Path(imgRef.(reference.Named))
+
+ // account for image names with directories in them like
+ // umohnani/get-started:part1
+ if k.HasRegistry {
+ k.Registry = registry
+ k.fqname = k.assembleFqName()
+ k.PullName = k.assembleFqName()
+
+ registries, err := getRegistries()
+ if err != nil {
+ return nil
+ }
+ if StringInSlice(k.Registry, registries) {
+ return nil
+ }
+ // We need to check if the registry name is legit
+ _, err = net.LookupAddr(k.Registry)
+ if err == nil {
+ return nil
+ }
+ // Combine the Registry and Image Name together and blank out the Registry Name
+ k.ImageName = fmt.Sprintf("%s/%s", k.Registry, k.ImageName)
+ k.Registry = ""
+
+ }
+ // No Registry means we check the globals registries configuration file
+ // and assemble a list of candidate sources to try
+ //searchRegistries, err := GetRegistries()
+ err = k.findImageOnRegistry()
+ k.PullName = k.assembleFqName()
+ if err != nil {
+ return errors.Wrapf(err, " the image name '%s' is incomplete.", k.Name)
+ }
+ return nil
+}
+
+// HasImageLocal returns a bool true if the image is already pulled
+func (k *Image) HasImageLocal() bool {
+ _, err := k.runtime.GetImage(k.Name)
+ if err == nil {
+ return true
+ }
+ fqname, _ := k.GetFQName()
+
+ _, err = k.runtime.GetImage(fqname)
+ if err == nil {
+ return true
+ }
+ return false
+}
+
+// HasLatest determines if we have the latest image local
+func (k *Image) HasLatest() (bool, error) {
+ if !k.HasImageLocal() {
+ return false, nil
+ }
+ fqname, err := k.GetFQName()
+ if err != nil {
+ return false, err
+ }
+ pullRef, err := alltransports.ParseImageName(fqname)
+ if err != nil {
+ return false, err
+ }
+ _, _, err = pullRef.(types.ImageSource).GetManifest()
+ if err != nil {
+ return false, err
+ }
+ return false, nil
+}
+
+// Pull is a wrapper function to pull and image
+func (k *Image) Pull() error {
+ // If the image hasn't been decomposed yet
+ if !k.beenDecomposed {
+ err := k.Decompose()
+ if err != nil {
+ return err
+ }
+ }
+ k.runtime.PullImage(k.PullName, CopyOptions{Writer: os.Stdout, SignaturePolicyPath: k.runtime.config.SignaturePolicyPath})
+ return nil
+}
+
+// GetRegistries gets the searchable registries from the global registration file.
+func GetRegistries() ([]string, error) {
+ registryConfigPath := ""
+ envOverride := os.Getenv("REGISTRIES_CONFIG_PATH")
+ if len(envOverride) > 0 {
+ registryConfigPath = envOverride
+ }
+ searchRegistries, err := sysregistries.GetRegistries(&types.SystemContext{SystemRegistriesConfPath: registryConfigPath})
+ if err != nil {
+ return nil, errors.Errorf("unable to parse the registries.conf file")
+ }
+ return searchRegistries, nil
+}
+
+// GetInsecureRegistries obtains the list of inseure registries from the global registration file.
+func GetInsecureRegistries() ([]string, error) {
+ registryConfigPath := ""
+ envOverride := os.Getenv("REGISTRIES_CONFIG_PATH")
+ if len(envOverride) > 0 {
+ registryConfigPath = envOverride
+ }
+ registries, err := sysregistries.GetInsecureRegistries(&types.SystemContext{SystemRegistriesConfPath: registryConfigPath})
+ if err != nil {
+ return nil, errors.Errorf("unable to parse the registries.conf file")
+ }
+ return registries, nil
+}
+
+// getRegistries returns both searchable and insecure registries from the global conf file.
+func getRegistries() ([]string, error) {
+ var r []string
+ registries, err := GetRegistries()
+ if err != nil {
+ return r, err
+ }
+ insecureRegistries, err := GetInsecureRegistries()
+ if err != nil {
+ return r, err
+ }
+ r = append(registries, insecureRegistries...)
+ return r, nil
+}
+
// ImageFilter is a function to determine whether an image is included in
// command output. Images to be outputted are tested using the function. A true
// return will include the image, a false return will exclude it.
diff --git a/libpod/storage.go b/libpod/storage.go
index f0bf9e9cd..5e18aaf5c 100644
--- a/libpod/storage.go
+++ b/libpod/storage.go
@@ -57,7 +57,7 @@ func (metadata *RuntimeContainerMetadata) SetMountLabel(mountLabel string) {
}
// CreateContainerStorage creates the storage end of things. We already have the container spec created
-// TO-DO We should be passing in an KpodImage object in the future.
+// TO-DO We should be passing in an Image object in the future.
func (r *storageService) CreateContainerStorage(systemContext *types.SystemContext, imageName, imageID, containerName, containerID, mountLabel string) (ContainerInfo, error) {
var ref types.ImageReference
if imageName == "" && imageID == "" {
diff --git a/libpod/util.go b/libpod/util.go
new file mode 100644
index 000000000..0270af07c
--- /dev/null
+++ b/libpod/util.go
@@ -0,0 +1,34 @@
+package libpod
+
+import (
+ "os"
+ "path/filepath"
+)
+
+// WriteFile writes a provided string to a provided path
+func WriteFile(content string, path string) error {
+ baseDir := filepath.Dir(path)
+ if baseDir != "" {
+ if _, err := os.Stat(path); err != nil {
+ return err
+ }
+ }
+ f, err := os.Create(path)
+ if err != nil {
+ return err
+ }
+ defer f.Close()
+ f.WriteString(content)
+ f.Sync()
+ return nil
+}
+
+// StringInSlice determines if a string is in a string slice, returns bool
+func StringInSlice(s string, sl []string) bool {
+ for _, i := range sl {
+ if i == s {
+ return true
+ }
+ }
+ return false
+}
diff --git a/test/helpers.bash b/test/helpers.bash
index 428336268..dee2193d3 100644
--- a/test/helpers.bash
+++ b/test/helpers.bash
@@ -90,7 +90,7 @@ CRIO_CNI_PLUGIN=${CRIO_CNI_PLUGIN:-/opt/cni/bin/}
POD_CIDR="10.88.0.0/16"
POD_CIDR_MASK="10.88.*.*"
-KPOD_OPTIONS="--root $TESTDIR/crio $STORAGE_OPTIONS --runroot $TESTDIR/crio-run --runtime ${RUNTIME_BINARY}"
+KPOD_OPTIONS="--root $TESTDIR/crio $STORAGE_OPTIONS --runroot $TESTDIR/crio-run --runtime ${RUNTIME_BINARY} --conmon ${CONMON_BINARY}"
cp "$CONMON_BINARY" "$TESTDIR/conmon"
diff --git a/test/kpod_create.bats b/test/kpod_create.bats
new file mode 100644
index 000000000..46a460ecd
--- /dev/null
+++ b/test/kpod_create.bats
@@ -0,0 +1,24 @@
+#!/usr/bin/env bats
+
+load helpers
+
+function teardown() {
+ cleanup_test
+}
+
+ALPINE="docker.io/library/alpine:latest"
+
+@test "create a container based on local image" {
+ run ${KPOD_BINARY} ${KPOD_OPTIONS} pull docker.io/library/busybox:latest
+ echo "$output"
+ [ "$status" -eq 0 ]
+ run ${KPOD_BINARY} ${KPOD_OPTIONS} create docker.io/library/busybox:latest ls
+ echo "$output"
+ [ "$status" -eq 0 ]
+}
+
+@test "create a container based on a remote image" {
+ run ${KPOD_BINARY} ${KPOD_OPTIONS} create ${ALPINE} ls
+ echo "$output"
+ [ "$status" -eq 0 ]
+}
diff --git a/test/kpod_run.bats b/test/kpod_run.bats
new file mode 100644
index 000000000..4945691a7
--- /dev/null
+++ b/test/kpod_run.bats
@@ -0,0 +1,20 @@
+#!/usr/bin/env bats
+
+load helpers
+
+ALPINE="docker.io/library/alpine:latest"
+
+@test "run a container based on local image" {
+ run ${KPOD_BINARY} ${KPOD_OPTIONS} pull docker.io/library/busybox:latest
+ echo "$output"
+ [ "$status" -eq 0 ]
+ run ${KPOD_BINARY} ${KPOD_OPTIONS} run docker.io/library/busybox:latest ls
+ echo "$output"
+ [ "$status" -eq 0 ]
+}
+
+@test "run a container based on a remote image" {
+ run ${KPOD_BINARY} ${KPOD_OPTIONS} run ${ALPINE} ls
+ echo "$output"
+ [ "$status" -eq 0 ]
+}
diff --git a/transfer.md b/transfer.md
index e077c9b76..95fd7a2e7 100644
--- a/transfer.md
+++ b/transfer.md
@@ -42,6 +42,7 @@ There are other equivalents for these tools
| `docker attach` | [`kpod exec`](./docs/kpod-attach.1.md) ***|
| `docker build` | [`buildah bud`](https://github.com/projectatomic/buildah/blob/master/docs/buildah-bud.md) |
| `docker cp` | [`kpod mount`](./docs/kpod-cp.1.md) **** |
+| `docker create` | [`kpod create`](./docs/kpod-create.1.md) |
| `docker diff` | [`kpod diff`](./docs/kpod-diff.1.md) |
| `docker export` | [`kpod export`](./docs/kpod-export.1.md) |
| `docker history`| [`kpod history`](./docs/kpod-history.1.md)|
@@ -57,12 +58,13 @@ There are other equivalents for these tools
| `docker rename` | [`kpod rename`](./docs/kpod-rename.1.md) |
| `docker rm` | [`kpod rm`](./docs/kpod-rm.1.md) |
| `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) |
+| `docker run` | [`kpod run`](./docs/kpod-run.1.md) |
| `docker save` | [`kpod save`](./docs/kpod-save.1.md) |
| `docker stop` | [`kpod stop`](./docs/kpod-stop.1.md) |
| `docker tag` | [`kpod tag`](./docs/kpod-tag.1.md) |
| `docker unpause`| [`kpod unpause`](./docs/kpod-unpause.1.md)|
| `docker version`| [`kpod version`](./docs/kpod-version.1.md)|
-| `docker wait` | [`kpod wait`](./docs/kpod-wait.1.md)|
+| `docker wait` | [`kpod wait`](./docs/kpod-wait.1.md) |
*** Use `kpod exec` to enter a container and `kpod logs` to view the output of pid 1 of a container.
**** Use mount to take advantage of the entire linux tool chain rather then just cp. Read [`here`](./docs/kpod-cp.1.md) for more information.
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-16 10:38:08 +0000