data

Documentation

Index

• Constants
• func GetContainerID(c *apicontainer.Container) (string, error)
• type Client
  • func New(dataDir string) (Client, error)
  • func NewNoopClient() Client
  • func NewWithSetup(dataDir string) (Client, error)

Constants

const (
	AgentVersionKey         = "agent-version"
	AvailabilityZoneKey     = "availability-zone"
	ClusterNameKey          = "cluster-name"
	ContainerInstanceARNKey = "container-instance-arn"
	EC2InstanceIDKey        = "ec2-instance-id"
	TaskManifestSeqNumKey   = "task-manifest-seq-num"
)

Functions

func GetContainerID

func GetContainerID(c *apicontainer.Container) (string, error)

GetContainerID returns a unique ID for a container to use as key when saving to DB.

Types

type Client

type Client interface {
	// SaveContainer saves the data of a container.
	SaveContainer(*container.Container) error
	// SaveDockerContainer saves the data of a docker container.
	// We have both SaveContainer and SaveDockerContainer so that a caller who doesn't have docker information
	// of the container can save container with SaveContainer, while a caller who wants to save the docker
	// information of the container can save it with SaveDockerContainer.
	SaveDockerContainer(*container.DockerContainer) error
	// DeleteContainer deletes the data of a container.
	DeleteContainer(string) error
	// GetContainers gets the data of all the containers.
	GetContainers() ([]*container.DockerContainer, error)

	// SaveTask saves the data of a task.
	SaveTask(*task.Task) error
	// DeleteTask deletes the data of a task.
	DeleteTask(string) error
	// GetTasks gets the data of all the tasks.
	GetTasks() ([]*task.Task, error)

	// SaveImageState saves the data of an image state.
	SaveImageState(*image.ImageState) error
	// DeleteImageState deletes the data of an image state.
	DeleteImageState(string) error
	// GetImageStates gets the data of all the image states.
	GetImageStates() ([]*image.ImageState, error)

	// SaveENIAttachment saves the data of an ENI attachment.
	SaveENIAttachment(*eni.ENIAttachment) error
	// DeleteENIAttachment deletes the data of an ENI atttachment.
	DeleteENIAttachment(string) error
	// GetENIAttachments gets the data of all the ENI attachment.
	GetENIAttachments() ([]*eni.ENIAttachment, error)

	// SaveMetadata saves a key value pair of metadata.
	SaveMetadata(string, string) error
	// GetMetadata gets the value of a certain kind of metadata.
	GetMetadata(string) (string, error)

	// Close closes the connection to database.
	Close() error
}

Client specifies the data management interface to persist and manage various kinds of data in the agent.

func New

func New(dataDir string) (Client, error)

New returns a data client that implements the Client interface with boltdb.

func NewNoopClient

func NewNoopClient() Client

NewNoopClient returns a client that implements the data interface with no-op. It is used by the agent when ECS_CHECKPOINT is set to false, and is also used in testing.

func NewWithSetup

func NewWithSetup(dataDir string) (Client, error)

NewWithSetup returns a data client that implements the Client interface with boltdb. It always runs the db setup. Used for testing.