From 68134ae8bcd24e89afb9d4bc82e5356cfd6af5e7 Mon Sep 17 00:00:00 2001 From: lentidas Date: Fri, 9 Feb 2024 12:14:55 +0000 Subject: [PATCH] docs(terraform-docs): generate docs and write to README.adoc --- README.adoc | 32 ++++++++++++++++++++++++++++++-- aks/README.adoc | 32 ++++++++++++++++++++++++++++++-- eks/README.adoc | 32 ++++++++++++++++++++++++++++++-- kind/README.adoc | 32 ++++++++++++++++++++++++++++++-- sks/README.adoc | 32 ++++++++++++++++++++++++++++++-- 5 files changed, 150 insertions(+), 10 deletions(-) diff --git a/README.adoc b/README.adoc index 72ee58d3..567849e8 100644 --- a/README.adoc +++ b/README.adoc @@ -106,7 +106,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v3.0.1"` +Default: `"v3.1.0"` ==== [[input_cluster_issuer]] <> @@ -172,6 +172,22 @@ Type: `any` Default: `{}` +==== [[input_enable_service_monitor]] <> + +Description: Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. + +Type: `bool` + +Default: `false` + +==== [[input_enable_monitoring_dashboard]] <> + +Description: Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. + +Type: `bool` + +Default: `true` + === Outputs The following outputs are exported: @@ -261,7 +277,7 @@ Description: ID to pass other modules in order to refer to this module as a depe |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v3.0.1"` +|`"v3.1.0"` |no |[[input_cluster_issuer]] <> @@ -320,6 +336,18 @@ object({ |`{}` |no +|[[input_enable_service_monitor]] <> +|Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. +|`bool` +|`false` +|no + +|[[input_enable_monitoring_dashboard]] <> +|Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. +|`bool` +|`true` +|no + |=== = Outputs diff --git a/aks/README.adoc b/aks/README.adoc index 7a9d554e..9a0f8695 100644 --- a/aks/README.adoc +++ b/aks/README.adoc @@ -310,7 +310,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v3.0.1"` +Default: `"v3.1.0"` ==== [[input_cluster_issuer]] <> @@ -376,6 +376,22 @@ Type: `any` Default: `{}` +==== [[input_enable_service_monitor]] <> + +Description: Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. + +Type: `bool` + +Default: `false` + +==== [[input_enable_monitoring_dashboard]] <> + +Description: Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. + +Type: `bool` + +Default: `true` + === Outputs The following outputs are exported: @@ -488,7 +504,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v3.0.1"` +|`"v3.1.0"` |no |[[input_cluster_issuer]] <> @@ -547,6 +563,18 @@ object({ |`{}` |no +|[[input_enable_service_monitor]] <> +|Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. +|`bool` +|`false` +|no + +|[[input_enable_monitoring_dashboard]] <> +|Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. +|`bool` +|`true` +|no + |=== = Outputs diff --git a/eks/README.adoc b/eks/README.adoc index 5c9afc26..9fc89d2c 100644 --- a/eks/README.adoc +++ b/eks/README.adoc @@ -303,7 +303,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v3.0.1"` +Default: `"v3.1.0"` ==== [[input_cluster_issuer]] <> @@ -369,6 +369,22 @@ Type: `any` Default: `{}` +==== [[input_enable_service_monitor]] <> + +Description: Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. + +Type: `bool` + +Default: `false` + +==== [[input_enable_monitoring_dashboard]] <> + +Description: Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. + +Type: `bool` + +Default: `true` + === Outputs The following outputs are exported: @@ -457,7 +473,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v3.0.1"` +|`"v3.1.0"` |no |[[input_cluster_issuer]] <> @@ -516,6 +532,18 @@ object({ |`{}` |no +|[[input_enable_service_monitor]] <> +|Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. +|`bool` +|`false` +|no + +|[[input_enable_monitoring_dashboard]] <> +|Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. +|`bool` +|`true` +|no + |=== = Outputs diff --git a/kind/README.adoc b/kind/README.adoc index 4e3a2a18..6d27a4f6 100644 --- a/kind/README.adoc +++ b/kind/README.adoc @@ -237,7 +237,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v3.0.1"` +Default: `"v3.1.0"` ==== [[input_cluster_issuer]] <> @@ -303,6 +303,22 @@ Type: `any` Default: `{}` +==== [[input_enable_service_monitor]] <> + +Description: Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. + +Type: `bool` + +Default: `false` + +==== [[input_enable_monitoring_dashboard]] <> + +Description: Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. + +Type: `bool` + +Default: `true` + === Outputs The following outputs are exported: @@ -393,7 +409,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v3.0.1"` +|`"v3.1.0"` |no |[[input_cluster_issuer]] <> @@ -452,6 +468,18 @@ object({ |`{}` |no +|[[input_enable_service_monitor]] <> +|Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. +|`bool` +|`false` +|no + +|[[input_enable_monitoring_dashboard]] <> +|Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. +|`bool` +|`true` +|no + |=== = Outputs diff --git a/sks/README.adoc b/sks/README.adoc index 0a07e822..c28d8764 100644 --- a/sks/README.adoc +++ b/sks/README.adoc @@ -186,7 +186,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v3.0.1"` +Default: `"v3.1.0"` ==== [[input_cluster_issuer]] <> @@ -252,6 +252,22 @@ Type: `any` Default: `{}` +==== [[input_enable_service_monitor]] <> + +Description: Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. + +Type: `bool` + +Default: `false` + +==== [[input_enable_monitoring_dashboard]] <> + +Description: Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. + +Type: `bool` + +Default: `true` + === Outputs The following outputs are exported: @@ -347,7 +363,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v3.0.1"` +|`"v3.1.0"` |no |[[input_cluster_issuer]] <> @@ -406,6 +422,18 @@ object({ |`{}` |no +|[[input_enable_service_monitor]] <> +|Boolean to enable the deployment of a service monitor for Prometheus. This also enables the deployment of default Prometheus rules, which are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/blob/main/examples/alerts/alerts.yaml[here]. +|`bool` +|`false` +|no + +|[[input_enable_monitoring_dashboard]] <> +|Boolean to enable the provisioning of multiple Grafana dashboards, one for each component of Thanos. These dashboards are embedded inside the chart templates and are taken from the official Thanos examples, available https://github.com/thanos-io/thanos/tree/main/examples/dashboards[here]. Requires the variable `enable_service_monitor` to be set to `true`. +|`bool` +|`true` +|no + |=== = Outputs