task

Documentation

Overview

Package task provides support for running Amazon ECS tasks.

Index

• type ClusterGetter
• type ConfigRunner
  • func (r *ConfigRunner) Run() ([]*Task, error)
• type DefaultClusterGetter
• type EnvRunner
  • func (r *EnvRunner) Run() ([]*Task, error)
• type EnvironmentDescriber
• type Runner
• type Task
• type VPCGetter

Types

type ClusterGetter

type ClusterGetter interface {
	ClusterARN(app, env string) (string, error)
}

ClusterGetter wraps the method of getting a cluster ARN.

type ConfigRunner

type ConfigRunner struct {
	// Count of the tasks to be launched.
	Count int
	// Group Name of the tasks that use the same task definition.
	GroupName string

	// The ARN of the cluster to run the task.
	Cluster string

	// Network configuration
	Subnets        []string
	SecurityGroups []string

	// Interfaces to interact with dependencies. Must not be nil.
	ClusterGetter DefaultClusterGetter
	Starter       Runner

	// Must not be nil if using default subnets.
	VPCGetter VPCGetter
}

ConfigRunner runs an Amazon ECS task in the subnets, security groups, and cluster. It uses the default subnets and the default cluster if the corresponding field is empty.

func (*ConfigRunner) Run

func (r *ConfigRunner) Run() ([]*Task, error)

Run runs tasks given subnets, security groups and the cluster, and returns the tasks. If subnets are not provided, it uses the default subnets. If cluster is not provided, it uses the default cluster.

type DefaultClusterGetter

type DefaultClusterGetter interface {
	DefaultCluster() (string, error)
}

DefaultClusterGetter wraps the method of getting a default cluster ARN.

type EnvRunner

type EnvRunner struct {
	// Count of the tasks to be launched.
	Count int
	// Group Name of the tasks that use the same task definition.
	GroupName string

	// App and Env in which the tasks will be launched.
	App string
	Env string

	// Interfaces to interact with dependencies. Must not be nil.
	VPCGetter            VPCGetter
	ClusterGetter        ClusterGetter
	Starter              Runner
	EnvironmentDescriber EnvironmentDescriber
}

EnvRunner can run an Amazon ECS task in the VPC and the cluster of an environment.

func (*EnvRunner) Run

func (r *EnvRunner) Run() ([]*Task, error)

Run runs tasks in the environment of the application, and returns the tasks.

type EnvironmentDescriber

type EnvironmentDescriber interface {
	Describe() (*describe.EnvDescription, error)
}

type Runner

type Runner interface {
	RunTask(input ecs.RunTaskInput) ([]*ecs.Task, error)
}

Runner wraps the method of running tasks.

type Task

type Task struct {
	TaskARN    string
	ClusterARN string
	StartedAt  *time.Time
	ENI        string
}

Task represents a one-off workload that runs until completed or an error occurs.

type VPCGetter

type VPCGetter interface {
	SubnetIDs(filters ...ec2.Filter) ([]string, error)
	SecurityGroups(filters ...ec2.Filter) ([]string, error)
}

VPCGetter wraps methods of getting VPC info.