Skip to content

Add api and feature gate reference docs #1098

Open
a-mccarthy wants to merge 1 commit into
kubernetes-sigs:mainfrom
a-mccarthy:docs/reference
Open

Add api and feature gate reference docs #1098
a-mccarthy wants to merge 1 commit into
kubernetes-sigs:mainfrom
a-mccarthy:docs/reference

Conversation

@a-mccarthy
Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

add API reference and feature gate documentation. this is targeting docs for the 25.12 release, what folks can use now.

Which issue(s) this PR is related to:

related to #1088 which covers prereq and install pages.

Special notes for your reviewer:

Does this PR introduce a user-facing change?

none


Additional documentation (design docs, usage docs, etc.):


Checklist

  • make check test passes locally
  • make check-generate passes if api/ changed (CRDs, deepcopy, informers, listers, clientset)
  • make check-modules passes if go.mod / go.sum changed
  • Tests added or updated for the change
  • Helm chart (deployments/helm) updated if flags, RBAC, or defaults changed

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Details

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.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels May 4, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented May 4, 2026

Deploy Preview for dra-driver-nvidia-gpu ready!

Name Link
🔨 Latest commit 2788120
🔍 Latest deploy log https://app.netlify.com/projects/dra-driver-nvidia-gpu/deploys/69f8de3914dfc90009e88627
😎 Deploy Preview https://deploy-preview-1098--dra-driver-nvidia-gpu.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@k8s-ci-robot k8s-ci-robot requested review from dims and varunrsekar May 4, 2026 16:46
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 4, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @a-mccarthy. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 4, 2026
@shivamerla
Copy link
Copy Markdown
Contributor

/lgtm
/approve
/hold please cancel when ready

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 4, 2026
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 4, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: 771096f435809751bd401b411d18f1311009a7fd

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: a-mccarthy, shivamerla

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details 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 May 4, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

@a-mccarthy: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-dra-driver-nvidia-gpu-e2e-gcp-nvkind 96ea33a link false /test pull-dra-driver-nvidia-gpu-e2e-gcp-nvkind

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Details

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. I understand the commands that are listed here.

@dims
Copy link
Copy Markdown
Member

dims commented May 4, 2026

/skip

@dims
Copy link
Copy Markdown
Member

dims commented May 4, 2026

Logs show:

12:46:07 PM: Error: Config file 'mkdocs.yml' does not exist.
12:46:07 PM: ​
12:46:07 PM: "build.command" failed                                        
12:46:07 PM: ────────────────────────────────────────────────────────────────

Signed-off-by: Abigail McCarthy <20771501+a-mccarthy@users.noreply.github.com>
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 4, 2026
@k8s-ci-robot k8s-ci-robot requested a review from shivamerla May 4, 2026 17:58
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

New changes are detected. LGTM label has been removed.

Comment thread docs/reference/api.md
With time-slicing:

```yaml
apiVersion: resource.nvidia.com/v1beta1
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why do we need to document all these? we should link to the demo folder which has so many examples already.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

agree, i dont want to duplicate examples. I'm curious how the examples in that folder names/organized? Seems like there are a lot in a quickstart folder, https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/tree/main/demo/specs/quickstart

@@ -0,0 +1,49 @@
# Feature gates
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

see this comment https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/pull/954/changes#r2956447469

we should build a separate page for each feature so that each can be tracked easily

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes, i created a reference navigation plan of content to build out and how to structure, #1103. Its in the plan to build out separate guides for how to use the features

@a-mccarthy a-mccarthy mentioned this pull request May 5, 2026
5 tasks
@a-mccarthy a-mccarthy requested a review from guptaNswati May 6, 2026 13:58
| `MPSSupport` | Alpha | `false` | Enables Multi-Process Service (MPS) sharing strategy in `GpuConfig` and `MigDeviceConfig`. |
| `IMEXDaemonsWithDNSNames` | Beta | `true` | IMEX daemons use DNS names instead of raw IP addresses for peer communication. Required by `ComputeDomainCliques`. |
| `PassthroughSupport` | Alpha | `false` | Enables VFIO passthrough device allocation using `VfioDeviceConfig`. |
| `DynamicMIG` | Alpha | `false` | Enables dynamic MIG device allocation and reconfiguration. |
Copy link
Copy Markdown
Contributor

@varunrsekar varunrsekar May 11, 2026

Choose a reason for hiding this comment

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

@a-mccarthy Can you mention that for k8s version [1.33~1.35] the feature-gate DRAPartitionableDevices needs to be enabled on the Kube-APIServer and Kube-Scheduler to use DynamicMIG?
https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/#DRAPartitionableDevices

@shivamerla shivamerla added this to the v0.4.1 milestone May 14, 2026
@shivamerla shivamerla moved this from Backlog to In-Review in DRA Driver for NVIDIA GPUs May 14, 2026
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. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

Status: In-Review

Development

Successfully merging this pull request may close these issues.

6 participants