Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turnerlabs/terraform-ecs-fargate-scheduled-task
A Terraform template used for provisioning scheduled tasks on AWS ECS Fargate
https://github.com/turnerlabs/terraform-ecs-fargate-scheduled-task
aws containers cron ecs fargate schedule task template terraform
Last synced: about 2 months ago
JSON representation
A Terraform template used for provisioning scheduled tasks on AWS ECS Fargate
- Host: GitHub
- URL: https://github.com/turnerlabs/terraform-ecs-fargate-scheduled-task
- Owner: turnerlabs
- License: apache-2.0
- Created: 2018-10-24T18:39:38.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-07-15T21:17:17.000Z (about 3 years ago)
- Last Synced: 2024-05-20T20:19:35.252Z (4 months ago)
- Topics: aws, containers, cron, ecs, fargate, schedule, task, template, terraform
- Language: HCL
- Homepage:
- Size: 154 KB
- Stars: 47
- Watchers: 5
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ecs - Scheduled Task (Job)
README
# Terraform ECS Fargate Scheduled Task
A set of Terraform templates used for provisioning scheduled tasks on [AWS ECS Fargate](https://aws.amazon.com/fargate/).
ECS Scheduled Tasks use CloudWatch Event Rules to run Fargate containers.
The templates are designed to be customized. The optional components can be removed by simply deleting the `.tf` file.
The templates are used for managing infrastructure concerns and, as such, the templates deploy a [hello-world docker image](env/dev/ecs.tf#L26). We recommend using the [fargate CLI](https://github.com/turnerlabs/fargate) for managing application concerns like deploying your actual application images and environment variables on top of this infrastructure. The fargate CLI can be used to deploy applications from your laptop or in CI/CD pipelines.
## Components
### base
These components are shared by all environments.
| Name | Description | Optional |
|------|-------------|:---:|
| [main.tf][bm] | AWS provider, output | |
| [state.tf][bs] | S3 bucket backend for storing Terraform remote state | |
| [ecr.tf][be] | ECR repository for application (all environments share) | ||
### env/dev
These components are for a specific environment. There should be a corresponding directory for each environment
that is needed.
| Name | Description | Optional |
|------|-------------|:----:|
| [main.tf][edm] | Terrform remote state, AWS provider, output | |
| [ecs.tf][ede] | ECS Cluster, Service, Task Definition, ecsTaskExecutionRole, CloudWatch Log Group | |
| [nsg.tf][edn] | NSG for Task | |
| [role.tf][edr] | Application Role for container | Yes |
| [cicd.tf][edc] | IAM user that can be used by CI/CD systems | Yes |
| [logs-logzio.tf][edll] | Ship container logs to logz.io | Yes |
| [secretsmanager.tf][edsm] | Add a base secret to Secretsmanager | Yes |
## Usage
Typically, the base Terraform will only need to be run once, and then should only
need changes very infrequently. After the base is built, each environment can be built.
```
# Move into the base directory
$ cd base
# Sets up Terraform to run
$ terraform init
# Executes the Terraform run
$ terraform apply
# Now, move into the dev environment
$ cd ../env/dev
# Sets up Terraform to run
$ terraform init
# Executes the Terraform run
$ terraform apply
```
## fargate-create
Alternatively you can use the [fargate-create CLI](https://github.com/turnerlabs/fargate-create) to scaffold new projects based on this template.
install
```shell
curl -s get-fargate-create.turnerlabs.io | sh
```
create an input vars file (`terraform.tfvars`)
```hcl
# app/env to scaffold
app = "my-app"
environment = "dev"
schedule_expression = "rate(5 minutes)"
region = "us-east-1"
aws_profile = "default"
saml_role = "admin"
vpc = "vpc-123"
private_subnets = "subnet-123,subnet-456"
public_subnets = "subnet-789,subnet-012"
tags = {
application = "my-app"
environment = "dev"
team = "my-team"
customer = "my-customer"
contact-email = "[email protected]"
}
```
```shell
$ fargate-create -t [email protected]:turnerlabs/terraform-ecs-fargate-scheduled-task
```
## Additional Information
+ [Base README][base]
+ [Environment `dev` README][env-dev]
[fargate]: https://aws.amazon.com/fargate/
[bm]: ./base/main.tf
[bs]: ./base/state.tf
[be]: ./base/ecr.tf
[edm]: ./env/dev/main.tf
[ede]: ./env/dev/ecs.tf
[edl]: ./env/dev/lb.tf
[edn]: ./env/dev/nsg.tf
[edlhttp]: ./env/dev/lb-http.tf
[edlhttps]: ./env/dev/lb-https.tf
[edd]: ./env/dev/dashboard.tf
[edr]: ./env/dev/role.tf
[edc]: ./env/dev/cicd.tf
[edap]: ./env/dev/autoscale-perf.tf
[edat]: ./env/dev/autoscale-time.tf
[edll]: ./env/dev/logs-logzio.tf
[edsm]: ./env/dev/secretsmanager.tf
[base]: ./base/README.md
[env-dev]: ./env/dev/README.md