diff --git a/README.md b/README.md index f4c34c9d..dba455a5 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ We create modules here for re-use between projects. Refer to specific module README for variables and recommended usage. -``` +```terraform module "awesome-module" { source = "github.com/dbl-works/terraform//awesome-module?ref=v2021.07.05" diff --git a/ecs/README.md b/ecs/README.md index 93a0de58..f25927d6 100644 --- a/ecs/README.md +++ b/ecs/README.md @@ -5,16 +5,24 @@ Create a compute cluster for hosting docker based apps. ## Usage -``` +```terraform module "ecs" { - source "github.com/dbl-works/terraform//ecs" + source = "github.com/dbl-works/terraform//ecs?ref=v2021.07.05" - project = local.project - environment = local.environment - vpc_id = module.vpc.id + project = local.project + environment = local.environment + vpc_id = module.vpc.id subnet_private_ids = module.vpc.subnet_private_ids - subnet_public_ids = module.vpc.subnet_private_ids - secrets_arns = [] - kms_key_arns = [] + subnet_public_ids = module.vpc.subnet_private_ids + secrets_arns = [] + kms_key_arns = [] + + # optional + health_check_path = "/healthz" + certificate_arn = "arn:aws:acm:...:certificateXXX" # my-domain.com + allowlisted_ssh_ips = [ + local.cidr_block, + "XX.XX.XX.XX/32", # e.g. a VPN + ] } ``` diff --git a/kms-key/README.md b/kms-key/README.md index 7d7e77df..b56e12cc 100644 --- a/kms-key/README.md +++ b/kms-key/README.md @@ -5,14 +5,14 @@ Creates a VPC in AWS account. Also generates a group fo public and private submo ## Usage -``` +```terraform module "kms-key" { - source = "https://github.com/dbl-works/terraform//kms-key" + source = "github.com/dbl-works/terraform//kms-key?ref=v2021.07.01" # Required environment = "staging" - project = "someproject" - alias = "rds" + project = "someproject" + alias = "rds" description = "Used for ecrypting databases and their backups" # Optional diff --git a/rds/README.md b/rds/README.md index ca75d72c..d0cf9062 100644 --- a/rds/README.md +++ b/rds/README.md @@ -5,7 +5,7 @@ Used for creating and configuring databases and their networking. ## Usage -``` +```terraform module "db" { source = "github.com/dbl-works/terraform//rds?ref=v2021.07.01"