automating terraform docs

.github/workflows/terraform-docs.yml

@@ -0,0 +1,38 @@
+name: Generate terraform docs
+on:
+  pull_request:
+    paths:
+      - "**/*.tf"
+
+jobs:
+  terraform-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Terraform Docs
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Install Terraform Docs
+        run: |
+          curl -LJO https://github.com/terraform-docs/terraform-docs/releases/download/v0.15.0/terraform-docs-v0.15.0-linux-amd64.tar.gz
+          tar -xzf terraform-docs-v0.15.0-linux-amd64.tar.gz
+          sudo mv terraform-docs /usr/local/bin/
+          rm terraform-docs-v0.15.0-linux-amd64.tar.gz
+
+      - name: Set Git user
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "awlfccamp"
+
+      - name: Generate and commit Terraform docs for each directory
+        run: |
+          find . -type f -name "*.tf" -exec dirname {} \; | sort -u | while read -r directory; do
+            echo "Generating Terraform docs for $directory"
+            terraform-docs markdown "${directory}" > "${directory}/README.md"
+            git -C "${directory}" add README.md
+            git -C "${directory}" commit -m "Update Terraform docs"
+          done
+
+      - name: Push changes to GitHub
+        run: git push

incubator/shared-resources/README.md

@@ -0,0 +1,23 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+No providers.
+
+## Modules
+
+No modules.
+
+## Resources
+
+No resources.
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.

terraform-incubator/access-the-data/README.md

@@ -1,8 +1,15 @@
-<!-- BEGIN_TF_DOCS -->
-# Groups
+## Requirements
 
-This module declares all of the resources necessary to create AWS IAM groups.
+| Name | Version |
+|------|---------|
+| <a name="requirement_postgresql"></a> [postgresql](#requirement\_postgresql) | ~> 1.21.0 |
 
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
+| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
 
 ## Modules
 
@@ -13,6 +20,7 @@ This module declares all of the resources necessary to create AWS IAM groups.
 | <a name="module_datastore_database"></a> [datastore\_database](#module\_datastore\_database) | ../../terraform-modules/database | n/a |
 | <a name="module_secrets"></a> [secrets](#module\_secrets) | ../../terraform-modules/cheap-secrets | n/a |
 | <a name="module_zone"></a> [zone](#module\_zone) | ../../terraform-modules/project-zone | n/a |
+
 ## Resources
 
 | Name | Type |
@@ -21,20 +29,10 @@ This module declares all of the resources necessary to create AWS IAM groups.
 | [aws_ssm_parameter.rds_credentials](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | data source |
 | [terraform_remote_state.shared](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/data-sources/remote_state) | data source |
 
+## Inputs
 
-## Providers
-
-| Name | Version |
-|------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
-| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
-## Requirements
+No inputs.
 
-| Name | Version |
-|------|---------|
-| <a name="requirement_postgresql"></a> [postgresql](#requirement\_postgresql) | ~> 1.21.0 |
+## Outputs
 
-To automatically update this documentation, install terraform-docs on your local machine run the following: 
-    cd <directory of README location to update>
-    terraform-docs -c .terraform.docs.yml . 
-<!-- END_TF_DOCS -->    
+No outputs.

terraform-incubator/people-depot/dev/README.md

@@ -0,0 +1,28 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+No providers.
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_dev"></a> [dev](#module\_dev) | ../project | n/a |
+
+## Resources
+
+No resources.
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_app_db_password"></a> [app\_db\_password](#input\_app\_db\_password) | n/a | `string` | n/a | yes |
+| <a name="input_root_db_password"></a> [root\_db\_password](#input\_root\_db\_password) | root database password | `string` | n/a | yes |
+
+## Outputs
+
+No outputs.

terraform-incubator/people-depot/dev/main.tf

@@ -9,7 +9,7 @@ terraform {
 }
 
 provider "aws" {
-  region = "us-west-2"
+  region = "us-east-2"
 }
 
 variable "root_db_password" {

terraform-incubator/people-depot/project/README.md

@@ -1,19 +1,25 @@
-<!-- BEGIN_TF_DOCS -->
-# Groups
+## Requirements
 
-This module declares all of the resources necessary to create AWS IAM groups.
+No requirements.
 
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
 
 ## Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | <a name="module_people_depot"></a> [people\_depot](#module\_people\_depot) | ../../../terraform-modules/service | n/a |
+
 ## Resources
 
 | Name | Type |
 |------|------|
 | [terraform_remote_state.shared](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/data-sources/remote_state) | data source |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
@@ -22,14 +28,6 @@ This module declares all of the resources necessary to create AWS IAM groups.
 | <a name="input_container_image"></a> [container\_image](#input\_container\_image) | n/a | `string` | n/a | yes |
 | <a name="input_root_db_password"></a> [root\_db\_password](#input\_root\_db\_password) | root database password | `string` | n/a | yes |
 
-## Providers
-
-| Name | Version |
-|------|---------|
-| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
-
+## Outputs
 
-To automatically update this documentation, install terraform-docs on your local machine run the following: 
-    cd <directory of README location to update>
-    terraform-docs -c .terraform.docs.yml . 
-<!-- END_TF_DOCS -->    
+No outputs.

terraform-incubator/people-depot/project/main.tf

@@ -6,7 +6,7 @@ data "terraform_remote_state" "shared" {
     dynamodb_table = "terraform-locks"
     encrypt        = true
     key            = "terragrunt-states/incubator/./terraform.tfstate"
-    region         = "us-west-2"
+    region         = "us-east-2"
   }
 }
 

terraform-incubator/shared_resources/acm/README.md

@@ -0,0 +1,27 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+No providers.
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_acm"></a> [acm](#module\_acm) | ../../../terraform-modules/acm | n/a |
+
+## Resources
+
+No resources.
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_acm_certificate_arns"></a> [acm\_certificate\_arns](#output\_acm\_certificate\_arns) | n/a |

terraform-incubator/shared_resources/alb/README.md

@@ -0,0 +1,38 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_alb"></a> [alb](#module\_alb) | ../../../terraform-modules/applicationlb | n/a |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [terraform_remote_state.shared](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/data-sources/remote_state) | data source |
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_alb_https_listener_arn"></a> [alb\_https\_listener\_arn](#output\_alb\_https\_listener\_arn) | n/a |
+| <a name="output_alb_id"></a> [alb\_id](#output\_alb\_id) | n/a |
+| <a name="output_alb_target_group_arn"></a> [alb\_target\_group\_arn](#output\_alb\_target\_group\_arn) | n/a |
+| <a name="output_alb_target_group_id"></a> [alb\_target\_group\_id](#output\_alb\_target\_group\_id) | n/a |
+| <a name="output_lb_arn"></a> [lb\_arn](#output\_lb\_arn) | n/a |
+| <a name="output_lb_dns_name"></a> [lb\_dns\_name](#output\_lb\_dns\_name) | n/a |
+| <a name="output_lb_zone_id"></a> [lb\_zone\_id](#output\_lb\_zone\_id) | n/a |
+| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | n/a |

terraform-incubator/shared_resources/all/README.md

@@ -0,0 +1,41 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [terraform_remote_state.shared](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/data-sources/remote_state) | data source |
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_alb_arn"></a> [alb\_arn](#output\_alb\_arn) | XXX individual outputs are not preferred - instead use the configuration output |
+| <a name="output_alb_external_dns"></a> [alb\_external\_dns](#output\_alb\_external\_dns) | n/a |
+| <a name="output_alb_https_listener_arn"></a> [alb\_https\_listener\_arn](#output\_alb\_https\_listener\_arn) | n/a |
+| <a name="output_alb_security_group_id"></a> [alb\_security\_group\_id](#output\_alb\_security\_group\_id) | n/a |
+| <a name="output_alb_zone_id"></a> [alb\_zone\_id](#output\_alb\_zone\_id) | n/a |
+| <a name="output_cluster_id"></a> [cluster\_id](#output\_cluster\_id) | n/a |
+| <a name="output_cluster_name"></a> [cluster\_name](#output\_cluster\_name) | n/a |
+| <a name="output_configuration"></a> [configuration](#output\_configuration) | n/a |
+| <a name="output_db_identifier"></a> [db\_identifier](#output\_db\_identifier) | n/a |
+| <a name="output_db_instance_endpoint"></a> [db\_instance\_endpoint](#output\_db\_instance\_endpoint) | n/a |
+| <a name="output_public_subnet_ids"></a> [public\_subnet\_ids](#output\_public\_subnet\_ids) | n/a |
+| <a name="output_task_execution_role_arn"></a> [task\_execution\_role\_arn](#output\_task\_execution\_role\_arn) | n/a |
+| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | n/a |

terraform-incubator/shared_resources/ecs/README.md

@@ -0,0 +1,30 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_ecs"></a> [ecs](#module\_ecs) | ../../../terraform-modules/ecs | n/a |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [terraform_remote_state.alb](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/data-sources/remote_state) | data source |
+| [terraform_remote_state.network](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/data-sources/remote_state) | data source |
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.

terraform-incubator/shared_resources/network/README.md

@@ -0,0 +1,25 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+No providers.
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_network"></a> [network](#module\_network) | ../../../terraform-modules/network | n/a |
+
+## Resources
+
+No resources.
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.