From cd81bfbee59cde14d43d2f66d0a92f065b4d0038 Mon Sep 17 00:00:00 2001 From: James Armes Date: Mon, 20 May 2024 14:34:33 -0400 Subject: [PATCH] Update README. --- aws/backend/README.md | 4 ++-- aws/cloudfront_waf/README.md | 6 +++--- aws/fargate_service/README.md | 14 ++++++++++++-- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/aws/backend/README.md b/aws/backend/README.md index fe63ba4..a38ca2e 100644 --- a/aws/backend/README.md +++ b/aws/backend/README.md @@ -14,7 +14,7 @@ to match your desired configuration. For example: module "backend" { source = "github.com/codeforamerica/tofu-modules/aws/backend" - project = "my-project" + project = "my-project" environment = "dev" } ``` @@ -35,7 +35,7 @@ Add the backend configuration to your `main.tf` file: terraform { backend "s3" { bucket = "my-project-dev-tfstate" - key = "my-project.tfstate" # Choose an appropriate key + key = "my-project.tfstate" # Choose an appropriate key region = "us-east-1" } } diff --git a/aws/cloudfront_waf/README.md b/aws/cloudfront_waf/README.md index 7b2b7b9..7b21953 100644 --- a/aws/cloudfront_waf/README.md +++ b/aws/cloudfront_waf/README.md @@ -13,10 +13,10 @@ to match your desired configuration. For example, to create a new distribution module "cloudfront_waf" { source = "github.com/codeforamerica/tofu-modules/aws/cloudfront_waf" - project = "my-project" + project = "my-project" environment = "dev" - domain = "my-project.org" - log_bucket = module.logging.bucket + domain = "my-project.org" + log_bucket = module.logging.bucket } ``` diff --git a/aws/fargate_service/README.md b/aws/fargate_service/README.md index 195c091..f22a3de 100644 --- a/aws/fargate_service/README.md +++ b/aws/fargate_service/README.md @@ -14,8 +14,18 @@ to match your desired configuration. For example: module "cloudfront_waf" { source = "github.com/codeforamerica/tofu-modules/aws/fargate_service" - project = "my-project" - environment = "dev" + project = "my-project" + project_short = "my-proj" + environment = "dev" + service = "worker" + service_short = "wrk" + + domain = "dev.worker.my-project.org" + vpc_id = module.vpc.vpc_id + private_subnets = module.vpc.private_subnets + public_subnets = module.vpc.public_subnets + logging_key_id = module.logging.kms_key_arn + container_port = 3000 } ```