ecspresso is a deployment tool for Amazon ECS.
(pronounced the same as "espresso" :coffee:)
$ brew install kayac/tap/ecspresso$ asdf plugin add ecspresso
# or
$ asdf plugin add ecspresso https://github.com/kayac/asdf-ecspresso.git
$ asdf install ecspresso 2.3.0
$ asdf global ecspresso 2.3.0aqua is a CLI version manager.
$ aqua g -i kayac/ecspressohttps://circleci.com/orbs/registry/orb/fujiwara/ecspresso
version: 2.1
orbs:
ecspresso: fujiwara/ecspresso@2.0.4
jobs:
install:
steps:
- checkout
- ecspresso/install:
version: v2.3.0 # or latest
# version-file: .ecspresso-version
os: linux # or windows or darwin
arch: amd64 # or arm64
- run:
command: |
ecspresso versionversion: latest installs different versions of ecspresso for each Orb version.
Note: version: latest is not recommended as it may cause unexpected behavior when a new version of ecspresso is released.
Orb fujiwara/ecspresso@2.0.2 supports version-file: path/to/file, which installs the ecspresso version specified in the file. This version number does not have a v prefix, For example, 2.0.0.
Action kayac/ecspresso@v2 installs an ecspresso binary for Linux(x86_64) into /usr/local/bin. This action runs install only.
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: kayac/ecspresso@v2
with:
version: v2.3.0 # or latest
# version-file: .ecspresso-version
- run: |
ecspresso deploy --config ecspresso.ymlTo use the latest version of ecspresso, pass the parameter "latest".
- uses: kayac/ecspresso@v2
with:
version: latestversion: latest installs different versions of ecspresso for each Action version.
Note: version: latest is not recommended as it may cause unexpected behavior when a new version of ecspresso is released.
Action kayac/ecspresso@v2 supports version-file: path/to/file, which installs the ecspresso version specified in the file. This version number does not have a v prefix, For example 2.3.0.
Usage: ecspresso <command>
Flags:
-h, --help Show context-sensitive help.
--envfile=ENVFILE,... environment files ($ECSPRESSO_ENVFILE)
--debug enable debug log ($ECSPRESSO_DEBUG)
--ext-str=KEY=VALUE;... external string values for Jsonnet ($ECSPRESSO_EXT_STR)
--ext-code=KEY=VALUE;... external code values for Jsonnet ($ECSPRESSO_EXT_CODE)
--config="ecspresso.yml" config file ($ECSPRESSO_CONFIG)
--assume-role-arn="" the ARN of the role to assume ($ECSPRESSO_ASSUME_ROLE_ARN)
--timeout=TIMEOUT timeout. Override in a configuration file ($ECSPRESSO_TIMEOUT).
--filter-command=STRING filter command ($ECSPRESSO_FILTER_COMMAND)
--[no-]color enable colorized output ($ECSPRESSO_COLOR)
Commands:
appspec
output AppSpec YAML for CodeDeploy to STDOUT
delete
delete service
deploy
deploy service
deregister
deregister task definition
diff
show diff between task definition, service definition with current running
service and task definition
exec
execute command on task
init --service=SERVICE
create configuration files from existing ECS service
refresh
refresh service. equivalent to deploy --skip-task-definition
--force-new-deployment --no-update-service
register
register task definition
render <targets>
render config, service definition or task definition file to STDOUT
revisions
show revisions of task definitions
rollback
rollback service
run
run task
scale
scale service. equivalent to deploy --skip-task-definition
--no-update-service
status
show status of service
tasks
list tasks that are in a service or having the same family
verify
verify resources in configurations
wait
wait until service stable
version
show versionFor more options for sub-commands, See ecspresso sub-command --help.
ecspresso allows you to easily manage your existing/running ECS services by code.
Try ecspresso init for your ECS service with option --region, --cluster and --service.
$ ecspresso init --region ap-northeast-1 --cluster default --service myservice --config ecspresso.yml
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 ecspresso.ymlReview the generated files: ecspresso.yml, ecs-service-def.json, and ecs-task-def.json.
Now you can deploy the service using ecspresso!
$ ecspresso deploy --config ecspresso.ymlecspresso can read service and task definition files as a template. A typical use case is to replace the image's tag in the task definition file.
Modify ecs-task-def.json as below.
- "image": "nginx:latest",
+ "image": "nginx:{{ must_env `IMAGE_TAG` }}",Then, deploy the service with environment variable IMAGE_TAG.
$ IMAGE_TAG=stable ecspresso deploy --config ecspresso.ymlFor more information, refer to the Configuration file and Template syntax sections.
A configuration file for ecspresso (YAML, JSON, or Jsonnet format).
region: ap-northeast-1 # or AWS_REGION environment variable
cluster: default
service: myservice
task_definition: taskdef.json
timeout: 5m # default 10m
ignore:
tags:
- ecspresso:ignore # ignore tags of service and task definitionecspresso deploy works as below.
task-definition file (JSON or Jsonnet).
{{ env `FOO` `bar` }} syntax in the JSON file with environment variable "FOO".{{ must_env `FOO` }} syntax in the JSON file wth environment variable "FOO".service_definition file (JSON or Jsonnet).Configuration files and task/service definition files are read by go-config which provides template functions env, must_env and json_escape.
ecspresso uses the text/template standard package in Go to render template files, and parses them as YAML or JSON.
When using Jsonnet, ecspresso first renders the Jsonnet files and then parses them as text/template. As a result, template functions can only render string values using "{{ ... }}", since the template function syntax {{ }} conflicts with Jsonnet syntax. To render non-string values, consider using Jsonnet functions instead.
By default, ecspresso provides the following as template functions.
env"{{ env `NAME` `default value` }}"This replaces the placeholder with the value of the environment variable NAME. If not set, it defaults to "default value".
must_env"{{ must_env `NAME` }}"This replaces the placeholder with the value of environment variable NAME. If not set, ecspresso will panic and stop forcefully.
Defining critical values with must_env helps prevent unintended deployments by ensuring these values are set before execution.
json_escape"{{ must_env `JSON_VALUE` | json_escape }}"This escapes values as JSON strings, which is useful for embedding values as strings that require escaping, such as quotes.
ecspresso also adds some template functions via plugins. See the Plugins section.
$ ecspresso deploy --config ecspresso.yml
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!ecspresso deploy can deploy services using the CODE_DEPLOY deployment controller. Configure ecs-service-def.json as follows.
{
"deploymentController": {
"type": "CODE_DEPLOY"
},
// ...
}Important notes:
# ecspresso.yml
codedeploy:
application_name: myapp
deployment_group_name: mydeploymentecspresso deploy creates a new deployment for CodeDeploy, and it continues on CodeDeploy.
$ ecspresso deploy --config ecspresso.yml --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-1CodeDeploy appspec hooks can be defined in a config file. ecspresso automatically creates Resources and version elements in appspec on deployment:
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"To change the desired count of a service, specify scale --tasks.
$ ecspresso scale --tasks 10scale command is equivalent to deploy --skip-task-definition --no-update-service.
ecspresso can deploy a service using a service_definition JSON file.
$ ecspresso deploy --config ecspresso.yml
...# ecspresso.yml
service_definition: service.jsonservice.json example:
{
"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.
$ ecspresso run --config ecspresso.yml --task-def=db-migrate.jsonIf --task-def is not set, ecspresso will use the task definition included in the service.
Other options for RunTask API are set by service attributes (CapacityProviderStrategy, LaunchType, PlacementConstraints, PlacementStrategy and PlatformVersion).
required_version in the configuration file is for fixing the version of ecspresso.
required_version: ">= 2.0.0, < 3"This allows ecspresso to execute if the version is greater than or equal to 2.0.0 and less than 3. If the version does not fall within this range, execution will fail.
This feature is implemented by go-version.
For ECS services using Application Auto Scaling, adjusting the minimum and maximum auto-scaling settings with the ecspresso scale command is a breeze. Simply specify either scale --auto-scaling-min or scale --auto-scaling-max to modify the settings.
$ ecspresso scale --tasks 5 --auto-scaling-min 5 --auto-scaling-max 20ecspresso deploy and scale can suspend and resume application auto scaling.
--suspend-auto-scaling sets suspended state to true.--resume-auto-scaling sets suspended state to false.To change the suspended state, simply use ecspresso scale --suspend-auto-scaling or ecspresso scale --resume-auto-scaling. These commands will only change the suspended state without affecting other settings.
ecspresso supports the Jsonnet file format.
If a file has the .jsonnet extension, ecspresso will proceed in the following order:
Using Template syntax in Jsonnet files may lead to syntax errors due to conflicts with Jsonnet syntax. In such cases, consider using Jsonnet functions instead.
{
cluster: 'default',
service: 'myservice',
service_definition: 'ecs-service-def.jsonnet',
task_definition: 'ecs-task-def.jsonnet',
}ecspresso includes github.com/google/go-jsonnet as a library, so a separate installation of jsonnet is not needed.
--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
}v2.4 and later supports Jsonnet native functions in Jsonnet files.
In the .jsonnet file,:
local func = std.native('func');func()Jsonnet functions are evaluated when rendering Jsonnet files, which helps avoid conflicts with template syntax.
env, must_envenv and must_env functions work the similary to template functions in JSON and YAML files. However, unlike template functions, Jsonnet functions are capable of rendering non-string values from environment variables using std.parseInt(), std.parseJson(), etc.
local env = std.native('env');
local must_env = std.native('must_env');
{
foo: env('FOO', 'default value'),
bar: must_env('BAR'),
bazNumber: std.parseInt(env('BAZ_NUMBER', '0')),
booBool: std.parseJson(env('BOO_BOOL', 'false')),
}See Plugins section.
When deploying services to Fargate, both task definitions and service definitions require specific settings.
For task definitions,
{
"taskDefinition": {
"networkMode": "awsvpc",
"requiresCompatibilities": [
"FARGATE"
],
"cpu": "1024",
"memory": "2048",
// ...
}For service-definitions,
{
"launchType": "FARGATE",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-aaaaaaaa",
"subnet-bbbbbbbb"
],
"securityGroups": [
"sg-11111111"
],
"assignPublicIp": "ENABLED"
}
},
// ...
}capacityProviders and defaultCapacityProviderStrategy for the ECS cluster.capacityProviderStrategy in the service definition as shown below. Use ecspresso deploy --update-service to apply the settings to the service.{
"capacityProviderStrategy": [
{
"base": 1,
"capacityProvider": "FARGATE",
"weight": 1
},
{
"base": 0,
"capacityProvider": "FARGATE_SPOT",
"weight": 1
}
],
// ...ecspresso supports ECS Service Connect.
To configure, define serviceConnectConfiguration in service definitions and portMappings in task definitions.
For more details, see Service Connect parameters
ecspresso supports Amazon EBS Volumes.
To configure, define volumeConfigurations in service definitions, and mountPoints and volumes in task definitions.
// ecs-service-def.json
"volumeConfigurations": [
{
"managedEBSVolume": {
"filesystemType": "ext4",
"roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole",
"sizeInGiB": 10,
"tagSpecifications": [
{
"propagateTags": "SERVICE",
"resourceType": "volume"
}
],
"volumeType": "gp3"
},
"name": "ebs"
}
]// ecs-task-def.json
// containerDefinitions[].mountPoints
"mountPoints": [
{
"containerPath": "/mnt/ebs",
"sourceVolume": "ebs"
}
]
// volumes
"volumes": [
{
"name": "ebs",
"configuredAtLaunch": true
}
]ecspresso run command supports EBS volumes too.
By default, EBS volumes attached to standalone tasks are deleted when the task stops. Use the --no-ebs-delete-on-termination option to preserve volumes.
$ ecspresso run --no-ebs-delete-on-terminationFor tasks run by ECS services, EBS volumes are always deleted when the task stops. This is an ECS specification that ecspresso cannot override.
ecspresso supports diff and verify commands.
Shows differences between local task/service definitions and remote (on ECS) definitions.
$ ecspresso diff
--- 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": {v2.4 or later, ecspresso diff --external can invoke an external command. You can use the "diff" command you like.
For example, use difftastic (difft) command.
$ ecspresso diff --external "difft --color=always"
$ ECSPRESSO_DIFF_COMMAND="difft --color=always" ecspresso diffThe command should exit with status 0. If it exits with a non-zero status when two files differ (for example, diff(1)), you need to write a wrapper command.
Verify resources related with service/task definitions.
For example it checks if,
ecspresso verify tries to assume the task execution role defined in task definitions to verify these items. If it fails to assume the role, it continues to verify with the current session.
$ ecspresso 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!ecspresso can manipulate ECS tasks using the tasks and exec commands.
After v2.0, These operations are provided by ecsta as a library. The ecsta CLI can manipulate any ECS tasks, not limited to those deployed by ecspresso.
Consider using ecsta as a CLI command.
The tasks command lists tasks run by a service or having the same family to a task definition.
Flags:
--id= task ID
--output=table output format
--find=false find a task from tasks list and dump it as JSON
--stop=false stop the task
--force=false stop the task without confirmation
--trace=false trace the taskThe --find option enables task selection rom a list and displays it as JSON.
The ECSPRESSO_FILTER_COMMAND environment variable can be set to specify a command for filtering tasks, such as peco, fzf, etc.
$ ECSPRESSO_FILTER_COMMAND=peco ecspresso tasks --findThe --stop option allows for task selecttion and stopping from a list.
The exec command executes a command on a task.
session-manager-plugin is required in PATH.
Flags:
--id= task ID
--command=sh command to execute
--container= container name
--port-forward=false enable port forward
--local-port=0 local port number
--port=0 remote port number (required for --port-forward)
--host= remote host (required for --port-forward)
-L short expression of local-port:host:portIf --id is not set, the command shows a list of tasks to select a task to execute.
The ECSPRESSO_FILTER_COMMAND environment variable works the same as with the tasks command.
See also the official documentation Using Amazon ECS Exec for debugging.
The --port-forward option enables port forwarding from a local port to an ECS task's port.
$ ecspresso exec --port-forward --port 80 --local-port 8080
...If --id is not set, the command shows a list of tasks to select for port forwarding.
When --local-port is not specified, an ephemeral port is used as the local port.
The -L option is a short expression for local-port:host:port. For example, -L 8080:example.com:80 is equivalent to --local-port 8080 --host example.com --port 80.
$ ecspresso exec --port-forward -L 8080:example.com:80ecspresso supports plugins to extend template functions and Jsonnet native functions.
The tfstate plugin introduces the tfstate and tfstatef template functions.
ecspresso.yml
region: ap-northeast-1
cluster: default
service: test
service_definition: ecs-service-def.json
task_definition: ecs-task-def.json
plugins:
- name: tfstate
config:
url: s3://my-bucket/terraform.tfstate
# or path: terraform.tfstate # path to local fileecs-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 the 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 for build a resource addresses with environment variables.
{{ tfstatef `aws_subnet.ecs['%s'].id` (must_env `SERVICE`) }}tfstate Jsonnet function works the same as template function in JSON and YAML files.
tfstatef Jsonnet function is not provided. Use std.format() or interpolation instead.
local tfstate = std.native('tfstate');
{
networkConfiguration: {
awsvpcConfiguration: {
subnets: [
tfstate('aws_subnet.private["%s"].id' % 'az-z'),
tfstate(std.format('aws_subnet.private["%s"].id', 'az-b')),
],
securityGroups: [
tfstate('data.aws_security_group.default.id'),
]
}
}
}file://path/to/terraform.tfstatehttps://example.com/terraform.tfstates3://{bucket}/{key}remote://api.terraform.io/{organization}/{workspaces}
TFE_TOKEN environment variable is required.gs://{bucket}/{key}azurerm://{resource_group_name}/{storage_account_name}/{container_name}/{blob_name}This plugin uses tfstate-lookup to load tfstate.
func_prefix adds prefixes to template function names for each plugin configuration, enabling support for multiple tfstate files.
# ecspresso.yml
plugins:
- name: tfstate
config:
url: s3://tfstate/first.tfstate
func_prefix: first_
- name: tfstate
config:
url: s3://tfstate/second.tfstate
func_prefix: second_In templates, functions are called with the specified prefixes.
[
"{{ first_tfstate `aws_s3_bucket.main.arn` }}",
"{{ second_tfstate `aws_s3_bucket.main.arn` }}"
]Similar features are also supported for Jsonnet.
local first_tfstate = std.native('first_tfstate'); // func_prefix: first_
local second_tfstate = std.native('second_tfstate'); // func_prefix: second_
[
first_tfstate('aws_s3_bucket.main.arn'),
second_tfstate('aws_s3_bucket.main.arn'),
]The cloudformation plugin introduces the cfn_output and cfn_export template functions.
An example of a CloudFormation stack template defining Outputs and Exports.
# StackName: ECS-ecspresso
Outputs:
SubnetAz1:
Value: !Ref PublicSubnetAz1
SubnetAz2:
Value: !Ref PublicSubnetAz2
EcsSecurityGroupId:
Value: !Ref EcsSecurityGroup
Export:
Name: !Sub ${AWS::StackName}-EcsSecurityGroupIdLoad the cloudformation plugin in a config file.
ecspresso.yml
# ...
plugins:
- name: cloudformationcfn_output StackName OutputKey looks up the OutputValue of OutputKey in the StackName.
cfn_export ExportName looks up the 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` }}"
]
}
}
}cfn_output, cfn_exportSimilar features are also supported for Jsonnet.
local cfn_output = std.native('cfn_output');
local cfn_export = std.native('cfn_export');
{
subnets: [
cfn_output('ECS-ecspresso', 'SubnetAz1'),
cfn_output('ECS-ecspresso', 'SubnetAz2'),
],
securityGroups: [
cfn_export('ECS-ecspresso-EcsSecurityGroupId'),
],
}The ssm template function reads parameters from AWS Systems Manager (SSM) Parameter Store.
Given SSM Parameter Store has the following parameters:
This template,
{
"string": "{{ ssm `/path/to/string` }}",
"stringlist": "{{ ssm `/path/to/stringlist` 1 }}", *1
"securestring": "{{ ssm `/path/to/securestring` }}"
}will be rendered as:
{
"string": "ImString",
"stringlist": "ImStringList1",
"securestring": "ImSecureString"
}ssm, ssm_listThe ssm function works the same as template function. For string list parameters, use ssm_list to specify the index.
local ssm = std.native('ssm');
local ssm_list = std.native('ssm_list');
{
string: ssm('/path/to/string'),
stringlist: ssm_list('/path/to/stringlist', 1),
securestring: ssm('/path/to/securestring'),
}The secretsmanager_arn template function resolves the Secrets Manager secret ARN by secret name.
"secrets": [
{
"name": "FOO",
"valueFrom": "{{ secretsmanager_arn `foo` }}"
}
]will be rendered as:
"secrets": [
{
"name": "FOO",
"valueFrom": "arn:aws:secretsmanager:ap-northeast-1:123456789012:secret:foo-06XQOH"
}
]secretsmanager_arnThe secretsmanager_arn function works the same as template function.
local secretsmanager_arn = std.native('secretsmanager_arn');
{
secrets: [
{
name: "FOO",
valueFrom: secretsmanager_arn('foo'),
}
]
}MIT
KAYAC Inc.