dockerhelper

Documentation

Index

• func DownloadDirFromContainer(client *docker.Client, container, src, dst string) error
• func StreamFileFromContainer(client *docker.Client, container, src string) (io.ReadCloser, error)
• func UploadFileToContainer(client *docker.Client, container, src, dest string) error
• type Helper
  • func NewHelper(client *docker.Client, engineAPIClient *dockerclient.Client) *Helper
  • func (h *Helper) CgroupDriver() (string, error)
  • func (h *Helper) CheckAndPull(image string, out io.Writer) error
  • func (h *Helper) ContainerLog(container string, numLines int) string
  • func (h *Helper) DockerRoot() (string, error)
  • func (h *Helper) GetContainerState(id string) (container *docker.Container, running bool, err error)
  • func (h *Helper) GetDockerProxySettings() (httpProxy, httpsProxy, noProxy string, err error)
  • func (h *Helper) HasInsecureRegistryArg() (bool, error)
  • func (h *Helper) HostIP() string
  • func (h *Helper) ListContainerNames() ([]string, error)
  • func (h *Helper) RemoveContainer(id string) error
  • func (h *Helper) StopAndRemoveContainer(container string) error
  • func (h *Helper) UserNamespaceEnabled() (bool, error)
  • func (h *Helper) Version() (*semver.Version, bool, error)
• type RegistryConfig

Functions

func DownloadDirFromContainer

func DownloadDirFromContainer(client *docker.Client, container, src, dst string) error

DownloadDirFromContainer downloads an entire directory of files from a remote container.

func StreamFileFromContainer

func StreamFileFromContainer(client *docker.Client, container, src string) (io.ReadCloser, error)

StreamFileFromContainer returns an io.ReadCloser from which the contents of a file in a remote container can be read.

func UploadFileToContainer

func UploadFileToContainer(client *docker.Client, container, src, dest string) error

UploadFileToContainer uploads a file to a remote container.

Types

type Helper

type Helper struct {
	// contains filtered or unexported fields
}

Helper provides utility functions to help with Docker

func NewHelper

func NewHelper(client *docker.Client, engineAPIClient *dockerclient.Client) *Helper

NewHelper creates a new Helper

func (*Helper) CgroupDriver

func (h *Helper) CgroupDriver() (string, error)

func (*Helper) CheckAndPull

func (h *Helper) CheckAndPull(image string, out io.Writer) error

CheckAndPull checks whether a Docker image exists. If not, it pulls it.

func (*Helper) ContainerLog

func (h *Helper) ContainerLog(container string, numLines int) string

func (*Helper) DockerRoot

func (h *Helper) DockerRoot() (string, error)

DockerRoot returns the root directory for Docker

func (*Helper) GetContainerState

func (h *Helper) GetContainerState(id string) (container *docker.Container, running bool, err error)

GetContainerState returns whether a container exists and if it does whether it's running

func (*Helper) GetDockerProxySettings

func (h *Helper) GetDockerProxySettings() (httpProxy, httpsProxy, noProxy string, err error)

func (*Helper) HasInsecureRegistryArg

func (h *Helper) HasInsecureRegistryArg() (bool, error)

HasInsecureRegistryArg checks whether the docker daemon is configured with the appropriate insecure registry argument

func (*Helper) HostIP

func (h *Helper) HostIP() string

HostIP returns the IP of the Docker host if connecting via TCP

func (*Helper) ListContainerNames

func (h *Helper) ListContainerNames() ([]string, error)

func (*Helper) RemoveContainer

func (h *Helper) RemoveContainer(id string) error

RemoveContainer removes the container with the given id

func (*Helper) StopAndRemoveContainer

func (h *Helper) StopAndRemoveContainer(container string) error

func (*Helper) UserNamespaceEnabled

func (h *Helper) UserNamespaceEnabled() (bool, error)

UserNamespaceEnabled checks whether docker daemon is running in user namespace mode.

func (*Helper) Version

func (h *Helper) Version() (*semver.Version, bool, error)

Version returns the Docker version and whether it is a Red Hat distro version

type RegistryConfig

type RegistryConfig struct {
	InsecureRegistryCIDRs []string
}