This module provides a basic Fleet with Terraform. This assumes that you bring nothing to the installation. If you want to bring your own VPC/database/cache nodes/ECS cluster, then use one of the submodules provided.
To quickly list all available module versions you can run:
git tag |grep '^tf'
The following is the module layout, so you can navigate to the module that you want:
- Root module (use this to get a Fleet instance ASAP with minimal setup)
- BYO-VPC (use this if you want to install Fleet inside an existing VPC)
- BYO-database (use this if you want to use an existing database and cache node)
- BYO-ECS (use this if you want to bring your own everything but Fleet ECS services)
- BYO-database (use this if you want to use an existing database and cache node)
- BYO-VPC (use this if you want to install Fleet inside an existing VPC)
Migrating from existing Dogfood code
The below code describes how to migrate from existing Dogfood code
moved {
from = module.vpc
to = module.main.module.vpc
}
moved {
from = module.aurora_mysql
to = module.main.module.byo-vpc.module.rds
}
moved {
from = aws_elasticache_replication_group.default
to = module.main.module.byo-vpc.module.redis.aws_elasticache_replication_group.default
}
This focuses on the resources that are "heavy" or store data. Note that the ALB cannot be moved like this because Dogfood uses the aws_alb resource and the module uses the aws_lb resource. The resources are aliases of eachother, but Terraform can't recognize that.
Cache Engine: Redis vs Valkey
This module supports both Redis and Valkey as the ElastiCache engine. Valkey is an open-source, Redis-compatible in-memory data store.
Provider Requirements
When using this module, ensure your AWS provider version is >= 5.73.0:
terraform {
required_providers {
aws = {
source = "hashicorp/aws"
version = ">= 5.73.0"
}
}
}
Using Valkey (Recommended for Cost Savings)
To use Valkey instead of Redis, configure the redis_config variable:
redis_config = {
engine = "valkey"
engine_version = "7.2"
family = "valkey7"
instance_type = "cache.m5.large"
cluster_size = 3
}
Using Redis (Default)
Redis remains the default engine for backwards compatibility:
redis_config = {
engine = "redis" # Default
engine_version = "7.1"
family = "redis7"
instance_type = "cache.m5.large"
cluster_size = 3
}
How to improve this module
If this module somehow doesn't fit your needs, feel free to contact us by opening a ticket, or contacting your contact at Fleet. Our goal is to make this module fit all needs within AWS, so we will try to find a solution so that this module fits your needs.
If you want to make the changes yourself, simply make a PR into main with your additions. We would ask that you make sure that variables are defined as null if there is no default that makes sense and that variable changes are reflected all the way up the stack.
How to update this readme
Edit .header.md and run terraform-docs markdown . > README.md
Requirements
| Name | Version |
|---|---|
| terraform | >= 1.3.8 |
Providers
No providers.
Modules
| Name | Source | Version |
|---|---|---|
| byo-vpc | ./byo-vpc | n/a |
| vpc | terraform-aws-modules/vpc/aws | 5.1.2 |
Resources
No resources.
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| alb_config | n/a | object({ |
{} |
no |
| certificate_arn | n/a | string |
n/a | yes |
| ecs_cluster | The config for the terraform-aws-modules/ecs/aws module | object({ |
{ |
no |
| fleet_config | The configuration object for Fleet itself. Fields that default to null will have their respective resources created if not specified. | object({ |
{ |
no |
| migration_config | The configuration object for Fleet's migration task. | object({ |
{ |
no |
| rds_config | The config for the terraform-aws-modules/rds-aurora/aws module | object({ |
{ |
no |
| redis_config | n/a | object({ |
{ |
no |
| vpc | n/a | object({ |
{ |
no |
Outputs
| Name | Description |
|---|---|
| byo-vpc | n/a |
| vpc | n/a |