Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Disruption Candidacy Documentation #1241

Open
jmdeal opened this issue May 9, 2024 · 2 comments
Open

Improve Disruption Candidacy Documentation #1241

jmdeal opened this issue May 9, 2024 · 2 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@jmdeal
Copy link
Member

jmdeal commented May 9, 2024

Karpenter's current documentation on this is relatively sparse, with the Control Flow section of the disruption docs going into some amount of detail.

It would be good to add a dedicated section to the disruption docs for candidacy. Minimally, I think it should cover the following topics:

  • What does being a candidate mean for the different disruption types
    • Consolidation is an interesting case since nodes don't need to be underutilized to be considered candidates. This may be surprising to users, and is important to document since this is surfaced as a metric.
  • What conditions must be met for a node to be considered a candidate
    • Document the general set of conditions as well as disruption type specific conditions (e.g. terminationGracePeriod overriding the do-not-disrupt and PDB check for expiration and drift).

Note: the docs are still located in the AWS provider repo, but I'm opening this here since it has do with an upstream concept.

@jmdeal
Copy link
Member Author

jmdeal commented May 9, 2024

/kind documentation

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. kind/documentation Categorizes issue or PR as related to documentation. labels May 9, 2024
@jonathan-innis
Copy link
Member

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

3 participants