dockertools

package
v0.10.1-0...-dbf77f2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 20, 2015 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	PodInfraContainerName = leaky.PodInfraContainerName
	DockerPrefix          = "docker://"
)

Variables

View Source 
var (
	// ErrNoContainersInPod is returned when there are no containers for a given pod
	ErrNoContainersInPod = errors.New("no containers exist for this pod")

	// ErrNoPodInfraContainerInPod is returned when there is no pod infra container for a given pod
	ErrNoPodInfraContainerInPod = errors.New("No pod infra container exists for this pod")

	// ErrContainerCannotRun is returned when a container is created, but cannot run properly
	ErrContainerCannotRun = errors.New("Container cannot run")
)

Functions

func BuildDockerName 

func BuildDockerName(podUID types.UID, podFullName string, container *api.Container) string

Creates a name which can be reversed to identify both full pod name and container name.

func GetDockerPodInfo 

func GetDockerPodInfo(client DockerInterface, manifest api.PodSpec, podFullName string, uid types.UID) (api.PodInfo, error)

GetDockerPodInfo returns docker info for all containers in the pod/manifest.

func GetKubeletDockerContainerLogs 

func GetKubeletDockerContainerLogs(client DockerInterface, containerID, tail string, follow bool, stdout, stderr io.Writer) (err error)

GetKubeletDockerContainerLogs returns logs of specific container By default the function will return snapshot of the container log Log streaming is possible if 'follow' param is set to true Log tailing is possible when number of tailed lines are set and only if 'follow' is false TODO: Make 'RawTerminal' option flagable.

func GetRecentDockerContainersWithNameAndUUID 

func GetRecentDockerContainersWithNameAndUUID(client DockerInterface, podFullName string, uid types.UID, containerName string) ([]*docker.Container, error)

GetRecentDockerContainersWithNameAndUUID returns a list of dead docker containers which matches the name and uid given.

func GetRunningContainers 

func GetRunningContainers(client DockerInterface, ids []string) ([]*docker.Container, error)

func HashContainer 

func HashContainer(container *api.Container) uint64

func ParseDockerName 

func ParseDockerName(name string) (podFullName string, podUID types.UID, containerName string, hash uint64)

TODO(vmarmol): This should probably return an error. Unpacks a container name, returning the pod full name and container name we would have used to construct the docker name. If the docker name isn't the one we created, we may return empty strings.

func RequireLatestImage 

func RequireLatestImage(name string) bool

RequireLatestImage returns if the user wants the latest image

Types

type ContainerCommandRunner 

type ContainerCommandRunner interface {
	RunInContainer(containerID string, cmd []string) ([]byte, error)
	GetDockerServerVersion() ([]uint, error)
}

func NewDockerContainerCommandRunner 

func NewDockerContainerCommandRunner(client DockerInterface) ContainerCommandRunner

NewDockerContainerCommandRunner creates a ContainerCommandRunner which uses nsinit to run a command inside a container.

type DockerContainers 

type DockerContainers map[DockerID]*docker.APIContainers

DockerContainers is a map of containers

func GetKubeletDockerContainers 

func GetKubeletDockerContainers(client DockerInterface, allContainers bool) (DockerContainers, error)

GetKubeletDockerContainers takes client and boolean whether to list all container or just the running ones. Returns a map of docker containers that we manage. The map key is the docker container ID

func (DockerContainers) FindContainersByPodFullName 

func (c DockerContainers) FindContainersByPodFullName(podFullName string) map[string]*docker.APIContainers

Note, this might return containers belong to a different Pod instance with the same name

func (DockerContainers) FindPodContainer 

func (c DockerContainers) FindPodContainer(podFullName string, uid types.UID, containerName string) (*docker.APIContainers, bool, uint64)

type DockerID 

type DockerID string

DockerID is an ID of docker container. It is a type to make it clear when we're working with docker container Ids

type DockerInterface 

type DockerInterface interface {
	ListContainers(options docker.ListContainersOptions) ([]docker.APIContainers, error)
	InspectContainer(id string) (*docker.Container, error)
	CreateContainer(docker.CreateContainerOptions) (*docker.Container, error)
	StartContainer(id string, hostConfig *docker.HostConfig) error
	StopContainer(id string, timeout uint) error
	RemoveContainer(opts docker.RemoveContainerOptions) error
	InspectImage(image string) (*docker.Image, error)
	ListImages(opts docker.ListImagesOptions) ([]docker.APIImages, error)
	PullImage(opts docker.PullImageOptions, auth docker.AuthConfiguration) error
	RemoveImage(image string) error
	Logs(opts docker.LogsOptions) error
	Version() (*docker.Env, error)
	CreateExec(docker.CreateExecOptions) (*docker.Exec, error)
	StartExec(string, docker.StartExecOptions) error
}

DockerInterface is an abstract interface for testability. It abstracts the interface of docker.Client.

func ConnectToDockerOrDie 

func ConnectToDockerOrDie(dockerEndpoint string) DockerInterface

type DockerPuller 

type DockerPuller interface {
	Pull(image string) error
	IsImagePresent(image string) (bool, error)
}

DockerPuller is an abstract interface for testability. It abstracts image pull operations.

func NewDockerPuller 

func NewDockerPuller(client DockerInterface, qps float32, burst int) DockerPuller

NewDockerPuller creates a new instance of the default implementation of DockerPuller.

type FakeDockerClient 

type FakeDockerClient struct {
	sync.Mutex
	ContainerList []docker.APIContainers
	Container     *docker.Container
	ContainerMap  map[string]*docker.Container
	Image         *docker.Image
	Images        []docker.APIImages
	Err           error

	Stopped []string

	Created       []string
	Removed       []string
	RemovedImages util.StringSet
	VersionInfo   docker.Env
	// contains filtered or unexported fields
}

FakeDockerClient is a simple fake docker client, so that kubelet can be run for testing without requiring a real docker setup.

func (*FakeDockerClient) AssertCalls 

func (f *FakeDockerClient) AssertCalls(calls []string) (err error)

func (*FakeDockerClient) ClearCalls 

func (f *FakeDockerClient) ClearCalls()

func (*FakeDockerClient) CreateContainer 

func (f *FakeDockerClient) CreateContainer(c docker.CreateContainerOptions) (*docker.Container, error)

CreateContainer is a test-spy implementation of DockerInterface.CreateContainer. It adds an entry "create" to the internal method call record.

func (*FakeDockerClient) CreateExec 

func (f *FakeDockerClient) CreateExec(_ docker.CreateExecOptions) (*docker.Exec, error)

func (*FakeDockerClient) InspectContainer 

func (f *FakeDockerClient) InspectContainer(id string) (*docker.Container, error)

InspectContainer is a test-spy implementation of DockerInterface.InspectContainer. It adds an entry "inspect" to the internal method call record.

func (*FakeDockerClient) InspectImage 

func (f *FakeDockerClient) InspectImage(name string) (*docker.Image, error)

InspectImage is a test-spy implementation of DockerInterface.InspectImage. It adds an entry "inspect" to the internal method call record.

func (*FakeDockerClient) ListContainers 

func (f *FakeDockerClient) ListContainers(options docker.ListContainersOptions) ([]docker.APIContainers, error)

ListContainers is a test-spy implementation of DockerInterface.ListContainers. It adds an entry "list" to the internal method call record.

func (*FakeDockerClient) ListImages 

func (f *FakeDockerClient) ListImages(opts docker.ListImagesOptions) ([]docker.APIImages, error)

func (*FakeDockerClient) Logs 

func (f *FakeDockerClient) Logs(opts docker.LogsOptions) error

Logs is a test-spy implementation of DockerInterface.Logs. It adds an entry "logs" to the internal method call record.

func (*FakeDockerClient) PullImage 

func (f *FakeDockerClient) PullImage(opts docker.PullImageOptions, auth docker.AuthConfiguration) error

PullImage is a test-spy implementation of DockerInterface.StopContainer. It adds an entry "pull" to the internal method call record.

func (*FakeDockerClient) RemoveContainer 

func (f *FakeDockerClient) RemoveContainer(opts docker.RemoveContainerOptions) error

func (*FakeDockerClient) RemoveImage 

func (f *FakeDockerClient) RemoveImage(image string) error

func (*FakeDockerClient) StartContainer 

func (f *FakeDockerClient) StartContainer(id string, hostConfig *docker.HostConfig) error

StartContainer is a test-spy implementation of DockerInterface.StartContainer. It adds an entry "start" to the internal method call record.

func (*FakeDockerClient) StartExec 

func (f *FakeDockerClient) StartExec(_ string, _ docker.StartExecOptions) error

func (*FakeDockerClient) StopContainer 

func (f *FakeDockerClient) StopContainer(id string, timeout uint) error

StopContainer is a test-spy implementation of DockerInterface.StopContainer. It adds an entry "stop" to the internal method call record.

func (*FakeDockerClient) Version 

func (f *FakeDockerClient) Version() (*docker.Env, error)

type FakeDockerPuller 

type FakeDockerPuller struct {
	sync.Mutex

	HasImages    []string
	ImagesPulled []string

	// Every pull will return the first error here, and then reslice
	// to remove it. Will give nil errors if this slice is empty.
	ErrorsToInject []error
}

FakeDockerPuller is a stub implementation of DockerPuller.

func (*FakeDockerPuller) IsImagePresent 

func (f *FakeDockerPuller) IsImagePresent(name string) (bool, error)

func (*FakeDockerPuller) Pull 

func (f *FakeDockerPuller) Pull(image string) (err error)

Pull records the image pull attempt, and optionally injects an error.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.