Adding Makefile and README using terraform docs

.devcontainer/devcontainer.json

@@ -19,6 +19,9 @@
 			"version": "1.7.2",
 			"tflint": "latest",
 			"terragrunt": "0.55.1"
+		},
+		"ghcr.io/dhoeric/features/terraform-docs:1": {
+			"version": "latest"
 		}
 	}
 

terragrunt/.terraform-docs.yml

@@ -0,0 +1,21 @@
+formatter: "markdown"
+
+output-values:
+  enabled: false
+  from: ""
+
+sort:
+  enabled: true
+  by: name
+
+settings:
+  anchor: true
+  color: true
+  default: true
+  description: true
+  escape: true
+  html: true
+  indent: 2
+  required: true
+  sensitive: true
+  type: true

terragrunt/aft/main/Makefile

@@ -0,0 +1,7 @@
+.PHONY: fmt docs
+
+fmt:
+	@terraform fmt -recursive
+
+docs:
+	@terraform-docs markdown -c ../../.terraform-docs.yml . > README.md

terragrunt/aft/main/README.md

@@ -0,0 +1,43 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_aft_slack_notification"></a> [aft\_slack\_notification](#module\_aft\_slack\_notification) | github.com/cds-snc/terraform-modules//notify_slack | v3.0.2 |
+| <a name="module_assume_apply_role"></a> [assume\_apply\_role](#module\_assume\_apply\_role) | ../../modules/assume_role | n/a |
+| <a name="module_assume_plan_role"></a> [assume\_plan\_role](#module\_assume\_plan\_role) | ../../modules/assume_role | n/a |
+| <a name="module_attach_tf_plan_policy_assume"></a> [attach\_tf\_plan\_policy\_assume](#module\_attach\_tf\_plan\_policy\_assume) | github.com/cds-snc/terraform-modules//attach_tf_plan_policy | v3.0.2 |
+| <a name="module_gh_oidc_roles"></a> [gh\_oidc\_roles](#module\_gh\_oidc\_roles) | github.com/cds-snc/terraform-modules//gh_oidc_role | v9.0.3 |
+| <a name="module_password_policy"></a> [password\_policy](#module\_password\_policy) | github.com/cds-snc/terraform-modules//aws_goc_password_policy | v3.0.2 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_iam_policy.aft_vault_cleanup](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
+| [aws_iam_role_policy_attachment.assume_admin](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_iam_role_policy_attachment.assume_aft_vault_cleanup_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
+| [aws_iam_policy.admin](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy) | data source |
+| [aws_iam_policy_document.aft_vault_cleanup](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_sns_topic.aft_failure_notifications](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/sns_topic) | data source |
+| [aws_sns_topic.aft_notifications](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/sns_topic) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_aft_slack_webhook"></a> [aft\_slack\_webhook](#input\_aft\_slack\_webhook) | The slack webhook URL to be used by Account Factory for Terraform | `any` | n/a | yes |
+
+## Outputs
+
+No outputs.

terragrunt/aft/notifications/Makefile

@@ -0,0 +1,7 @@
+.PHONY: fmt docs
+
+fmt:
+	@terraform fmt -recursive
+
+docs:
+	@terraform-docs markdown -c ../../.terraform-docs.yml . > README.md

terragrunt/aft/notifications/README.md

@@ -0,0 +1,32 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_aft_failure_notifications"></a> [aft\_failure\_notifications](#module\_aft\_failure\_notifications) | github.com/cds-snc/terraform-modules//notify_slack | v3.0.17 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_sns_topic_subscription.aft_failure_notifications](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription) | resource |
+| [aws_sns_topic.aft_failure_notifications](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/sns_topic) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_aft_notifications_hook"></a> [aft\_notifications\_hook](#input\_aft\_notifications\_hook) | (Required) The webhook to post AFT Notifications to | `string` | n/a | yes |
+
+## Outputs
+
+No outputs.

terragrunt/audit/main/Makefile

@@ -0,0 +1,7 @@
+.PHONY: fmt docs
+
+fmt:
+	@terraform fmt -recursive
+
+docs:
+	@terraform-docs markdown -c ../../.terraform-docs.yml . > README.md

terragrunt/audit/main/README.md

@@ -0,0 +1,33 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_assume_apply_role"></a> [assume\_apply\_role](#module\_assume\_apply\_role) | ../../modules/assume_role | n/a |
+| <a name="module_assume_plan_role"></a> [assume\_plan\_role](#module\_assume\_plan\_role) | ../../modules/assume_role | n/a |
+| <a name="module_attach_tf_plan_policy_assume"></a> [attach\_tf\_plan\_policy\_assume](#module\_attach\_tf\_plan\_policy\_assume) | github.com/cds-snc/terraform-modules//attach_tf_plan_policy | v3.0.2 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_iam_role_policy_attachment.assume_admin](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
+| [aws_iam_policy.admin](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy) | data source |
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.

terragrunt/audit/sre_bot/Makefile

@@ -0,0 +1,7 @@
+.PHONY: fmt docs
+
+fmt:
+	@terraform fmt -recursive
+
+docs:
+	@terraform-docs markdown -c ../../.terraform-docs.yml . > README.md

terragrunt/audit/sre_bot/README.md

@@ -0,0 +1,38 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_iam_policy.sre_bot_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
+| [aws_iam_policy.sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
+| [aws_iam_role.sre_bot](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
+| [aws_iam_role.sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
+| [aws_iam_role_policy_attachment.sre_bot](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_iam_role_policy_attachment.sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_iam_policy_document.sre_bot_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.sre_bot_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.sre_vulnerability_report_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_admin_sso_role_arn"></a> [admin\_sso\_role\_arn](#input\_admin\_sso\_role\_arn) | (Required) The ARN for the admin SSO role | `string` | n/a | yes |
+
+## Outputs
+
+No outputs.

terragrunt/common/Makefile

@@ -0,0 +1,7 @@
+.PHONY: fmt docs
+
+fmt:
+	@terraform fmt -recursive
+
+docs:
+	@terraform-docs markdown -c ../.terraform-docs.yml . > README.md

terragrunt/common/README.md

@@ -0,0 +1,32 @@
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.40.0, <= 5.11 |
+
+## Providers
+
+No providers.
+
+## Modules
+
+No modules.
+
+## Resources
+
+No resources.
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_account_id"></a> [account\_id](#input\_account\_id) | (Required) The account ID to perform actions on. | `string` | n/a | yes |
+| <a name="input_billing_code"></a> [billing\_code](#input\_billing\_code) | The billing code to tag our resources with | `string` | n/a | yes |
+| <a name="input_env"></a> [env](#input\_env) | The current running environment | `string` | n/a | yes |
+| <a name="input_org_account"></a> [org\_account](#input\_org\_account) | The account ID of the main organization account | `any` | n/a | yes |
+| <a name="input_product_name"></a> [product\_name](#input\_product\_name) | (Required) The name of the product you are deploying. | `string` | n/a | yes |
+| <a name="input_region"></a> [region](#input\_region) | The current AWS region | `string` | n/a | yes |
+
+## Outputs
+
+No outputs.

terragrunt/log_archive/legacy_archives/Makefile

@@ -0,0 +1,7 @@
+.PHONY: fmt docs
+
+fmt:
+	@terraform fmt -recursive
+
+docs:
+	@terraform-docs markdown -c ../../.terraform-docs.yml . > README.md

terragrunt/log_archive/legacy_archives/README.md

@@ -0,0 +1,26 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+No providers.
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_aws-landing-zone-logs_bucket"></a> [aws-landing-zone-logs\_bucket](#module\_aws-landing-zone-logs\_bucket) | github.com/cds-snc/terraform-modules//S3 | v3.0.20 |
+| <a name="module_aws-landing-zone-s3-access-logs_bucket"></a> [aws-landing-zone-s3-access-logs\_bucket](#module\_aws-landing-zone-s3-access-logs\_bucket) | github.com/cds-snc/terraform-modules//S3 | v3.0.20 |
+
+## Resources
+
+No resources.
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.

terragrunt/log_archive/main/Makefile

@@ -0,0 +1,7 @@
+.PHONY: fmt docs
+
+fmt:
+	@terraform fmt -recursive
+
+docs:
+	@terraform-docs markdown -c ../../.terraform-docs.yml . > README.md

terragrunt/log_archive/main/README.md

@@ -0,0 +1,33 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_assume_apply_role"></a> [assume\_apply\_role](#module\_assume\_apply\_role) | ../../modules/assume_role | n/a |
+| <a name="module_assume_plan_role"></a> [assume\_plan\_role](#module\_assume\_plan\_role) | ../../modules/assume_role | n/a |
+| <a name="module_attach_tf_plan_policy_assume"></a> [attach\_tf\_plan\_policy\_assume](#module\_attach\_tf\_plan\_policy\_assume) | github.com/cds-snc/terraform-modules//attach_tf_plan_policy | v3.0.2 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_iam_role_policy_attachment.assume_admin](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
+| [aws_iam_policy.admin](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy) | data source |
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.

terragrunt/log_archive/sre_bot/Makefile

@@ -0,0 +1,7 @@
+.PHONY: fmt docs
+
+fmt:
+	@terraform fmt -recursive
+
+docs:
+	@terraform-docs markdown -c ../../.terraform-docs.yml . > README.md

terragrunt/log_archive/sre_bot/README.md

@@ -0,0 +1,46 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_OIDC_Roles"></a> [OIDC\_Roles](#module\_OIDC\_Roles) | github.com/cds-snc/terraform-modules//gh_oidc_role | v5.0.0 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_iam_policy.assume_sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
+| [aws_iam_policy.sre_bot_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
+| [aws_iam_policy.sre_sechub_automation_rules](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
+| [aws_iam_policy.sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
+| [aws_iam_role.sre_bot](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
+| [aws_iam_role.sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
+| [aws_iam_role_policy_attachment.assume_sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_iam_role_policy_attachment.sre_bot](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_iam_role_policy_attachment.sre_sechub_automation_rules](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_iam_role_policy_attachment.sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_iam_policy_document.assume_sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.sre_bot_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.sre_bot_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.sre_sechub_automation_rules](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.sre_vulnerability_report](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.sre_vulnerability_report_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_admin_sso_role_arn"></a> [admin\_sso\_role\_arn](#input\_admin\_sso\_role\_arn) | (Required) The ARN for the admin SSO role | `string` | n/a | yes |
+
+## Outputs
+
+No outputs.