From ac5c3bb2b5e7fe8698f0103b2ee4ff420d4be916 Mon Sep 17 00:00:00 2001 From: lentidas Date: Fri, 15 Sep 2023 13:06:10 +0000 Subject: [PATCH] docs(terraform-docs): generate docs and write to README.adoc --- README.adoc | 46 ++++++++++++++++++++++++++++++++++++++++++++-- aks/README.adoc | 42 ++++++++++++++++++++++++++++++++++++++++++ eks/README.adoc | 42 ++++++++++++++++++++++++++++++++++++++++++ kind/README.adoc | 42 ++++++++++++++++++++++++++++++++++++++++++ sks/README.adoc | 42 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 212 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 3a78e8d9..53cd81b7 100644 --- a/README.adoc +++ b/README.adoc @@ -83,6 +83,30 @@ Type: `string` Default: `"argocd"` +==== [[input_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. + +Type: `string` + +Default: `null` + +==== [[input_argocd_labels]] <> + +Description: Labels to attach to the Argo CD Application resource. + +Type: `map(string)` + +Default: `{}` + +==== [[input_destination_cluster]] <> + +Description: Destination cluster where the application should be deployed. + +Type: `string` + +Default: `"in-cluster"` + ==== [[input_target_revision]] <> Description: Override of target revision of the application chart. @@ -194,10 +218,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]] <> |>= 3 -|[[provider_argocd]] <> |>= 5 |[[provider_random]] <> |>= 3 |[[provider_utils]] <> |>= 1 +|[[provider_argocd]] <> |>= 5 +|[[provider_null]] <> |>= 3 |=== = Resources @@ -236,6 +260,24 @@ Description: ID to pass other modules in order to refer to this module as a depe |`"argocd"` |no +|[[input_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` +|`null` +|no + +|[[input_argocd_labels]] <> +|Labels to attach to the Argo CD Application resource. +|`map(string)` +|`{}` +|no + +|[[input_destination_cluster]] <> +|Destination cluster where the application should be deployed. +|`string` +|`"in-cluster"` +|no + |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` diff --git a/aks/README.adoc b/aks/README.adoc index 75c1ea7b..e649d75c 100644 --- a/aks/README.adoc +++ b/aks/README.adoc @@ -283,6 +283,30 @@ Type: `string` Default: `"argocd"` +==== [[input_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. + +Type: `string` + +Default: `null` + +==== [[input_argocd_labels]] <> + +Description: Labels to attach to the Argo CD Application resource. + +Type: `map(string)` + +Default: `{}` + +==== [[input_destination_cluster]] <> + +Description: Destination cluster where the application should be deployed. + +Type: `string` + +Default: `"in-cluster"` + ==== [[input_target_revision]] <> Description: Override of target revision of the application chart. @@ -456,6 +480,24 @@ object({ |`"argocd"` |no +|[[input_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` +|`null` +|no + +|[[input_argocd_labels]] <> +|Labels to attach to the Argo CD Application resource. +|`map(string)` +|`{}` +|no + +|[[input_destination_cluster]] <> +|Destination cluster where the application should be deployed. +|`string` +|`"in-cluster"` +|no + |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` diff --git a/eks/README.adoc b/eks/README.adoc index 3fc8b19d..dd807d8b 100644 --- a/eks/README.adoc +++ b/eks/README.adoc @@ -281,6 +281,30 @@ Type: `string` Default: `"argocd"` +==== [[input_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. + +Type: `string` + +Default: `null` + +==== [[input_argocd_labels]] <> + +Description: Labels to attach to the Argo CD Application resource. + +Type: `map(string)` + +Default: `{}` + +==== [[input_destination_cluster]] <> + +Description: Destination cluster where the application should be deployed. + +Type: `string` + +Default: `"in-cluster"` + ==== [[input_target_revision]] <> Description: Override of target revision of the application chart. @@ -434,6 +458,24 @@ object({ |`"argocd"` |no +|[[input_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` +|`null` +|no + +|[[input_argocd_labels]] <> +|Labels to attach to the Argo CD Application resource. +|`map(string)` +|`{}` +|no + +|[[input_destination_cluster]] <> +|Destination cluster where the application should be deployed. +|`string` +|`"in-cluster"` +|no + |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` diff --git a/kind/README.adoc b/kind/README.adoc index 014104e8..04e6dec0 100644 --- a/kind/README.adoc +++ b/kind/README.adoc @@ -215,6 +215,30 @@ Type: `string` Default: `"argocd"` +==== [[input_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. + +Type: `string` + +Default: `null` + +==== [[input_argocd_labels]] <> + +Description: Labels to attach to the Argo CD Application resource. + +Type: `map(string)` + +Default: `{}` + +==== [[input_destination_cluster]] <> + +Description: Destination cluster where the application should be deployed. + +Type: `string` + +Default: `"in-cluster"` + ==== [[input_target_revision]] <> Description: Override of target revision of the application chart. @@ -370,6 +394,24 @@ object({ |`"argocd"` |no +|[[input_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` +|`null` +|no + +|[[input_argocd_labels]] <> +|Labels to attach to the Argo CD Application resource. +|`map(string)` +|`{}` +|no + +|[[input_destination_cluster]] <> +|Destination cluster where the application should be deployed. +|`string` +|`"in-cluster"` +|no + |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` diff --git a/sks/README.adoc b/sks/README.adoc index 3ee2e69d..eaef2ca6 100644 --- a/sks/README.adoc +++ b/sks/README.adoc @@ -164,6 +164,30 @@ Type: `string` Default: `"argocd"` +==== [[input_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. + +Type: `string` + +Default: `null` + +==== [[input_argocd_labels]] <> + +Description: Labels to attach to the Argo CD Application resource. + +Type: `map(string)` + +Default: `{}` + +==== [[input_destination_cluster]] <> + +Description: Destination cluster where the application should be deployed. + +Type: `string` + +Default: `"in-cluster"` + ==== [[input_target_revision]] <> Description: Override of target revision of the application chart. @@ -324,6 +348,24 @@ object({ |`"argocd"` |no +|[[input_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` +|`null` +|no + +|[[input_argocd_labels]] <> +|Labels to attach to the Argo CD Application resource. +|`map(string)` +|`{}` +|no + +|[[input_destination_cluster]] <> +|Destination cluster where the application should be deployed. +|`string` +|`"in-cluster"` +|no + |[[input_target_revision]] <> |Override of target revision of the application chart. |`string`