Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CDI Devices to Device Plugin API #42001

Merged

Conversation

elezar
Copy link
Contributor

@elezar elezar commented Jul 12, 2023

This change expands the documentation for the Device Plugin to include
the addition of support for CDI Device Names as a feature-gated feature
in the 1.28 release as part of KEP-4009.

@k8s-ci-robot k8s-ci-robot added this to the 1.28 milestone Jul 12, 2023
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 12, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @elezar!

It looks like this is your first PR to kubernetes/website 🎉. 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/website 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 k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 12, 2023
@elezar elezar marked this pull request as draft July 12, 2023 20:12
@k8s-ci-robot 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 Jul 12, 2023
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jul 12, 2023
Copy link
Member

@Vikash-8090-Yadav Vikash-8090-Yadav left a comment

Choose a reason for hiding this comment

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

LGTM 👍

This change expands the documentation for the Device Plugin to include
the addition of support for CDI Device Names as a feature-gated feature
in the 1.28 release.

Signed-off-by: Evan Lezar <elezar@nvidia.com>
@elezar elezar force-pushed the KEP-4009/add-cdi-to-device-plugin-api branch from 83efd8d to 9af46c8 Compare July 24, 2023 08:53
@netlify
Copy link

netlify bot commented Jul 24, 2023

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

Name Link
🔨 Latest commit 9efc244
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/64bfa04339b55b0008dc6101

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 24, 2023
@elezar elezar marked this pull request as ready for review July 24, 2023 08:53
@k8s-ci-robot 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 Jul 24, 2023
…/device-plugins.md

Co-authored-by: Mengjiao Liu <44460091+mengjiao-liu@users.noreply.github.com>
@sftim
Copy link
Contributor

sftim commented Aug 5, 2023

/sig node

@k8s-ci-robot k8s-ci-robot added the sig/node Categorizes an issue or PR as relevant to SIG Node. label Aug 5, 2023
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

Fixups welcome (see inline feedback)

LGTM from #42001 (review)
and for docs:
/lgtm


/approve

device plugin defines modifications that must be made to a container's definition to provide
access to the device. These modifications include:

* annotations
Copy link
Contributor

Choose a reason for hiding this comment

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

Are these Annotations or something else?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I think this link is valid. I've updated the link in #42600


{{< note >}}
The processing of the fully-qualified CDI device names by the Device Manager requires
the `DevicePluginCDIDevices` feature gate to be enabled. This was added as an alpha feature in
Copy link
Contributor

Choose a reason for hiding this comment

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

We'd prefer something like

-   the `DevicePluginCDIDevices` feature gate to be enabled. This was added as an alpha feature in
+   that the `DevicePluginCDIDevices` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
+  is enabled for the kubelet and the kube-apiserver. This was added as an alpha feature in Kubernetes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in #42600

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 5, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 505e01498056373addc2f9c419b8054718175e4f

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim, Vikash-8090-Yadav

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:

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 5, 2023
@k8s-ci-robot k8s-ci-robot merged commit 21cfe0c into kubernetes:dev-1.28 Aug 5, 2023
Rishit-dagli pushed a commit to Rishit-dagli/website that referenced this pull request Aug 12, 2023
…evice-plugin-api

Add CDI Devices to Device Plugin API
@elezar elezar deleted the KEP-4009/add-cdi-to-device-plugin-api branch August 17, 2023 12:41
elezar added a commit to elezar/k8s-website that referenced this pull request Aug 17, 2023
These changes are a follow-up to kubernetes#42001.
They make minor edits to the documentation of the DevicePlugin API.

Signed-off-by: Evan Lezar <elezar@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/node Categorizes an issue or PR as relevant to SIG Node. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants