Skip to content

Commit

Permalink
Update terraform docs (#1082)
Browse files Browse the repository at this point in the history
* update docs

* update docs

* update docs

* update docs

* add makefile target for updating terraform docs
  • Loading branch information
andrewpearce-digital authored Feb 28, 2024
1 parent 8e21927 commit bdd73d2
Show file tree
Hide file tree
Showing 20 changed files with 81 additions and 67 deletions.
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,10 @@ set-uploads-infected: ##@events calls emit-object-tags-added-with-virus for all

logs: ##@app tails logs for all containers running
docker compose -f docker/docker-compose.yml -f docker/docker-compose.dev.yml logs -f

terraform-update-docs: ##@terraform updates all terraform-docs managed documentation
terraform-docs --config terraform/environment/.terraform-docs.yml ./terraform/environment
terraform-docs --config terraform/environment/region/.terraform-docs.yml ./terraform/environment/region
terraform-docs --config terraform/environment/global/.terraform-docs.yml ./terraform/environment/global
terraform-docs --config terraform/account/.terraform-docs.yml ./terraform/account
terraform-docs --config terraform/account/region/.terraform-docs.yml ./terraform/account/region
12 changes: 6 additions & 6 deletions terraform/account/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,17 @@ For terraform_environment, this will be based on your PR and can be found in the
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | 1.7.3 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | 1.7.4 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |
## Providers
| Name | Version |
|------|---------|
| <a name="provider_aws.eu_west_1"></a> [aws.eu\_west\_1](#provider\_aws.eu\_west\_1) | 5.37.0 |
| <a name="provider_aws.eu_west_2"></a> [aws.eu\_west\_2](#provider\_aws.eu\_west\_2) | 5.37.0 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | 5.37.0 |
| <a name="provider_aws.management_global"></a> [aws.management\_global](#provider\_aws.management\_global) | 5.37.0 |
| <a name="provider_aws.eu_west_1"></a> [aws.eu\_west\_1](#provider\_aws.eu\_west\_1) | 5.38.0 |
| <a name="provider_aws.eu_west_2"></a> [aws.eu\_west\_2](#provider\_aws.eu\_west\_2) | 5.38.0 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | 5.38.0 |
| <a name="provider_aws.management_global"></a> [aws.management\_global](#provider\_aws.management\_global) | 5.38.0 |
## Modules
Expand Down
11 changes: 6 additions & 5 deletions terraform/account/region/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.37.0 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | ~> 5.37.0 |
| <a name="provider_aws.management"></a> [aws.management](#provider\_aws.management) | ~> 5.37.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.37.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.38.0 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | ~> 5.38.0 |
| <a name="provider_aws.management"></a> [aws.management](#provider\_aws.management) | ~> 5.38.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.38.0 |

## Modules

Expand Down Expand Up @@ -43,6 +43,7 @@
| [aws_iam_role.default_vpc_flow_log_cloudwatch](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role.rum_monitor_unauthenticated](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role_policy_attachment.default_vpc_flow_log_cloudwatch](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
| [aws_opensearchserverless_vpc_endpoint.lpas_collection_vpc_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/opensearchserverless_vpc_endpoint) | resource |
| [aws_route53_record.certificate_validation_app](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
| [aws_s3_bucket.access_log](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
| [aws_s3_bucket_lifecycle_configuration.log_retention_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_lifecycle_configuration) | resource |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This module creates a S3 bucket for antivirus definitions, and a Lambda function
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.37.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.38.0 |

## Modules

Expand Down
4 changes: 2 additions & 2 deletions terraform/account/region/modules/dns_firewall/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This module creates a DNS Firewall rule group and rule group associations.
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.37.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.38.0 |

## Modules

Expand Down
4 changes: 2 additions & 2 deletions terraform/account/region/modules/s3_batch_manifests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This module creates a S3 bucket for S3 Batch Job Manifests.
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.37.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.38.0 |

## Modules

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This module creates a S3 bucket event notifications and event notification filte
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.37.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.38.0 |

## Modules

Expand Down
22 changes: 14 additions & 8 deletions terraform/environment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,19 +113,19 @@ For terraform_environment, this will be based on your PR and can be found in the
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | 1.7.3 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_pagerduty"></a> [pagerduty](#requirement\_pagerduty) | 3.7.1 |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | 1.7.4 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |
| <a name="requirement_pagerduty"></a> [pagerduty](#requirement\_pagerduty) | 3.8.1 |
## Providers
| Name | Version |
|------|---------|
| <a name="provider_aws.eu_west_1"></a> [aws.eu\_west\_1](#provider\_aws.eu\_west\_1) | 5.37.0 |
| <a name="provider_aws.eu_west_2"></a> [aws.eu\_west\_2](#provider\_aws.eu\_west\_2) | 5.37.0 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | 5.37.0 |
| <a name="provider_aws.management_eu_west_1"></a> [aws.management\_eu\_west\_1](#provider\_aws.management\_eu\_west\_1) | 5.37.0 |
| <a name="provider_aws.management_global"></a> [aws.management\_global](#provider\_aws.management\_global) | 5.37.0 |
| <a name="provider_aws.eu_west_1"></a> [aws.eu\_west\_1](#provider\_aws.eu\_west\_1) | 5.38.0 |
| <a name="provider_aws.eu_west_2"></a> [aws.eu\_west\_2](#provider\_aws.eu\_west\_2) | 5.38.0 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | 5.38.0 |
| <a name="provider_aws.management_eu_west_1"></a> [aws.management\_eu\_west\_1](#provider\_aws.management\_eu\_west\_1) | 5.38.0 |
| <a name="provider_aws.management_global"></a> [aws.management\_global](#provider\_aws.management\_global) | 5.38.0 |
## Modules
Expand All @@ -145,12 +145,17 @@ For terraform_environment, this will be based on your PR and can be found in the
| [aws_backup_vault_notifications.aws_backup_failure_events](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/backup_vault_notifications) | resource |
| [aws_dynamodb_table.lpas_table](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) | resource |
| [aws_dynamodb_table_replica.lpas_table](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table_replica) | resource |
| [aws_opensearchserverless_access_policy.lpas_collection_data_access_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/opensearchserverless_access_policy) | resource |
| [aws_opensearchserverless_collection.lpas_collection](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/opensearchserverless_collection) | resource |
| [aws_opensearchserverless_security_policy.lpas_collection_encryption_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/opensearchserverless_security_policy) | resource |
| [aws_opensearchserverless_security_policy.lpas_collection_network_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/opensearchserverless_security_policy) | resource |
| [aws_sns_topic.aws_backup_failure_events](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic) | resource |
| [aws_sns_topic_policy.aws_backup_failure_events](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_policy) | resource |
| [aws_ssm_parameter.container_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |
| [aws_ssm_parameter.dns_target_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |
| [aws_backup_vault.eu_west_1](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/backup_vault) | data source |
| [aws_backup_vault.eu_west_2](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/backup_vault) | data source |
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
| [aws_ecr_repository.app](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ecr_repository) | data source |
| [aws_ecr_repository.mock_onelogin](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ecr_repository) | data source |
| [aws_iam_policy_document.aws_backup_sns](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
Expand All @@ -160,6 +165,7 @@ For terraform_environment, this will be based on your PR and can be found in the
| [aws_kms_alias.dynamodb_encryption_key_eu_west_1](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) | data source |
| [aws_kms_alias.dynamodb_encryption_key_eu_west_2](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) | data source |
| [aws_kms_alias.sns_encryption_key_eu_west_1](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) | data source |
| [aws_vpc_endpoint.opensearch](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc_endpoint) | data source |
## Inputs
Expand Down
8 changes: 4 additions & 4 deletions terraform/environment/global/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,15 @@ No modules.
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_pagerduty"></a> [pagerduty](#requirement\_pagerduty) | 3.7.1 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |
| <a name="requirement_pagerduty"></a> [pagerduty](#requirement\_pagerduty) | 3.8.1 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.37.0 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | ~> 5.37.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.38.0 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | ~> 5.38.0 |

## Modules

Expand Down
26 changes: 13 additions & 13 deletions terraform/environment/region/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ This module creates the regional resources for an environment.
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_pagerduty"></a> [pagerduty](#requirement\_pagerduty) | 3.7.1 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |
| <a name="requirement_pagerduty"></a> [pagerduty](#requirement\_pagerduty) | 3.8.1 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | ~> 5.37.0 |
| <a name="provider_aws.management"></a> [aws.management](#provider\_aws.management) | ~> 5.37.0 |
| <a name="provider_aws.management_global"></a> [aws.management\_global](#provider\_aws.management\_global) | ~> 5.37.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.37.0 |
| <a name="provider_pagerduty"></a> [pagerduty](#provider\_pagerduty) | 3.7.1 |
| <a name="provider_aws.global"></a> [aws.global](#provider\_aws.global) | ~> 5.38.0 |
| <a name="provider_aws.management"></a> [aws.management](#provider\_aws.management) | ~> 5.38.0 |
| <a name="provider_aws.management_global"></a> [aws.management\_global](#provider\_aws.management\_global) | ~> 5.38.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.38.0 |
| <a name="provider_pagerduty"></a> [pagerduty](#provider\_pagerduty) | 3.8.1 |

## Modules

Expand Down Expand Up @@ -61,10 +61,10 @@ This module creates the regional resources for an environment.
| [aws_sns_topic_subscription.dependency_health_check](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription) | resource |
| [aws_sns_topic_subscription.ecs_autoscaling_alarms](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription) | resource |
| [aws_sns_topic_subscription.service_health_check](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription) | resource |
| [pagerduty_service_integration.cloudwatch_application_insights](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.7.1/docs/resources/service_integration) | resource |
| [pagerduty_service_integration.dependency_health_check](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.7.1/docs/resources/service_integration) | resource |
| [pagerduty_service_integration.ecs_autoscaling_alarms](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.7.1/docs/resources/service_integration) | resource |
| [pagerduty_service_integration.service_health_check](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.7.1/docs/resources/service_integration) | resource |
| [pagerduty_service_integration.cloudwatch_application_insights](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.8.1/docs/resources/service_integration) | resource |
| [pagerduty_service_integration.dependency_health_check](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.8.1/docs/resources/service_integration) | resource |
| [pagerduty_service_integration.ecs_autoscaling_alarms](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.8.1/docs/resources/service_integration) | resource |
| [pagerduty_service_integration.service_health_check](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.8.1/docs/resources/service_integration) | resource |
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
| [aws_default_tags.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/default_tags) | data source |
Expand Down Expand Up @@ -93,8 +93,8 @@ This module creates the regional resources for an environment.
| [aws_subnet.application](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | data source |
| [aws_subnet.public](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | data source |
| [aws_vpc.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
| [pagerduty_service.main](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.7.1/docs/data-sources/service) | data source |
| [pagerduty_vendor.cloudwatch](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.7.1/docs/data-sources/vendor) | data source |
| [pagerduty_service.main](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.8.1/docs/data-sources/service) | data source |
| [pagerduty_vendor.cloudwatch](https://registry.terraform.io/providers/PagerDuty/pagerduty/3.8.1/docs/data-sources/vendor) | data source |

## Inputs

Expand Down
6 changes: 3 additions & 3 deletions terraform/environment/region/modules/app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ The module creates an ECS service for the Modernising LPA application, and assoc
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.37.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.37.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.38.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.38.0 |

## Modules

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ The module creates a cloudwatch log group and useful log queries for application
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.37.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.38.0 |

## Modules

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This module creates the autoscaling resources for an ECS service.
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.2 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.37.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.38.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.37.0 |
| <a name="provider_aws.region"></a> [aws.region](#provider\_aws.region) | ~> 5.38.0 |

## Modules

Expand Down
Loading

0 comments on commit bdd73d2

Please sign in to comment.