From 9348e9f832afa40a1b32c080d8e01f5b113c9aaf Mon Sep 17 00:00:00 2001 From: lentidas Date: Tue, 16 Apr 2024 13:45:46 +0000 Subject: [PATCH] docs(terraform-docs): generate docs and write to README.adoc --- README.adoc | 6 +++--- aks/README.adoc | 33 +++++++++++++++++++++------------ 2 files changed, 24 insertions(+), 15 deletions(-) diff --git a/README.adoc b/README.adoc index cf5ae7b7..10e541fa 100644 --- a/README.adoc +++ b/README.adoc @@ -38,16 +38,16 @@ The following requirements are needed by this module: The following providers are used by this module: -- [[provider_null]] <> (>= 3) +- [[provider_random]] <> (>= 3) - [[provider_kubernetes]] <> (>= 2) -- [[provider_random]] <> (>= 3) - - [[provider_utils]] <> (>= 1) - [[provider_argocd]] <> (>= 5) +- [[provider_null]] <> (>= 3) + === Resources The following resources are used by this module: diff --git a/aks/README.adoc b/aks/README.adoc index db59d125..67d4fd24 100644 --- a/aks/README.adoc +++ b/aks/README.adoc @@ -17,6 +17,8 @@ The following requirements are needed by this module: The following providers are used by this module: +- [[provider_null]] <> (>= 3) + - [[provider_azurerm]] <> === Modules @@ -33,9 +35,11 @@ Version: The following resources are used by this module: -- https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment[azurerm_role_assignment.contributor] (resource) +- https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/federated_identity_credential[azurerm_federated_identity_credential.prometheus] (resource) +- https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment[azurerm_role_assignment.storage_contributor] (resource) - https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/user_assigned_identity[azurerm_user_assigned_identity.prometheus] (resource) -- https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group[azurerm_resource_group.node] (data source) +- https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource[null_resource.dependencies] (resource) +- https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group[azurerm_resource_group.node_resource_group] (data source) - https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/storage_container[azurerm_storage_container.container] (data source) === Required Inputs @@ -66,10 +70,11 @@ Type: [source,hcl] ---- object({ - container = string - storage_account = string - managed_identity_node_rg_name = optional(string, null) - storage_account_key = optional(string, null) + container = string + storage_account = string + managed_identity_node_rg_name = optional(string, null) + managed_identity_oidc_issuer_url = optional(string, null) + storage_account_key = optional(string, null) }) ---- @@ -252,6 +257,7 @@ Description: The admin password for Grafana. [cols="a,a",options="header,autowidth"] |=== |Name |Version +|[[provider_null]] <> |>= 3 |[[provider_azurerm]] <> |n/a |=== @@ -268,9 +274,11 @@ Description: The admin password for Grafana. [cols="a,a",options="header,autowidth"] |=== |Name |Type -|https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment[azurerm_role_assignment.contributor] |resource +|https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/federated_identity_credential[azurerm_federated_identity_credential.prometheus] |resource +|https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment[azurerm_role_assignment.storage_contributor] |resource |https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/user_assigned_identity[azurerm_user_assigned_identity.prometheus] |resource -|https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group[azurerm_resource_group.node] |data source +|https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource[null_resource.dependencies] |resource +|https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group[azurerm_resource_group.node_resource_group] |data source |https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/storage_container[azurerm_storage_container.container] |data source |=== @@ -286,10 +294,11 @@ Description: The admin password for Grafana. [source] ---- object({ - container = string - storage_account = string - managed_identity_node_rg_name = optional(string, null) - storage_account_key = optional(string, null) + container = string + storage_account = string + managed_identity_node_rg_name = optional(string, null) + managed_identity_oidc_issuer_url = optional(string, null) + storage_account_key = optional(string, null) }) ----