ecsceed

A ECS config base deployment tool.
Inspired by ecspresso and kustomize.

It features:

• Override base config. (mainly for multi stage)
• Extend Task definition. (e.g. cut out common parts between web server and worker)

Example

See test_files/example1

Install

Download a binary from the release page

Usage

Write config

config.yml

region: ap-northeast-1
cluster: my-cluster

params:
  ImageTag: latest
  ExecutionRoleArn: my-task-execution-role-arn
  TaskRoleArn: my-task-role-arn
  ApiTargetGroupArn: my-alb-target-group-arn

task_definitions:
  - name: api
    base_file: common_td.json
    file: api_td.json
  - name: worker
    base_file: common_td.json
    file: worker_td.json
services:
  - name: api
    task_definition: api
    file: api_service.json
  - name: worker
    task_definition: worker
    file: worker_service.json

• params : define parameters for JSON (Task Definition and Service) template.
• task_definitions : define Task Definitions
  • base_file, file : Task Definition file. file extends base_file.
• services : define Services
  • task_definition : ref task_definitions.name
  • file : service file.

{
    "containerDefinitions": [
      {
        "cpu": 0,
        "environment": [
          {"name": "APP_NAME", "value": "awesome-name"}
        ],
        "essential": true,
        "image": "debian:{{.ImageTag}}",
        "memoryReservation": 1024,
        "mountPoints": [],
        "name": "app",
        "volumesFrom": [],
        "logConfiguration": {
          "logDriver": "awslogs",
          "options": {
            "awslogs-group": "{{.LogGroup}}",
            "awslogs-region": "ap-northeast-1"
          }
        }
      }
    ],
    "executionRoleArn": "{{.ExecutionRoleArn}}",
    "placementConstraints": [],
    "requiresCompatibilities": [
      "EC2"
    ],
    "volumes": []
}

JSON template bases on text/template module.

Commands

$ ecsceed
NAME:
   ecsceed - A ECS deployment tool

USAGE:
   ecsceed [global options] command [command options] [arguments...]

COMMANDS:
   deploy    deploy
   run       run
   rollback  rollback
   delete    delete
   status    status
   logs      logs
   help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

Deploy

$ ecsceed deploy help
NAME:
   ecsceed deploy - deploy

USAGE:
   ecsceed deploy [command options] [arguments...]

OPTIONS:
   --config value, -c value  specify config path
   --param value, -p value   additional params
   --update-service          update service (default: false)
   --force-new-deploy        force new deploy (default: false)
   --no-wait                 no wait for services stable (default: false)
   --help, -h                show help (default: false)

ecsceed deploy -c overlays/develop/config.yml -p ImageTag=$(git rev-parse HEAD)

Run

$ ecsceed run help
NAME:
   ecsceed run - run

USAGE:
   ecsceed run [command options] [arguments...]

OPTIONS:
   --service value, -s value  service name
   --config value, -c value   specify config path
   --param value, -p value    additional params
   --no-wait                  no wait for services stable (default: false)
   --count value              count (default: 1)
   --task-def value           task definition
   --overrides value          task definition overrides
   --command value            execute command
   --container value          specify container name
   --help, -h                 show help (default: false)

ecsceed run -c overlays/develop/config.yml -s api --command "echo test"

Logs

Show / watch logs

$ ecsceed logs help
NAME:
   ecsceed logs - logs

USAGE:
   ecsceed logs [command options] [arguments...]

OPTIONS:
   --service value, -s value  service name
   --config value, -c value   specify config path
   --param value, -p value    additional params
   --container value          specify container name
   --start-time value         start time
   --tail, -t                 tail (default: false)
   --help, -h                 show help (default: false)

ecsceed logs --config ./ecs/overlays/develop/config.yml -s api --container app --start-time 1m -t