diff --git a/README.md b/README.md index 72be07a..fff797a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## A meta-module for deploying a small cluster of services to AWS ECS with Fargate -**Disclaimer** - This repo is not an _out-of-the-box_ solution for using Terraform to deploy to ECS. It serves as a reference for folks Googling docs and samples on how to do it as, it's not terribly easy the first (or sixth) time doing it. +**Disclaimer** - This repo is not an _out-of-the-box_ solution for using Terraform to deploy to ECS. Instead, this repo serves as a reference for folks Googling documentation and samples on how to deploy to AWS Elastic Container Service using Fargate. ### Prerequisites @@ -12,4 +12,13 @@ Before using this repo, make sure you've got these things: * Experience using Terraform and AWS * General understanding around networking * A Docker image (or 3) located in a cloud repository (I used ECR for this, Docker Hub et al would be fine too) -* A shell that is Unix-friendly + +There's a handy Terraform wrapper-script included in this repo that helps wrap common Terraform commands and generally makes using Terraform easier. It's not required but it's very useful especially if you want to run Terraform as part of a CI/CD pipeline. + +### State Files + +The code in this repository does not account for the Terraform State File. By default, Terraform will generate the State File and place it in the local directory. Ideally you would want to put your State File in something like S3 rather than leaving it stored on your file system. + +### Module Organization + +This module consists of four distinct `.tf` files which contain Terraform resources. You could easily break each file out into it's own external Terraform Module, however I kept everything contained to a single module because it's easier to read and understand. There's also a `vars.tf` file which includes variables and parameters you'll want to change for your own solution.