KEP-4622: Add a TopologyManager policy option for MaxAllowableNUMANodes

[cyclinder]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add a config option to the kubelet that allows us to configure the value of maxAllowableNUMANodes in the TopologyManager
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-node/4622-topologymanager-max-allowable-numa-nodes/README.md
• Discussion Link: kubelet: Add a TopologyManager policy option: max-allowable-numa-nodes kubernetes#124148 (comment)
• Primary contact (assignee): @klueska @ffromani @cyclinder
• Responsible SIGs: /sig node
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y):
  • Beta release target (x.y): 1.31
  • Stable release target (x.y): 1.33?
• Beta
  • KEP (k/enhancements) update PR(s): KEP-4622: New TopologyManager Policy: max-allowable-numa-nodes #4624
  • Code (k/k) update PR(s): kubelet: Add a TopologyManager policy option: max-allowable-numa-nodes kubernetes#124148
  • Docs (k/website) update PR(s): KEP-4622: Add docs for TopologyManager policy option for MaxAllowableNUMANodes website#46870
• Stable
  • KEP (k/enhancements) update PR(s):
  • Code (k/k) update PR(s): Add a metric to record the pod admission time.
  • Docs (k/website) update(s):

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

Tasks

Preview Give feedback

1. Feature implemented behind the existing static policy feature flag
2. Initial unit tests completed and coverage is improved
3. Documents are improved and enough guidance and examples can be given to potential users.
4. Add an e2e test to verify the input validation.

[cyclinder]

/sig node

[cyclinder]

/assign @cyclinder

[klueska]

I've added this to the tracking sheet for 1.31:
https://docs.google.com/document/d/1U10J0WwgWXkdYrqWGGvO8iH2HKeerQAlygnqgDgWv4E/edit

[SergeyKanzhelev]

/label lead-opted-in
/milestone v1.31
/stage alpha

[prianna]

Hello @cyclinder @klueska 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 14th June 2024 / 19:00 PDT Thursday 13th June 2024.

This enhancement is targeting stage alpha for v1.31 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.31. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here). If your production readiness review is not completed yet, please make sure to fill the production readiness questionnaire in your KEP by the PRR Freeze deadline of Thursday 6th June 2024 so that the PRR team has enough time to review your KEP.

For this KEP, it looks like we still need to do the following:

• Merge KEP-4622: New TopologyManager Policy: max-allowable-numa-nodes #4624 before the enhancement freeze date.
• Update KEP stage to alpha if that's the intended stage, right now it looks as though the KEP is targeting beta for v1.31
• Add graduation criteria for alpha if that's the intended stage targeted

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well.

If you anticipate missing enhancements freeze, you can file an exception request in advance. Thank you!

[ffromani]

Hello @cyclinder @klueska 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 14th June 2024 / 19:00 PDT Thursday 13th June 2024.

This enhancement is targeting stage alpha for v1.31 (correct me, if otherwise)

In this case we are opting in the new sig-arch recommendations: kubernetes/community@d060ec0 and starting directly to beta stage as the change is very safe and self-contained.

cc @SergeyKanzhelev @klueska

[prianna]

@ffromani @cyclinder I can update targeting for this enhancement, could you please update the issue description with the stages and targeted milestones accordingly?

[prianna]

/stage beta

[cyclinder]

Hi @Priann, I've updated the PR descriptions, Is this okay with you? and please let me know if you need me to update anything else.

[sreeram-venkitesh]

@cyclinder: The description looks good, please make sure to get #4624 merged before the enhancements freeze deadline!

[prianna]

@cyclinder @klueska This is super close to being merged it looks like, but we’re at the freeze deadline. Please file an exception if you want this included in the release.

[sreeram-venkitesh]

@prianna We've already received an exception request for this KEP for 1 day. We can keep this as at risk for enhancements freeze for now and come back once the decision for the exception request is made.

[klueska]

Yes, I preemptively filed an exception request yesterday. It looks like the PR is now merged though.

[sreeram-venkitesh]

@klueska Awesome, thanks for the update! I will update the KEP once I get to my laptop.

[mbianchidev]

Hey @sreeram-venkitesh can you let me know if this one will be officially moved to Tracked for Enhancement Freeze? 👀

[sreeram-venkitesh]

Yes it will be, I'm traveling right now. I will update it in the board in some time.

[mbianchidev]

Thanks @sreeram-venkitesh!

Sooo hey @cyclinder

👋 from the v1.31 Communications Team!
We'd love for you to opt in to write a feature blog about your enhancement!
Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating. Or like in this case, a flag that enables a new kind of config.

To opt in, let us know and open a Feature Blog placeholder PR against the website repository by 3rd July, 2024. For more information about writing a blog see the blog contribution guidelines.

Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

[ffromani]

My (unsolicited) 2c: this feature is kinda exceptional. It's really only about to add a knob to make topology manager work with modern hardware. The risks are pretty minimal and also the risks for the project to backtrack this work and remove it are really low. I'd be in favor if pushing to GA, granted we meet the standard criterias of course.

[tjons]

Hi, enhancements lead here - I inadvertently added this to the 1.32 tracking board 😀. Please readd it if you wish to progress this enhancement in 1.32.

/remove-label lead-opted-in

[haircommander]

/milestone v1.32
/label lead-opted-in

[tjons]

Hello @cyclinder 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 11th October 2024 / 19:00 PDT Thursday 10th October 2024.

This enhancement is targeting for stage stable for v1.32 (correct me, if otherwise).

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.32.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here). If your production readiness review is not completed yet, please make sure to fill the production readiness questionnaire in your KEP by the PRR Freeze deadline on Thursday, October 3rd, 2024 so that the PRR team has enough time to review your KEP.

For this KEP, we would just need to update the following:

• KEP status is marked as implementable for latest-milestone: v1.32.
• KEP has a production readiness review that has been completed and merged into k/enhancements.
• Update the KEP to use the latest template and add the missing Motivation section. Please ensure that all required sections (not marked Optional in https://github.com/kubernetes/enhancements/blob/master/keps/NNNN-kep-template/README.md`) are present.

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well.

If you anticipate missing enhancements freeze, you can file an exception request in advance. Thank you!

[jpbetz]

PRR reviewer here. Is this still targeting v1.32? The PRR deadline is Thursday. Is there anything I can review?

[kannon92]

@cyclinder Please respond. If we don't hear from you, we will no longer be considering this feature for 1.32.

[kannon92]

We are removing this from the 1.32 release. Please bring this up for 1.33 as we are interested in this feature.

[cyclinder]

Sorry for not getting back to you sooner, I was on vacation the other day.

Please bring this up for 1.33 as we are interested in this feature.

Okay, let's work this in 1.33.

[tjons]

/milestone clear
/remove-label lead-opted-in

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[ffromani]

/remove-lifecycle stale

[swatisehgal]

We are removing this from the 1.32 release. Please bring this up for 1.33 as we are interested in this feature.

Do we want to go ahead with graduation of this KEP to GA in v1.33? 1.33 planning will be happening soon.

[ffromani]

We are removing this from the 1.32 release. Please bring this up for 1.33 as we are interested in this feature.

Do we want to go ahead with graduation of this KEP to GA in v1.33? 1.33 planning will be happening soon.

we totally should!