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

Add diagram of strategies #546

Merged
merged 1 commit into from
Apr 12, 2021

Conversation

ingvagabund
Copy link
Contributor

@ingvagabund ingvagabund commented Apr 8, 2021

Provide diagram with various strategies and the way they operate over pods.

All except LNU (it does not fit properly into the diagram).

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 8, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ingvagabund

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 8, 2021
@ingvagabund
Copy link
Contributor Author

@damemi @seanmalloy @lixiang233 the diagram is not necessarily a final one. Happy to improve or add more information into it. The goal is to make a high level diagram to show how each strategy works in general. LNU is not included since it does not fit there.

Copy link
Contributor

@damemi damemi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice, do you want to also add some for the individual strategy sections (or maybe just add one under LNU to explain that a bit more?)

I really like how this fits into the readme though, which is currently a lot of text. Breaking it up with some diagrams will make it more digestable

@seanmalloy
Copy link
Member

I think the diagram looks very good. Thanks!

I'll let you work out with @damemi if you want to add more diagrams in this PR or a separate PR.

@seanmalloy
Copy link
Member

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Apr 9, 2021
@ingvagabund
Copy link
Contributor Author

Looks nice, do you want to also add some for the individual strategy sections (or maybe just add one under LNU to explain that a bit more?)

I'd like to avoid creating a single diagram for each strategy. Some strategies are quite straightforward to understand (e.g. PodLifeTime, RemovePodsHavingTooManyRestarts, RemovePodsViolatingNodeTaints) and a diagram with a single node and one or two pods would be too simple. Unless each diagram gets more detailed.

Providing more diagrams later sounds better. LowNodeUtilization requires different approach, PodLifeTime's diagram might contain warnings about setting the TTL too low (e.g. in case of VMs), RemovePodsViolatingTopologySpreadConstraint might include soft constraints, etc.

@damemi
Copy link
Contributor

damemi commented Apr 12, 2021

@ingvagabund sounds good to me, yeah everything doesn't need a diagram and this is a great summary of all the strategies working together.
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 12, 2021
@k8s-ci-robot k8s-ci-robot merged commit 43a2ccf into kubernetes-sigs:master Apr 12, 2021
@ingvagabund ingvagabund deleted the add-diagram branch April 13, 2021 06:38
briend pushed a commit to briend/descheduler that referenced this pull request Feb 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants