docs: update Helm docs for consul-k8s 1.4.0#20770
Merged
Conversation
zalimeni
added
type/docs
boruszak
approved these changes
Feb 29, 2024
Contributor
boruszak
left a comment
boruszak
left a comment
There was a problem hiding this comment.
I left suggestions to correct some of the more obvious errors and deviations from the style guide. Approving on behalf of consul-docs so that you're not blocked.
Comment on lines
+552
to
+553
| - `enableHostMetrics` ((#v-global-metrics-enablehostmetrics)) (`boolean: false`) - Configures consul agent underlying host metrics. Only applicable if | ||
| Only applicable if `global.metrics.enabled` and `global.metrics.enableAgentMetrics` is true. |
Contributor
There was a problem hiding this comment.
Suggested change
| - `enableHostMetrics` ((#v-global-metrics-enablehostmetrics)) (`boolean: false`) - Configures consul agent underlying host metrics. Only applicable if | |
| 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. Default is false. | |
| Only applicable if `global.metrics.enabled` and `global.metrics.enableAgentMetrics` is true. |
I'm assuming it was meant to mirror the previous specification.
| - `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 |
Contributor
There was a problem hiding this comment.
Suggested change
| - `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 |
Comment on lines
+573
to
+575
|
|
||
| - allowList: | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| - allowList: |
Is this an error? I know the page is automatically generated, but this seems unintentional.
Member
Author
There was a problem hiding this comment.
Yeah I think this was accidentally included
|
|
||
| - `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 |
Contributor
There was a problem hiding this comment.
Suggested change
| 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. |
Per style guide, links should include descriptive text.
Comment on lines
+776
to
+777
| * `v2tenancy`: | ||
| _**Danger**_! This feature is under active development. It is not |
Contributor
There was a problem hiding this comment.
Suggested change
| * `v2tenancy`: | |
| _**Danger**_! This feature is under active development. It is not | |
| - `v2tenancy`: | |
| _**Warning**_! This feature is under active development. It is not |
Standard markdown for bullet + standard "warning" instead of "danger"
| - `maxUnavailable` ((#v-server-disruptionbudget-maxunavailable)) (`integer: null`) - The maximum number of unavailable pods. By default, this will be | ||
| automatically computed based on the `server.replicas` value to be `(n/2)-1`. | ||
| - `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. |
Contributor
There was a problem hiding this comment.
Suggested change
| 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. |
4 tasks
Member
Author
This was referenced Sep 26, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR is the regeneration of the Helm docs with updated values from
consul-k8s1.4.0, released today.Testing & Reproduction steps
Visual inspection
Links
Generated from the 1.4.0
values.yamlherePR Checklist