zulhfreelancer/ecs-run-task

Run a once-off task on Amazon ECS and stream the output

ecs-run-task

Runs a once-off ECS task and streams the output via Cloudwatch Logs. This forked version does not depend on aws-vault for AWS identity. It can read AWS profile from ~/.aws/credentials file or AWS_DEFAULT_PROFILE environment variable.

Usage

NAME:
   ecs-run-task - run a once-off task on ECS and tail the output from cloudwatch

USAGE:
   ecs-run-task [options] [command override]

VERSION:
   v1.4.0

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug                 Show debugging information (default: false)
   --file value            Task definition file in JSON or YAML
   --name value            Task name
   --cluster value         ECS cluster name (default: "default")
   --log-group value       Cloudwatch Log Group Name to write logs to (default: "ecs-task-runner")
   --service value         service to replace cmd for
   --fargate               Specified if task is to be run under FARGATE as opposed to EC2 (default: false)
   --security-group value  Security groups to launch task in (required for FARGATE). Can be specified multiple times
   --subnet value          Subnet to launch task in (required for FARGATE). Can be specified multiple times
   --env KEY=value         An environment variable to add in the form KEY=value or `KEY` (shorthand for `KEY=$KEY` to pass through an env var from the current host). Can be specified multiple times
   --inherit-env           Inherit all of the environment variables from the calling shell (default: false)
   --count value           Number of tasks to run (default: 1)
   --region value          AWS Region
   --profile value         AWS profile name from ~/.aws/credentials file
   --focus value           Focus container - when specified, only logs from this container will be tailed
   --deregister            Deregister task definition once done (default: false)
   --help, -h              show help (default: false)
   --version, -v           print the version (default: false)

Example

$ export AWS_DEFAULT_PROFILE=my-profile
$ ecs-run-task --file examples/helloworld/taskdefinition.json echo "Hello from Docker!"

Hello from Docker!
...

IAM Permissions

The following IAM permissions are required:

- PolicyName: ECSRunTask
  PolicyDocument:
    Version: '2012-10-17'
    Statement:
    - Effect: Allow
      Action:
        - ecs:RegisterTaskDefinition
        - ecs:DeregisterTaskDefinition
        - ecs:RunTask
        - ecs:DescribeTasks
        - logs:DescribeLogGroups
        - logs:DescribeLogStreams
        - logs:CreateLogStream
        - logs:PutLogEvents
        - logs:FilterLogEvents
      Resource: '*'

Development

We're using Go 1.11 with modules.

export GO111MODULE=on
go get -u github.com/buildkite/ecs-run-task