Extend podresources API to report allocatable resources

[ffromani]

Enhancement Description

• One-line enhancement description (can be used as a release note): Extend the podresources API to report the allocatable compute resources
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/pull/2404
• Discussion Link: SIG Node Meeting 20200811: Recording, Slides Slack thread for introducing GetAllocatableResources() endpoint (previously called GetAvailableResources) in podresource API
• Primary contact (assignee): Francesco Romani (@fromanirh)
• Responsible SIGs: sig-node
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y):
  • Beta release target (x.y):
  • Stable release target (1.21):

Previous/Related work:

• initial issue - initially targeting 1.20, we are creating a separate issue + KEP to clearly describe this unit of work.

PRs:

• kubernetes/kubernetes#95734

[ffromani]

/sig node

[ffromani]

rationale for this split in this slack conversation

the main goal is to make this change easier to review

[derekwaynecarr]

/milestone v1.21

[JamesLaverack]

Hey @fromanirh, enhancements 1.21 shadow here,

Enhancements Freeze is 2 days away, Feb 9th EOD PST

The enhancements team is aware that KEP update is currently in progress (PR #2404). Please make sure to work on PRR questionnaires and requirements and get it merged before the freeze. For PRR related questions or to boost the PR for PRR review, please reach out in Slack on the #prod-readiness channel.

Any enhancements that do not complete the following requirements by the freeze will require an exception.

• [IN PROGRESS] The KEP must be merged in an implementable state
• [IN PROGRESS] The KEP must have test plans
• [IN PROGRESS] The KEP must have graduation criteria
• [IN PROGRESS] The KEP must have a production readiness review

[JamesLaverack]

Hi @fromanirh,

Since your Enhancement is scheduled to be in 1.21, please keep in mind the important upcoming dates:

• Tuesday, March 9th: Week 9 — Code Freeze
• Tuesday, March 16th: Week 10 — Docs Placeholder PR deadline
  • If this enhancement requires new docs or modification to existing docs, please follow the steps in the Open a placeholder PR doc to open a PR against k/website repo.

As a reminder, please link all of your k/k PR(s) and k/website PR(s) to this issue so we can track them.

Thanks!

[ffromani]

Hi @fromanirh,

Since your Enhancement is scheduled to be in 1.21, please keep in mind the important upcoming dates:

* Tuesday, March 9th: Week 9 — Code Freeze

* Tuesday, March 16th: Week 10 — Docs Placeholder PR deadline
  
  * If this enhancement requires new docs or modification to existing docs, please follow the steps in the [Open a placeholder PR doc](https://kubernetes.io/docs/contribute/new-content/new-features/#open-a-placeholder-pr) to open a PR against k/website repo.

As a reminder, please link all of your k/k PR(s) and k/website PR(s) to this issue so we can track them.

Thanks!

Thanks for the reminder! I don't think this enhancement requires a k/website PR, but I'll doublecheck and file a placeholder PR if needed. Implementation PR: https://github.com/kubernetes/kubernetes/pull/95734

[JamesLaverack]

Hi @fromanirh,

A friendly reminder that Code freeze is 3 days away, March 9th EOD PST

Any enhancements that are NOT code complete by the freeze will be removed from the milestone and will require an exception to be added back.

Please also keep in mind that if this enhancement requires new docs or modification to existing docs, you'll need to follow the steps in the Open a placeholder PR doc to open a PR against k/website repo by March 16th EOD PST

Thanks!

[annajung]

Hi @fromanirh, with https://github.com/kubernetes/kubernetes/pull/95734 merged in, we will mark this as code complete.

[ffromani]

yes, thanks!

[k8s-triage-robot]

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale

[pacoxu]

/remove-lifecycle stale

[ehashman]

/milestone v1.23

per 08/24 Node meeting

[ehashman]

/stage beta

[salaxander]

Hi @fromanirh! 1.23 Enhancements team here. Just checking in as we approach enhancements freeze on Thursday 09/09. Here's where this enhancement currently stands:

• [ ] Updated KEP file using the latest template has been merged into the k/enhancements repo. (PR open)
• [X] ~~KEP status is marked as implementable~~
• [X] ~~KEP has a test plan section filled out.~~
• [X] ~~KEP has up to date graduation criteria.~~
• [ ] KEP has a production readiness review that has been completed and merged into k/enhancements. (PR open)

As long as that PR merge by enhancements freeze, we should be all good!

Thanks!

[swatisehgal]

Graduating PodResource API GetAllocatableResource to Beta in 1.23 release:

• [ ] Beta

  • [x] KEP (k/enhancements) update PR(s): KEP-2403: Update PodResource API GetAllocatableResource 1.23 Beta #2932
  • [x] Code (k/k) update PR(s):
  • [x] https://github.com/kubernetes/kubernetes/pull/103289
  • [x] https://github.com/kubernetes/kubernetes/pull/104123
  • [x] https://github.com/kubernetes/kubernetes/pull/97415
  • [x] k/k PR to graduate the feature to Beta (enable by default): https://github.com/kubernetes/kubernetes/pull/105003
  • [x] Docs (k/website) update PR(s) to dev-1.23 branch: https://github.com/kubernetes/website/pull/29751

[jlbutler]

Hi @swatisehgal @fromanirh :wave: 1.23 Docs lead here

This enhancement issue is listed as "Needs Docs" for the 1.23 release. I see a docs PR is open (k/website 28074), can you point it at the dev-1.23 branch in k/website please?

For more info, please refer to the steps in the documentation. Ping if you have any questions.

Thanks!

[swatisehgal]

Hi @swatisehgal @fromanirh 1.23 Docs lead here

This enhancement issue is listed as "Needs Docs" for the 1.23 release. I see a docs PR is open (k/website 28074), can you point it at the dev-1.23 branch in k/website please?

For more info, please refer to the steps in the documentation. Ping if you have any questions.

Thanks!

Thanks @jlbutler, I have created a docs PR that points to dev-1.23 branch in k/website here: https://github.com/kubernetes/website/pull/29751. Let me know if there is anything else you need from my end.

[salaxander]

Hi @swatisehgal @fromanirh 👋

Checking in once more as we approach 1.23 code freeze at 6:00 pm PST on Tuesday, November 16.

Please ensure the following items are completed:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PRs are fully merged by the code freeze deadline.
• Have a documentation placeholder PR open by Thursday, November 18.

As always, we are here to help should questions come up.

Thanks!!

[ffromani]

hi @salaxander ! @swatisehgal has already tracked the items you mentioned in https://github.com/kubernetes/enhancements/issues/2403#issuecomment-913806988 . Please let us know if something's missing!

[ffromani]

Graduating PodResource API GetAllocatableResource to Beta in 1.23 release:

• [X] Beta
  • [x] KEP (k/enhancements) update PR(s): KEP-2403: Update PodResource API GetAllocatableResource 1.23 Beta #2932
  • [x] Code (k/k) update PR(s):
  • [x] podresources: do not export empty NUMA topology kubernetes#103289
  • [x] devicemanager: skip unhealthy devices in GetAllocatable kubernetes#104123
  • [x] Return only isolated cpus in podresources interface kubernetes#97415
  • [x] k/k PR to graduate the feature to Beta (enable by default): podresource-api: getAllocatableResources to Beta kubernetes#105003
  • [x] Docs (k/website) update PR(s) to dev-1.23 branch: Pod Resource API: graduate getAllocatableResources to Beta website#29751

All PRs merged!

EDIT: fix formatting

[k8s-triage-robot]

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

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

/lifecycle stale

[k8s-triage-robot]

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

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

/lifecycle rotten

[swatisehgal]

/remove-lifecycle rotten

[k8s-triage-robot]

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR 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

[k8s-triage-robot]

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR 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

[k8s-triage-robot]

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

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

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active 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 rotten
• Close this issue with /close
• Offer to help out with Issue Triage

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

/lifecycle rotten

[ffromani]

/remove-lifecycle rotten