package
0.0.0-20180718163623-7f4d65f4f38e
Repository: https://github.com/puppetlabs/lumogon.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
DockerConfig returns values for the following environment variables, setting a default if no variable is set: DOCKER_HOST, DOCKER_CERT_PATH, DOCKER_TLS_VERIFY **NOTE** DOCKER_CERT_PATH, DOCKER_TLS_VERIFY are not currently used.
FilterDockerStream reads the requested stream from *bufio.Reader, strips the frameHeader added by Dockers stdWriter.Write(p []byte) and returns a slice of strings for each line received (splitting on '/n').
ImageExists returns true if the imageName exists.
New returns a client connected with the highest API version supported by both the Lumogon client and the Docker runtime.
NormaliseTargets takes a slice of strings which can be Container IDs or Names, and returns a slice of types.TargetContainers.
ServerInfo returns the Server APIVersion and the servers ID.
# Constants
MinSupportedAPIVersion is the lowest Docker API version that Lumogon supports Docker API Version 1.21 - Docker Engine 1.10.x - for support < 1.21 need to be able to identify the scheduler container so it can be excluded from results - for support < 1.20 need to use an alternative to copy when detecting the target containers OS.
Stderr represents standard error stream type.
Stdin represents standard input stream type.
Stdout represents standard output stream type.
Systemerr represents errors originating from the system that make it into the the multiplexed stream.
# Structs
DockerAPICapability embedded type adds a Docker specific Harvest function field which passes a client satisfying the dockeradapter.Harvester interface.
# Interfaces
Client is a Docker (currently local) ContainerRuntime.
CopyFrom interface exposes methods required to copy file data from a container.
Creator interface exposes methods required to create an attached container.
Diff interface exposes methods required to determine files in running container that have been changed/added/removed relative to the containers image.
Executor TODO.
Harvester interface exposes methods used by Capabilties Harvest functions.
HostInspector interface exposes methods required to inspect a docker host.
ImageInspector interface exposes methods required to inspect an image.
ImageInspectorPuller interface exposes methods required to both pull and and inspect an image.
ImagePuller interface exposes methods required to pull an image.
Inspector interface exposes methods required to inspect a container.
Lister interface exposes methods required to list containers.
LogGetter interface exposes methods required to get logs from a container.
Remover interface exposes methods required to remove a container.
Starter interface exposes methods required to start a container.