Documentation

Overview

    Package docker contains helpers for working with docker This package has no stability guarantees whatsoever!

    Package docker contains helpers for working with docker This package has no stability guarantees whatsoever!

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func ContainerCmder

    func ContainerCmder(containerNameOrID string) exec.Cmder

      ContainerCmder creates a new exec.Cmder against a docker container

      func CopyFrom

      func CopyFrom(containerNameOrID, srcPath, hostPath string) error

        CopyFrom copies the file or dir in the container at srcPath to the host at hostPath

        func CopyTo

        func CopyTo(hostPath, containerNameOrID, destPath string) error

          CopyTo copies the file at hostPath to the container at destPath

          func GetArchiveTags

          func GetArchiveTags(path string) ([]string, error)

            GetArchiveTags obtains a list of "repo:tag" docker image tags from a given docker image archive (tarball) path compatible with all known specs: https://github.com/moby/moby/blob/master/image/spec/v1.0.md https://github.com/moby/moby/blob/master/image/spec/v1.1.md https://github.com/moby/moby/blob/master/image/spec/v1.2.md

            func Inspect

            func Inspect(containerNameOrID, format string) ([]string, error)

              Inspect return low-level information on containers

              func Kill

              func Kill(signal, containerNameOrID string) error

                Kill sends the named signal to the container

                func Pull

                func Pull(image string, retries int) error

                  Pull pulls an image, retrying up to retries times

                  func PullIfNotPresent

                  func PullIfNotPresent(image string, retries int) (pulled bool, err error)

                    PullIfNotPresent will pull an image if it is not present locally retrying up to retries times it returns true if it attempted to pull, and any errors from pulling

                    func Run

                    func Run(image string, runArgs []string, containerArgs []string) (id string, err error)

                      Run creates a container with "docker run", with some error handling it will return the ID of the created container if any, even on error

                      func Save

                      func Save(image, dest string) error

                        Save saves image to dest, as in `docker save`

                        func UsernsRemap

                        func UsernsRemap() bool

                          UsernsRemap checks if userns-remap is enabled in dockerd

                          Types

                          This section is empty.