ecspresso

README

ecspresso

ecspresso is a deployment tool for Amazon ECS.

(pronounced same as "espresso")

Usage

usage: ecspresso --config=CONFIG [<flags>] <command> [<args> ...]

Flags:
  --help           Show context-sensitive help (also try --help-long and --help-man).
  --config=CONFIG  config file

Commands:
  help [<command>...]
    Show help.

  deploy [<flags>]
    deploy service

  create [<flags>]
    create service

  status [<flags>]
    show status of service

  rollback [<flags>]
    rollback service

For more options for sub-commands, See ecspresso sub-command --help.

Configuration file

YAML format.

region: ap-northeast-1
cluster: default
service: myService
task_definition: myTask.json
timeout: 5m

ecspresso works as below.

• Register a new task definition from JSON file.
  • JSON file is allowed both of formats as below.
    • aws ecs describe-task-definition output.
    • aws ecs register-task-definition --cli-input-json input.
  • Replace {{ env `FOO` `bar` }} syntax in the JSON file to environment variable "FOO".
    • If "FOO" is not defined, replaced by "bar"
  • Replace {{ must_env `FOO` }} syntax in the JSON file to environment variable "FOO".
    • If "FOO" is not defined, abort immediately.
• Update a service definition.
• Wait a service stable.

Example of deploy

$ ecspresso deploy --config config.yaml
2017/11/09 23:20:13 myService/default Starting deploy
Service: myService
Cluster: default
TaskDefinition: myService:3
Deployments:
    PRIMARY myService:3 desired:1 pending:0 running:1
Events:
2017/11/09 23:20:13 myService/default Creating a new task definition by myTask.json
2017/11/09 23:20:13 myService/default Registering a new task definition...
2017/11/09 23:20:13 myService/default Task definition is registered myService:4
2017/11/09 23:20:13 myService/default Updating service...
2017/11/09 23:20:13 myService/default Waiting for service stable...(it will take a few minutes)
2017/11/09 23:23:23 myService/default  PRIMARY myService:4 desired:1 pending:0 running:1
2017/11/09 23:23:29 myService/default Service is stable now. Completed!

Scale out/in

To change desired count of the service, specify --tasks option.

If --skip-task-definition is set, task definition will not be registered.

$ ecspresso deploy --config config.yaml --tasks 10 --skip-task-definition

Example of create

escpresso can create service by service_definition JSON file and task_definition.

$ ecspresso create --config config.yaml
...

# config.yaml
service_definition: service.json

example of service.json below.

{
  "role": "ecsServiceRole",
  "desiredCount": 2,
  "loadBalancers": [
    {
      "containerName": "myLoadbalancer",
      "containerPort": 80,
      "targetGroupArn": "arn:aws:elasticloadbalancing:[region]:[account-id]:targetgroup/{target-name}/201ae83c14de522d"
    }
  ]
}

Keys are same format as aws ecs describe-services output.

• deploymentConfiguration
• launchType
• loadBalancers
• networkConfiguration
• placementConstraint
• placementStrategy
• role

Notes

Deploy to Fargate

If you want to deploy services to Fargate, task-definition and service-definition requires some settings.

For task definition,

• requiresCompatibilities (required "FARGATE")
• networkMode (required "awsvpc")
• cpu (required)
• memory (required)
• executionRoleArn (optional)

{
  "taskDefinition": {
    "networkMode": "awsvpc",
    "requiresCompatibilities": [
      "FARGATE"
    ],
    "cpu": "1024",
    "memory": "2048",
    // ...
}

For service-definition,

• launchType (required "FARGATE")
• networkConfiguration (required "awsvpcConfiguration")

{
  "launchType": "FARGATE",
  "networkConfiguration": {
    "awsvpcConfiguration": {
      "subnets": [
        "subnet-aaaaaaaa",
        "subnet-bbbbbbbb"
      ],
      "securityGroups": [
        "sg-11111111"
      ],
      "assignPublicIp": "ENABLED"
    }
  },
  // ...
}

LICENCE

MIT

Author

KAYAC Inc.

Documentation

Index

• Constants
• Variables
• type App
  • func NewApp(conf *Config) (*App, error)
  • func (d *App) Create(opt CreateOption) error
  • func (d *App) Deploy(opt DeployOption) error
  • func (d *App) DescribeServiceDeployments(ctx context.Context, startedAt time.Time) (int, error)
  • func (d *App) DescribeServiceStatus(ctx context.Context, events int) (*ecs.Service, error)
  • func (d *App) DescribeServicesInput() *ecs.DescribeServicesInput
  • func (d *App) FindRollbackTarget(ctx context.Context, taskDefinitionArn string) (string, error)
  • func (d *App) LoadServiceDefinition(path string) (*ecs.CreateServiceInput, error)
  • func (d *App) LoadTaskDefinition(path string) (*ecs.TaskDefinition, error)
  • func (d *App) Log(v ...interface{})
  • func (d *App) Name() string
  • func (d *App) RegisterTaskDefinition(ctx context.Context, td *ecs.TaskDefinition) (*ecs.TaskDefinition, error)
  • func (d *App) Rollback(opt RollbackOption) error
  • func (d *App) Start() (context.Context, context.CancelFunc)
  • func (d *App) Status(opt StatusOption) error
  • func (d *App) UpdateService(ctx context.Context, taskDefinitionArn string, count int64, force bool) error
  • func (d *App) WaitServiceStable(ctx context.Context, startedAt time.Time) error
• type Config
  • func NewDefaultConfig() *Config
  • func (c *Config) Validate() error
• type CreateOption
• type DeployOption
• type RollbackOption
• type ServiceDefinition
• type StatusOption

Constants

const KeepDesiredCount = -1

Variables

var TerminalWidth = 90

Types

type App

type App struct {
	Service string
	Cluster string
	// contains filtered or unexported fields
}

func NewApp

func NewApp(conf *Config) (*App, error)

func (*App) Create

func (d *App) Create(opt CreateOption) error

func (*App) Deploy

func (d *App) Deploy(opt DeployOption) error

func (*App) DescribeServiceDeployments

func (d *App) DescribeServiceDeployments(ctx context.Context, startedAt time.Time) (int, error)

func (*App) DescribeServiceStatus

func (d *App) DescribeServiceStatus(ctx context.Context, events int) (*ecs.Service, error)

func (*App) DescribeServicesInput

func (d *App) DescribeServicesInput() *ecs.DescribeServicesInput

func (*App) FindRollbackTarget

func (d *App) FindRollbackTarget(ctx context.Context, taskDefinitionArn string) (string, error)

func (*App) LoadServiceDefinition

func (d *App) LoadServiceDefinition(path string) (*ecs.CreateServiceInput, error)

func (*App) LoadTaskDefinition

func (d *App) LoadTaskDefinition(path string) (*ecs.TaskDefinition, error)

func (*App) Log

func (d *App) Log(v ...interface{})

func (*App) Name

func (d *App) Name() string

func (*App) RegisterTaskDefinition

func (d *App) RegisterTaskDefinition(ctx context.Context, td *ecs.TaskDefinition) (*ecs.TaskDefinition, error)

func (*App) Rollback

func (d *App) Rollback(opt RollbackOption) error

func (*App) Start

func (d *App) Start() (context.Context, context.CancelFunc)

func (*App) Status

func (d *App) Status(opt StatusOption) error

func (*App) UpdateService

func (d *App) UpdateService(ctx context.Context, taskDefinitionArn string, count int64, force bool) error

func (*App) WaitServiceStable

func (d *App) WaitServiceStable(ctx context.Context, startedAt time.Time) error

type Config

type Config struct {
	Region                string        `yaml:"region"`
	Service               string        `yaml:"service"`
	Cluster               string        `yaml:"cluster"`
	TaskDefinitionPath    string        `yaml:"task_definition"`
	ServiceDefinitionPath string        `yaml:"service_definition"`
	Timeout               time.Duration `yaml:"timeout"`
}

func NewDefaultConfig

func NewDefaultConfig() *Config

func (*Config) Validate

func (c *Config) Validate() error

type CreateOption

type CreateOption struct {
	DryRun       *bool
	DesiredCount *int64
}

type DeployOption

type DeployOption struct {
	DryRun             *bool
	DesiredCount       *int64
	SkipTaskDefinition *bool
	ForceNewDeployment *bool
}

type RollbackOption

type RollbackOption struct {
	DryRun                   *bool
	DeregisterTaskDefinition *bool
}

type ServiceDefinition

type ServiceDefinition struct {
	DeploymentConfiguration *ecs.DeploymentConfiguration `json:"deploymentConfiguration"`
	LaunchType              *string                      `json:"launchType"`
	LoadBalancers           []*ecs.LoadBalancer          `json:"loadBalancers"`
	NetworkConfiguration    *ecs.NetworkConfiguration    `json:"networkConfiguration"`
	PlacementConstraints    []*ecs.PlacementConstraint   `json:"placementConstraints"`
	PlacementStrategy       []*ecs.PlacementStrategy     `json:"placementStrategy"`
	Role                    *string                      `json:"role"`
	DesiredCount            *int64                       `json:"desiredCount"`
}

type StatusOption

type StatusOption struct {
	Events *int
}