From 69c7d2c742b4d5e32afe58ffdc4f751aa5d328c8 Mon Sep 17 00:00:00 2001 From: Colin Saliceti Date: Mon, 25 Nov 2024 17:25:01 +0000 Subject: [PATCH] Add tfdocs link to all READMEs --- aks/application/README.md | 3 +++ aks/application_configuration/README.md | 7 +++++-- aks/cluster_data/README.md | 3 +++ aks/dfe_analytics/README.md | 3 +++ aks/postgres/README.md | 3 +++ aks/redis/README.md | 5 ++++- aks/secrets/README.md | 3 +++ dns/records/readme.md | 3 +++ dns/zones/readme.md | 3 +++ domains/environment_domains/README.md | 6 ++++++ domains/infrastructure/README.md | 6 ++++++ 11 files changed, 42 insertions(+), 3 deletions(-) create mode 100644 domains/environment_domains/README.md create mode 100644 domains/infrastructure/README.md diff --git a/aks/application/README.md b/aks/application/README.md index 0c1ee34..7547993 100644 --- a/aks/application/README.md +++ b/aks/application/README.md @@ -2,6 +2,9 @@ Terraform code for deploying an application. +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). + ## Usage ```terraform diff --git a/aks/application_configuration/README.md b/aks/application_configuration/README.md index a3fa507..0a05e34 100644 --- a/aks/application_configuration/README.md +++ b/aks/application_configuration/README.md @@ -2,6 +2,9 @@ Terraform code for generating the application configuration. +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). + ## Usage ```terraform @@ -34,9 +37,9 @@ RAILS_LOG_TO_STDOUT=true Secrets are automatically extracted from an Azure Key Vault using the [AKS Secrets](../secrets) module and exposed to the application via environment variables. -**Azure Key Vault doesn't allow keys with underscores and environment variable names can't have dashes, so dashes are automatically replaced with underscores before being exposed as environment variables.** +**Azure Key Vault doesn't allow keys with underscores and environment variable names can't have dashes, so dashes are automatically replaced with underscores before being exposed as environment variables.** -The short name of the key vault can be customised by setting `secret_key_vault_short`, usually this should either be `null` or set to `"app"`. Any dashes in the keys are automatically converted to underscores. +The short name of the key vault can be customised by setting `secret_key_vault_short`, usually this should either be `null` or set to `"app"`. Any dashes in the keys are automatically converted to underscores. If your application still has an old-style YAML secret in the key vault, this module can be used to extract the values from it by setting the `secret_yaml_key` variable. diff --git a/aks/cluster_data/README.md b/aks/cluster_data/README.md index 45d6690..773d873 100644 --- a/aks/cluster_data/README.md +++ b/aks/cluster_data/README.md @@ -2,6 +2,9 @@ Terraform module for managing information about the cluster. +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). + ## Usage ```terraform diff --git a/aks/dfe_analytics/README.md b/aks/dfe_analytics/README.md index 70dcf18..b977784 100644 --- a/aks/dfe_analytics/README.md +++ b/aks/dfe_analytics/README.md @@ -1,6 +1,9 @@ # DfE Analytics Create resources in Google cloud Bigquery and provides the required variables to applications so they can send events. +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). + ## Usage ### Reuse existing dataset and events table diff --git a/aks/postgres/README.md b/aks/postgres/README.md index 80f072c..6e0b722 100644 --- a/aks/postgres/README.md +++ b/aks/postgres/README.md @@ -2,6 +2,9 @@ Terraform code for deploying a PostgreSQL instance. +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). + ## Usage ```terraform diff --git a/aks/redis/README.md b/aks/redis/README.md index b23c8a2..d404153 100644 --- a/aks/redis/README.md +++ b/aks/redis/README.md @@ -2,6 +2,9 @@ Terraform code for deploying a Redis instance. +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). + ## Usage ```terraform @@ -38,4 +41,4 @@ The URL of the Redis instance. ### `connection_string` -A connection string that's compatible with .NET applications to the Redis instance. \ No newline at end of file +A connection string that's compatible with .NET applications to the Redis instance. diff --git a/aks/secrets/README.md b/aks/secrets/README.md index 51f7dc1..bd5ecd4 100644 --- a/aks/secrets/README.md +++ b/aks/secrets/README.md @@ -2,6 +2,9 @@ Terraform code for extracting secrets from Azure Key Vaults. +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). + ## Usage ```terraform diff --git a/dns/records/readme.md b/dns/records/readme.md index 8e3c66b..9f2df59 100644 --- a/dns/records/readme.md +++ b/dns/records/readme.md @@ -1,3 +1,6 @@ # DNS records Terraform code for managing Azure DNS records. + +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). diff --git a/dns/zones/readme.md b/dns/zones/readme.md index ebcd959..7c24d01 100644 --- a/dns/zones/readme.md +++ b/dns/zones/readme.md @@ -1,3 +1,6 @@ # DNS Zones Terraform code for managing Azure DNS Zones. + +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). diff --git a/domains/environment_domains/README.md b/domains/environment_domains/README.md new file mode 100644 index 0000000..4396bef --- /dev/null +++ b/domains/environment_domains/README.md @@ -0,0 +1,6 @@ +# Environment domains + +Create domains for each environment in the [domains infrastructure](../infrastructure/). Generates the DNS records as well as front door domain, endpoint, route, origin, redirect rules... + +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs). diff --git a/domains/infrastructure/README.md b/domains/infrastructure/README.md new file mode 100644 index 0000000..020ea19 --- /dev/null +++ b/domains/infrastructure/README.md @@ -0,0 +1,6 @@ +# Domains infrastructure + +Create DNS zone, front door and the default DNS records that will be used to support the service domains of each environment, using the [environment_domains module](../environment_domains/README). + +## Terraform documentation +For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).