status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update 1.4.0 Helm docs with Docs team feedback (#20798)

This commit is contained in:
Michael Zalimeni 2024-03-06 09:09:28 -05:00 committed by GitHub
parent 1522678da8
commit 90117613e8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
website/content/docs/k8s/helm.mdx
View File

@ -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. - `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. 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. 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 - `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 - `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. 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: metrics by prefix in the following format:
A leading "+" will enable any metrics with the given prefix, and a leading "-" will block them. 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. 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. Blocking will take priority if the same prefix is listed multiple times.
- allowList:
- `allowList` ((#v-global-metrics-prefixfilter-allowlist)) (`array<string>: []`) - `allowList` ((#v-global-metrics-prefixfilter-allowlist)) (`array<string>: []`)
- `blockList` ((#v-global-metrics-prefixfilter-blocklist)) (`array<string>: []`) - `blockList` ((#v-global-metrics-prefixfilter-blocklist)) (`array<string>: []`)
@ -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. - `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 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 configurations. Refer to the [Datadog documentation](https://docs.datadoghq.com/containers/kubernetes/prometheus/?tab=kubernetesadv2) for more details.
surround further configuration.
- `enabled` ((#v-global-metrics-datadog-openmetricsprometheus-enabled)) (`boolean: false`) - `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<string>: []`) - Consul feature flags that will be enabled across components. - `experiments` ((#v-global-experiments)) (`array<string>: []`) - Consul feature flags that will be enabled across components.
Supported feature flags: Supported feature flags:
* `resource-apis`: - `resource-apis`:
_**Danger**_! This feature is under active development. It is not _**Warning**_! This feature is under active development. It is not
recommended for production use. Setting this flag during an recommended for production use. Setting this flag during an
upgrade could risk breaking your Consul cluster. upgrade could risk breaking your Consul cluster.
If this flag is set, Consul components will use the If this flag is set, Consul components will use the
V2 resources APIs for all operations. V2 resources APIs for all operations.
* `v2tenancy`: - `v2tenancy`:
_**Danger**_! This feature is under active development. It is not _**Warning**_! This feature is under active development. It is not
recommended for production use. Setting this flag during an recommended for production use. Setting this flag during an
upgrade could risk breaking your Consul cluster. upgrade could risk breaking your Consul cluster.
If this flag is set, Consul V2 resources (catalog, mesh, auth, etc) 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`. 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 - `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 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 consensus pool. When running an odd number of servers, one server leaving the pool does not change the quorum