fix docs

terraform-modules · Apr 6, 2023 · 97a5c29 · 97a5c29
1 parent 66c24cc
commit 97a5c29
Show file tree

Hide file tree

Showing 8 changed files with 136 additions and 4 deletions.
diff --git a/a/README.md b/a/README.md
@@ -25,6 +25,39 @@ The record looks like:
 
 ```console
 % dig +short in txt EXAMPLE
+ 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
+```
+
+The fields/key-value pairs are
+
+| name | description |
+|------|-------------|
+| heritage=terraform | primary label indicating all other values will be use \_terraform\_/ as a prefix |
+| {label}/{key}={value} | label (above); key and value (below) |
+| account\_id | AWS Account ID |
+| region | AWS Region where this has been created |
+| create\_time | Unix epoch time on creation of this and the associated record |
+
+You may add additional values here, such as an ALB ID or other useful, short values which do not change, in the `heritage_tags` map:
+
+```hcl
+  heritage_tags = {
+    alb_id = aws_lb.my_lb.id
+  }
+```
+
+Be sure not to use an ARN as a value, and avoid values which change frequently.
+
+# Caveats
+## Simple, using vpc\_domain\_name from parent
+
+```hcl
+module "dms_replication_dns"  {
+  source = "git@github.e.it.census.gov:terraform-modules/aws-dns//host"
+
+  name    = format("%v.%v", aws_dms_replication_instance.dev.replication_instance_id, var.vpc_domain_name)
+  values  = aws_dms_replication_instance.dev.replication_instance_private_ips
+}
 ```
 
 ## Requirements

diff --git a/a/main.tf b/a/main.tf
@@ -26,7 +26,7 @@
 * 
 * ```console
 * % dig +short in txt EXAMPLE
-EXAMPLE> 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
+*  900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
 * ```
 * 
 * The fields/key-value pairs are

diff --git a/aaaa/README.md b/aaaa/README.md
@@ -25,6 +25,39 @@ The record looks like:
 
 ```console
 % dig +short in txt EXAMPLE
+> 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
+```
+
+The fields/key-value pairs are
+
+| name | description |
+|------|-------------|
+| heritage=terraform | primary label indicating all other values will be use \_terraform\_/ as a prefix |
+| {label}/{key}={value} | label (above); key and value (below) |
+| account\_id | AWS Account ID |
+| region | AWS Region where this has been created |
+| create\_time | Unix epoch time on creation of this and the associated record |
+
+You may add additional values here, such as an ALB ID or other useful, short values which do not change, in the `heritage_tags` map:
+
+```hcl
+  heritage_tags = {
+    alb_id = aws_lb.my_lb.id
+  }
+```
+
+Be sure not to use an ARN as a value, and avoid values which change frequently.
+
+# Caveats
+## Simple, using vpc\_domain\_name from parent
+
+```hcl
+module "dms_replication_dns"  {
+  source = "git@github.e.it.census.gov:terraform-modules/aws-dns//aaaa"
+
+  name    = format("%v.%v", aws_dms_replication_instance.dev.replication_instance_id, var.vpc_domain_name)
+  values  = aws_dms_replication_instance.dev.replication_instance_private_ips
+}
 ```
 
 ## Requirements

diff --git a/aaaa/main.tf b/aaaa/main.tf
@@ -26,7 +26,7 @@
 * 
 * ```console
 * % dig +short in txt EXAMPLE
-EXAMPLE> 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
+* > 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
 * ```
 * 
 * The fields/key-value pairs are

diff --git a/host/README.md b/host/README.md
@@ -25,6 +25,39 @@ The record looks like:
 
 ```console
 % dig +short in txt EXAMPLE
+> 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
+```
+
+The fields/key-value pairs are
+
+| name | description |
+|------|-------------|
+| heritage=terraform | primary label indicating all other values will be use \_terraform\_/ as a prefix |
+| {label}/{key}={value} | label (above); key and value (below) |
+| account\_id | AWS Account ID |
+| region | AWS Region where this has been created |
+| create\_time | Unix epoch time on creation of this and the associated record |
+
+You may add additional values here, such as an ALB ID or other useful, short values which do not change, in the `heritage_tags` map:
+
+```hcl
+  heritage_tags = {
+    alb_id = aws_lb.my_lb.id
+  }
+```
+
+Be sure not to use an ARN as a value, and avoid values which change frequently.
+
+# Caveats
+## Simple, using vpc\_domain\_name from parent
+
+```hcl
+module "dms_replication_dns"  {
+  source = "git@github.e.it.census.gov:terraform-modules/aws-dns//host"
+
+  name    = format("%v.%v", aws_dms_replication_instance.dev.replication_instance_id, var.vpc_domain_name)
+  values  = aws_dms_replication_instance.dev.replication_instance_private_ips
+}
 ```
 
 ## Requirements

diff --git a/host/main.tf b/host/main.tf
@@ -26,7 +26,7 @@
 * 
 * ```console
 * % dig +short in txt EXAMPLE
-EXAMPLE> 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
+* > 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
 * ```
 * 
 * The fields/key-value pairs are

diff --git a/ptr/README.md b/ptr/README.md
@@ -21,6 +21,39 @@ The record looks like:
 
 ```console
 % dig +short in txt EXAMPLE
+> 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
+```
+
+The fields/key-value pairs are
+
+| name | description |
+|------|-------------|
+| heritage=terraform | primary label indicating all other values will be use \_terraform\_/ as a prefix |
+| {label}/{key}={value} | label (above); key and value (below) |
+| account\_id | AWS Account ID |
+| region | AWS Region where this has been created |
+| create\_time | Unix epoch time on creation of this and the associated record |
+
+You may add additional values here, such as an ALB ID or other useful, short values which do not change, in the `heritage_tags` map:
+
+```hcl
+  heritage_tags = {
+    alb_id = aws_lb.my_lb.id
+  }
+```
+
+Be sure not to use an ARN as a value, and avoid values which change frequently.
+
+# Caveats
+## Simple, using vpc\_domain\_name from parent
+
+```hcl
+module "dms_replication_dns"  {
+  source = "git@github.e.it.census.gov:terraform-modules/aws-dns//ptr"
+
+  name    = format("%v.%v", aws_dms_replication_instance.dev.replication_instance_id, var.vpc_domain_name)
+  values  = aws_dms_replication_instance.dev.replication_instance_private_ips
+}
 ```
 
 ## Requirements

diff --git a/ptr/main.tf b/ptr/main.tf
@@ -22,7 +22,7 @@
 * 
 * ```console
 * % dig +short in txt EXAMPLE
-EXAMPLE> 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
+* > 900 IN TXT   "heritage=terraform,terraform/account_id=818199694861,terraform/region=us-gov-west-1,terraform/create_time=1679501130"
 * ```
 * 
 * The fields/key-value pairs are