update docs

terraform-modules · May 17, 2024 · 13b3a1e · 13b3a1e
1 parent 1f4adfb
commit 13b3a1e
Show file tree

Hide file tree

Showing 2 changed files with 112 additions and 0 deletions.
diff --git a/acmpca-iam-rolesanywhere/README.md b/acmpca-iam-rolesanywhere/README.md
@@ -25,6 +25,10 @@ module "certificate" {
   role_name  = "r-edl-cods"
   contact_email = "group-mailing-list@census.gov"
 
+## optional
+##  certificate_subject_ou = "IAM RolesAnywhere EDL"
+##  validity_days = 30
+
   tags = merge(
     local.base_tags,
     local.common_tags,
@@ -34,6 +38,58 @@ module "certificate" {
   )
 }
 ```
+# Sample Output Fields
+## certificate\_details
+```hcl
+certificate_details = tomap({
+  "is_ca" = "false"
+  "issuer" = "CN=US Census Bureau AWS uge1 CA1,OU=PKI,O=U.S. Census Bureau,C=US"
+  "not_after" = "2025-05-17T20:01:21Z"
+  "not_before" = "2024-05-17T19:01:21Z"
+  "public_key_algorithm" = "RSA"
+  "serial_number" = "299504527720560123004605552014079790533"
+  "sha1_fingerprint" = "47579407dedeb9c39c94cf3a295f578929e42ff5"
+  "signature_algorithm" = "SHA384-RSA"
+  "subject" = "CN=r-edl-cods,OU=IAM RolesAnywhere EDL,O=U.S. Census Bureau,C=US"
+  "version" = "3"
+})
+```
+
+## certificate\_issuer\_details
+```hcl
+certificate_issuer_details = tomap({
+  "is_ca" = "true"
+  "issuer" = "CN=US Census Bureau CA Issuing CA 1,OU=TCO+OU=PKI,0.9.2342.19200300.100.1.25=#130643656e737573,0.9.2342.19200300.100.1.25=#1303476f76"
+  "not_after" = "2026-06-27T19:55:52Z"
+  "not_before" = "2023-06-28T19:55:52Z"
+  "public_key_algorithm" = "RSA"
+  "serial_number" = "981232789038868979201913777997235598800191546"
+  "sha1_fingerprint" = "513eae8b5d4752b8eb1902cb07b42bea17ca9393"
+  "signature_algorithm" = "SHA256-RSA"
+  "subject" = "CN=US Census Bureau AWS uge1 CA1,OU=PKI,O=U.S. Census Bureau,C=US"
+  "version" = "3"
+})
+```
+
+## certificate\_issuer\_subject
+```hcl
+certificate_issuer_subject = {
+  "common_name" = "US Census Bureau AWS uge1 CA1"
+  "country" = "US"
+  "organization" = "U.S. Census Bureau"
+  "organizational_unit" = "PKI"
+}
+```
+
+## certificate\_subject
+```hcl
+certificate_subject = {
+  "common_name" = "r-edl-cods"
+  "country" = "US"
+  "organization" = "U.S. Census Bureau"
+  "organizational_unit" = "IAM RolesAnywhere EDL"
+}
+```
 
 ## Requirements
 

diff --git a/acmpca-iam-rolesanywhere/main.tf b/acmpca-iam-rolesanywhere/main.tf
@@ -25,6 +25,10 @@
 *   role_name  = "r-edl-cods"
 *   contact_email = "group-mailing-list@census.gov"
 * 
+* ## optional
+* ##  certificate_subject_ou = "IAM RolesAnywhere EDL"
+* ##  validity_days = 30
+*
 *   tags = merge(
 *     local.base_tags,
 *     local.common_tags,
@@ -34,6 +38,58 @@
 *   )
 * }
 * ```
+* # Sample Output Fields
+* ## certificate_details
+* ```hcl
+* certificate_details = tomap({
+*   "is_ca" = "false"
+*   "issuer" = "CN=US Census Bureau AWS uge1 CA1,OU=PKI,O=U.S. Census Bureau,C=US"
+*   "not_after" = "2025-05-17T20:01:21Z"
+*   "not_before" = "2024-05-17T19:01:21Z"
+*   "public_key_algorithm" = "RSA"
+*   "serial_number" = "299504527720560123004605552014079790533"
+*   "sha1_fingerprint" = "47579407dedeb9c39c94cf3a295f578929e42ff5"
+*   "signature_algorithm" = "SHA384-RSA"
+*   "subject" = "CN=r-edl-cods,OU=IAM RolesAnywhere EDL,O=U.S. Census Bureau,C=US"
+*   "version" = "3"
+* })
+* ```
+*
+* ## certificate_issuer_details
+* ```hcl
+* certificate_issuer_details = tomap({
+*   "is_ca" = "true"
+*   "issuer" = "CN=US Census Bureau CA Issuing CA 1,OU=TCO+OU=PKI,0.9.2342.19200300.100.1.25=#130643656e737573,0.9.2342.19200300.100.1.25=#1303476f76"
+*   "not_after" = "2026-06-27T19:55:52Z"
+*   "not_before" = "2023-06-28T19:55:52Z"
+*   "public_key_algorithm" = "RSA"
+*   "serial_number" = "981232789038868979201913777997235598800191546"
+*   "sha1_fingerprint" = "513eae8b5d4752b8eb1902cb07b42bea17ca9393"
+*   "signature_algorithm" = "SHA256-RSA"
+*   "subject" = "CN=US Census Bureau AWS uge1 CA1,OU=PKI,O=U.S. Census Bureau,C=US"
+*   "version" = "3"
+* })
+* ```
+*
+* ## certificate_issuer_subject
+* ```hcl
+* certificate_issuer_subject = {
+*   "common_name" = "US Census Bureau AWS uge1 CA1"
+*   "country" = "US"
+*   "organization" = "U.S. Census Bureau"
+*   "organizational_unit" = "PKI"
+* }
+* ```
+*
+* ## certificate_subject
+* ```hcl
+* certificate_subject = {
+*   "common_name" = "r-edl-cods"
+*   "country" = "US"
+*   "organization" = "U.S. Census Bureau"
+*   "organizational_unit" = "IAM RolesAnywhere EDL"
+* }
+* ```
 */
 
 locals {