diff --git a/README.md b/README.md index d7f40cd..5338e22 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ -Usage: +# Usage + +for terraform 0.11 v1.x use tf-0.11 +for terraform 0.12 v2.x use tf-0.12 (until rolled into head) or specific version v2.x.y ```code module "scanner" { - source = "vc1.csvd.census.gov:terraform-modules/aws-security-audit.git" + source = "../module/aws-security-audit" + source = "git::https://vc1.csvd.census.gov/terraform-modules/aws-security-audit.git?ref=tf-0.12 group = "g-audit-group" users = [ "s-ois-scan" ] + email_addresses = [ "ois.compliance.scanning.group@census.gov" ] create_access_keys = true - pgp_key = "${file("gpg-key.b64)}" + pgp_key = file(filename.b64) } ``` @@ -75,3 +80,4 @@ Description: Access Secret Key IDs for Users Description: Users created + diff --git a/main.tf b/main.tf index 5e1cd66..d4db49b 100644 --- a/main.tf +++ b/main.tf @@ -1,9 +1,10 @@ /** - * Usage: +* # Usage * * for terraform 0.11 v1.x use tf-0.11 * for terraform 0.12 v2.x use tf-0.12 (until rolled into head) or specific version v2.x.y * +* ```code * module "scanner" { * source = "../module/aws-security-audit" * source = "git::https://vc1.csvd.census.gov/terraform-modules/aws-security-audit.git?ref=tf-0.12 @@ -14,6 +15,7 @@ * create_access_keys = true * pgp_key = file(filename.b64) * } +* ``` */ locals {