Skip to content

Commit

Permalink
Lud/better readmes (#9)
Browse files Browse the repository at this point in the history
* update readme

* ensure publicly_accessible is a boolean

* allow setting multi_az (defaults to false)

* improve all readmes
  • Loading branch information
swiknaba authored Jul 5, 2021
1 parent c2c52db commit 09c18f7
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
24 changes: 16 additions & 8 deletions ecs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
]
}
```
8 changes: 4 additions & 4 deletions kms-key/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion rds/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 09c18f7

Please sign in to comment.