commands

Documentation

Index

• Variables
• func LabelArgs(labelStrings []string) map[string]string
• func ObjectWithLabelArgs(clicontext *cli.Context) (string, map[string]string)
• func PrintAsJSON(x interface{})
• func WritePidFile(path string, pid int) error

Variables

var (
	// SnapshotterFlags are cli flags specifying snapshotter names
	SnapshotterFlags = []cli.Flag{
		cli.StringFlag{
			Name:   "snapshotter",
			Usage:  "snapshotter name. Empty value stands for the default value.",
			EnvVar: "CONTAINERD_SNAPSHOTTER",
		},
	}

	// LabelFlag is a cli flag specifying labels
	LabelFlag = cli.StringSliceFlag{
		Name:  "label",
		Usage: "labels to attach to the image",
	}

	// RegistryFlags are cli flags specifying registry options
	RegistryFlags = []cli.Flag{
		cli.BoolFlag{
			Name:  "skip-verify,k",
			Usage: "skip SSL certificate validation",
		},
		cli.BoolFlag{
			Name:  "plain-http",
			Usage: "allow connections using plain HTTP",
		},
		cli.StringFlag{
			Name:  "user,u",
			Usage: "user[:password] Registry user and password",
		},
		cli.StringFlag{
			Name:  "refresh",
			Usage: "refresh token for authorization server",
		},
	}

	// ContainerFlags are cli flags specifying container options
	ContainerFlags = []cli.Flag{
		cli.StringFlag{
			Name:  "config,c",
			Usage: "path to the runtime-specific spec config file",
		},
		cli.StringFlag{
			Name:  "cwd",
			Usage: "specify the working directory of the process",
		},
		cli.StringSliceFlag{
			Name:  "env",
			Usage: "specify additional container environment variables (i.e. FOO=bar)",
		},
		cli.StringSliceFlag{
			Name:  "label",
			Usage: "specify additional labels (i.e. foo=bar)",
		},
		cli.StringSliceFlag{
			Name:  "mount",
			Usage: "specify additional container mount (ex: type=bind,src=/tmp,dst=/host,options=rbind:ro)",
		},
		cli.BoolFlag{
			Name:  "net-host",
			Usage: "enable host networking for the container",
		},
		cli.BoolFlag{
			Name:  "privileged",
			Usage: "run privileged container",
		},
		cli.BoolFlag{
			Name:  "read-only",
			Usage: "set the containers filesystem as readonly",
		},
		cli.StringFlag{
			Name:  "runtime",
			Usage: "runtime name",
			Value: defaults.DefaultRuntime,
		},
		cli.BoolFlag{
			Name:  "tty,t",
			Usage: "allocate a TTY for the container",
		},
		cli.StringSliceFlag{
			Name:  "with-ns",
			Usage: "specify existing Linux namespaces to join at container runtime (format '<nstype>:<path>')",
		},
		cli.StringFlag{
			Name:  "pid-file",
			Usage: "file path to write the task's pid",
		},
		cli.IntFlag{
			Name:  "gpus",
			Usage: "add gpus to the container",
		},
		cli.BoolFlag{
			Name:  "allow-new-privs",
			Usage: "turn off OCI spec's NoNewPrivileges feature flag",
		},
		cli.Uint64Flag{
			Name:  "memory-limit",
			Usage: "memory limit (in bytes) for the container",
		},
		cli.StringSliceFlag{
			Name:  "device",
			Usage: "add a device to a container",
		},
	}
	// ImageDecryptionFlags are cli flags needed when decrypting an image
	ImageDecryptionFlags = []cli.Flag{
		cli.StringFlag{
			Name:  "gpg-homedir",
			Usage: "The GPG homedir to use; by default gpg uses ~/.gnupg",
		}, cli.StringFlag{
			Name:  "gpg-version",
			Usage: "The GPG version (\"v1\" or \"v2\"), default will make an educated guess",
		}, cli.StringSliceFlag{
			Name:  "key",
			Usage: "A secret key's filename and an optional password separated by colon; this option may be provided multiple times",
		}, cli.StringSliceFlag{
			Name:  "dec-recipient",
			Usage: "Recipient of the image; used only for PKCS7 and must be an x509 certificate",
		},
	}
)

Functions

func LabelArgs

func LabelArgs(labelStrings []string) map[string]string

LabelArgs returns a map of label key,value pairs

func ObjectWithLabelArgs

func ObjectWithLabelArgs(clicontext *cli.Context) (string, map[string]string)

ObjectWithLabelArgs returns the first arg and a LabelArgs object

func PrintAsJSON

func PrintAsJSON(x interface{})

PrintAsJSON prints input in JSON format

func WritePidFile

func WritePidFile(path string, pid int) error

WritePidFile writes the pid atomically to a file