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 20, 2024
1 parent 2a27233 commit 0352f8b
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 14 deletions.
26 changes: 20 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ The following requirements are needed by this module:

The following providers are used by this module:

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

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

- [[provider_random]] <<provider_random,random>> (>= 3)

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

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

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

=== Resources

The following resources are used by this module:
Expand Down Expand Up @@ -76,6 +76,14 @@ Type: `string`

The following input variables are optional (have default values):

==== [[input_subdomain]] <<input_subdomain,subdomain>>

Description: Sub domain of the cluster. Value used for the ingress' URL of the application.

Type: `string`

Default: `"apps"`

==== [[input_argocd_project]] <<input_argocd_project,argocd_project>>

Description: 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.
Expand Down Expand Up @@ -106,7 +114,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v3.1.0"`
Default: `"v3.2.0"`

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

Expand Down Expand Up @@ -256,6 +264,12 @@ Description: ID to pass other modules in order to refer to this module as a depe
|n/a
|yes
|[[input_subdomain]] <<input_subdomain,subdomain>>
|Sub domain of the cluster. Value used for the ingress' URL of the application.
|`string`
|`"apps"`
|no
|[[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 @@ -277,7 +291,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`
|`"v3.1.0"`
|`"v3.2.0"`
|no
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
Expand Down
18 changes: 16 additions & 2 deletions aks/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,14 @@ Type: `string`

The following input variables are optional (have default values):

==== [[input_subdomain]] <<input_subdomain,subdomain>>

Description: Sub domain of the cluster. Value used for the ingress' URL of the application.

Type: `string`

Default: `"apps"`

==== [[input_argocd_project]] <<input_argocd_project,argocd_project>>

Description: 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.
Expand Down Expand Up @@ -310,7 +318,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v3.1.0"`
Default: `"v3.2.0"`

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

Expand Down Expand Up @@ -483,6 +491,12 @@ object({
|n/a
|yes
|[[input_subdomain]] <<input_subdomain,subdomain>>
|Sub domain of the cluster. Value used for the ingress' URL of the application.
|`string`
|`"apps"`
|no
|[[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 @@ -504,7 +518,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.1.0"`
|`"v3.2.0"`
|no
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
Expand Down
18 changes: 16 additions & 2 deletions eks/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,14 @@ Type: `string`

The following input variables are optional (have default values):

==== [[input_subdomain]] <<input_subdomain,subdomain>>

Description: Sub domain of the cluster. Value used for the ingress' URL of the application.

Type: `string`

Default: `"apps"`

==== [[input_argocd_project]] <<input_argocd_project,argocd_project>>

Description: 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.
Expand Down Expand Up @@ -303,7 +311,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v3.1.0"`
Default: `"v3.2.0"`

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

Expand Down Expand Up @@ -452,6 +460,12 @@ object({
|n/a
|yes
|[[input_subdomain]] <<input_subdomain,subdomain>>
|Sub domain of the cluster. Value used for the ingress' URL of the application.
|`string`
|`"apps"`
|no
|[[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 @@ -473,7 +487,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.1.0"`
|`"v3.2.0"`
|no
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
Expand Down
18 changes: 16 additions & 2 deletions kind/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,14 @@ Type: `string`

The following input variables are optional (have default values):

==== [[input_subdomain]] <<input_subdomain,subdomain>>

Description: Sub domain of the cluster. Value used for the ingress' URL of the application.

Type: `string`

Default: `"apps"`

==== [[input_argocd_project]] <<input_argocd_project,argocd_project>>

Description: 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.
Expand Down Expand Up @@ -237,7 +245,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v3.1.0"`
Default: `"v3.2.0"`

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

Expand Down Expand Up @@ -388,6 +396,12 @@ object({
|n/a
|yes
|[[input_subdomain]] <<input_subdomain,subdomain>>
|Sub domain of the cluster. Value used for the ingress' URL of the application.
|`string`
|`"apps"`
|no
|[[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 @@ -409,7 +423,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.1.0"`
|`"v3.2.0"`
|no
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
Expand Down
18 changes: 16 additions & 2 deletions sks/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,14 @@ Type: `string`

The following input variables are optional (have default values):

==== [[input_subdomain]] <<input_subdomain,subdomain>>

Description: Sub domain of the cluster. Value used for the ingress' URL of the application.

Type: `string`

Default: `"apps"`

==== [[input_argocd_project]] <<input_argocd_project,argocd_project>>

Description: 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.
Expand Down Expand Up @@ -186,7 +194,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v3.1.0"`
Default: `"v3.2.0"`

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

Expand Down Expand Up @@ -342,6 +350,12 @@ object({
|n/a
|yes
|[[input_subdomain]] <<input_subdomain,subdomain>>
|Sub domain of the cluster. Value used for the ingress' URL of the application.
|`string`
|`"apps"`
|no
|[[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 @@ -363,7 +377,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.1.0"`
|`"v3.2.0"`
|no
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
Expand Down

0 comments on commit 0352f8b

Please sign in to comment.