Skip to content

Commit 3ff9032

Browse files
committed
docs(terraform-docs): generate docs and write to README.adoc
1 parent f678c15 commit 3ff9032

5 files changed

Lines changed: 58 additions & 17 deletions

File tree

README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Description: Override of target revision of the application chart.
120120

121121
Type: `string`
122122

123-
Default: `"v10.1.0"`
123+
Default: `"v10.1.1"`
124124

125125
==== [[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
126126

@@ -358,10 +358,10 @@ Description: The admin password for Grafana.
358358
[cols="a,a",options="header,autowidth"]
359359
|===
360360
|Name |Version
361-
|[[provider_random]] <<provider_random,random>> |>= 3
362361
|[[provider_null]] <<provider_null,null>> |>= 3
363362
|[[provider_argocd]] <<provider_argocd,argocd>> |>= 5
364363
|[[provider_kubernetes]] <<provider_kubernetes,kubernetes>> |>= 2
364+
|[[provider_random]] <<provider_random,random>> |>= 3
365365
|[[provider_utils]] <<provider_utils,utils>> |>= 1
366366
|===
367367
@@ -425,7 +425,7 @@ Description: The admin password for Grafana.
425425
|[[input_target_revision]] <<input_target_revision,target_revision>>
426426
|Override of target revision of the application chart.
427427
|`string`
428-
|`"v10.1.0"`
428+
|`"v10.1.1"`
429429
|no
430430
431431
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>

aks/README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Description: Override of target revision of the application chart.
118118

119119
Type: `string`
120120

121-
Default: `"v10.1.0"`
121+
Default: `"v10.1.1"`
122122

123123
==== [[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
124124

@@ -437,7 +437,7 @@ object({
437437
|[[input_target_revision]] <<input_target_revision,target_revision>>
438438
|Override of target revision of the application chart.
439439
|`string`
440-
|`"v10.1.0"`
440+
|`"v10.1.1"`
441441
|no
442442

443443
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>

eks/README.adoc

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,36 @@ The following requirements are needed by this module:
1313

1414
- [[requirement_utils]] <<requirement_utils,utils>> (>= 1)
1515

16+
=== Providers
17+
18+
The following providers are used by this module:
19+
20+
- [[provider_aws]] <<provider_aws,aws>>
21+
1622
=== Modules
1723

1824
The following Modules are called:
1925

26+
==== [[module_iam_assumable_role_kube_prometheus_stack]] <<module_iam_assumable_role_kube_prometheus_stack,iam_assumable_role_kube_prometheus_stack>>
27+
28+
Source: terraform-aws-modules/iam/aws//modules/iam-assumable-role-with-oidc
29+
30+
Version: ~> 5.0
31+
2032
==== [[module_kube-prometheus-stack]] <<module_kube-prometheus-stack,kube-prometheus-stack>>
2133

2234
Source: ../
2335

2436
Version:
2537

38+
=== Resources
39+
40+
The following resources are used by this module:
41+
42+
- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy[aws_iam_policy.kube_prometheus_stack] (resource)
43+
- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document[aws_iam_policy_document.kube_prometheus_stack] (data source)
44+
- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket[aws_s3_bucket.kube_prometheus_stack] (data source)
45+
2646
=== Required Inputs
2747

2848
The following input variables are required:
@@ -51,9 +71,10 @@ Type:
5171
[source,hcl]
5272
----
5373
object({
54-
bucket_id = string
55-
region = string
56-
iam_role_arn = string
74+
bucket_id = string
75+
create_role = bool
76+
iam_role_arn = optional(string, null)
77+
cluster_oidc_issuer_url = optional(string, null)
5778
})
5879
----
5980

@@ -97,7 +118,7 @@ Description: Override of target revision of the application chart.
97118

98119
Type: `string`
99120

100-
Default: `"v10.1.0"`
121+
Default: `"v10.1.1"`
101122

102123
==== [[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
103124

@@ -324,14 +345,33 @@ Description: The admin password for Grafana.
324345
|[[requirement_utils]] <<requirement_utils,utils>> |>= 1
325346
|===
326347

348+
= Providers
349+
350+
[cols="a,a",options="header,autowidth"]
351+
|===
352+
|Name |Version
353+
|[[provider_aws]] <<provider_aws,aws>> |n/a
354+
|===
355+
327356
= Modules
328357

329358
[cols="a,a,a",options="header,autowidth"]
330359
|===
331360
|Name |Source |Version
361+
|[[module_iam_assumable_role_kube_prometheus_stack]] <<module_iam_assumable_role_kube_prometheus_stack,iam_assumable_role_kube_prometheus_stack>> |terraform-aws-modules/iam/aws//modules/iam-assumable-role-with-oidc |~> 5.0
332362
|[[module_kube-prometheus-stack]] <<module_kube-prometheus-stack,kube-prometheus-stack>> |../ |
333363
|===
334364

365+
= Resources
366+
367+
[cols="a,a",options="header,autowidth"]
368+
|===
369+
|Name |Type
370+
|https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy[aws_iam_policy.kube_prometheus_stack] |resource
371+
|https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document[aws_iam_policy_document.kube_prometheus_stack] |data source
372+
|https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket[aws_s3_bucket.kube_prometheus_stack] |data source
373+
|===
374+
335375
= Inputs
336376

337377
[cols="a,a,a,a,a",options="header,autowidth"]
@@ -344,9 +384,10 @@ Description: The admin password for Grafana.
344384
[source]
345385
----
346386
object({
347-
bucket_id = string
348-
region = string
349-
iam_role_arn = string
387+
bucket_id = string
388+
create_role = bool
389+
iam_role_arn = optional(string, null)
390+
cluster_oidc_issuer_url = optional(string, null)
350391
})
351392
----
352393

@@ -392,7 +433,7 @@ object({
392433
|[[input_target_revision]] <<input_target_revision,target_revision>>
393434
|Override of target revision of the application chart.
394435
|`string`
395-
|`"v10.1.0"`
436+
|`"v10.1.1"`
396437
|no
397438

398439
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>

kind/README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Description: Override of target revision of the application chart.
9999

100100
Type: `string`
101101

102-
Default: `"v10.1.0"`
102+
Default: `"v10.1.1"`
103103

104104
==== [[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
105105

@@ -396,7 +396,7 @@ object({
396396
|[[input_target_revision]] <<input_target_revision,target_revision>>
397397
|Override of target revision of the application chart.
398398
|`string`
399-
|`"v10.1.0"`
399+
|`"v10.1.1"`
400400
|no
401401

402402
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>

sks/README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ Description: Override of target revision of the application chart.
240240

241241
Type: `string`
242242

243-
Default: `"v10.1.0"`
243+
Default: `"v10.1.1"`
244244

245245
==== [[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
246246

@@ -542,7 +542,7 @@ object({
542542
|[[input_target_revision]] <<input_target_revision,target_revision>>
543543
|Override of target revision of the application chart.
544544
|`string`
545-
|`"v10.1.0"`
545+
|`"v10.1.1"`
546546
|no
547547
548548
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>

0 commit comments

Comments
 (0)