engine

package
v1.6.0 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2015 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause, + 1 more Imports: 26 Imported by: 0

Documentation

Overview

The 'engine' package contains code for interacting with container-running backends and handling events from them. It supports Docker as the sole task engine type.

The DockerTaskEngine is an abstraction over the DockerGoClient so that it does not have to know about tasks, only containers

Index

Constants

View Source 
const (
	DOCKER_ENDPOINT_ENV_VARIABLE = "DOCKER_HOST"
	DOCKER_DEFAULT_ENDPOINT      = "unix:///var/run/docker.sock"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CannotGetDockerClientError added in v1.5.0 

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

func (CannotGetDockerClientError) Error added in v1.5.0 

func (c CannotGetDockerClientError) Error() string

func (CannotGetDockerClientError) ErrorName added in v1.5.0 

func (CannotGetDockerClientError) ErrorName() string

type CannotXContainerError added in v1.1.0 

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

func (CannotXContainerError) Error added in v1.1.0 

func (err CannotXContainerError) Error() string

func (CannotXContainerError) ErrorName added in v1.1.0 

func (err CannotXContainerError) ErrorName() string

type ContainerNotFound 

type ContainerNotFound struct {
	TaskArn       string
	ContainerName string
}

func (ContainerNotFound) Error 

func (cnferror ContainerNotFound) Error() string

type ContainerVanishedError added in v1.1.0 

type ContainerVanishedError struct{}

func (ContainerVanishedError) Error added in v1.1.0 

func (err ContainerVanishedError) Error() string

func (ContainerVanishedError) ErrorName added in v1.1.0 

func (err ContainerVanishedError) ErrorName() string

type DockerClient 

type DockerClient interface {
	// SupportedVersions returns a slice of the supported docker versions (or at least supposedly supported).
	SupportedVersions() []dockerclient.DockerVersion
	// WithVersion returns a new DockerClient for which all operations will use the given remote api version.
	// A default version will be used for a client not produced via this method.
	WithVersion(dockerclient.DockerVersion) DockerClient
	ContainerEvents(ctx context.Context) (<-chan DockerContainerChangeEvent, error)

	PullImage(image string) DockerContainerMetadata
	CreateContainer(*docker.Config, *docker.HostConfig, string) DockerContainerMetadata
	StartContainer(string) DockerContainerMetadata
	StopContainer(string) DockerContainerMetadata
	DescribeContainer(string) (api.ContainerStatus, DockerContainerMetadata)

	RemoveContainer(string) error

	GetContainerName(string) (string, error)
	InspectContainer(string) (*docker.Container, error)

	ListContainers(bool) ListContainersResponse

	Version() (string, error)
}

Interface to make testing it easier

type DockerContainerChangeEvent 

type DockerContainerChangeEvent struct {
	Status api.ContainerStatus

	DockerContainerMetadata
}

type DockerContainerMetadata added in v1.1.0 

type DockerContainerMetadata struct {
	DockerId     string
	ExitCode     *int
	PortBindings []api.PortBinding
	Error        error
	Volumes      map[string]string
}

type DockerGoClient 

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

DockerGoClient wraps the underlying go-dockerclient library. It exists primarily for the following three purposes:

  1. Provide an abstraction over inputs and outputs, a) Inputs: Trims them down to what we actually need (largely unchanged tbh) b) Outputs: Unifies error handling and the common 'start->inspect' pattern by having a consistent error output. This error output contains error data with a given Name that aims to be presentable as a 'reason' in state changes. It also filters out the information about a container that is of interest, such as network bindings, while ignoring the rest.
  2. Timeouts: It adds timeouts everywhere, mostly as a reaction to pull-related issues in the Docker daemon.
  3. Versioning: It abstracts over multiple client versions to allow juggling appropriately there.

Implements DockerClient

func NewDockerGoClient 

func NewDockerGoClient(clientFactory dockerclient.Factory, authType string, authData *config.SensitiveRawMessage) (*DockerGoClient, error)

NewDockerGoClient creates a new DockerGoClient

func (*DockerGoClient) ContainerEvents 

func (dg *DockerGoClient) ContainerEvents(ctx context.Context) (<-chan DockerContainerChangeEvent, error)

Listen to the docker event stream for container changes and pass them up

func (*DockerGoClient) CreateContainer 

func (dg *DockerGoClient) CreateContainer(config *docker.Config, hostConfig *docker.HostConfig, name string) DockerContainerMetadata

func (*DockerGoClient) DescribeContainer 

func (dg *DockerGoClient) DescribeContainer(dockerId string) (api.ContainerStatus, DockerContainerMetadata)

func (*DockerGoClient) GetContainerName 

func (dg *DockerGoClient) GetContainerName(id string) (string, error)

func (*DockerGoClient) InspectContainer 

func (dg *DockerGoClient) InspectContainer(dockerId string) (*docker.Container, error)

func (*DockerGoClient) ListContainers added in v1.2.0 

func (dg *DockerGoClient) ListContainers(all bool) ListContainersResponse

ListContainers returns a slice of container IDs.

func (*DockerGoClient) PullImage 

func (dg *DockerGoClient) PullImage(image string) DockerContainerMetadata

func (*DockerGoClient) RemoveContainer 

func (dg *DockerGoClient) RemoveContainer(dockerId string) error

func (*DockerGoClient) StartContainer 

func (dg *DockerGoClient) StartContainer(id string) DockerContainerMetadata

func (*DockerGoClient) StopContainer 

func (dg *DockerGoClient) StopContainer(dockerId string) DockerContainerMetadata

func (*DockerGoClient) SupportedVersions added in v1.5.0 

func (dg *DockerGoClient) SupportedVersions() []dockerclient.DockerVersion

func (*DockerGoClient) Version added in v1.0.0 

func (dg *DockerGoClient) Version() (string, error)

func (*DockerGoClient) WithVersion added in v1.5.0 

func (dg *DockerGoClient) WithVersion(version dockerclient.DockerVersion) DockerClient

type DockerImageResponse 

type DockerImageResponse struct {
	Images []docker.APIImages
}

type DockerStateError added in v1.1.0 

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

DockerStateError is a wrapper around the error docker puts in the '.State.Error' field of its inspect output.

func NewDockerStateError added in v1.1.0 

func NewDockerStateError(err string) DockerStateError

func (DockerStateError) Error added in v1.1.0 

func (err DockerStateError) Error() string

func (DockerStateError) ErrorName added in v1.1.0 

func (err DockerStateError) ErrorName() string

type DockerTaskEngine 

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

The DockerTaskEngine interacts with docker to implement a task engine

func NewDockerTaskEngine 

func NewDockerTaskEngine(cfg *config.Config) *DockerTaskEngine

NewDockerTaskEngine returns a created, but uninitialized, DockerTaskEngine. The distinction between created and initialized is that when created it may be serialized/deserialized, but it will not communicate with docker until it is also initialized.

func (*DockerTaskEngine) AddTask 

func (engine *DockerTaskEngine) AddTask(task *api.Task) error

func (*DockerTaskEngine) Capabilities added in v1.5.0 

func (engine *DockerTaskEngine) Capabilities() []string

Capabilities returns the supported capabilities of this agent / docker-client pair. Currently, the following capabilities are possible: 

com.amazonaws.ecs.capability.privileged-container
com.amazonaws.ecs.capability.docker-remote-api.1.17
com.amazonaws.ecs.capability.docker-remote-api.1.18
com.amazonaws.ecs.capability.docker-remote-api.1.19
com.amazonaws.ecs.capability.docker-remote-api.1.20
com.amazonaws.ecs.capability.logging-driver.json-file
com.amazonaws.ecs.capability.logging-driver.syslog
com.amazonaws.ecs.capability.logging-driver.fluentd
com.amazonaws.ecs.capability.logging-driver.journald
com.amazonaws.ecs.capability.logging-driver.gelf
com.amazonaws.ecs.capability.selinux
com.amazonaws.ecs.capability.apparmor

func (*DockerTaskEngine) CheckTaskState added in v1.1.0 

func (engine *DockerTaskEngine) CheckTaskState(task *api.Task)

CheckTaskState inspects the state of all containers within a task and writes their state to the managed task's container channel.

func (*DockerTaskEngine) Disable added in v1.0.0 

func (engine *DockerTaskEngine) Disable()

Disable prevents this engine from managing any additional tasks.

func (*DockerTaskEngine) Init 

func (engine *DockerTaskEngine) Init() error

Init initializes a DockerTaskEngine such that it may communicate with docker and operate normally. This function must be called before any other function, except serializing and deserializing, can succeed without error.

func (*DockerTaskEngine) ListTasks 

func (engine *DockerTaskEngine) ListTasks() ([]*api.Task, error)

func (*DockerTaskEngine) MarshalJSON 

func (engine *DockerTaskEngine) MarshalJSON() ([]byte, error)

MarshalJSON marshals into state directly

func (*DockerTaskEngine) MustInit 

func (engine *DockerTaskEngine) MustInit()

MustInit blocks and retries until an engine can be initialized.

func (*DockerTaskEngine) SetDockerClient added in v1.1.0 

func (engine *DockerTaskEngine) SetDockerClient(client DockerClient)

SetDockerClient provides a way to override the client used for communication with docker as a testing hook.

func (*DockerTaskEngine) SetSaver 

func (engine *DockerTaskEngine) SetSaver(saver statemanager.Saver)

func (*DockerTaskEngine) Shutdown added in v1.1.0 

func (engine *DockerTaskEngine) Shutdown()

Shutdown makes a best-effort attempt to cleanup after the task engine. This should not be relied on for anything more complicated than testing.

func (*DockerTaskEngine) State 

func (engine *DockerTaskEngine) State() *dockerstate.DockerTaskEngineState

State is a function primarily meant for testing usage; it is explicitly not part of the TaskEngine interface and should not be relied upon. It returns an internal representation of the state of this DockerTaskEngine.

func (*DockerTaskEngine) TaskEvents 

func (engine *DockerTaskEngine) TaskEvents() (<-chan api.TaskStateChange, <-chan api.ContainerStateChange)

TaskEvents returns channels to read task and container state changes. These changes should be read as soon as possible as them not being read will block processing the task referenced by the event.

func (*DockerTaskEngine) UnmarshalJSON 

func (engine *DockerTaskEngine) UnmarshalJSON(data []byte) error

UnmarshalJSON restores a previously marshaled task-engine state from json

func (*DockerTaskEngine) Version added in v1.0.0 

func (engine *DockerTaskEngine) Version() (string, error)

Version returns the underlying docker version.

type DockerTimeoutError added in v1.1.0 

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

func (*DockerTimeoutError) Error added in v1.1.0 

func (err *DockerTimeoutError) Error() string

func (*DockerTimeoutError) ErrorName added in v1.1.0 

func (err *DockerTimeoutError) ErrorName() string

type ListContainersResponse added in v1.2.0 

type ListContainersResponse struct {
	DockerIds []string
	Error     error
}

ListContainersResponse encapsulates the response from the docker client for the ListContainers call.

type OutOfMemoryError added in v1.1.0 

type OutOfMemoryError struct{}

func (OutOfMemoryError) Error added in v1.1.0 

func (err OutOfMemoryError) Error() string

func (OutOfMemoryError) ErrorName added in v1.1.0 

func (err OutOfMemoryError) ErrorName() string

type TaskEngine 

type TaskEngine interface {
	Init() error
	MustInit()
	// Disable *must* only be called when this engine will no longer be used
	// (e.g. right before exiting down the process). It will irreversably stop
	// this task engine from processing new tasks
	Disable()

	// TaskEvents will provide information about tasks that have been previously
	// executed. Specifically, it will provide information when they reach
	// running or stopped, as well as providing portbinding and other metadata
	TaskEvents() (<-chan api.TaskStateChange, <-chan api.ContainerStateChange)
	SetSaver(statemanager.Saver)

	// AddTask adds a new task to the task engine and manages its container's
	// lifecycle. If it returns an error, the task was not added.
	AddTask(*api.Task) error

	ListTasks() ([]*api.Task, error)

	Version() (string, error)
	// Capabilities returns an array of capabilities this task engine has, which
	// should model what it can execute.
	Capabilities() []string

	json.Marshaler
	json.Unmarshaler
}

func NewTaskEngine 

func NewTaskEngine(cfg *config.Config) TaskEngine

NewTaskEngine returns a default TaskEngine

Source Files

View all Source files

Directories

Path Synopsis
Package dockerauth handles storing auth configuration information for Docker registries.
 Package dockerauth handles storing auth configuration information for Docker registries.
mocks
Package dockeriface contains an interface for go-dockerclient matching the subset used by the agent
 Package dockeriface contains an interface for go-dockerclient matching the subset used by the agent
mocks
testutils
Package testutils contains files that are used in tests but not elsewhere and thus can be excluded from the final executable.
 Package testutils contains files that are used in tests but not elsewhere and thus can be excluded from the final executable.
Package emptyvolume contains some information related to the 'emptyvolumes'
 Package emptyvolume contains some information related to the 'emptyvolumes'
Package testutils contains files that are used in tests but not elsewhere and thus can be excluded from the final executable.
 Package testutils contains files that are used in tests but not elsewhere and thus can be excluded from the final executable.

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.