🌱 MS: improve replica defaulting for autoscaler #9649

aiden-von · 2023-10-31T15:34:43Z

What this PR does / why we need it: MachineSet.spec.replicas defaulting should take into account autoscaler min/max size if defined. This PR applies the same default replicas policy of MD to MS.

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 #8085

k8s-ci-robot · 2023-10-31T15:34:53Z

Welcome @aiden-von!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2023-10-31T15:34:54Z

Hi @aiden-von. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

killianmuldoon

Thanks!

/ok-to-test

/area machineset

elmiko

this generally makes sense to me and the code looks good.

my main concern is the replicas automatically getting set to minimum, but i think the documentation with this PR is good so, hopefully, users won't be too surprised.

/lgtm

k8s-ci-robot · 2023-11-07T18:16:19Z

LGTM label has been added.

Git tree hash: 34ee03e67f19ed5cd7d97b7e1e1322cfa55bac1d

aiden-von · 2023-11-20T12:25:59Z

@killianmuldoon, @elmiko
Hello, This is my first PR. It's been a while since my PR stucked, is there any process I missed?

sbueringer · 2023-11-20T17:42:39Z

@killianmuldoon, @elmiko Hello, This is my first PR. It's been a while since my PR stucked, is there any process I missed?

No worries you didn't miss anything. Just pretty busy recently so nobody got around to review the PR yet

aiden-von · 2023-11-20T23:25:43Z

No worries you didn't miss anything. Just pretty busy recently so nobody got around to review the PR yet

Thank you for being responsive @sbueringer :)
I undertood. Please review it at your convenience.

sbueringer

Just a few nits.

The replica calculation is a bit duplicate to the one for MD, but maybe it's easier to copy instead of refactoring to one generic func (so fine for me as is)

docs/book/src/tasks/automated-machine-management/autoscaling.md

webhooks/alias.go

internal/webhooks/machineset.go

sbueringer · 2023-11-21T13:57:22Z

In general looks good. Looks like the gci linter reports some findings: https://github.com/kubernetes-sigs/cluster-api/actions/runs/6944695786/job/18892668156

  webhooks/alias.go:20: File is not `gci`-ed with --skip-generated -s standard -s default -s prefix(sigs.k8s.io/cluster-api) --custom-order (gci)
  	"sigs.k8s.io/cluster-api/internal/webhooks"
  webhooks/alias.go:22: File is not `gci`-ed with --skip-generated -s standard -s default -s prefix(sigs.k8s.io/cluster-api) --custom-order (gci)
  	"sigs.k8s.io/controller-runtime/pkg/client"

(you can try if make lint-fix just fixes them)

Please also directly squash when you resolve these issues

aiden-von · 2023-11-21T14:02:06Z

In general looks good. Looks like the gci linter reports some findings: https://github.com/kubernetes-sigs/cluster-api/actions/runs/6944695786/job/18892668156
  webhooks/alias.go:20: File is not `gci`-ed with --skip-generated -s standard -s default -s prefix(sigs.k8s.io/cluster-api) --custom-order (gci)
  	"sigs.k8s.io/cluster-api/internal/webhooks"
  webhooks/alias.go:22: File is not `gci`-ed with --skip-generated -s standard -s default -s prefix(sigs.k8s.io/cluster-api) --custom-order (gci)
  	"sigs.k8s.io/controller-runtime/pkg/client"
(you can try if make lint-fix just fixes them)

Please also directly squash when you resolve these issues

Thank you for review and fast responsive.
The lint issue has been resolved.
If all tests pass except api-diff, I will squash the commit.

sbueringer · 2023-11-21T14:02:53Z

/lgtm

so far :)

k8s-ci-robot · 2023-11-21T14:03:04Z

LGTM label has been added.

Git tree hash: eaae21e402eb42ec8576f1be964159f478b8c268

enxebre · 2023-11-21T14:05:19Z

internal/webhooks/machineset.go

+// Notes:
+//   - While the min size and max size annotations of the autoscaler provide the best UX, other autoscalers can use the
+//     DefaultReplicasAnnotation if they have similar use cases.
+func calculateMachineSetReplicas(ctx context.Context, oldMS *clusterv1.MachineSet, newMS *clusterv1.MachineSet, dryRun bool) (int32, error) {


have we considered passing oldReplicas, newReplicas through the signature of this function instead of the machineSet resources and reuse it for both MD and MS? It seems the objects are only needed for if oldMD == nil { which would actually be the same code path than case oldMD.Spec.Replicas == nil:

If we just use one generic function instead of duplicating I would prefer to pass in oldObject (or oldMDorMS) of type runtime.Object instead of merging the two code paths of oldMS == nil & oldMS.Spec.Replicas in the func

(Because those are actual different cases even if the result that we use minSize is the same and I think it would be better to have that logic clear in our code)

ok cool, let's keep current implementation since it seems to have general lgtm and this code is unlikely to change often.

k8s-ci-robot · 2023-11-21T14:12:15Z

@aiden-von: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-cluster-api-apidiff-main	`addb065`	link	false	`/test pull-cluster-api-apidiff-main`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

sbueringer · 2023-11-21T14:28:16Z

(failing apidiff job is fine, It's just surfacing a change to an exported type and I think this one is fine)

enxebre · 2023-11-27T08:35:26Z

/lgtm

sbueringer · 2023-11-27T14:52:33Z

Thank you!!

/lgtm
/approve

k8s-ci-robot · 2023-11-27T14:52:43Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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:

~~OWNERS~~ [sbueringer]

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 added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label labels Oct 31, 2023

k8s-ci-robot requested a review from elmiko October 31, 2023 15:34

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 31, 2023

k8s-ci-robot requested a review from killianmuldoon October 31, 2023 15:34

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 31, 2023

killianmuldoon reviewed Oct 31, 2023

View reviewed changes

aiden-von force-pushed the pr-ms-autoscaler-defaulting branch 3 times, most recently from cb12306 to 8d7ca40 Compare November 1, 2023 00:41

elmiko reviewed Nov 7, 2023

View reviewed changes

k8s-ci-robot assigned elmiko Nov 7, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 7, 2023

sbueringer reviewed Nov 21, 2023

View reviewed changes

docs/book/src/tasks/automated-machine-management/autoscaling.md Outdated Show resolved Hide resolved

webhooks/alias.go Outdated Show resolved Hide resolved

internal/webhooks/machineset.go Outdated Show resolved Hide resolved

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 21, 2023

k8s-ci-robot requested a review from elmiko November 21, 2023 13:36

aiden-von force-pushed the pr-ms-autoscaler-defaulting branch 2 times, most recently from 88f3d1a to 63c1ee1 Compare November 21, 2023 13:52

k8s-ci-robot assigned sbueringer Nov 21, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 21, 2023

MS: improve replica defaulting for autoscaler

addb065

enxebre reviewed Nov 21, 2023

View reviewed changes

aiden-von force-pushed the pr-ms-autoscaler-defaulting branch from 63c1ee1 to addb065 Compare November 21, 2023 14:09

k8s-ci-robot assigned enxebre Nov 27, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 27, 2023

k8s-ci-robot merged commit d1ff0b5 into kubernetes-sigs:main Nov 27, 2023

k8s-ci-robot added this to the v1.7 milestone Nov 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 MS: improve replica defaulting for autoscaler #9649

🌱 MS: improve replica defaulting for autoscaler #9649

aiden-von commented Oct 31, 2023

k8s-ci-robot commented Oct 31, 2023

k8s-ci-robot commented Oct 31, 2023

killianmuldoon left a comment

elmiko left a comment

k8s-ci-robot commented Nov 7, 2023

aiden-von commented Nov 20, 2023

sbueringer commented Nov 20, 2023 •

edited

Loading

aiden-von commented Nov 20, 2023 •

edited

Loading

sbueringer left a comment

sbueringer commented Nov 21, 2023

aiden-von commented Nov 21, 2023

sbueringer commented Nov 21, 2023

k8s-ci-robot commented Nov 21, 2023

enxebre Nov 21, 2023 •

edited

Loading

sbueringer Nov 21, 2023 •

edited

Loading

enxebre Nov 23, 2023

k8s-ci-robot commented Nov 21, 2023

sbueringer commented Nov 21, 2023

enxebre commented Nov 27, 2023

sbueringer commented Nov 27, 2023

k8s-ci-robot commented Nov 27, 2023

🌱 MS: improve replica defaulting for autoscaler #9649

🌱 MS: improve replica defaulting for autoscaler #9649

Conversation

aiden-von commented Oct 31, 2023

k8s-ci-robot commented Oct 31, 2023

k8s-ci-robot commented Oct 31, 2023

killianmuldoon left a comment

Choose a reason for hiding this comment

elmiko left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 7, 2023

aiden-von commented Nov 20, 2023

sbueringer commented Nov 20, 2023 • edited Loading

aiden-von commented Nov 20, 2023 • edited Loading

sbueringer left a comment

Choose a reason for hiding this comment

sbueringer commented Nov 21, 2023

aiden-von commented Nov 21, 2023

sbueringer commented Nov 21, 2023

k8s-ci-robot commented Nov 21, 2023

enxebre Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

sbueringer Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

enxebre Nov 23, 2023

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 21, 2023

sbueringer commented Nov 21, 2023

enxebre commented Nov 27, 2023

sbueringer commented Nov 27, 2023

k8s-ci-robot commented Nov 27, 2023

sbueringer commented Nov 20, 2023 •

edited

Loading

aiden-von commented Nov 20, 2023 •

edited

Loading

enxebre Nov 21, 2023 •

edited

Loading

sbueringer Nov 21, 2023 •

edited

Loading