Skip to content

Latest commit

 

History

History
99 lines (60 loc) · 2.31 KB

README.md

File metadata and controls

99 lines (60 loc) · 2.31 KB
Raw

Perx Health

AWS ECS Run Task

Note: This action is designed for use within Perx Health's infrastructure... it might not be very useful for other scenarios!

This repository contains a GitHub Action allowing you to run ECS tasks by providing a task definition.

Usage Example

As an example, add the following step to a GitHub Actions workflow.

- name: 🚀 Migrate Database
  uses: perxhealth/aws-ecs-task-action@v1
  with:
    perx_env: qa
    perx_region: au
    perx_app_name: behavioural-science-hacks
    definition: /path/to/definition.tpl.json

Inputs

The Action currently expects five required inputs, and no further optional inputs.

NOTE: Input names are underscores, not hyphenated.

  1. perx_env

    Name of the Perx Environment which the deploy will target.

  2. perx_region

    Name of the Perx Region, representing locations on Earth and data sovereignty boundaries where the deploy will live.

  3. perx_app_name

    Name of the application/service itself. This is expected to match the application/service's cluster/runner naming convention.

  4. definition

    Location on disk from where the task definition file can be read. This is the task definition which is then registered with ECS.

  5. launch_type

    Define whether your task should launch in to EC2, FARGATE or EXTERNAL

Outputs

  1. task-definition-arn

    ARN of the resultant task definition on ECS

  2. task-arns

    Array of ARNs which identify the resultant tasks

  3. tasks-started-count

    Provides the total number of how many ECS Tasks were started, regardless of their status or success

  4. tasks-started-failed-count

    Provides the total number of ECS tasks which failed to start

AWS Credentials

The Action currently expects AWS credentials to exist in the environment, with sufficient permissions to perform the following actions.

ECS

  • DescribeTasks
  • RegisterTaskDefinition
  • RunTask

Development

The Action is written in Node with the main entrypoint being src/index.ts.

Clone the repository

$ git clone git@github.com:perxhealth/aws-ecs-task-action.git
$ cd aws-ecs-task-action

Testing

At the time of writing, there's no test suite to run.