GitHub Action: deploy-ecspresso

Deploy on ECS with Escpresso

Introduction

This is template repository to create composite GitHub Actions. Feel free to use it as reference and starting point.

Usage

  name: Pull Request
  on:
    push:
      branches: [ 'main' ]

  jobs:
    context:
      runs-on: ubuntu-latest
      steps:
        - name: Example action
          uses: cloudposse/example-github-action-deploy-ecspresso@main
          id: example
          with:
            image: 1111111111111.dkr.ecr.us-east-2.amazonaws.com/cloudposse/example-app-on-ecs
            image-tag: latest
            region: us-east-2
            operation: deploy
            cluster: acme-plat-ue2-sandbox
            application: acme-plat-ue2-sandbox-example-app-on-ecs
            taskdef-path: taskdef.json

      outputs:
        result: ${{ steps.example.outputs.webapp-url }}

S3 Mirroring

S3 Mirroring is a pattern of uploading the deployed task definition to an S3 Bucket. This is so that the task definition can be updated with the latest image tag, and the terraform does not reset it back to a previous tag set in the infrastructure repository.

Partial Task Definition

A "Partial Task Definition" is an authoring pattern where the application repository maintains only the parts of the ECS task definition that the app team owns or changes frequently (for example, container image/tag, environment variables, command/args, CPU/memory for a container). The more static, infrastructure-owned parts (for example, IAM roles, volumes, EFS mounts, log configuration, task-level networking) are provided by a template maintained in the infrastructure repository.

During deployment, this action merges the infrastructure-provided template (optionally fetched from S3) with the local partial task definition from the application repo to produce a complete task-definition.json, which is then deployed by ecspresso.

Inputs

Name	Description	Default	Required
application	Application name	N/A	true
cluster	Cluster name	N/A	true
debug	Debug mode	false	false
ecspresso-version	Ecspresso version	v2.1.0	false
image	Docker image	N/A	true
image-tag	Docker image tag	N/A	true
mirror_to_s3_bucket	Mirror task definition to s3 bucket	N/A	false
operation	Operation (valid options - deploy, destroy)	deploy	true
region	AWS Region	N/A	true
taskdef-path	Task definition path	N/A	true
timeout	Ecspresso timeout	5m	false
use_partial_taskdefinition	NOTE: Experimental. Load templated task definition from S3 bucket, which is created by the ecs-service component. This is useful when you want to manage the task definition in the infrastructure repository and the application repository. The infrastructure repository manages things like Volumes and EFS mounts, and the Application repository manages the application code and environment variables.	N/A	false

Outputs

Name	Description
webapp-url	Web Application url