docker

Documentation

Overview

Provides global docker information.

Handler for Docker containers.

Index

• Constants
• Variables
• func APIVersion() ([]int, error)
• func APIVersionString() (string, error)
• func Client() (*dclient.Client, error)
• func ContainerNameToDockerId(name string) string
• func Images() ([]v1.DockerImage, error)
• func NewPlugin() container.Plugin
• func Register(factory info.MachineInfoFactory, fsInfo fs.FsInfo, ...) error
• func RootDir() string
• func SetTimeout(timeout time.Duration)
• func Status() (v1.DockerStatus, error)
• func StatusFromDockerInfo(dockerInfo dockertypes.Info) (v1.DockerStatus, error)
• func StatusWithContext(ctx context.Context) (v1.DockerStatus, error)
• func ValidateInfo() (*dockertypes.Info, error)
• func Version() ([]int, error)
• func VersionString() (string, error)

Constants

const DockerNamespace = "docker"

The namespace under which Docker aliases are unique.

Variables

var ArgDockerCA = flag.String("docker-tls-ca", "ca.pem", "path to trusted CA")

var ArgDockerCert = flag.String("docker-tls-cert", "cert.pem", "path to client certificate")

var ArgDockerEndpoint = flag.String("docker", "unix:///var/run/docker.sock", "docker endpoint")

var ArgDockerKey = flag.String("docker-tls-key", "key.pem", "path to private key")

var ArgDockerTLS = flag.Bool("docker-tls", false, "use TLS to connect to docker")

Functions

func APIVersion

func APIVersion() ([]int, error)

func APIVersionString

func APIVersionString() (string, error)

func Client

func Client() (*dclient.Client, error)

Client creates a Docker API client based on the given Docker flags

func ContainerNameToDockerId

func ContainerNameToDockerId(name string) string

Returns the Docker ID from the full container name.

func Images

func Images() ([]v1.DockerImage, error)

func NewPlugin

func NewPlugin() container.Plugin

NewPlugin returns an implementation of container.Plugin suitable for passing to container.RegisterPlugin()

func Register

func Register(factory info.MachineInfoFactory, fsInfo fs.FsInfo, includedMetrics container.MetricSet) error

Register root container before running this function!

func RootDir

func RootDir() string

func SetTimeout

func SetTimeout(timeout time.Duration)

func Status

func Status() (v1.DockerStatus, error)

func StatusFromDockerInfo

func StatusFromDockerInfo(dockerInfo dockertypes.Info) (v1.DockerStatus, error)

func StatusWithContext

func StatusWithContext(ctx context.Context) (v1.DockerStatus, error)

func ValidateInfo

func ValidateInfo() (*dockertypes.Info, error)

Checks whether the dockerInfo reflects a valid docker setup, and returns it if it does, or an error otherwise.

func Version

func Version() ([]int, error)

func VersionString

func VersionString() (string, error)