From bd27c3552fb6faec9ccf9eb8c2862f5b51fdd8d2 Mon Sep 17 00:00:00 2001 From: Michael Zalimeni Date: Tue, 5 Mar 2024 21:51:06 +0000 Subject: [PATCH] backport of commit a6eeb408e57622e4c9262de47b436ca032afbddf --- website/content/docs/k8s/helm.mdx | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/website/content/docs/k8s/helm.mdx b/website/content/docs/k8s/helm.mdx index d47a8c9196c2..5eafa9596791 100644 --- a/website/content/docs/k8s/helm.mdx +++ b/website/content/docs/k8s/helm.mdx @@ -549,7 +549,7 @@ Use these links to navigate to a particular top-level stanza. - `disableAgentHostName` ((#v-global-metrics-disableagenthostname)) (`boolean: false`) - Set to true to stop prepending the machine's hostname to gauge-type metrics. Default is false. Only applicable if `global.metrics.enabled` and `global.metrics.enableAgentMetrics` is true. - - `enableHostMetrics` ((#v-global-metrics-enablehostmetrics)) (`boolean: false`) - Configures consul agent underlying host metrics. Only applicable if + - `enableHostMetrics` ((#v-global-metrics-enablehostmetrics)) (`boolean: false`) - Configures consul agent underlying host metrics. Default is false. Only applicable if `global.metrics.enabled` and `global.metrics.enableAgentMetrics` is true. - `agentMetricsRetentionTime` ((#v-global-metrics-agentmetricsretentiontime)) (`string: 1m`) - Configures the retention time for metrics in Consul clients and @@ -564,15 +564,13 @@ Use these links to navigate to a particular top-level stanza. - `enableTelemetryCollector` ((#v-global-metrics-enabletelemetrycollector)) (`boolean: false`) - Configures the Helm chart’s components to forward envoy metrics for the Consul service mesh to the consul-telemetry-collector. This includes gateway metrics and sidecar metrics. - - `prefixFilter` ((#v-global-metrics-prefixfilter)) - This configures the list of filter rules to apply for allowing/blocking + - `prefixFilter` ((#v-global-metrics-prefixfilter)) - Configures the list of filter rules to apply for allowing or blocking metrics by prefix in the following format: A leading "+" will enable any metrics with the given prefix, and a leading "-" will block them. If there is overlap between two rules, the more specific rule will take precedence. Blocking will take priority if the same prefix is listed multiple times. - - allowList: - - `allowList` ((#v-global-metrics-prefixfilter-allowlist)) (`array: []`) - `blockList` ((#v-global-metrics-prefixfilter-blocklist)) (`array: []`) @@ -606,8 +604,7 @@ Use these links to navigate to a particular top-level stanza. - `openMetricsPrometheus` ((#v-global-metrics-datadog-openmetricsprometheus)) - Configures Kubernetes Prometheus/OpenMetrics auto-discovery annotations for use with Datadog. This configuration is less common and more for advanced usage with custom metrics monitoring - configurations. See https://docs.datadoghq.com/containers/kubernetes/prometheus/?tab=kubernetesadv2 for more details - surround further configuration. + configurations. Refer to the [Datadog documentation](https://docs.datadoghq.com/containers/kubernetes/prometheus/?tab=kubernetesadv2) for more details. - `enabled` ((#v-global-metrics-datadog-openmetricsprometheus-enabled)) (`boolean: false`) @@ -767,14 +764,14 @@ Use these links to navigate to a particular top-level stanza. - `experiments` ((#v-global-experiments)) (`array: []`) - Consul feature flags that will be enabled across components. Supported feature flags: - * `resource-apis`: - _**Danger**_! This feature is under active development. It is not + - `resource-apis`: + _**Warning**_! This feature is under active development. It is not recommended for production use. Setting this flag during an upgrade could risk breaking your Consul cluster. If this flag is set, Consul components will use the V2 resources APIs for all operations. - * `v2tenancy`: - _**Danger**_! This feature is under active development. It is not + - `v2tenancy`: + _**Warning**_! This feature is under active development. It is not recommended for production use. Setting this flag during an upgrade could risk breaking your Consul cluster. If this flag is set, Consul V2 resources (catalog, mesh, auth, etc) @@ -975,7 +972,7 @@ Use these links to navigate to a particular top-level stanza. the server cluster is enabled. To disable, set to `false`. - `maxUnavailable` ((#v-server-disruptionbudget-maxunavailable)) (`integer: null`) - The maximum number of unavailable pods. In most cases you should not change this as it is automatically set to - the correct number when left as null. This setting has been kept to not break backwards compatibility. + the correct number when left as null. This setting has been kept to preserve backwards compatibility. By default, this is set to 1 internally in the chart. When server pods are stopped gracefully, they leave the Raft consensus pool. When running an odd number of servers, one server leaving the pool does not change the quorum