Extend PodResources API for Dynamic Resource Allocation #39978

moshe010 · 2023-03-14T00:00:28Z

Placeholder for the KEP-3695: extend pod resource API to for DRA
kubernetes/enhancements#3738

content/en/docs/reference/command-line-tools-reference/feature-gates.md

tengqm · 2023-03-31T03:07:14Z

content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md

+    repeated ClaimResource claim_resources = 4;
+}
+
+// ClaimResource contains per plugin resource information


Suggested change

// ClaimResource contains per plugin resource information

// ClaimResource contains per-plugin resource information

tengqm · 2023-03-31T03:09:22Z

content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md

+The `Get` endpoint provides information on resources of a running pod. It exposes similar information as
+describe in the `List` endpoint. The `Get` endpoint requires `pod_name` and `pod_namesapce` of the running
+pod.


Suggested change

The `Get` endpoint provides information on resources of a running pod. It exposes similar information as

describe in the `List` endpoint. The `Get` endpoint requires `pod_name` and `pod_namesapce` of the running

pod.

The `Get` endpoint provides information on resources of a running Pod. It exposes information

similar to those described in the `List` endpoint. The `Get` endpoint requires `pod_name` and

`pod_namespace` of the running Pod.

By the way, the design to use _ in the field name is a bad decision against the convention to use camelCase names.

so this pod_namespace and pod_name taken from the proto file syntax which is underscore. For golang it will be camelCase according to golang conventions. I updated in the commit.

@moshe010 Would you mind responding to @tengqm when you get the chance? Tomorrow, April 4th, is the Docs complete — All PRs reviewed and ready to merge deadline.

sorry for the late response I was OOO on Monday.

tengqm · 2023-03-31T03:11:48Z

content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md

+}
+```
+
+To enable this feature `kubelet` must be started with the following flag:


Suggested change

To enable this feature `kubelet` must be started with the following flag:

To enable this feature, you must start your kubelet services with the following flag:

tengqm · 2023-03-31T03:13:06Z

content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md

+The `Get` enpoint can provide information on dynamic resources
+of a running pod allocated by the dynamic resource allocation API. To enable this feature `kubelet`


Suggested change

The `Get` enpoint can provide information on dynamic resources

of a running pod allocated by the dynamic resource allocation API. To enable this feature `kubelet`

The `Get` endpoint can provide Pod information related to dynamic resources

allocated by the dynamic resource allocation API. To enable this feature, you must

tengqm · 2023-03-31T03:13:28Z

content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md

+
+The `Get` enpoint can provide information on dynamic resources
+of a running pod allocated by the dynamic resource allocation API. To enable this feature `kubelet`
+must be started with the following flags:


Suggested change

must be started with the following flags:

ensure your kubelet services are started with the following flags:

tengqm · 2023-03-31T03:13:58Z

content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md

@@ -162,6 +162,12 @@ gets scheduled onto one node and then cannot run there, which is bad because
 such a pending Pod also blocks all other resources like RAM or CPU that were
 set aside for it.

+## Monitoring resources
+
+The kubelet provides a gRPC service to enable discovery of Dynamic Resources of


Suggested change

The kubelet provides a gRPC service to enable discovery of Dynamic Resources of

The kubelet provides a gRPC service to enable discovery of dynamic resources of

tengqm · 2023-03-31T03:15:32Z

content/en/docs/reference/command-line-tools-reference/feature-gates.md

+- `KubeletPodResourcesGet`: Enable the kubelet's pod resources gRPC endpoint
+  `Get` functionality. This API augments the [resource allocation reporting](/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#monitoring-device-plugin-resources).


Suggested change

- `KubeletPodResourcesGet`: Enable the kubelet's pod resources gRPC endpoint

`Get` functionality. This API augments the [resource allocation reporting](/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#monitoring-device-plugin-resources).

- `KubeletPodResourcesGet`: Enable the `Get` gRPC endpoint on kubelet's for Pod resources.

This API augments the [resource allocation reporting](/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#monitoring-device-plugin-resources).

mickeyboxell · 2023-04-03T21:04:33Z

@moshe010 Would you mind responding to @tengqm when you get the chance? Tomorrow, April 4th, is the Docs complete — All PRs reviewed and ready to merge deadline.

netlify · 2023-04-04T07:11:09Z

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name	Link
🔨 Latest commit	`eaf9199`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/642bcf0208b605000837b4f8

Signed-off-by: Moshe Levi <moshele@nvidia.com>

mickeyboxell · 2023-04-04T15:32:27Z

/approve

k8s-ci-robot · 2023-04-04T15:32:51Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mickeyboxell

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:

~~content/en/OWNERS~~ [mickeyboxell]

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

LukeMwila · 2023-04-04T15:35:01Z

/lgtm

k8s-ci-robot · 2023-04-04T15:35:14Z

LGTM label has been added.

Git tree hash: 9e5b21034cb7ee674a50780647aa7c537404a9a0

k8s-ci-robot added this to the 1.27 milestone Mar 14, 2023

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 Mar 14, 2023

moshe010 changed the title ~~doc: extend PodResources API for Dynamic Resource Allocation~~ WIP doc: extend PodResources API for Dynamic Resource Allocation Mar 14, 2023

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 14, 2023

k8s-ci-robot requested a review from mehabhalodiya March 14, 2023 00:01

k8s-ci-robot added the language/en Issues or PRs related to English language label Mar 14, 2023

k8s-ci-robot requested a review from mengjiao-liu March 14, 2023 00:01

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Mar 14, 2023

tengqm reviewed Mar 14, 2023

View reviewed changes

content/en/docs/reference/command-line-tools-reference/feature-gates.md Show resolved Hide resolved

klueska mentioned this pull request Mar 15, 2023

DRA: Extend PodResources to include resources from Dynamic Resource Allocation kubernetes/enhancements#3695

Open

8 tasks

moshe010 force-pushed the pod-resource-api-dra-doc-upstream branch from 2fc4899 to d3fadde Compare March 16, 2023 08:49

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 16, 2023

moshe010 changed the title ~~WIP doc: extend PodResources API for Dynamic Resource Allocation~~ Extend PodResources API for Dynamic Resource Allocation Mar 16, 2023

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 16, 2023

tengqm reviewed Mar 31, 2023

View reviewed changes

moshe010 force-pushed the pod-resource-api-dra-doc-upstream branch from d3fadde to 7671435 Compare April 4, 2023 07:11

doc: extend PodResources API for Dynamic Resource Allocation

eaf9199

Signed-off-by: Moshe Levi <moshele@nvidia.com>

moshe010 force-pushed the pod-resource-api-dra-doc-upstream branch from 7671435 to eaf9199 Compare April 4, 2023 07:17

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

k8s-ci-robot assigned LukeMwila Apr 4, 2023

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

k8s-ci-robot merged commit f62d58d into kubernetes:dev-1.27 Apr 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend PodResources API for Dynamic Resource Allocation #39978

Extend PodResources API for Dynamic Resource Allocation #39978

moshe010 commented Mar 14, 2023

tengqm Mar 31, 2023

moshe010 Apr 4, 2023

tengqm Mar 31, 2023

tengqm Mar 31, 2023

moshe010 Apr 4, 2023

moshe010 Apr 4, 2023

tengqm Mar 31, 2023

moshe010 Apr 4, 2023

tengqm Mar 31, 2023

moshe010 Apr 4, 2023

tengqm Mar 31, 2023

moshe010 Apr 4, 2023

tengqm Mar 31, 2023

moshe010 Apr 4, 2023

tengqm Mar 31, 2023

moshe010 Apr 4, 2023

mickeyboxell commented Apr 3, 2023

netlify bot commented Apr 4, 2023 •

edited

Loading

mickeyboxell commented Apr 4, 2023

k8s-ci-robot commented Apr 4, 2023

LukeMwila commented Apr 4, 2023

k8s-ci-robot commented Apr 4, 2023

	// ClaimResource contains per plugin resource information
	// ClaimResource contains per-plugin resource information

-The `Get` endpoint provides information on resources of a running pod. It exposes similar information as
-describe in the `List` endpoint. The `Get` endpoint requires `pod_name` and `pod_namesapce` of the running
-pod.
+The `Get` endpoint provides information on resources of a running Pod. It exposes information
+similar to those described in the `List` endpoint. The `Get` endpoint requires `pod_name` and
+`pod_namespace` of the running Pod.

	To enable this feature `kubelet` must be started with the following flag:
	To enable this feature, you must start your kubelet services with the following flag:

		The `Get` enpoint can provide information on dynamic resources
		of a running pod allocated by the dynamic resource allocation API. To enable this feature `kubelet`

	must be started with the following flags:
	ensure your kubelet services are started with the following flags:

	The kubelet provides a gRPC service to enable discovery of Dynamic Resources of
	The kubelet provides a gRPC service to enable discovery of dynamic resources of

		- `KubeletPodResourcesGet`: Enable the kubelet's pod resources gRPC endpoint
		`Get` functionality. This API augments the [resource allocation reporting](/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#monitoring-device-plugin-resources).

Extend PodResources API for Dynamic Resource Allocation #39978

Extend PodResources API for Dynamic Resource Allocation #39978

Conversation

moshe010 commented Mar 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mickeyboxell commented Apr 3, 2023

netlify bot commented Apr 4, 2023 • edited Loading

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

mickeyboxell commented Apr 4, 2023

k8s-ci-robot commented Apr 4, 2023

LukeMwila commented Apr 4, 2023

k8s-ci-robot commented Apr 4, 2023

netlify bot commented Apr 4, 2023 •

edited

Loading