ecspresso

README

ecspresso

ecspresso is a deployment tool for Amazon ECS.

(pronounced same as "espresso")

Documents

ecspresso handbook (Japanese)

ecspresso Advent Calendar 2020 (Japanese)

Install

Homebrew (macOS and Linux)

$ brew install kayac/tap/ecspresso

Binary packages

Releases

CircleCI Orbs

https://circleci.com/orbs/registry/orb/fujiwara/ecspresso

version: 2.1
orbs:
  ecspresso: fujiwara/ecspresso@0.0.15
jobs:
  install:
    steps:
      - checkout
      - ecspresso/install:
          version: v1.6.0 # or latest
      - run:
          command: |
            ecspresso version

GitHub Actions

Action kayac/ecspresso@v1 installs ecspresso binary for Linux into /usr/local/bin. This action runs install only.

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: kayac/ecspresso@v1
        with:
          version: v1.6.0
      - run: |
          ecspresso deploy --config config.yaml

Pass the parameter "latest" to use the latest version of ecspresso.

      - uses: kayac/ecspresso@v1
        with:
          version: latest

Usage

usage: ecspresso [<flags>] <command> [<args> ...]

Flags:
  --help                 Show context-sensitive help (also try --help-long and
                         --help-man).
  --config=CONFIG        config file
  --debug                enable debug log
  --envfile=ENVFILE ...  environment files
  --color                enable colored output

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

  version
    show version

  deploy [<flags>]
    deploy service

  scale [<flags>]
    scale service. equivalent to deploy --skip-task-definition
    --no-update-service

  refresh [<flags>]
    refresh service. equivalent to deploy --skip-task-definition
    --force-new-deployment --no-update-service

  create [<flags>]
    create service

  status [<flags>]
    show status of service

  rollback [<flags>]
    rollback service

  delete [<flags>]
    delete service

  run [<flags>]
    run task

  register [<flags>]
    register task definition

  wait
    wait until service stable

  init --service=SERVICE [<flags>]
    create service/task definition files by existing ECS service

  diff
    display diff for task definition compared with latest one on ECS

  appspec [<flags>]
    output AppSpec YAML for CodeDeploy to STDOUT

  verify [<flags>]
    verify resources in configurations

  render [<flags>]
    render config, service definition or task definition file to stdout

  tasks [<flags>]
    list tasks that are in a service or having the same family

  exec [<flags>]
    execute command in a task

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

Quick Start

ecspresso can easily manage your existing/running ECS service by codes.

Try ecspresso init for your ECS service with option --region, --cluster and --service.

$ ecspresso init --region ap-northeast-1 --cluster default --service myservice --config config.yaml
2019/10/12 01:31:48 myservice/default save service definition to ecs-service-def.json
2019/10/12 01:31:48 myservice/default save task definition to ecs-task-def.json
2019/10/12 01:31:48 myservice/default save config to config.yaml

Let me see the generated files config.yaml, ecs-service-def.json, and ecs-task-def.json.

And then, you already can deploy the service by ecspresso!

$ ecspresso deploy --config config.yaml

Configuration file

YAML format.

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

ecspresso deploy works as below.

• Register a new task definition from JSON file.
  • JSON file is allowed in both 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 service tasks.
  • When --update-service option set, update service attributes by service definition.
• Wait for a service to be stable.

Configuration files and task/service definition files are read by go-config. go-config has template functions env, must_env and json_escape.

Example of deployment

Rolling deployment

$ 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!

Blue/Green deployment (with AWS CodeDeploy)

ecspresso create can create a service having CODE_DEPLOY deployment controller. See ecs-service-def.json below.

{
  "deploymentController": {
    "type": "CODE_DEPLOY"
  },
  # ...
}

Currently, ecspresso doesn't create any resources on CodeDeploy. You must create an application and a deployment group for your ECS service on CodeDeploy in the other way.

ecspresso deploy creates a new deployment for CodeDeploy, and it continues on CodeDeploy.

$ ecspresso deploy --config config.yaml --rollback-events DEPLOYMENT_FAILURE
2019/10/15 22:47:07 myService/default Starting deploy
Service: myService
Cluster: default
TaskDefinition: myService:5
TaskSets:
   PRIMARY myService:5 desired:1 pending:0 running:1
Events:
2019/10/15 22:47:08 myService/default Creating a new task definition by ecs-task-def.json
2019/10/15 22:47:08 myService/default Registering a new task definition...
2019/10/15 22:47:08 myService/default Task definition is registered myService:6
2019/10/15 22:47:08 myService/default desired count: 1
2019/10/15 22:47:09 myService/default Deployment d-XXXXXXXXX is created on CodeDeploy
2019/10/15 22:47:09 myService/default https://ap-northeast-1.console.aws.amazon.com/codesuite/codedeploy/deployments/d-XXXXXXXXX?region=ap-northeast-1

CodeDeploy appspec hooks can be defined in a config file. ecspresso creates Resources and version elements in appspec on deploy automatically.

cluster: default
service: test
service_definition: ecs-service-def.json
task_definition: ecs-task-def.json
appspec:
  Hooks:
    - BeforeInstall: "LambdaFunctionToValidateBeforeInstall"
    - AfterInstall: "LambdaFunctionToValidateAfterTraffic"
    - AfterAllowTestTraffic: "LambdaFunctionToValidateAfterTestTrafficStarts"
    - BeforeAllowTraffic: "LambdaFunctionToValidateBeforeAllowingProductionTraffic"
    - AfterAllowTraffic: "LambdaFunctionToValidateAfterAllowingProductionTraffic"

Scale out/in

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

$ ecspresso scale --config config.yaml --tasks 10

scale command is equivalent to deploy --skip-task-definition --no-update-service.

Example of create

escpresso can create a 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 in the same format as aws ecs describe-services output.

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

Example of run task

$ ecspresso run --config config.yaml --task-def=db-migrate.json

When --task-def is not set, use a task definition included in a service.

Other options for RunTask API are set by service attributes(CapacityProviderStrategy, LaunchType, PlacementConstraints, PlacementStrategy and PlatformVersion).

Notes

Use Jsonnet instead of JSON

ecspresso v1.7 or later can use Jsonnet file format for service and task definition.

If the file extension is .jsonnet, ecspresso will process Jsonnet first, convert it to JSON, and then load it.

service_definition: ecs-service-def.jsonnet
task_definition: ecs-task-def.jsonnet

ecspresso includes github.com/google/go-jsonnet as a library, we don't need the jsonnet command.

--ext-str and --ext-code flag sets Jsonnet External Variables.

$ ecspresso --ext-str Foo=foo --ext-code "Bar=1+1" ...

{
  foo: std.extVar('Foo'), // = "foo"
  bar: std.extVar('Bar'), // = 2
}

Deploy to Fargate

If you want to deploy services to Fargate, task definitions and service definitions require some settings.

For task definitions,

• 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"
    }
  },
  // ...
}

Fargate Spot support

1. Set capacityProviders and defaultCapacityProviderStrategy to ECS cluster.
2. If you hope to migrate existing service to use Fargate Spot, define capacityProviderStrategy into service definition as below. ecspresso deploy --update-service applies the settings to the service.

{
  "capacityProviderStrategy": [
    {
      "base": 1,
      "capacityProvider": "FARGATE",
      "weight": 1
    },
    {
      "base": 0,
      "capacityProvider": "FARGATE_SPOT",
      "weight": 1
    }
  ],
  # ...

How to check diff and verify service/task definitions before deploy.

ecspresso supports diff and verify subcommands.

diff

Shows differences between local task/service definitions and remote (on ECS) definitions.

$ ecspresso --config config.yaml diff --unified
--- arn:aws:ecs:ap-northeast-1:123456789012:service/ecspresso-test/nginx-local
+++ ecs-service-def.json
@@ -38,5 +38,5 @@
   },
   "placementConstraints": [],
   "placementStrategy": [],
-  "platformVersion": "1.3.0"
+  "platformVersion": "LATEST"
 }
 
--- arn:aws:ecs:ap-northeast-1:123456789012:task-definition/ecspresso-test:202
+++ ecs-task-def.json
@@ -1,6 +1,10 @@
 {
   "containerDefinitions": [
     {
       "cpu": 0,
       "environment": [],
       "essential": true,
-      "image": "nginx:latest",
+      "image": "nginx:alpine",
       "logConfiguration": {
         "logDriver": "awslogs",
         "options": {

verify

Verify resources related with service/task definitions.

For example,

• An ECS cluster exists.
• The target groups in service definitions match the container name and port defined in the definitions.
• A task role and a task execution role exist and can be assumed by ecs-tasks.amazonaws.com.
• Container images exist at the URL defined in task definitions. (Checks only for ECR or DockerHub public images.)
• Secrets in task definitions exist and be readable.
• Can create log streams, can put messages to the streams in specified CloudWatch log groups.

ecspresso verify tries to assume the task execution role defined in task definitions to verify these items. If failed to assume the role, it continues to verify with the current sessions.

$ ecspresso --config config.yaml verify
2020/12/08 11:43:10 nginx-local/ecspresso-test Starting verify
  TaskDefinition
    ExecutionRole[arn:aws:iam::123456789012:role/ecsTaskRole]
    --> [OK]
    TaskRole[arn:aws:iam::123456789012:role/ecsTaskRole]
    --> [OK]
    ContainerDefinition[nginx]
      Image[nginx:alpine]
      --> [OK]
      LogConfiguration[awslogs]
      --> [OK]
    --> [OK]
  --> [OK]
  ServiceDefinition
  --> [OK]
  Cluster
  --> [OK]
2020/12/08 11:43:14 nginx-local/ecspresso-test Verify OK!

tasks

task command lists tasks run by a service or having the same family to a task definition.

Flags:
  --id=""                task ID
  --output=table         output format (table|json|tsv)
  --find                 find a task from tasks list and dump it as JSON
  --stop                 stop a task
  --force                stop a task without confirmation prompt

When --find option is set, you can select a task in a list of tasks and show the task as JSON.

filter_command in config.yaml can define a command to filter tasks. For example peco, fzf and etc.

filter_command: peco

When --stop option is set, you can select a task in a list of tasks and stop the task.

exec

exec command executes a command on task.

session-manager-plugin is required in PATH.

Flags:
  --id=""                task ID
  --command="sh"         command
  --container=CONTAINER  container name

If --id is not set, the command shows a list of tasks to select a task to execute.

filter_command in config.yaml works the same as tasks command.

See also the official document Using Amazon ECS Exec for debugging.

port forwarding

ecspresso exec --port-forward forwards local port to ECS tasks port.

$ ecspresso exec --port-forward --port 80 --local-port 8080
...

If --id is not set, the command shows a list of tasks to select a task to forward port.

When --local-port is not specified, use the ephemeral port for local port.

suspend / resume application auto scaling

ecspresso deploy and scale can suspend / resume application auto scaling.

--suspend-auto-scaling sets suspended state true. --resume-auto-scaling sets suspended state false.

When you want to change the suspended state simply, try ecspresso scale --suspend-auto-scaling or ecspresso scale --resume-auto-scaling. That operation will change suspended state only.

Plugins

tfstate

tfstate plugin introduces a template function tfstate.

config.yaml

region: ap-northeast-1
cluster: default
service: test
service_definition: ecs-service-def.json
task_definition: ecs-task-def.json
plugins:
  - name: tfstate
    config:
      path: terraform.tfstate    # path to tfstate file
      # or url: s3://my-bucket/terraform.tfstate

ecs-service-def.json

{
  "networkConfiguration": {
    "awsvpcConfiguration": {
      "subnets": [
        "{{ tfstatef `aws_subnet.private['%s'].id` `az-a` }}"
      ],
      "securityGroups": [
        "{{ tfstate `data.aws_security_group.default.id` }}"
      ]
    }
  }
}

{{ tfstate "resource_type.resource_name.attr" }} will expand to an attribute value of the resource in tfstate.

{{ tfstatef "resource_type.resource_name['%s'].attr" "index" }} is similar to {{ tfstatef "resource_type.resource_name['index'].attr" }}. This function is useful to build a resource address with environment variables.

{{ tfstatef `aws_subnet.ecs['%s'].id` (must_env `SERVICE`) }}

cloudformation

cloudformation plugin introduces template functions cfn_output and cfn_export.

An example of CloudFormation stack template defines Outputs and Exports.

# StackName: ECS-ecspresso
Outputs:
  SubnetAz1:
    Value: !Ref PublicSubnetAz1
  SubnetAz2:
    Value: !Ref PublicSubnetAz2
  EcsSecurityGroupId:
    Value: !Ref EcsSecurityGroup
    Export:
      Name: !Sub ${AWS::StackName}-EcsSecurityGroupId

Load cloudformation plugin in a config file.

config.yaml

# ...
plugins:
  - name: cloudformation

cfn_output StackName OutputKey lookups OutputValue of OutputKey in the StackName. cfn_export ExportName lookups exported value by name.

ecs-service-def.json

{
  "networkConfiguration": {
    "awsvpcConfiguration": {
      "subnets": [
        "{{ cfn_output `ECS-ecspresso` `SubnetAz1` }}",
        "{{ cfn_output `ECS-ecspresso` `SubnetAz2` }}"
      ],
      "securityGroups": [
        "{{ cfn_export `ECS-ecspresso-EcsSecurityGroupId` }}"
      ]
    }
  }
}

LICENCE

MIT

Author

KAYAC Inc.

Documentation

Index

• Constants
• Variables
• func ExportEnvFile(file string) error
• func MarshalJSON(s interface{}) ([]byte, error)
• func MarshalJSONString(s interface{}) string
• func NormalizePlatform(p *ecs.RuntimePlatform, isFargate bool) (arch, os string)
• type App
  • func NewApp(conf *Config) (*App, error)
  • func (d *App) AppSpec(opt AppSpecOption) error
  • func (d *App) Create(opt CreateOption) error
  • func (d *App) DebugLog(v ...interface{})
  • func (d *App) Delete(opt DeleteOption) error
  • func (d *App) Deploy(opt DeployOption) error
  • func (d *App) DeployByCodeDeploy(ctx context.Context, taskDefinitionArn string, count *int64, sv *ecs.Service, ...) error
  • func (d *App) Deregister(opt DeregisterOption) error
  • func (d *App) DescribeService(ctx context.Context) (*ecs.Service, 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) DescribeTaskDefinition(ctx context.Context, tdArn string) (*TaskDefinitionInput, error)
  • func (d *App) DescribeTaskStatus(ctx context.Context, task *ecs.Task, watchContainer *ecs.ContainerDefinition) error
  • func (d *App) DescribeTasksInput(task *ecs.Task) *ecs.DescribeTasksInput
  • func (d *App) Diff(opt DiffOption) error
  • func (d *App) Exec(opt ExecOption) error
  • func (d *App) FindRollbackTarget(ctx context.Context, taskDefinitionArn string) (string, error)
  • func (d *App) GetLogEvents(ctx context.Context, logGroup string, logStream string, startedAt time.Time, ...) (*string, error)
  • func (d *App) GetLogEventsInput(logGroup string, logStream string, startAt int64, nextToken *string) *cloudwatchlogs.GetLogEventsInput
  • func (d *App) GetLogInfo(task *ecs.Task, c *ecs.ContainerDefinition) (string, string)
  • func (d *App) Init(opt InitOption) error
  • func (d *App) LoadServiceDefinition(path string) (*ecs.Service, error)
  • func (d *App) LoadTaskDefinition(path string) (*TaskDefinitionInput, error)
  • func (d *App) Log(v ...interface{})
  • func (d *App) LogJSON(v interface{})
  • func (d *App) Name() string
  • func (d *App) Register(opt RegisterOption) error
  • func (d *App) RegisterTaskDefinition(ctx context.Context, td *TaskDefinitionInput) (*TaskDefinition, error)
  • func (d *App) Render(opt RenderOption) error
  • func (d *App) Revesions(opt RevisionsOption) error
  • func (d *App) Rollback(opt RollbackOption) error
  • func (d *App) RollbackByCodeDeploy(ctx context.Context, sv *ecs.Service, tdArn string, opt RollbackOption) error
  • func (d *App) Run(opt RunOption) error
  • func (d *App) RunTask(ctx context.Context, tdArn string, ov *ecs.TaskOverride, opt *RunOption) (*ecs.Task, error)
  • func (d *App) Start() (context.Context, context.CancelFunc)
  • func (d *App) Status(opt StatusOption) error
  • func (d *App) Tasks(opt TasksOption) error
  • func (d *App) UpdateServiceAttributes(ctx context.Context, sv *ecs.Service, opt DeployOption) error
  • func (d *App) UpdateServiceTasks(ctx context.Context, taskDefinitionArn string, count *int64, opt DeployOption) error
  • func (d *App) Verify(opt VerifyOption) error
  • func (d *App) Wait(opt WaitOption) error
  • func (d *App) WaitForCodeDeploy(ctx context.Context, sv *ecs.Service) error
  • func (d *App) WaitRunTask(ctx context.Context, task *ecs.Task, watchContainer *ecs.ContainerDefinition, ...) error
  • func (d *App) WaitServiceStable(ctx context.Context, startedAt time.Time) error
• type AppSpecOption
• type Config
  • func NewDefaultConfig() *Config
  • func (c *Config) Load(path string) error
  • func (c *Config) Restrict() error
  • func (c *Config) ValidateVersion(version string) error
• type ConfigPlugin
  • func (p ConfigPlugin) Setup(c *Config) error
• type CreateOption
  • func (opt CreateOption) DryRunString() string
• type DeleteOption
  • func (opt DeleteOption) DryRunString() string
• type DeployOption
  • func (opt DeployOption) DryRunString() string
• type DeregisterOption
  • func (opt DeregisterOption) DryRunString() string
• type DiffOption
• type DryRunnable
• type ExecOption
• type InitOption
• type RegisterOption
  • func (opt RegisterOption) DryRunString() string
• type RenderOption
• type RevisionsOption
• type RollbackOption
  • func (opt RollbackOption) DryRunString() string
• type RunOption
  • func (opt RunOption) DryRunString() string
• type StatusOption
• type TaskDefinition
• type TaskDefinitionInput
• type TasksOption
• type VerifyOption
• type WaitOption

Constants

const (
	DefaultClusterName = "default"
	DefaultTimeout     = 10 * time.Minute
)

const (
	CodeDeployConsoleURLFmt = "https://%s.console.aws.amazon.com/codesuite/codedeploy/deployments/%s?region=%s"
)

const DefaultDesiredCount = -1

const SessionManagerPluginBinary = "session-manager-plugin"

Variables

var CreateFileMode = os.FileMode(0644)

var TerminalWidth = 90

Functions

func ExportEnvFile

func ExportEnvFile(file string) error

ExportEnvFile exports envfile to environment variables.

func MarshalJSON

func MarshalJSON(s interface{}) ([]byte, error)

func MarshalJSONString

func MarshalJSONString(s interface{}) string

func NormalizePlatform

func NormalizePlatform(p *ecs.RuntimePlatform, isFargate bool) (arch, os string)

Types

type App

type App struct {
	Service string
	Cluster string

	Debug bool

	ExtStr  map[string]string
	ExtCode map[string]string
	// contains filtered or unexported fields
}

func NewApp

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

func (*App) AppSpec

func (d *App) AppSpec(opt AppSpecOption) error

func (*App) Create

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

func (*App) DebugLog

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

func (*App) Delete

func (d *App) Delete(opt DeleteOption) error

func (*App) Deploy

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

func (*App) DeployByCodeDeploy

func (d *App) DeployByCodeDeploy(ctx context.Context, taskDefinitionArn string, count *int64, sv *ecs.Service, opt DeployOption) error

func (*App) Deregister

func (d *App) Deregister(opt DeregisterOption) error

func (*App) DescribeService

func (d *App) DescribeService(ctx context.Context) (*ecs.Service, 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) DescribeTaskDefinition

func (d *App) DescribeTaskDefinition(ctx context.Context, tdArn string) (*TaskDefinitionInput, error)

func (*App) DescribeTaskStatus

func (d *App) DescribeTaskStatus(ctx context.Context, task *ecs.Task, watchContainer *ecs.ContainerDefinition) error

func (*App) DescribeTasksInput

func (d *App) DescribeTasksInput(task *ecs.Task) *ecs.DescribeTasksInput

func (*App) Diff

func (d *App) Diff(opt DiffOption) error

func (*App) Exec

func (d *App) Exec(opt ExecOption) error

func (*App) FindRollbackTarget

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

func (*App) GetLogEvents

func (d *App) GetLogEvents(ctx context.Context, logGroup string, logStream string, startedAt time.Time, nextToken *string) (*string, error)

func (*App) GetLogEventsInput

func (d *App) GetLogEventsInput(logGroup string, logStream string, startAt int64, nextToken *string) *cloudwatchlogs.GetLogEventsInput

func (*App) GetLogInfo

func (d *App) GetLogInfo(task *ecs.Task, c *ecs.ContainerDefinition) (string, string)

func (*App) Init

func (d *App) Init(opt InitOption) error

func (*App) LoadServiceDefinition

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

func (*App) LoadTaskDefinition

func (d *App) LoadTaskDefinition(path string) (*TaskDefinitionInput, error)

func (*App) Log

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

func (*App) LogJSON

func (d *App) LogJSON(v interface{})

func (*App) Name

func (d *App) Name() string

func (*App) Register

func (d *App) Register(opt RegisterOption) error

func (*App) RegisterTaskDefinition

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

func (*App) Render

func (d *App) Render(opt RenderOption) error

func (*App) Revesions

func (d *App) Revesions(opt RevisionsOption) error

func (*App) Rollback

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

func (*App) RollbackByCodeDeploy

func (d *App) RollbackByCodeDeploy(ctx context.Context, sv *ecs.Service, tdArn string, opt RollbackOption) error

func (*App) Run

func (d *App) Run(opt RunOption) error

func (*App) RunTask

func (d *App) RunTask(ctx context.Context, tdArn string, ov *ecs.TaskOverride, opt *RunOption) (*ecs.Task, error)

func (*App) Start

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

func (*App) Status

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

func (*App) Tasks

func (d *App) Tasks(opt TasksOption) error

func (*App) UpdateServiceAttributes

func (d *App) UpdateServiceAttributes(ctx context.Context, sv *ecs.Service, opt DeployOption) error

func (*App) UpdateServiceTasks

func (d *App) UpdateServiceTasks(ctx context.Context, taskDefinitionArn string, count *int64, opt DeployOption) error

func (*App) Verify

func (d *App) Verify(opt VerifyOption) error

Verify verifies service / task definitions related resources are valid.

func (*App) Wait

func (d *App) Wait(opt WaitOption) error

func (*App) WaitForCodeDeploy

func (d *App) WaitForCodeDeploy(ctx context.Context, sv *ecs.Service) error

func (*App) WaitRunTask

func (d *App) WaitRunTask(ctx context.Context, task *ecs.Task, watchContainer *ecs.ContainerDefinition, startedAt time.Time, untilRunning bool) error

func (*App) WaitServiceStable

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

type AppSpecOption

type AppSpecOption struct {
	TaskDefinition *string
	UpdateService  *bool
}

type Config

type Config struct {
	RequiredVersion       string           `yaml:"required_version,omitempty"`
	Region                string           `yaml:"region"`
	Cluster               string           `yaml:"cluster"`
	Service               string           `yaml:"service"`
	ServiceDefinitionPath string           `yaml:"service_definition"`
	TaskDefinitionPath    string           `yaml:"task_definition"`
	Timeout               time.Duration    `yaml:"timeout"`
	Plugins               []ConfigPlugin   `yaml:"plugins,omitempty"`
	AppSpec               *appspec.AppSpec `yaml:"appspec,omitempty"`
	FilterCommand         string           `yaml:"filter_command,omitempty"`
	// contains filtered or unexported fields
}

Config represents a configuration.

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig creates a default configuration.

func (*Config) Load

func (c *Config) Load(path string) error

Load loads configuration file from file path.

func (*Config) Restrict

func (c *Config) Restrict() error

Restrict restricts a configuration.

func (*Config) ValidateVersion

func (c *Config) ValidateVersion(version string) error

ValidateVersion validates a version satisfies required_version.

type ConfigPlugin

type ConfigPlugin struct {
	Name   string                 `yaml:"name"`
	Config map[string]interface{} `yaml:"config"`
}

func (ConfigPlugin) Setup

func (p ConfigPlugin) Setup(c *Config) error

type CreateOption

type CreateOption struct {
	DryRun       *bool
	DesiredCount *int64
	NoWait       *bool
}

func (CreateOption) DryRunString

func (opt CreateOption) DryRunString() string

type DeleteOption

type DeleteOption struct {
	DryRun *bool
	Force  *bool
}

func (DeleteOption) DryRunString

func (opt DeleteOption) DryRunString() string

type DeployOption

type DeployOption struct {
	DryRun               *bool
	DesiredCount         *int64
	SkipTaskDefinition   *bool
	ForceNewDeployment   *bool
	NoWait               *bool
	SuspendAutoScaling   *bool
	RollbackEvents       *string
	UpdateService        *bool
	LatestTaskDefinition *bool
}

func (DeployOption) DryRunString

func (opt DeployOption) DryRunString() string

type DeregisterOption

type DeregisterOption struct {
	DryRun   *bool
	Keeps    *int
	Revision *int64
	Force    *bool
}

func (DeregisterOption) DryRunString

func (opt DeregisterOption) DryRunString() string

type DiffOption

type DiffOption struct {
	Unified *bool
}

type DryRunnable

type DryRunnable interface {
	DryRunString() bool
}

type ExecOption

type ExecOption struct {
	ID        *string
	Command   *string
	Container *string

	PortForward *bool
	LocalPort   *int
	Port        *int
}

type InitOption

type InitOption struct {
	Region                *string
	Cluster               *string
	Service               *string
	TaskDefinitionPath    *string
	ServiceDefinitionPath *string
	ConfigFilePath        *string
	ForceOverwrite        *bool
	Jsonnet               *bool
}

type RegisterOption

type RegisterOption struct {
	DryRun *bool
	Output *bool
}

func (RegisterOption) DryRunString

func (opt RegisterOption) DryRunString() string

type RenderOption

type RenderOption struct {
	ConfigFile        *bool
	ServiceDefinition *bool
	TaskDefinition    *bool
}

type RevisionsOption

type RevisionsOption struct {
	Revision *int64
	Output   *string
}

type RollbackOption

type RollbackOption struct {
	DryRun                   *bool
	DeregisterTaskDefinition *bool
	NoWait                   *bool
	RollbackEvents           *string
}

func (RollbackOption) DryRunString

func (opt RollbackOption) DryRunString() string

type RunOption

type RunOption struct {
	DryRun               *bool
	TaskDefinition       *string
	NoWait               *bool
	TaskOverrideStr      *string
	TaskOverrideFile     *string
	SkipTaskDefinition   *bool
	Count                *int64
	WatchContainer       *string
	LatestTaskDefinition *bool
	PropagateTags        *string
	Tags                 *string
	WaitUntil            *string
	Revision             *int64
}

func (RunOption) DryRunString

func (opt RunOption) DryRunString() string

type StatusOption

type StatusOption struct {
	Events *int
}

type TaskDefinition

type TaskDefinition = ecs.TaskDefinition

type TaskDefinitionInput

type TaskDefinitionInput = ecs.RegisterTaskDefinitionInput

type TasksOption

type TasksOption struct {
	ID     *string
	Output *string
	Find   *bool
	Stop   *bool
	Force  *bool
	Trace  *bool
}

type VerifyOption

type VerifyOption struct {
	GetSecrets *bool
	PutLogs    *bool
}

VerifyOption represents options for Verify()

type WaitOption

type WaitOption struct {
}