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 5dd52e9 commit 3ddd080
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 49 deletions.
36 changes: 4 additions & 32 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,6 @@ The following requirements are needed by this module:

The following providers are used by this module:

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

- [[provider_jwt]] <<provider_jwt,jwt>> (>= 1.1)

- [[provider_time]] <<provider_time,time>> (>= 0.9)
Expand All @@ -235,6 +233,8 @@ The following providers are used by this module:

- [[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 @@ -280,14 +280,6 @@ Type: `string`

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

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

Description: Namespace used by Argo CD where the Application and AppProject resources should be created. Normally, it should take the outputof the namespace from the bootstrap module.

Type: `string`

Default: `"argocd"`

==== [[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 All @@ -310,7 +302,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v3.5.1"`
Default: `"v3.5.2"`

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

Expand All @@ -320,14 +312,6 @@ Type: `string`

Default: `"selfsigned-issuer"`

==== [[input_namespace]] <<input_namespace,namespace>>

Description: Namespace where to deploy Argo CD.

Type: `string`

Default: `"argocd"`

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

Description: Helm chart value overrides. They should be passed as a list of HCL structures.
Expand Down Expand Up @@ -716,12 +700,6 @@ Description: Map of extra accounts that were created and their tokens.
|n/a
|yes
|[[input_argocd_namespace]] <<input_argocd_namespace,argocd_namespace>>
|Namespace used by Argo CD where the Application and AppProject resources should be created. Normally, it should take the outputof the namespace from the bootstrap module.
|`string`
|`"argocd"`
|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 @@ -737,7 +715,7 @@ Description: Map of extra accounts that were created and their tokens.
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v3.5.1"`
|`"v3.5.2"`
|no
|[[input_cluster_issuer]] <<input_cluster_issuer,cluster_issuer>>
Expand All @@ -746,12 +724,6 @@ Description: Map of extra accounts that were created and their tokens.
|`"selfsigned-issuer"`
|no
|[[input_namespace]] <<input_namespace,namespace>>
|Namespace where to deploy Argo CD.
|`string`
|`"argocd"`
|no
|[[input_helm_values]] <<input_helm_values,helm_values>>
|Helm chart value overrides. They should be passed as a list of HCL structures.
|`any`
Expand Down
20 changes: 3 additions & 17 deletions bootstrap/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,6 @@ The following resources are used by this module:

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

==== [[input_namespace]] <<input_namespace,namespace>>

Description: Namespace where to deploy Argo CD.

Type: `string`

Default: `"argocd"`

==== [[input_argocd_projects]] <<input_argocd_projects,argocd_projects>>

Description: List of AppProject definitions to be created in Argo CD. By default, no projects are created since this variable defaults to an empty map.
Expand Down Expand Up @@ -166,7 +158,7 @@ Description: ID to pass other modules in order to refer to this module as a depe

==== [[output_argocd_namespace]] <<output_argocd_namespace,argocd_namespace>>

Description: The namespace where to deploy Argo CD.
Description: The namespace where Argo CD resides. The main use of this output is to create an implicit dependency when passing this attribute to the oboukili/argocd provider settings.

==== [[output_argocd_project_names]] <<output_argocd_project_names,argocd_project_names>>

Expand Down Expand Up @@ -211,9 +203,9 @@ Description: The Argo CD accounts pipeline tokens.
[cols="a,a",options="header,autowidth"]
|===
|Name |Version
|[[provider_random]] <<provider_random,random>> |>= 3
|[[provider_jwt]] <<provider_jwt,jwt>> |>= 1.1
|[[provider_time]] <<provider_time,time>> |>= 0.9
|[[provider_random]] <<provider_random,random>> |>= 3
|[[provider_helm]] <<provider_helm,helm>> |>= 2
|[[provider_argocd]] <<provider_argocd,argocd>> |>= 6
|[[provider_utils]] <<provider_utils,utils>> |>= 1.6
Expand All @@ -240,12 +232,6 @@ Description: The Argo CD accounts pipeline tokens.
[cols="a,a,a,a,a",options="header,autowidth"]
|===
|Name |Description |Type |Default |Required
|[[input_namespace]] <<input_namespace,namespace>>
|Namespace where to deploy Argo CD.
|`string`
|`"argocd"`
|no
|[[input_argocd_projects]] <<input_argocd_projects,argocd_projects>>
|List of AppProject definitions to be created in Argo CD. By default, no projects are created since this variable defaults to an empty map.
Expand Down Expand Up @@ -291,7 +277,7 @@ map(object({
|===
|Name |Description
|[[output_id]] <<output_id,id>> |ID to pass other modules in order to refer to this module as a dependency.
|[[output_argocd_namespace]] <<output_argocd_namespace,argocd_namespace>> |The namespace where to deploy Argo CD.
|[[output_argocd_namespace]] <<output_argocd_namespace,argocd_namespace>> |The namespace where Argo CD resides. The main use of this output is to create an implicit dependency when passing this attribute to the oboukili/argocd provider settings.
|[[output_argocd_project_names]] <<output_argocd_project_names,argocd_project_names>> |The names of all the Argo CD AppProjects created by the bootstrap module.
|[[output_argocd_server_secretkey]] <<output_argocd_server_secretkey,argocd_server_secretkey>> |The Argo CD server secret key.
|[[output_argocd_auth_token]] <<output_argocd_auth_token,argocd_auth_token>> |The token to set in `ARGOCD_AUTH_TOKEN` environment variable. May be used for configuring Argo CD Terraform provider.
Expand Down

0 comments on commit 3ddd080

Please sign in to comment.