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

update document for volcano-vgpu feature #4034

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

archlitchi
Copy link
Contributor

/kind documentation

We need a document about how to use volcano-vgpu in user-guide section in volcano document

@volcano-sh-bot volcano-sh-bot added kind/documentation Categorizes issue or PR as related to documentation. retest-not-required-docs-only labels Feb 24, 2025
@volcano-sh-bot volcano-sh-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 24, 2025
@archlitchi archlitchi changed the title update-docs update document for volcano-vgpu feature Feb 24, 2025
@archlitchi
Copy link
Contributor Author

/assign @Monokaix @JesseStutler

@@ -0,0 +1,142 @@
# GPU Sharing User guide
Copy link
Member

Choose a reason for hiding this comment

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

Seems this is no needed, we just emphasize vgpu feature is ok.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

right, fixed

- name: drf
- name: deviceshare
arguments:
deviceshare.VGPUEnable: true # enable vgpu
Copy link
Member

Choose a reason for hiding this comment

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

This should also be compatible with lower version with v1.8.2-

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The Prerequisites of volcano-vgpu including 'volcano version >= v1.9', before that, it is a rather 'experimental' feature and lacks a lot, which we don't recommend using in production.

hugepages-2Mi: "0"
memory: 8174332Ki
pods: "110"
volcano.sh/gpu-memory: "89424"
Copy link
Member

Choose a reason for hiding this comment

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

volcano.sh/gpu-memory?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

hugepages-2Mi: "0"
memory: 8174332Ki
pods: "110"
volcano.sh/gpu-memory: "89424"
Copy link
Member

Choose a reason for hiding this comment

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

same above.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

Signed-off-by: limengxuan <[email protected]>
@Monokaix
Copy link
Member

/approve

@volcano-sh-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Monokaix

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

@volcano-sh-bot volcano-sh-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 25, 2025
@JesseStutler
Copy link
Member

Great. But the contribution guide does not exist:
image

@JesseStutler
Copy link
Member

By the way, could you update the usage documentation for vgpu on the Volcano website when you have time? Users may not find it directly sometimes

![img](https://github.com/Project-HAMi/volcano-vgpu-device-plugin/blob/main/doc/vgpu_device_plugin_metrics.png)
# Issues and Contributing
[Checkout the Contributing document!](CONTRIBUTING.md)
Copy link
Member

Choose a reason for hiding this comment

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

where is the CONTRIBUTING.md located ?

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. kind/documentation Categorizes issue or PR as related to documentation. retest-not-required-docs-only size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants