Documentation
¶
Index ¶
- type DockerTaskEngineState
- func (state *DockerTaskEngineState) AddContainer(container *api.DockerContainer, task *api.Task)
- func (state *DockerTaskEngineState) AddENIAttachment(eniAttachment *api.ENIAttachment)
- func (state *DockerTaskEngineState) AddImageState(imageState *image.ImageState)
- func (state *DockerTaskEngineState) AddTask(task *api.Task)
- func (state *DockerTaskEngineState) AllENIAttachments() []*api.ENIAttachment
- func (state *DockerTaskEngineState) AllImageStates() []*image.ImageState
- func (state *DockerTaskEngineState) AllTasks() []*api.Task
- func (state *DockerTaskEngineState) ContainerByID(id string) (*api.DockerContainer, bool)
- func (state *DockerTaskEngineState) ContainerMapByArn(arn string) (map[string]*api.DockerContainer, bool)
- func (state *DockerTaskEngineState) ENIByMac(mac string) (*api.ENIAttachment, bool)
- func (state *DockerTaskEngineState) GetAllContainerIDs() []string
- func (state *DockerTaskEngineState) MarshalJSON() ([]byte, error)
- func (state *DockerTaskEngineState) RemoveENIAttachment(mac string)
- func (state *DockerTaskEngineState) RemoveImageState(imageState *image.ImageState)
- func (state *DockerTaskEngineState) RemoveTask(task *api.Task)
- func (state *DockerTaskEngineState) Reset()
- func (state *DockerTaskEngineState) TaskByArn(arn string) (*api.Task, bool)
- func (state *DockerTaskEngineState) TaskByID(cid string) (*api.Task, bool)
- func (state *DockerTaskEngineState) TaskByShortID(cid string) ([]*api.Task, bool)
- func (state *DockerTaskEngineState) UnmarshalJSON(data []byte) error
- type TaskEngineState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DockerTaskEngineState ¶
type DockerTaskEngineState struct {
// contains filtered or unexported fields
}
DockerTaskEngineState keeps track of all mappings between tasks we know about and containers docker runs It contains a mutex that can be used to ensure out-of-date state cannot be accessed before an update comes and to ensure multiple goroutines can safely work with it.
The methods on it will aquire the read lock, but not all aquire the write lock (sometimes it is up to the caller). This is because the write lock for containers should encapsulate the creation of the resource as well as adding, and creating the resource (docker container) is outside the scope of this package. This isn't ideal usage and I'm open to this being reworked/improved.
Some information is duplicated in the interest of having efficient lookups
func (*DockerTaskEngineState) AddContainer ¶
func (state *DockerTaskEngineState) AddContainer(container *api.DockerContainer, task *api.Task)
AddContainer adds a container to the state. If the container has been added with only a name and no docker-id, this updates the state to include the docker id
func (*DockerTaskEngineState) AddENIAttachment ¶
func (state *DockerTaskEngineState) AddENIAttachment(eniAttachment *api.ENIAttachment)
AddENIAttachment adds the eni into the state
func (*DockerTaskEngineState) AddImageState ¶
func (state *DockerTaskEngineState) AddImageState(imageState *image.ImageState)
AddImageState adds an image.ImageState to be stored
func (*DockerTaskEngineState) AddTask ¶
func (state *DockerTaskEngineState) AddTask(task *api.Task)
AddTask adds a new task to the state
func (*DockerTaskEngineState) AllENIAttachments ¶
func (state *DockerTaskEngineState) AllENIAttachments() []*api.ENIAttachment
AllENIAttachments returns all the enis managed by ecs on the instance
func (*DockerTaskEngineState) AllImageStates ¶
func (state *DockerTaskEngineState) AllImageStates() []*image.ImageState
AllImageStates returns all of the image.ImageStates
func (*DockerTaskEngineState) AllTasks ¶
func (state *DockerTaskEngineState) AllTasks() []*api.Task
AllTasks returns all of the tasks
func (*DockerTaskEngineState) ContainerByID ¶
func (state *DockerTaskEngineState) ContainerByID(id string) (*api.DockerContainer, bool)
ContainerByID returns an api.DockerContainer for a given container ID
func (*DockerTaskEngineState) ContainerMapByArn ¶
func (state *DockerTaskEngineState) ContainerMapByArn(arn string) (map[string]*api.DockerContainer, bool)
ContainerMapByArn returns a map of containers belonging to a particular task ARN
func (*DockerTaskEngineState) ENIByMac ¶
func (state *DockerTaskEngineState) ENIByMac(mac string) (*api.ENIAttachment, bool)
ENIByMac returns the eni object that match the give mac address
func (*DockerTaskEngineState) GetAllContainerIDs ¶
func (state *DockerTaskEngineState) GetAllContainerIDs() []string
GetAllContainerIDs returns all of the Container Ids
func (*DockerTaskEngineState) MarshalJSON ¶
func (state *DockerTaskEngineState) MarshalJSON() ([]byte, error)
func (*DockerTaskEngineState) RemoveENIAttachment ¶
func (state *DockerTaskEngineState) RemoveENIAttachment(mac string)
RemoveENIAttachment removes the eni from state and stop managing
func (*DockerTaskEngineState) RemoveImageState ¶
func (state *DockerTaskEngineState) RemoveImageState(imageState *image.ImageState)
RemoveImageState removes an image.ImageState
func (*DockerTaskEngineState) RemoveTask ¶
func (state *DockerTaskEngineState) RemoveTask(task *api.Task)
RemoveTask removes a task from this state. It removes all containers and other associated metadata. It does acquire the write lock.
func (*DockerTaskEngineState) Reset ¶
func (state *DockerTaskEngineState) Reset()
Reset resets all the states
func (*DockerTaskEngineState) TaskByArn ¶
func (state *DockerTaskEngineState) TaskByArn(arn string) (*api.Task, bool)
TaskByArn returns a task for a given ARN
func (*DockerTaskEngineState) TaskByID ¶
func (state *DockerTaskEngineState) TaskByID(cid string) (*api.Task, bool)
TaskByID retrieves the task of a given docker container id
func (*DockerTaskEngineState) TaskByShortID ¶
func (state *DockerTaskEngineState) TaskByShortID(cid string) ([]*api.Task, bool)
TaskByShortID retrieves the task of a given docker short container id
func (*DockerTaskEngineState) UnmarshalJSON ¶
func (state *DockerTaskEngineState) UnmarshalJSON(data []byte) error
type TaskEngineState ¶
type TaskEngineState interface {
// AllTasks returns all of the tasks
AllTasks() []*api.Task
// AllImageStates returns all of the image.ImageStates
AllImageStates() []*image.ImageState
// GetAllContainerIDs returns all of the Container Ids
GetAllContainerIDs() []string
// ContainerByID returns an api.DockerContainer for a given container ID
ContainerByID(id string) (*api.DockerContainer, bool)
// ContainerMapByArn returns a map of containers belonging to a particular task ARN
ContainerMapByArn(arn string) (map[string]*api.DockerContainer, bool)
// TaskByShortID retrieves the task of a given docker short container id
TaskByShortID(cid string) ([]*api.Task, bool)
// TaskByID returns an api.Task for a given container ID
TaskByID(cid string) (*api.Task, bool)
// TaskByArn returns a task for a given ARN
TaskByArn(arn string) (*api.Task, bool)
// AddTask adds a task to the state to be stored
AddTask(task *api.Task)
// AddContainer adds a container to the state to be stored for a given task
AddContainer(container *api.DockerContainer, task *api.Task)
// AddImageState adds an image.ImageState to be stored
AddImageState(imageState *image.ImageState)
// AddENIAttachment adds an eni attachment from acs to be stored
AddENIAttachment(eni *api.ENIAttachment)
// RemoveENIAttachment removes an eni attachment to stop tracking
RemoveENIAttachment(mac string)
// ENIByMac returns the specific ENIAttachment of the given mac address
ENIByMac(mac string) (*api.ENIAttachment, bool)
// RemoveTask removes a task from the state
RemoveTask(task *api.Task)
// Reset resets all the fileds in the state
Reset()
// RemoveImageState removes an image.ImageState
RemoveImageState(imageState *image.ImageState)
json.Marshaler
json.Unmarshaler
}
TaskEngineState keeps track of all mappings between tasks we know about and containers docker runs
func NewTaskEngineState ¶
func NewTaskEngineState() TaskEngineState
NewTaskEngineState returns a new TaskEngineState
Source Files
Directories