Populate NodeResourceTopology API #1

swatisehgal · 2023-10-13T13:20:04Z

What this PR does / why we need it:
This API is needed for Topology aware scheduling work in Kubernetes and it was suggested that a CRD based API in staging is not ideal and it would be better to find a more suitable location under Kubernetes umbrella (under kubernetes-sigs). The repo was created under kubernetes-sigs (kubernetes/org#4224) and this PR populates the repo.

Background information/ Additional context
NFD Topology Updater in Node feature Discovery and Topology aware scheduler plugin in scheduler-plugins are two components for enabling Topology aware scheduling in Kubernetes (additional details about these components can be found below). These two projects are based in kubernetes-sigs organisation and depend on https://github.com/k8stopologyawareschedwg/noderesourcetopology-api which is not operated by Kubernetes github management team.

Additional information about NFD Topology Updater and scheduler plugin

NFD Topology Updater, a daemon depends on NodeResourceTopology API to expose resource hardware topology on a per NUMA basis via CRs that correspond to all the nodes in the cluster.
Topology aware scheduler plugin, an out of tree scheduler plugin depends on NodeResourceTopology API to consumed the CRs that corresponds to nodes (created by NFD Topology Updater) to make an intelligent NUMA aware scheduling decision.

Why do we need Topology aware scheduling in Kubernetes?
With the introduction of Topology Manager in Kubelet, pods could be scheduled on a node where total amount of resources available satisfy the resources requested, but resource distribution could not satisfy the appropriate Topology Manager policy leading to pod admission failure. Topology aware scheduler aims to empower scheduler to make intelligent topology aware placement decisions optimizing cluster wide performance of workloads.

Which issue(s) this PR fixes:
kubernetes/community#6308
kubernetes/kubernetes#84869

Additional notes/documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

Node Feature Discovery Issue: Exposing Hardware Topology through CRDs in Node feature discovery
Topology Aware Scheduling Use Cases: here
Kubernetes Node Resource Topology Custom Resource Definition Standard: here
NFD
[Other doc]: Based on ideas that were discussed in following documents:

Signed-off-by: Swati Sehgal <[email protected]>

k8s-ci-robot · 2023-10-13T13:20:11Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: swatisehgal

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~~ [swatisehgal]

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

swatisehgal · 2023-10-13T13:30:48Z

/hold
to prevent inadvertent merge

ffromani

non-binding LGTM, want to have another pass later
question inside

ffromani · 2023-10-18T15:36:24Z

go.mod

+	k8s.io/apimachinery v0.22.3
+	k8s.io/client-go v0.22.3
+	k8s.io/code-generator v0.22.3


why so old versions?

I will bump the deps to newer version, Thanks for pointing this out.

I added additional commits but if squashing of commits is preferred, I can do that.

marquiz

Thanks @swatisehgal for the PR. And apologies for the slow response time 🙄

Looks generally good, just a few small comments below.

README.md

go.mod

pkg/apis/topology/v1alpha1/register.go

manifests/cr-instance-example.yaml

Signed-off-by: Swati Sehgal <[email protected]>

swatisehgal · 2023-12-04T10:57:53Z

/assign @liggitt @thockin
for API reviews based on the suggestion here.

vsoch · 2023-12-19T01:09:23Z

hey folks! My team is interested in this work (and I could help if needed). Is there a status update / what are next steps?

swatisehgal · 2023-12-19T12:55:04Z

hey folks! My team is interested in this work (and I could help if needed). Is there a status update / what are next steps?

Hi @vsoch The current status is that we are waiting for this PR to be reviewed by Kubernetes API reviewers. I am conscious that we are close to the holiday season and a lot of people are already out so will be actively pursuing soliciting of reviews from API reviewers in the beginning of new year.

If you have bandwidth and would like, you are more than welcome to review the PR and let us know your feeedback.

vsoch

A few comments - still reviewing!

API.md

Signed-off-by: Swati Sehgal <[email protected]>

We are getting the following warnings if we continue using generate-groups.sh so updating to kube_codegen.sh instead as per the recommendation: ``` WARNING: generate-groups.sh is deprecated. WARNING: Please use k8s.io/code-generator/kube_codegen.sh instead. ``` Signed-off-by: Swati Sehgal <[email protected]>

swatisehgal · 2024-03-11T13:59:26Z

@liggitt A gentle ping for api reviews.

liggitt · 2024-03-14T14:55:58Z

will route this one to @thockin, it is much more aligned with the DRA reviews he's been doing and he has the topology stuff much more in his head

Present in https://github.com/orgs/kubernetes/projects/169/views/3?sliceBy%5Bvalue%5D=thockin

swatisehgal · 2024-03-14T16:06:16Z

will route this one to @thockin, it is much more aligned with the DRA reviews he's been doing and he has the topology stuff much more in his head

Present in https://github.com/orgs/kubernetes/projects/169/views/3?sliceBy%5Bvalue%5D=thockin

Thanks!

thockin · 2024-03-15T00:27:30Z

Hi Swati, I am about to get on a plane for KubeCon - is this OK to wait until after?

…

On Thu, Mar 14, 2024 at 9:06 AM Swati Sehgal ***@***.***> wrote: will route this one to @thockin <https://github.com/thockin>, it is much more aligned with the DRA reviews he's been doing and he has the topology stuff much more in his head Present in https://github.com/orgs/kubernetes/projects/169/views/3?sliceBy%5Bvalue%5D=thockin Thanks! — Reply to this email directly, view it on GitHub <#1 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABKWAVCAQ6EEPYPKUUERT3TYYHDJBAVCNFSM6AAAAAA57EZG5SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJXHAYDONZYGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

vsoch · 2024-03-15T00:34:08Z

He's leaaaavin' on a jet plane... ✈️

swatisehgal · 2024-03-15T12:20:47Z

Hi Swati, I am about to get on a plane for KubeCon - is this OK to wait until after?

Hi Tim, sure no problem. Have a great KubeCon!

swatisehgal · 2024-04-09T10:16:31Z

@thockin A gentle ping to review this PR. Thanks!

pacoxu · 2024-04-25T07:33:29Z

manifests/cr-instance-example.yaml

+    allocatable:  51
+    available:    51
+    capacity:     52
+  name:     node-1


- name: node-1

Same to line 12.

k8s-triage-robot · 2024-07-24T08:22:32Z

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle stale

SergeyKanzhelev · 2024-07-26T17:40:50Z

/assign @johnbelamaric

SergeyKanzhelev · 2024-07-26T17:41:01Z

/remove-lifecycle stale

k8s-triage-robot · 2024-10-24T18:07:48Z

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

This bot triages 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 PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this 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 · 2024-11-23T18:14:09Z

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

This bot triages 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 PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle rotten
Close this PR with /close
Offer to help out with Issue Triage

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

/lifecycle rotten

k8s-triage-robot · 2024-12-23T18:50:54Z

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

This bot triages 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 PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

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

/close

k8s-ci-robot · 2024-12-23T18:50:59Z

@k8s-triage-robot: Closed this PR.

In response to this:

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

This bot triages 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 PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

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

/close

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-sigs/prow repository.

Repo bootstrapping

e64d621

Signed-off-by: Swati Sehgal <[email protected]>

k8s-ci-robot requested review from ffromani and marquiz October 13, 2023 13:20

swatisehgal force-pushed the k8s-sigs-nrt-api branch 2 times, most recently from 7cdce58 to 8404673 Compare October 13, 2023 13:29

k8s-ci-robot removed the do-not-merge/invalid-owners-file Indicates that a PR should not merge because it has an invalid OWNERS file in it. label Oct 13, 2023

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 13, 2023

swatisehgal force-pushed the k8s-sigs-nrt-api branch from 8404673 to e983aa0 Compare October 16, 2023 09:36

swatisehgal mentioned this pull request Oct 17, 2023

empty noderesourcetopology-api repository in kubernetes-sigs kubernetes/community#6308

Open

ffromani reviewed Oct 18, 2023

View reviewed changes

swatisehgal force-pushed the k8s-sigs-nrt-api branch 2 times, most recently from ae94654 to 6dd5f63 Compare October 18, 2023 17:48

marquiz reviewed Nov 16, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

go.mod Show resolved Hide resolved

pkg/apis/topology/v1alpha1/register.go Outdated Show resolved Hide resolved

manifests/cr-instance-example.yaml Show resolved Hide resolved

swatisehgal added 4 commits November 20, 2023 14:00

Add NRT API

786e556

Signed-off-by: Swati Sehgal <[email protected]>

Setup go modules

1bd8170

Signed-off-by: Swati Sehgal <[email protected]>

Autogenerated code

1f66b79

Signed-off-by: Swati Sehgal <[email protected]>

manifest: Add manifests

0c61b5d

Signed-off-by: Swati Sehgal <[email protected]>

swatisehgal force-pushed the k8s-sigs-nrt-api branch from 6dd5f63 to 922662d Compare November 20, 2023 14:05

k8s-ci-robot assigned liggitt and thockin Dec 4, 2023

vsoch reviewed Dec 20, 2023

View reviewed changes

API.md Outdated Show resolved Hide resolved

API.md Show resolved Hide resolved

API.md Show resolved Hide resolved

KunWuLuan reviewed Jan 15, 2024

View reviewed changes

API.md Show resolved Hide resolved

KunWuLuan reviewed Jan 15, 2024

View reviewed changes

API.md Show resolved Hide resolved

swatisehgal added 3 commits January 25, 2024 12:46

docs: Document and add details on API fields

4e58a37

Signed-off-by: Swati Sehgal <[email protected]>

owners: Add OWNERS_ALIASES file and add Kubernetes API reviewers

f6cee70

Signed-off-by: Swati Sehgal <[email protected]>

swatisehgal force-pushed the k8s-sigs-nrt-api branch 2 times, most recently from a39ed45 to 20b997d Compare January 25, 2024 12:50

liggitt removed their assignment Mar 14, 2024

pacoxu reviewed Apr 25, 2024

View reviewed changes

manifests/cr-instance-example.yaml

allocatable: 51

available: 51

capacity: 52

name: node-1

Copy link

Member

pacoxu Apr 25, 2024

Choose a reason for hiding this comment

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

- name: node-1

Same to line 12.

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 24, 2024

k8s-ci-robot assigned johnbelamaric Jul 26, 2024

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 26, 2024

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 24, 2024

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 23, 2024

k8s-ci-robot closed this Dec 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Populate NodeResourceTopology API #1

Populate NodeResourceTopology API #1

swatisehgal commented Oct 13, 2023 •

edited

Loading

k8s-ci-robot commented Oct 13, 2023

swatisehgal commented Oct 13, 2023

ffromani left a comment

ffromani Oct 18, 2023

swatisehgal Oct 18, 2023

swatisehgal Oct 18, 2023

marquiz left a comment

swatisehgal commented Dec 4, 2023

vsoch commented Dec 19, 2023

swatisehgal commented Dec 19, 2023 •

edited

Loading

vsoch left a comment

swatisehgal commented Mar 11, 2024

liggitt commented Mar 14, 2024 •

edited

Loading

swatisehgal commented Mar 14, 2024

thockin commented Mar 15, 2024 via email

vsoch commented Mar 15, 2024

swatisehgal commented Mar 15, 2024

swatisehgal commented Apr 9, 2024

pacoxu Apr 25, 2024

k8s-triage-robot commented Jul 24, 2024

SergeyKanzhelev commented Jul 26, 2024

SergeyKanzhelev commented Jul 26, 2024

k8s-triage-robot commented Oct 24, 2024

k8s-triage-robot commented Nov 23, 2024

k8s-triage-robot commented Dec 23, 2024

k8s-ci-robot commented Dec 23, 2024

Populate NodeResourceTopology API #1

Populate NodeResourceTopology API #1

Conversation

swatisehgal commented Oct 13, 2023 • edited Loading

k8s-ci-robot commented Oct 13, 2023

swatisehgal commented Oct 13, 2023

ffromani left a comment

Choose a reason for hiding this comment

ffromani Oct 18, 2023

Choose a reason for hiding this comment

swatisehgal Oct 18, 2023

Choose a reason for hiding this comment

swatisehgal Oct 18, 2023

Choose a reason for hiding this comment

marquiz left a comment

Choose a reason for hiding this comment

swatisehgal commented Dec 4, 2023

vsoch commented Dec 19, 2023

swatisehgal commented Dec 19, 2023 • edited Loading

vsoch left a comment

Choose a reason for hiding this comment

swatisehgal commented Mar 11, 2024

liggitt commented Mar 14, 2024 • edited Loading

swatisehgal commented Mar 14, 2024

thockin commented Mar 15, 2024 via email

vsoch commented Mar 15, 2024

swatisehgal commented Mar 15, 2024

swatisehgal commented Apr 9, 2024

pacoxu Apr 25, 2024

Choose a reason for hiding this comment

k8s-triage-robot commented Jul 24, 2024

SergeyKanzhelev commented Jul 26, 2024

SergeyKanzhelev commented Jul 26, 2024

k8s-triage-robot commented Oct 24, 2024

k8s-triage-robot commented Nov 23, 2024

k8s-triage-robot commented Dec 23, 2024

k8s-ci-robot commented Dec 23, 2024

swatisehgal commented Oct 13, 2023 •

edited

Loading

swatisehgal commented Dec 19, 2023 •

edited

Loading

liggitt commented Mar 14, 2024 •

edited

Loading