From 4c7018d93cb46fffd7f3690dba7060463a6c9e6f Mon Sep 17 00:00:00 2001 From: Colin Saliceti Date: Fri, 20 Sep 2024 11:56:06 +0100 Subject: [PATCH] Update tf docs action to 1.3.0 --- .github/workflows/lint.yaml | 2 +- aks/application/tfdocs.md | 2 +- aks/postgres/tfdocs.md | 4 ++-- aks/redis/tfdocs.md | 4 ++-- domains/environment_domains/tfdocs.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index f447220..3926310 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -19,7 +19,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: terraform-docs/gh-actions@v1.2.2 + - uses: terraform-docs/gh-actions@v1.3.0 with: find-dir: . fail-on-diff: true diff --git a/aks/application/tfdocs.md b/aks/application/tfdocs.md index 7e7824a..c4a8900 100644 --- a/aks/application/tfdocs.md +++ b/aks/application/tfdocs.md @@ -32,7 +32,7 @@ No modules. |------|-------------|------|---------|:--------:| | [azure\_enable\_monitoring](#input\_azure\_enable\_monitoring) | Whether to enable monitoring of container failures | `bool` | `false` | no | | [azure\_resource\_prefix](#input\_azure\_resource\_prefix) | Prefix of Azure resources for the service | `string` | `null` | no | -| [cluster\_configuration\_map](#input\_cluster\_configuration\_map) | Configuration map for the cluster | 
object({
    resource_group_name = string,
    resource_prefix     = string,
    dns_zone_prefix     = optional(string),
    cpu_min             = number
  })
| n/a | yes | +| [cluster\_configuration\_map](#input\_cluster\_configuration\_map) | Configuration map for the cluster | 
object({
    resource_group_name = string,
    resource_prefix     = string,
    dns_zone_prefix     = optional(string),
    cpu_min             = number
  })
| n/a | yes | | [command](#input\_command) | Custom command that overwrites Docker image | `list(string)` | `[]` | no | | [docker\_image](#input\_docker\_image) | Path to the docker image | `string` | n/a | yes | | [enable\_gcp\_wif](#input\_enable\_gcp\_wif) | Let the deployment use the GCP workload identity federation service account to get a token | `string` | `false` | no | diff --git a/aks/postgres/tfdocs.md b/aks/postgres/tfdocs.md index 05182c4..2014031 100644 --- a/aks/postgres/tfdocs.md +++ b/aks/postgres/tfdocs.md @@ -54,14 +54,14 @@ No modules. | [azure\_enable\_high\_availability](#input\_azure\_enable\_high\_availability) | n/a | `bool` | `false` | no | | [azure\_enable\_monitoring](#input\_azure\_enable\_monitoring) | n/a | `bool` | `true` | no | | [azure\_extensions](#input\_azure\_extensions) | n/a | `list(string)` | `[]` | no | -| [azure\_maintenance\_window](#input\_azure\_maintenance\_window) | n/a | 
object({
    day_of_week  = optional(number)
    start_hour   = optional(number)
    start_minute = optional(number)
  })
| `null` | no | +| [azure\_maintenance\_window](#input\_azure\_maintenance\_window) | n/a | 
object({
    day_of_week  = optional(number)
    start_hour   = optional(number)
    start_minute = optional(number)
  })
| `null` | no | | [azure\_memory\_threshold](#input\_azure\_memory\_threshold) | n/a | `number` | `80` | no | | [azure\_name\_override](#input\_azure\_name\_override) | Replace the generated name with hardcoded name | `string` | `null` | no | | [azure\_resource\_prefix](#input\_azure\_resource\_prefix) | Prefix of Azure resources for the service | `string` | n/a | yes | | [azure\_sku\_name](#input\_azure\_sku\_name) | n/a | `string` | `"B_Standard_B1ms"` | no | | [azure\_storage\_mb](#input\_azure\_storage\_mb) | n/a | `number` | `32768` | no | | [azure\_storage\_threshold](#input\_azure\_storage\_threshold) | n/a | `number` | `80` | no | -| [cluster\_configuration\_map](#input\_cluster\_configuration\_map) | Configuration map for the cluster | 
object({
    resource_group_name = string,
    resource_prefix     = string,
    dns_zone_prefix     = optional(string),
    cpu_min             = number
  })
| n/a | yes | +| [cluster\_configuration\_map](#input\_cluster\_configuration\_map) | Configuration map for the cluster | 
object({
    resource_group_name = string,
    resource_prefix     = string,
    dns_zone_prefix     = optional(string),
    cpu_min             = number
  })
| n/a | yes | | [config\_short](#input\_config\_short) | Short name of the configuration | `string` | n/a | yes | | [environment](#input\_environment) | Current application environment | `string` | n/a | yes | | [name](#input\_name) | Name of the instance | `string` | `null` | no | diff --git a/aks/redis/tfdocs.md b/aks/redis/tfdocs.md index 187ff85..52a5ddb 100644 --- a/aks/redis/tfdocs.md +++ b/aks/redis/tfdocs.md @@ -39,11 +39,11 @@ No modules. | [azure\_maxmemory\_policy](#input\_azure\_maxmemory\_policy) | n/a | `string` | `"allkeys-lru"` | no | | [azure\_memory\_threshold](#input\_azure\_memory\_threshold) | n/a | `number` | `80` | no | | [azure\_minimum\_tls\_version](#input\_azure\_minimum\_tls\_version) | n/a | `string` | `"1.2"` | no | -| [azure\_patch\_schedule](#input\_azure\_patch\_schedule) | n/a | 
list(object({
    day_of_week        = string,
    start_hour_utc     = optional(number),
    maintenance_window = optional(string)
  }))
| `[]` | no | +| [azure\_patch\_schedule](#input\_azure\_patch\_schedule) | n/a | 
list(object({
    day_of_week        = string,
    start_hour_utc     = optional(number),
    maintenance_window = optional(string)
  }))
| `[]` | no | | [azure\_public\_network\_access\_enabled](#input\_azure\_public\_network\_access\_enabled) | n/a | `bool` | `false` | no | | [azure\_resource\_prefix](#input\_azure\_resource\_prefix) | Prefix of Azure resources for the service | `string` | n/a | yes | | [azure\_sku\_name](#input\_azure\_sku\_name) | n/a | `string` | `"Standard"` | no | -| [cluster\_configuration\_map](#input\_cluster\_configuration\_map) | Configuration map for the cluster | 
object({
    resource_group_name = string,
    resource_prefix     = string,
    dns_zone_prefix     = optional(string),
    cpu_min             = number
  })
| n/a | yes | +| [cluster\_configuration\_map](#input\_cluster\_configuration\_map) | Configuration map for the cluster | 
object({
    resource_group_name = string,
    resource_prefix     = string,
    dns_zone_prefix     = optional(string),
    cpu_min             = number
  })
| n/a | yes | | [config\_short](#input\_config\_short) | Short name of the configuration | `string` | n/a | yes | | [environment](#input\_environment) | Current application environment | `string` | n/a | yes | | [name](#input\_name) | Name of the instance | `string` | `null` | no | diff --git a/domains/environment_domains/tfdocs.md b/domains/environment_domains/tfdocs.md index 97cea94..a549450 100644 --- a/domains/environment_domains/tfdocs.md +++ b/domains/environment_domains/tfdocs.md @@ -44,7 +44,7 @@ No modules. | [host\_name](#input\_host\_name) | Origin host name ie domain to where front door sends the requests. It may not be used if all requests are redirected. | `string` | `"not-in-use.education.gov.uk"` | no | | [multiple\_hosted\_zones](#input\_multiple\_hosted\_zones) | n/a | `bool` | `false` | no | | [null\_host\_header](#input\_null\_host\_header) | The origin\_host\_header for the azurerm\_cdn\_frontdoor\_origin resource will be var.host\_name (if false) or null (if true). If null then the host name from the incoming request will be used. | `bool` | `false` | no | -| [redirect\_rules](#input\_redirect\_rules) | List of ordered redirect rules with format:
[
{
"from-domain": "One of the domains from var.domains to redirect from",
"to-domain": "Redirect destination domain",
"to-path": "Optional path appended to the destination URL. If not provided, the path will be the same as in the incoming request",
"to-query-string": "Optional path appended to the destination URL. If not provided, defaults to empty string"
},
{
...
}
] | `list(any)` | `[]` | no | +| [redirect\_rules](#input\_redirect\_rules) | List of ordered redirect rules with format:
[
{
"from-domain": "One of the domains from var.domains to redirect from",
"to-domain": "Redirect destination domain",
"to-path": "Optional path appended to the destination URL. If not provided, the path will be the same as in the incoming request",
"to-query-string": "Optional path appended to the destination URL. If not provided, defaults to empty string"
},
{
...
}
] | `list(any)` | `[]` | no | | [resource\_group\_name](#input\_resource\_group\_name) | n/a | `any` | n/a | yes | | [rule\_set\_ids](#input\_rule\_set\_ids) | n/a | `list(any)` | `[]` | no | | [zone](#input\_zone) | n/a | `any` | n/a | yes |