Skip to content

Commit

Permalink
docs(terraform-docs): generate docs and write to README.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
lentidas authored and github-actions[bot] committed Feb 24, 2023
1 parent 1f0d148 commit 1c69176
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Type: `string`

==== [[input_create_role]] <<input_create_role,create_role>>

Description: Boolean to indicate that the OIDC assumable IAM role should be created. If passing `iam_role_arn` this should be false, otherwise if you want to create the OIDC assumable IAM role provided by this module, you will need to specify the variable `cluster_oidc_issuer_url`.
Description: Boolean to indicate that the OIDC assumable IAM role should be created. **If passing `iam_role_arn` this should be false, otherwise if you want to create the OIDC assumable IAM role provided by this module, you will need to specify the variable `cluster_oidc_issuer_url`.**

Type: `bool`

Expand Down Expand Up @@ -154,7 +154,7 @@ Default: `"cluster"`

==== [[input_cluster_oidc_issuer_url]] <<input_cluster_oidc_issuer_url,cluster_oidc_issuer_url>>

Description: Cluster OIDC issuer URL used to create the OIDC assumable IAM role. **This variable is required to create a IAM role if you set `create_role` as true.**
Description: Cluster OIDC issuer URL used to create the OIDC assumable IAM role. This variable is required to create a IAM role if you set `create_role` as true.

Type: `string`

Expand All @@ -178,7 +178,7 @@ Default: `[]`

==== [[input_iam_role_arn]] <<input_iam_role_arn,iam_role_arn>>

Description: ARN of an OIDC assumable IAM role that has access to the EBS volumes. When specified, this is added as an annotation to the EBS CSI driver controller ServiceAccount, to allow the driver to manage EBS access points for dynamic volumes provisioning. **If not specified, you need to specify the variable `cluster_oidc_issuer_url` and turn on the flag `create_role`.**
Description: ARN of an OIDC assumable IAM role that has access to the EBS volumes. When specified, this is added as an annotation to the EBS CSI driver controller ServiceAccount, to allow the driver to manage EBS access points for dynamic volumes provisioning.

Type: `string`

Expand Down Expand Up @@ -298,13 +298,13 @@ object({
|no
|[[input_cluster_oidc_issuer_url]] <<input_cluster_oidc_issuer_url,cluster_oidc_issuer_url>>
|Cluster OIDC issuer URL used to create the OIDC assumable IAM role. **This variable is required to create a IAM role if you set `create_role` as true.**
|Cluster OIDC issuer URL used to create the OIDC assumable IAM role. This variable is required to create a IAM role if you set `create_role` as true.
|`string`
|`""`
|no
|[[input_create_role]] <<input_create_role,create_role>>
|Boolean to indicate that the OIDC assumable IAM role should be created. If passing `iam_role_arn` this should be false, otherwise if you want to create the OIDC assumable IAM role provided by this module, you will need to specify the variable `cluster_oidc_issuer_url`.
|Boolean to indicate that the OIDC assumable IAM role should be created. **If passing `iam_role_arn` this should be false, otherwise if you want to create the OIDC assumable IAM role provided by this module, you will need to specify the variable `cluster_oidc_issuer_url`.**
|`bool`
|n/a
|yes
Expand All @@ -322,7 +322,7 @@ object({
|no
|[[input_iam_role_arn]] <<input_iam_role_arn,iam_role_arn>>
|ARN of an OIDC assumable IAM role that has access to the EBS volumes. When specified, this is added as an annotation to the EBS CSI driver controller ServiceAccount, to allow the driver to manage EBS access points for dynamic volumes provisioning. **If not specified, you need to specify the variable `cluster_oidc_issuer_url` and turn on the flag `create_role`.**
|ARN of an OIDC assumable IAM role that has access to the EBS volumes. When specified, this is added as an annotation to the EBS CSI driver controller ServiceAccount, to allow the driver to manage EBS access points for dynamic volumes provisioning.
|`string`
|`null`
|no
Expand Down

0 comments on commit 1c69176

Please sign in to comment.