124 - terraform docs: ecr, dns-entry (#128)

* docs for ecr and dns-entry

* terraform-docs: automated updates to Terraform modules README.md

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ale210

terraform/modules/container/README.md

@@ -35,7 +35,7 @@ No modules.
 |------|-------------|------|---------|:--------:|
 | <a name="input_additional_host_urls"></a> [additional\_host\_urls](#input\_additional\_host\_urls) | n/a | `list(string)` | `[]` | no |
 | <a name="input_application_type"></a> [application\_type](#input\_application\_type) | defines what type of application is running, fullstack, client, backend, etc. will be used for cloudwatch logs | `string` | n/a | yes |
-| <a name="input_container_cpu"></a> [container\_cpu](#input\_container\_cpu) | n/a | `number` | `512` | no |
+| <a name="input_container_cpu"></a> [container\_cpu](#input\_container\_cpu) | n/a | `number` | `256` | no |
 | <a name="input_container_environment"></a> [container\_environment](#input\_container\_environment) | n/a | <pre>list(object({<br/>    name = string<br/>    value = string<br/>  }))</pre> | n/a | yes |
 | <a name="input_container_environment_secrets"></a> [container\_environment\_secrets](#input\_container\_environment\_secrets) | n/a | <pre>list(object({<br/>    name = string<br/>    valueFrom = string<br/>  }))</pre> | `[]` | no |
 | <a name="input_container_image"></a> [container\_image](#input\_container\_image) | n/a | `string` | n/a | yes |
@@ -44,6 +44,7 @@ No modules.
 | <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | n/a | yes |
 | <a name="input_health_check_path"></a> [health\_check\_path](#input\_health\_check\_path) | n/a | `string` | `"/"` | no |
 | <a name="input_hostname"></a> [hostname](#input\_hostname) | n/a | `string` | n/a | yes |
+| <a name="input_launch_type"></a> [launch\_type](#input\_launch\_type) | n/a | `string` | `"fargate"` | no |
 | <a name="input_listener_priority"></a> [listener\_priority](#input\_listener\_priority) | n/a | `number` | n/a | yes |
 | <a name="input_path"></a> [path](#input\_path) | n/a | `string` | `null` | no |
 | <a name="input_project_name"></a> [project\_name](#input\_project\_name) | The overall name of the project using this infrastructure; used to group related resources by | `any` | n/a | yes |

terraform/modules/dns-entry/README.md

@@ -1,4 +1,10 @@
 <!-- BEGIN_TF_DOCS -->
+# dns-entry
+
+This is used to create a root DNS entry in Route 53, for example "qa.vrms.io" or "staging.homeunite.us".
+The Route 53 DNS entry points to incubator's main ingress (cloudfront or ALB). All services that require
+web access (frontends or API backends) should use this.
+
 ## Requirements
 
 No requirements.
@@ -18,19 +24,17 @@ No modules.
 | Name | Type |
 |------|------|
 | [aws_route53_record.www](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
-| [aws_lb.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lb) | data source |
-| [aws_route53_zone.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_subdomain"></a> [subdomain](#input\_subdomain) | n/a | `string` | n/a | yes |
-| <a name="input_zone_id"></a> [zone\_id](#input\_zone\_id) | n/a | `string` | n/a | yes |
+| <a name="input_subdomain"></a> [subdomain](#input\_subdomain) | DNS entry - for example, in `qa.vrms.io` the subdomain is `qa` | `string` | n/a | yes |
+| <a name="input_zone_id"></a> [zone\_id](#input\_zone\_id) | the Route 53 hosted zone id to create the entry | `string` | n/a | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| <a name="output_full_dns_name"></a> [full\_dns\_name](#output\_full\_dns\_name) | n/a |
+| <a name="output_full_dns_name"></a> [full\_dns\_name](#output\_full\_dns\_name) | full dns name, i.e. `qa.vrms.io` |
 <!-- END_TF_DOCS -->

terraform/modules/dns-entry/main.tf

@@ -1,15 +1,22 @@
+/**
+ * # dns-entry
+ *
+ * This is used to create a root DNS entry in Route 53, for example "qa.vrms.io" or "staging.homeunite.us". 
+ * The Route 53 DNS entry points to incubator's main ingress (cloudfront or ALB). All services that require 
+ * web access (frontends or API backends) should use this.
+ * 
+ */
 
+// terraform-docs-ignore
 data "aws_route53_zone" "this" {
   zone_id = var.zone_id
 } 
 
-
+// terraform-docs-ignore
 data "aws_lb" "this" {
   arn  = "arn:aws:elasticloadbalancing:us-west-2:035866691871:loadbalancer/app/incubator-prod-lb/7451adf77133ef36"
 }
 
-
-
 resource "aws_route53_record" "www" {
   zone_id = var.zone_id
   name    = var.subdomain

terraform/modules/dns-entry/outputs.tf

@@ -1,3 +1,4 @@
 output "full_dns_name" {
     value = "${var.subdomain}.${data.aws_route53_zone.this.name}"
+    description = "full dns name, i.e. `qa.vrms.io`"
 }

terraform/modules/dns-entry/variables.tf

@@ -1,8 +1,10 @@
 variable "zone_id" {
   type = string
+  description = "the Route 53 hosted zone id to create the entry"
 }
 
 
 variable "subdomain" {
     type = string
+    description = "DNS entry - for example, in `qa.vrms.io` the subdomain is `qa`"
 } 

terraform/modules/ecr/.terraform.docs.yml

@@ -1,4 +1,8 @@
 <!-- BEGIN_TF_DOCS -->
+# ecr
+
+This creates a standard Elastic Container Registry docker registry.
+
 ## Requirements
 
 No requirements.
@@ -23,12 +27,12 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | The overall name of the project using this infrastructure; used to group related resources by | `string` | n/a | yes |
+| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | HfLA project name (vrms, home-unite-us, etc) | `string` | n/a | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| <a name="output_arn"></a> [arn](#output\_arn) | n/a |
-| <a name="output_repository_url"></a> [repository\_url](#output\_repository\_url) | n/a |
+| <a name="output_arn"></a> [arn](#output\_arn) | ARN of the created ECR repository |
+| <a name="output_repository_url"></a> [repository\_url](#output\_repository\_url) | URL of the docker repository repo |
 <!-- END_TF_DOCS -->    

terraform/modules/ecr/README.md

@@ -1,16 +1,16 @@
-// XXX Decommision - not enough here to merit separate module
-// --------------------------
-// General Variables
-// --------------------------
+/**
+ * # ecr
+ *
+ * This creates a standard Elastic Container Registry docker registry.
+ * 
+ */
+
 
 variable "project_name" {
   type        = string
-  description = "The overall name of the project using this infrastructure; used to group related resources by"
+  description = "HfLA project name (vrms, home-unite-us, etc)"
 }
 
-// --------------------------
-// Elastic Container Repository
-// --------------------------
 resource "aws_ecr_repository" "this" {
   name                 = var.project_name
   image_tag_mutability = "MUTABLE"

terraform/modules/ecr/main.tf

@@ -1,7 +1,9 @@
 output "arn" {
   value = aws_ecr_repository.this.arn
+  description = "ARN of the created ECR repository"
 }
 
 output "repository_url" {
     value = aws_ecr_repository.this.repository_url
+    description = "URL of the docker repository repo"
 }