api

Documentation

Index

• type ContainerStateChange
  • func NewContainerStateChangeEvent(task *apitask.Task, cont *apicontainer.Container, reason string) (ContainerStateChange, error)
  • func (ContainerStateChange) GetEventType() statechange.EventType
  • func (c *ContainerStateChange) String() string
• type ECSClient
• type ECSSDK
• type ECSSubmitStateSDK
• type TaskStateChange
  • func NewTaskStateChangeEvent(task *apitask.Task, reason string) (TaskStateChange, error)
  • func (TaskStateChange) GetEventType() statechange.EventType
  • func (change *TaskStateChange) SetTaskTimestamps()
  • func (change *TaskStateChange) ShouldBeReported() bool
  • func (change *TaskStateChange) String() string

Types

type ContainerStateChange

type ContainerStateChange struct {
	// TaskArn is the unique identifier for the task
	TaskArn string
	// ContainerName is the name of the container
	ContainerName string
	// Status is the status to send
	Status apicontainerstatus.ContainerStatus

	// Reason may contain details of why the container stopped
	Reason string
	// ExitCode is the exit code of the container, if available
	ExitCode *int
	// PortBindings are the details of the host ports picked for the specified
	// container ports
	PortBindings []apicontainer.PortBinding

	// Container is a pointer to the container involved in the state change that gives the event handler a hook into
	// storing what status was sent.  This is used to ensure the same event is handled only once.
	Container *apicontainer.Container
}

ContainerStateChange represents a state change that needs to be sent to the SubmitContainerStateChange API

func NewContainerStateChangeEvent

func NewContainerStateChangeEvent(task *apitask.Task, cont *apicontainer.Container, reason string) (ContainerStateChange, error)

NewContainerStateChangeEvent creates a new container state change event

func (ContainerStateChange) GetEventType

func (ContainerStateChange) GetEventType() statechange.EventType

GetEventType returns an enum identifying the event type

func (*ContainerStateChange) String

func (c *ContainerStateChange) String() string

String returns a human readable string representation of this object

type ECSClient

type ECSClient interface {
	// RegisterContainerInstance calculates the appropriate resources, creates
	// the default cluster if necessary, and returns the registered
	// ContainerInstanceARN if successful. Supplying a non-empty container
	// instance ARN allows a container instance to update its registered
	// resources.
	RegisterContainerInstance(existingContainerInstanceArn string, attributes []*ecs.Attribute) (string, error)
	// SubmitTaskStateChange sends a state change and returns an error
	// indicating if it was submitted
	SubmitTaskStateChange(change TaskStateChange) error
	// SubmitContainerStateChange sends a state change and returns an error
	// indicating if it was submitted
	SubmitContainerStateChange(change ContainerStateChange) error
	// DiscoverPollEndpoint takes a ContainerInstanceARN and returns the
	// endpoint at which this Agent should contact ACS
	DiscoverPollEndpoint(containerInstanceArn string) (string, error)
	// DiscoverTelemetryEndpoint takes a ContainerInstanceARN and returns the
	// endpoint at which this Agent should contact Telemetry Service
	DiscoverTelemetryEndpoint(containerInstanceArn string) (string, error)
}

ECSClient is an interface over the ECSSDK interface which abstracts away some details around constructing the request and reading the response down to the parts the agent cares about. For example, the ever-present 'Cluster' member is abstracted out so that it may be configured once and used throughout transparently.

type ECSSDK

type ECSSDK interface {
	CreateCluster(*ecs.CreateClusterInput) (*ecs.CreateClusterOutput, error)
	RegisterContainerInstance(*ecs.RegisterContainerInstanceInput) (*ecs.RegisterContainerInstanceOutput, error)
	DiscoverPollEndpoint(*ecs.DiscoverPollEndpointInput) (*ecs.DiscoverPollEndpointOutput, error)
}

ECSSDK is an interface that specifies the subset of the AWS Go SDK's ECS client that the Agent uses. This interface is meant to allow injecting a mock for testing.

type ECSSubmitStateSDK

type ECSSubmitStateSDK interface {
	SubmitContainerStateChange(*ecs.SubmitContainerStateChangeInput) (*ecs.SubmitContainerStateChangeOutput, error)
	SubmitTaskStateChange(*ecs.SubmitTaskStateChangeInput) (*ecs.SubmitTaskStateChangeOutput, error)
}

ECSSubmitStateSDK is an interface with customized ecs client that implements the SubmitTaskStateChange and SubmitContainerStateChange

type TaskStateChange

type TaskStateChange struct {
	// Attachment is the eni attachment object to send
	Attachment *apieni.ENIAttachment
	// TaskArn is the unique identifier for the task
	TaskARN string
	// Status is the status to send
	Status apitaskstatus.TaskStatus
	// Reason may contain details of why the task stopped
	Reason string
	// Containers holds the events generated by containers owned by this task
	Containers []ContainerStateChange

	// PullStartedAt is the timestamp when the task start pulling
	PullStartedAt *time.Time
	// PullStoppedAt is the timestamp when the task finished pulling
	PullStoppedAt *time.Time
	// ExecutionStoppedAt is the timestamp when the essential container stopped
	ExecutionStoppedAt *time.Time

	// Task is a pointer to the task involved in the state change that gives the event handler a hook into storing
	// what status was sent.  This is used to ensure the same event is handled only once.
	Task *apitask.Task
}

TaskStateChange represents a state change that needs to be sent to the SubmitTaskStateChange API

func NewTaskStateChangeEvent

func NewTaskStateChangeEvent(task *apitask.Task, reason string) (TaskStateChange, error)

NewTaskStateChangeEvent creates a new task state change event

func (TaskStateChange) GetEventType

func (TaskStateChange) GetEventType() statechange.EventType

GetEventType returns an enum identifying the event type

func (*TaskStateChange) SetTaskTimestamps

func (change *TaskStateChange) SetTaskTimestamps()

SetTaskTimestamps adds the timestamp information of task into the event to be sent by SubmitTaskStateChange

func (*TaskStateChange) ShouldBeReported

func (change *TaskStateChange) ShouldBeReported() bool

ShouldBeReported checks if the statechange should be reported to backend

func (*TaskStateChange) String

func (change *TaskStateChange) String() string

String returns a human readable string representation of this object