update docs

terraform-modules · Mar 16, 2021 · 6f6148e · 6f6148e
1 parent e101e96
commit 6f6148e
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 11 deletions.
diff --git a/ses-domain/README.md b/ses-domain/README.md
@@ -35,9 +35,9 @@ This can be used without any variables to get the default configuration.
 module "ses" {
   source = "git@github.e.it.census.gov:terraform-modules/aws-inf-setup.git//ses-domain"
 
-  # optional
-  ses_domain_name = "somerandomdomain.aws.mail.census.gov"
-  # while these can be changed, it is not advised
+  ## optional
+  # ses_domain_name = "somerandomdomain.aws.mail.census.gov"
+  ## while these can be changed, it is not advised
   ses_base_domain_name = "aws.mail.census.gov"
   ses_base_dkim_domain_name = "dkim.amazonses.com"
 }

diff --git a/ses-domain/example.ses_dns.md b/ses-domain/example.ses_dns.md
@@ -1,4 +1,6 @@
-# DNS Validation
+# SES Setup
+
+## DNS Validation
 
 Update DNS to complete SES verification with the following details. This must be done
 on all views: internal, Dmz, and Public, though Public is the most important one.
@@ -8,30 +10,46 @@ on all views: internal, Dmz, and Public, though Public is the most important one
 ```
 $ORIGIN 817869416306.aws.mail.census.gov.
 _amazaonses  600 in txt "/Pz6+wpIUfumhdG8l0NkdfLx+wHMp+/Za2Nf5jOQTos="
+```
+
+* TXT records for validation fully qualified:
 
-# OR fully-qualified
+```
 _amazaonses.817869416306.aws.mail.census.gov. 600 in txt "/Pz6+wpIUfumhdG8l0NkdfLx+wHMp+/Za2Nf5jOQTos="
 
 ```
 
-# DKIM Records
+## DKIM Records
 
 Update DNS to set the DKIM records with the following details. This must be done
 on all views: internal, Dmz, and Public, though Public is the most important one.
 
+* CNAME records:
+
 ```
 $ORIGIN 817869416306.aws.mail.census.gov.
 j4ixb5k4cum55axim6dhdn6nelsoigfm._domainkey 600in cname j4ixb5k4cum55axim6dhdn6nelsoigfm.dkim.amazonses.com.
 njeeupi3lqslhjudeklt2utyhlggdrab._domainkey 600in cname njeeupi3lqslhjudeklt2utyhlggdrab.dkim.amazonses.com.
 qdhk5oxqhqllj7hnxmvt74rk75zwwuhx._domainkey 600in cname qdhk5oxqhqllj7hnxmvt74rk75zwwuhx.dkim.amazonses.com.
+```
 
-# OR fully-qualified
+* CNAME records fully qualified:
+
+```
 j4ixb5k4cum55axim6dhdn6nelsoigfm._domainkey.817869416306.aws.mail.census.gov. 600 in cname j4ixb5k4cum55axim6dhdn6nelsoigfm.dkim.amazonses.com.
 njeeupi3lqslhjudeklt2utyhlggdrab._domainkey.817869416306.aws.mail.census.gov. 600 in cname njeeupi3lqslhjudeklt2utyhlggdrab.dkim.amazonses.com.
 qdhk5oxqhqllj7hnxmvt74rk75zwwuhx._domainkey.817869416306.aws.mail.census.gov. 600 in cname qdhk5oxqhqllj7hnxmvt74rk75zwwuhx.dkim.amazonses.com.
 ```
 
-# MX Records
+## MX Records
+
+Configuration of MX unknown at this time.
+
+## SPF Records
+
+Configuration of SPF unknown at this time.
 
+## DMARC Records
 
+Configuration of DMARC unknown at this time.
 
diff --git a/ses-domain/main.tf b/ses-domain/main.tf
@@ -36,9 +36,9 @@
 * module "ses" {
 *   source = "git@github.e.it.census.gov:terraform-modules/aws-inf-setup.git//ses-domain"
 *
-*   # optional
-*   ses_domain_name = "somerandomdomain.aws.mail.census.gov"
-*   # while these can be changed, it is not advised
+*   ## optional
+*   # ses_domain_name = "somerandomdomain.aws.mail.census.gov"
+*   ## while these can be changed, it is not advised
 *   ses_base_domain_name = "aws.mail.census.gov"
 *   ses_base_dkim_domain_name = "dkim.amazonses.com"
 * }