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
lconsuegra authored and github-actions[bot] committed Jan 31, 2024
1 parent 0c1ee92 commit 87f7b69
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 12 deletions.
22 changes: 18 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,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 @@ -105,7 +113,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v3.0.0"`
Default: `"v3.0.1"`

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

Expand Down Expand Up @@ -202,10 +210,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_random]] <<provider_random,random>> |>= 3
|[[provider_utils]] <<provider_utils,utils>> |>= 1
|[[provider_argocd]] <<provider_argocd,argocd>> |>= 5
|[[provider_null]] <<provider_null,null>> |>= 3
|===
= Resources
Expand Down Expand Up @@ -238,6 +246,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 @@ -259,7 +273,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.0.0"`
|`"v3.0.1"`
|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.0.0"`
Default: `"v3.0.1"`

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

Expand Down Expand Up @@ -467,6 +475,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 @@ -488,7 +502,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.0.0"`
|`"v3.0.1"`
|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.0.0"`
Default: `"v3.0.1"`

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

Expand Down Expand Up @@ -436,6 +444,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 @@ -457,7 +471,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.0.0"`
|`"v3.0.1"`
|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.0.0"`
Default: `"v3.0.1"`

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

Expand Down Expand Up @@ -372,6 +380,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 @@ -393,7 +407,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.0.0"`
|`"v3.0.1"`
|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.0.0"`
Default: `"v3.0.1"`

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

Expand Down Expand Up @@ -326,6 +334,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 @@ -347,7 +361,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.0.0"`
|`"v3.0.1"`
|no
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
Expand Down

0 comments on commit 87f7b69

Please sign in to comment.