Task

AWS ECS Task

Parameters

Cluster name to place On-Demand runner tasks in
ECS Cluster to place On-Demand runners in. This defaults to the cluster used by the Waypoint server

The name of the AWS IAM role to apply to the task's Execution Role
ExecutionRoleName is the name of the AWS IAM role to apply to the task's Execution Role. At this time we reuse the same Role as the Waypoint server Execution Role.

Cloud Watch Log Group to use for On-Demand Runners
Cloud Watch Log Group to use for On-Demand Runners. Defaults to the log group used for runners (waypoint-runner).

CPU to use for the On-Demand runners.
Configure the CPU for the On-Demand runners. The default is 512. See https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html for valid values

Docker image for the Waypoint On-Demand Runners
Docker image for the Waypoint On-Demand Runners. This will
default to the server image with the name (not label) suffixed with '-odr'."

Memory to use for the On-Demand runners.
Configure the memory for the On-Demand runners. The default is 1024. See https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html for valid values

AWS Region to use
AWS region to use. Defaults to the region used for the Waypoint Server.

Security Group ID to place the On-Demand Runner task in
Security Group ID to place the On-Demand Runner task in. This defaults to the security group used for the Waypoint server

List of subnets to place the On-Demand Runner task in.
List of subnets to place the On-Demand Runner task in. This defaults to the list of subnets configured for the Waypoint server and must be either identical or a subset of the subnets used by the Waypoint server

The name of the AWS IAM role to apply to the task's Task Role
TaskRoleName is the name of the AWS IAM role to apply to the task. This role determines the privileges the ODR builder. If no role name is given, an IAM role will be created with the required policies

Outputs

Platform

AWS ECS Platform

Provides additional configuration for using an ALB with ECS

the ARN of an AWS Certificate Manager cert to associate with the ALB

Fully qualified domain name to set for the ALB
set along with zone_id to have DNS automatically setup for the ALB. this value should include the full hostname and domain name, for instance app.example.com

Internet-facing traffic port. Defaults to 80 if 'certificate' is unset, 443 if set.
used to set the ALB listener port, and the ALB security group ingress port

Whether or not the created ALB should be internal
used when listener_arn is not set. If set, the created ALB will have a scheme of `internal`, otherwise by default it has a scheme of `internet-facing`.

the ARN on an existing ALB to configure
when this is set, Waypoint will use this ALB instead of creating its own. A target group will still be created for each deployment, and will be added to a listener on the configured ALB port (Waypoint will the listener if it doesn't exist). This allows users to configure their ALB outside Waypoint but still have Waypoint hook the application to that ALB

Route53 ZoneID to create a DNS record into
set along with alb.domain_name to have DNS automatically setup for the ALB

the instruction set CPU architecture that the Amazon ECS supports. Valid values are: "x86_64", "arm64"

assign a public ip address to tasks. Defaults to true. Ignored if using an ec2 cluster.
If this is set to false, deployments will fail unless tasks are able to egress to the container registry by some other means (i.e. a subnet default route to a NAT gateway).

the name of the ECS cluster to deploy into
the ECS cluster that will run the application as a Service. if there is no ECS cluster with this name, the ECS cluster will be created and configured to use Fargate to run containers.

how many instances of the application should run

how many cpu shares the container running the application is allowed
on Fargate, possible values for this are configured by the amount of memory the container is using. Here is a complete listing of possible values: 512MB: 256
1024MB: 256, 512
2048MB: 256, 512, 1024
3072MB: 512, 1024
4096MB: 512, 1024
5120MB: 1024
6144MB: 1024
7168MB: 1024
8192MB: 1024

do not create a load balancer assigned to the service

indicate if the ECS cluster should be EC2 type rather than Fargate
this controls if we should verify the ECS cluster in EC2 type. The cluster will not be created if it doesn't exist, only that there as existing cluster this is using EC2 and not Fargate

the name of the IAM role to use for ECS execution

The number of consecutive successful health checks required toconsider a target healthy.

The amount of time, in seconds, between health checks.

The range of HTTP codes to use when checking for a successful response fromthe target.

The destination of the ping path for the target health check.

The protocol for the health check to use.

The amount of time, in seconds, for which no target response means a failure.

The number of consecutive failed health checks required to consider a target unhealthy.

the CloudWatchLogs log group to store container logs into

Provides additional configuration for logging flags for ECS
Part of the ecs task definition.  These configuration flags help control how the awslogs log driver is configured.

Enables creation of the aws logs group if not present

Defines the multiline start pattern in Python strftime format

When using non-blocking logging mode, this is the buffer size for message storage

Delivery method for log messages, either 'blocking' or 'non-blocking'

Defines the multiline start pattern using a regular expression

Prefix for application in cloudwatch logs path

how much memory to assign to the container running the application
when running in Fargate, this must be one of a few values, specified in MB: 512, 1024, 2048, 3072, 4096, 5120, and up to 16384 in increments of 1024. The memory value also controls the possible values for cpu

secret key/values to pass to the ECS container

Security Group IDs of existing security groups to use for the ECS service's network access
list of existing group IDs to use for the ECS service's network access. If none are specified, waypoint will create one. If DisableALB is false (the default), waypoint will only allow ingress from the ALB's security group

the TCP port that the application is listening on

Additional container to run as a sidecar.
This runs additional containers in addition to the main container that comes from the build phase.

The port number on the host to reserve for the container

The amount (in MiB) of memory to present to the container

The soft limit (in MiB) of memory to reserve for the container

Environment variables to expose to this container

static environment variables to make available

the VPC subnets to use for the service
you may set a list of private subnets here to prevent your tasks from being directly exposed publicly

the name of the task IAM role to assign.
If no role exists and a one or more task role policies are requested, a role with this name will be created.

IAM Policy arns for attaching to the task role.
If no task role name is specified a task role with a default name will be created for this app, and these policies will be attached.

Components

Related Plugins

Resources

Developer

Waypoint

Integrations

AWS ECS

v0.11.0

The AWS ECS plugin deploys an application image to an AWS ECS cluster. It also launches on-demand runners to do operations remotely.

This integration is shipped in the core product and does not need to be installed.

Built-in

Our community conference is taking place in San Francisco and online October 10-12.

A curated collection of official, partner, and community Waypoint Integrations.