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
hbollon authored and github-actions[bot] committed Jan 25, 2024
1 parent e01e34f commit 5c278c0
Showing 1 changed file with 85 additions and 5 deletions.
90 changes: 85 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -216,11 +216,11 @@ The following providers are used by this module:

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

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

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

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

=== Resources

Expand Down Expand Up @@ -291,7 +291,7 @@ Description: Override of target revision of the application chart.

Type: `string`

Default: `"v2.3.0"`
Default: `"v3.0.0"`

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

Expand Down Expand Up @@ -465,6 +465,45 @@ object({

Default: `null`

==== [[input_automatic_filesystem_trim]] <<input_automatic_filesystem_trim,automatic_filesystem_trim>>

Description: Settings to enable and configure automatic filesystem trim of volumes managed by Longhorn.

Type:
[source,hcl]
----
object({
enabled = bool
cron = string
job_group = string
})
----

Default:
[source,json]
----
{
"cron": "0 6 * * *",
"enabled": false,
"job_group": ""
}
----

==== [[input_recurring_job_selectors]] <<input_recurring_job_selectors,recurring_job_selectors>>

Description: Define a group list to add to recurring job selector for the default storage class (the custom backup one if `set_default_storage_class` is set or else the Longhorn default one).

Type:
[source,hcl]
----
list(object({
name = string
isGroup = bool
}))
----

Default: `null`

==== [[input_replica_count]] <<input_replica_count,replica_count>>

Description: Amount of replicas created by Longhorn for each volume.
Expand Down Expand Up @@ -525,9 +564,9 @@ Description: ID to pass other modules in order to refer to this module as a depe
|===
|Name |Version
|[[provider_random]] <<provider_random,random>> |>= 3
|[[provider_null]] <<provider_null,null>> |n/a
|[[provider_utils]] <<provider_utils,utils>> |>= 1
|[[provider_argocd]] <<provider_argocd,argocd>> |>= 5
|[[provider_null]] <<provider_null,null>> |n/a
|===
= Resources
Expand Down Expand Up @@ -587,7 +626,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.3.0"`
|`"v3.0.0"`
|no
|[[input_helm_values]] <<input_helm_values,helm_values>>
Expand Down Expand Up @@ -749,6 +788,47 @@ object({
|`null`
|no
|[[input_automatic_filesystem_trim]] <<input_automatic_filesystem_trim,automatic_filesystem_trim>>
|Settings to enable and configure automatic filesystem trim of volumes managed by Longhorn.
|
[source]
----
object({
enabled = bool
cron = string
job_group = string
})
----
|
[source]
----
{
"cron": "0 6 * * *",
"enabled": false,
"job_group": ""
}
----
|no
|[[input_recurring_job_selectors]] <<input_recurring_job_selectors,recurring_job_selectors>>
|Define a group list to add to recurring job selector for the default storage class (the custom backup one if `set_default_storage_class` is set or else the Longhorn default one).
|
[source]
----
list(object({
name = string
isGroup = bool
}))
----
|`null`
|no
|[[input_replica_count]] <<input_replica_count,replica_count>>
|Amount of replicas created by Longhorn for each volume.
|`number`
Expand Down

0 comments on commit 5c278c0

Please sign in to comment.