From 3ff903292f4350ce0a4f9ead0bb81a2ca6b827bd Mon Sep 17 00:00:00 2001 From: lentidas Date: Fri, 19 Apr 2024 08:00:34 +0000 Subject: [PATCH] docs(terraform-docs): generate docs and write to README.adoc --- README.adoc | 6 ++--- aks/README.adoc | 4 ++-- eks/README.adoc | 57 +++++++++++++++++++++++++++++++++++++++++------- kind/README.adoc | 4 ++-- sks/README.adoc | 4 ++-- 5 files changed, 58 insertions(+), 17 deletions(-) diff --git a/README.adoc b/README.adoc index ef84b680..4ddfc23b 100644 --- a/README.adoc +++ b/README.adoc @@ -120,7 +120,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v10.1.0"` +Default: `"v10.1.1"` ==== [[input_cluster_issuer]] <> @@ -358,10 +358,10 @@ Description: The admin password for Grafana. [cols="a,a",options="header,autowidth"] |=== |Name |Version -|[[provider_random]] <> |>= 3 |[[provider_null]] <> |>= 3 |[[provider_argocd]] <> |>= 5 |[[provider_kubernetes]] <> |>= 2 +|[[provider_random]] <> |>= 3 |[[provider_utils]] <> |>= 1 |=== @@ -425,7 +425,7 @@ Description: The admin password for Grafana. |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v10.1.0"` +|`"v10.1.1"` |no |[[input_cluster_issuer]] <> diff --git a/aks/README.adoc b/aks/README.adoc index bb8b92f6..7b3eefdb 100644 --- a/aks/README.adoc +++ b/aks/README.adoc @@ -118,7 +118,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v10.1.0"` +Default: `"v10.1.1"` ==== [[input_cluster_issuer]] <> @@ -437,7 +437,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v10.1.0"` +|`"v10.1.1"` |no |[[input_cluster_issuer]] <> diff --git a/eks/README.adoc b/eks/README.adoc index 28d3ef3a..0cda807f 100644 --- a/eks/README.adoc +++ b/eks/README.adoc @@ -13,16 +13,36 @@ The following requirements are needed by this module: - [[requirement_utils]] <> (>= 1) +=== Providers + +The following providers are used by this module: + +- [[provider_aws]] <> + === Modules The following Modules are called: +==== [[module_iam_assumable_role_kube_prometheus_stack]] <> + +Source: terraform-aws-modules/iam/aws//modules/iam-assumable-role-with-oidc + +Version: ~> 5.0 + ==== [[module_kube-prometheus-stack]] <> Source: ../ Version: +=== Resources + +The following resources are used by this module: + +- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy[aws_iam_policy.kube_prometheus_stack] (resource) +- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document[aws_iam_policy_document.kube_prometheus_stack] (data source) +- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket[aws_s3_bucket.kube_prometheus_stack] (data source) + === Required Inputs The following input variables are required: @@ -51,9 +71,10 @@ Type: [source,hcl] ---- object({ - bucket_id = string - region = string - iam_role_arn = string + bucket_id = string + create_role = bool + iam_role_arn = optional(string, null) + cluster_oidc_issuer_url = optional(string, null) }) ---- @@ -97,7 +118,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v10.1.0"` +Default: `"v10.1.1"` ==== [[input_cluster_issuer]] <> @@ -324,14 +345,33 @@ Description: The admin password for Grafana. |[[requirement_utils]] <> |>= 1 |=== += Providers + +[cols="a,a",options="header,autowidth"] +|=== +|Name |Version +|[[provider_aws]] <> |n/a +|=== + = Modules [cols="a,a,a",options="header,autowidth"] |=== |Name |Source |Version +|[[module_iam_assumable_role_kube_prometheus_stack]] <> |terraform-aws-modules/iam/aws//modules/iam-assumable-role-with-oidc |~> 5.0 |[[module_kube-prometheus-stack]] <> |../ | |=== += Resources + +[cols="a,a",options="header,autowidth"] +|=== +|Name |Type +|https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy[aws_iam_policy.kube_prometheus_stack] |resource +|https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document[aws_iam_policy_document.kube_prometheus_stack] |data source +|https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket[aws_s3_bucket.kube_prometheus_stack] |data source +|=== + = Inputs [cols="a,a,a,a,a",options="header,autowidth"] @@ -344,9 +384,10 @@ Description: The admin password for Grafana. [source] ---- object({ - bucket_id = string - region = string - iam_role_arn = string + bucket_id = string + create_role = bool + iam_role_arn = optional(string, null) + cluster_oidc_issuer_url = optional(string, null) }) ---- @@ -392,7 +433,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v10.1.0"` +|`"v10.1.1"` |no |[[input_cluster_issuer]] <> diff --git a/kind/README.adoc b/kind/README.adoc index d8790aec..d414961b 100644 --- a/kind/README.adoc +++ b/kind/README.adoc @@ -99,7 +99,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v10.1.0"` +Default: `"v10.1.1"` ==== [[input_cluster_issuer]] <> @@ -396,7 +396,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v10.1.0"` +|`"v10.1.1"` |no |[[input_cluster_issuer]] <> diff --git a/sks/README.adoc b/sks/README.adoc index 7e26e477..a6a0bda5 100644 --- a/sks/README.adoc +++ b/sks/README.adoc @@ -240,7 +240,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v10.1.0"` +Default: `"v10.1.1"` ==== [[input_cluster_issuer]] <> @@ -542,7 +542,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v10.1.0"` +|`"v10.1.1"` |no |[[input_cluster_issuer]] <>