docs: High Availability Setup documentation #2715
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
needs-triage
k8s-ci-robot
added
size/S
|
/assign |
k8s-ci-robot
added
triage/accepted
README.md
Outdated
| @@ -304,6 +305,12 @@ spec: | |||
|
|
|||
| Other metrics can be sharded via [Horizontal sharding](#horizontal-sharding). | |||
|
|
|||
| ### High Availability | |||
|
|
|||
| For high availability, run multiple kube-state-metrics replicas with anti-affinity rules to prevent single points of failure. Configure 2 replicas, anti-affinity rules on hostname, rolling update strategy with `maxUnavailable: 1`, and a PodDisruptionBudget with `minAvailable: 1`. | |||
There was a problem hiding this comment.
What is the value-add specifically for ksm here? I believe this would apply to most Kubernetes deployments if you want to run them highly available.
There was a problem hiding this comment.
I'll update the documentation to explain that users must perform query-time deduplication
README.md
Outdated
|
|
||
| For high availability, run multiple kube-state-metrics replicas with anti-affinity rules to prevent single points of failure. Configure 2 replicas, anti-affinity rules on hostname, rolling update strategy with `maxUnavailable: 1`, and a PodDisruptionBudget with `minAvailable: 1`. | ||
|
|
||
| When using multiple replicas, Prometheus will scrape all instances resulting in duplicate metrics with different instance labels. Handle deduplication in queries using `avg without(instance) (metric_name)`. Brief inconsistencies may occur during state transitions but resolve quickly as replicas sync with the API server. |
There was a problem hiding this comment.
This depends on how you scrape the metrics with prometheus, on a pod level or a service level.
There was a problem hiding this comment.
yeah right, I'll update the section to clarify the differences.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Rishab87 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@mrueg I've addressed reviews can you have a look again? |
What this PR does / why we need it:
Adds documentation for high availability setups
How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
does not change cardinality
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #2081