Update README.md for kubernetes_cluster_autoscaler #20061
Conversation
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
cswatt
added
the
editorial review
|
Thanks for this PR! created DOCS-10610 to review |
cswatt
approved these changes
Apr 16, 2025
temporal-github-worker-1
bot
added
docs/approved
and removed
docs/review-requested
labels
L3n41c
reviewed
Apr 17, 2025
| @@ -54,7 +59,7 @@ kind: Pod | |||
| metadata: | |||
| name: '<POD_NAME>' | |||
| annotations: | |||
| ad.datadoghq.com/controller.checks: | | |||
| ad.datadoghq.com/<CONTAINER_NAME>.checks: | | |||
There was a problem hiding this comment.
This <CONTAINER_NAME> has to match the name of the container defined below line 76.
If we keep a container name hard-coded to controller line 76, it should be fine to keep controller here as well.
If we want to be able to customize the name of the container, then, we should also put <CONTAINER_NAME> below, line 76.
| The only parameters required for configuring the `kubernetes_cluster_autoscaler` check are: | ||
|
|
||
| * CONTAINER_NAME | ||
| Describe the pod belonging to your cluster autoscaler, and find the container name. |
There was a problem hiding this comment.
Suggested change
| Describe the pod belonging to your cluster autoscaler, and find the container name. | |
| Name of the container of the cluster autoscaler controller. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
The Kubernetes Cluster Autoscaler does not work out of the box with the configuration listed in the README.md file.
The default container name changes depending on where it is deployed, and
controlleris not a valid container name for all deployments.Abstracted the readme to highlight the fact that you need to specify the container name as part of the annotation instead of using
controllerfor the container name.Motivation
In an AWS EKS deployment, the container name is
aws-cluster-autoscalerand the integration didn't work out of the box with the instructions from the readme.Review checklist (to be filled by reviewers)
qa/skip-qalabel if the PR doesn't need to be tested during QA.backport/<branch-name>label to the PR and it will automatically open a backport PR once this one is merged