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 committed Jan 19, 2024
1 parent c897ac4 commit 9cc1d05
Showing 1 changed file with 6 additions and 32 deletions.
38 changes: 6 additions & 32 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,12 @@ The following providers are used by this module:

- [[provider_null]] <<provider_null,null>> (>= 3)

- [[provider_argocd]] <<provider_argocd,argocd>> (>= 5)

- [[provider_utils]] <<provider_utils,utils>> (>= 1)

- [[provider_aws]] <<provider_aws,aws>>

- [[provider_argocd]] <<provider_argocd,argocd>> (>= 5)

=== Modules

The following Modules are called:
Expand All @@ -152,12 +152,6 @@ The following resources are used by this module:

The following input variables are required:

==== [[input_argocd_namespace]] <<input_argocd_namespace,argocd_namespace>>

Description: Namespace used by Argo CD where the Application and AppProject resources should be created.

Type: `string`

==== [[input_efs_file_system_id]] <<input_efs_file_system_id,efs_file_system_id>>

Description: EFS Filesystem ID to use by the CSI driver to create volumes.
Expand Down Expand Up @@ -212,7 +206,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v2.2.0"`
Default: `"v2.4.0"`

==== [[input_helm_values]] <<input_helm_values,helm_values>>

Expand Down Expand Up @@ -254,14 +248,6 @@ Type: `map(string)`

Default: `{}`

==== [[input_name]] <<input_name,name>>

Description: Name used to override the chart name on deployment.

Type: `string`

Default: `"efs-csi-driver"`

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

Description: ARN of an OIDC assumable IAM role that has access to the EFS filesystem. When specified, this is added as an annotation to the EFS CSI driver controller ServiceAccount, to allow the driver to manage EFS access points for dynamic volumes provisioning.
Expand Down Expand Up @@ -308,10 +294,10 @@ Description: ID to pass other modules in order to refer to this module as a depe
[cols="a,a",options="header,autowidth"]
|===
|Name |Version
|[[provider_null]] <<provider_null,null>> |>= 3
|[[provider_argocd]] <<provider_argocd,argocd>> |>= 5
|[[provider_utils]] <<provider_utils,utils>> |>= 1
|[[provider_aws]] <<provider_aws,aws>> |n/a
|[[provider_argocd]] <<provider_argocd,argocd>> |>= 5
|[[provider_null]] <<provider_null,null>> |>= 3
|===
= Modules
Expand Down Expand Up @@ -346,12 +332,6 @@ Description: ID to pass other modules in order to refer to this module as a depe
|`"cluster"`
|no
|[[input_argocd_namespace]] <<input_argocd_namespace,argocd_namespace>>
|Namespace used by Argo CD where the Application and AppProject resources should be created.
|`string`
|n/a
|yes
|[[input_argocd_project]] <<input_argocd_project,argocd_project>>
|Name of the Argo CD AppProject where the Application should be created. If not set, the Application will be created in a new AppProject only for this Application.
|`string`
Expand All @@ -373,7 +353,7 @@ Description: ID to pass other modules in order to refer to this module as a depe
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v2.2.0"`
|`"v2.4.0"`
|no
|[[input_helm_values]] <<input_helm_values,helm_values>>
Expand Down Expand Up @@ -414,12 +394,6 @@ object({
|`{}`
|no
|[[input_name]] <<input_name,name>>
|Name used to override the chart name on deployment.
|`string`
|`"efs-csi-driver"`
|no
|[[input_efs_file_system_id]] <<input_efs_file_system_id,efs_file_system_id>>
|EFS Filesystem ID to use by the CSI driver to create volumes.
|`string`
Expand Down

0 comments on commit 9cc1d05

Please sign in to comment.