Add api and feature gate reference docs #1098
Conversation
|
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. DetailsInstructions 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. |
✅ Deploy Preview for dra-driver-nvidia-gpu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 Tip We noticed you've done this a few times! Consider joining the org to skip this step and gain Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
|
/lgtm |
|
LGTM label has been added. DetailsGit tree hash: 771096f435809751bd401b411d18f1311009a7fd |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@a-mccarthy: The following test failed, say
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. DetailsInstructions 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. |
|
/skip |
|
Logs show: |
Signed-off-by: Abigail McCarthy <20771501+a-mccarthy@users.noreply.github.com>
|
New changes are detected. LGTM label has been removed. |
| With time-slicing: | ||
|
|
||
| ```yaml | ||
| apiVersion: resource.nvidia.com/v1beta1 |
There was a problem hiding this comment.
why do we need to document all these? we should link to the demo folder which has so many examples already.
There was a problem hiding this comment.
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 | |||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
| | `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. | |
There was a problem hiding this comment.
@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
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 testpasses locallymake check-generatepasses ifapi/changed (CRDs, deepcopy, informers, listers, clientset)make check-modulespasses ifgo.mod/go.sumchangeddeployments/helm) updated if flags, RBAC, or defaults changed