Documentation

Index

Constants

This section is empty.

Variables

View Source
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",
		},
		cli.StringFlag{
			Name: "hosts-dir",

			Usage: "Custom hosts configuration directory",
		},
		cli.StringFlag{
			Name:  "tlscacert",
			Usage: "path to TLS root CA",
		},
		cli.StringFlag{
			Name:  "tlscert",
			Usage: "path to TLS client certificate",
		},
		cli.StringFlag{
			Name:  "tlskey",
			Usage: "path to TLS client key",
		},
	}

	// 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.StringFlag{
			Name:  "env-file",
			Usage: "specify additional container environment variables in a file(i.e. FOO=bar, one per line)",
		},
		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",
		},
		cli.BoolFlag{
			Name:  "seccomp",
			Usage: "enable the default seccomp profile",
		},
	}
)
View Source
var PushTracker = docker.NewInMemoryTracker()

    PushTracker returns a new InMemoryTracker which tracks the ref status

    Functions

    func AppContext

    func AppContext(context *cli.Context) (gocontext.Context, gocontext.CancelFunc)

      AppContext returns the context for a command. Should only be called once per command, near the start.

      This will ensure the namespace is picked up and set the timeout, if one is defined.

      func ForwardAllSignals

      func ForwardAllSignals(ctx gocontext.Context, task killer) chan os.Signal

        ForwardAllSignals forwards signals

        func GetResolver

        func GetResolver(ctx gocontext.Context, clicontext *cli.Context) (remotes.Resolver, error)

          GetResolver prepares the resolver from the environment and options

          func IntToInt32Array

          func IntToInt32Array(in []int) []int32

            IntToInt32Array converts an array of int's to int32's

            func LabelArgs

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

              LabelArgs returns a map of label key,value pairs

              func NewClient

                NewClient returns a new containerd client

                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 StopCatch

                    func StopCatch(sigc chan os.Signal)

                      StopCatch stops and closes a channel

                      func WritePidFile

                      func WritePidFile(path string, pid int) error

                        WritePidFile writes the pid atomically to a file

                        Types

                        This section is empty.