You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by "vishesh92 (via GitHub)" <gi...@apache.org> on 2025/07/07 09:18:04 UTC

[PR] Update docs for GPU support with KVM [cloudstack-documentation]

vishesh92 opened a new pull request, #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526

   To be merged after: https://github.com/apache/cloudstack/pull/11143


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#issuecomment-3131208319

   @sureshanaparti a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "sureshanaparti (via GitHub)" <gi...@apache.org>.
sureshanaparti commented on code in PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#discussion_r2238956746


##########
source/adminguide/hosts.rst:
##########
@@ -223,6 +223,38 @@ Following hypervisor-specific documentations can be referred for different maxim
    Guest Instance limit check is not done while deploying an Instance on a KVM hypervisor host.
 
 
+.. _discovering-gpu-devices-on-hosts:

Review Comment:
   ```suggestion
   .. _discovering-gpu-devices-on-kvm-hosts:
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#issuecomment-3131274752

   QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/526. (QA-JID 403)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#issuecomment-3131270147

   @sureshanaparti a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "sureshanaparti (via GitHub)" <gi...@apache.org>.
sureshanaparti commented on code in PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#discussion_r2238957804


##########
source/adminguide/virtual_machines.rst:
##########
@@ -1710,14 +1746,17 @@ GPU/vGPU Assignment Workflow
 
 CloudStack follows the below sequence of operations to provide GPU/vGPU support for Instances:
 
-#. Ensure that XenServer host is ready with GPU installed and configured.
-   For more information, see `Citrix 3D Graphics Pack <https://www.citrix.com/go/private/vgpu.html>`_.
+#. Ensure that the host is ready with GPU installed and configured.
+
+   - For more information for XenServer, see `XenServer Documentation <https://docs.xenserver.com/en-us/citrix-hypervisor/graphics/hv-graphics-config>`_.
+
+   - For KVM, to configure the host see how to `discover GPU Devices on Hosts here <hosts.html#discovering-gpu-devices-on-hosts>`_.

Review Comment:
   ```suggestion
      - For KVM, to configure the host see how to `discover GPU Devices on Hosts here <hosts.html#discovering-gpu-devices-on-kvm-hosts>`_.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#issuecomment-3131211389

   QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/526. (QA-JID 401)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "sureshanaparti (via GitHub)" <gi...@apache.org>.
sureshanaparti commented on PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#issuecomment-3131264828

   @blueorangutan docbuild


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "sureshanaparti (via GitHub)" <gi...@apache.org>.
sureshanaparti merged PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "sureshanaparti (via GitHub)" <gi...@apache.org>.
sureshanaparti commented on PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#issuecomment-3131205922

   @blueorangutan docbuild


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "sureshanaparti (via GitHub)" <gi...@apache.org>.
sureshanaparti commented on code in PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#discussion_r2238954062


##########
source/adminguide/hosts.rst:
##########
@@ -223,6 +223,38 @@ Following hypervisor-specific documentations can be referred for different maxim
    Guest Instance limit check is not done while deploying an Instance on a KVM hypervisor host.
 
 
+.. _discovering-gpu-devices-on-hosts:
+
+Discovering GPU Devices on Hosts

Review Comment:
   ```suggestion
   Discovering GPU Devices on KVM Hosts
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update docs for GPU support with KVM [cloudstack-documentation]

Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #526:
URL: https://github.com/apache/cloudstack-documentation/pull/526#discussion_r2189471505


##########
source/adminguide/virtual_machines.rst:
##########
@@ -1593,39 +1593,54 @@ CloudStack meet the intensive graphical processing requirement by means of the
 high computation power of GPU/vGPU, and CloudStack users can run multimedia
 rich applications, such as Auto-CAD, that they otherwise enjoy at their desk on
 a virtualized environment.
-CloudStack leverages the XenServer support for NVIDIA GRID Kepler 1 and 2 series
-to run GPU/vGPU enabled Instances. NVIDIA GRID cards allows sharing a single GPU cards
-among multiple Instances by creating vGPUs for each Instance. With vGPU technology, the
-graphics commands from each Instance are passed directly to the underlying dedicated
-GPU, without the intervention of the hypervisor. This allows the GPU hardware
-to be time-sliced and shared across multiple Instances. XenServer hosts use the GPU
-cards in following ways:
-
-**GPU passthrough**: GPU passthrough represents a physical GPU which can be
+
+For KVM, CloudStack leverages libvirt's PCI passthrough feature to assign a
+physical GPU to a guest Instance. For vGPU profiles, depending on the vGPU type,
+CloudStack uses mediated devices or Virtual Functions(VF) to assign a virtual
+GPU to a guest Instance. It's the responsibility of the operator to ensure that
+GPU devices are in correct state and are available for use on the host. If the
+operator wants to use vGPU profiles, they need to ensure that the vGPU type is
+supported by the host and has been created on the host.
+
+For XenServer, CloudStack leverages the XenServer support for NVIDIA GRID
+Kepler 1 and 2 series to run GPU/vGPU enabled Instances.
+
+Some NVIDIA cards allows sharing a single GPU card among multiple Instances by

Review Comment:
   Grammatical error: 'cards allows' should be 'cards allow'.
   ```suggestion
   Some NVIDIA cards allow sharing a single GPU card among multiple Instances by
   ```



##########
source/adminguide/virtual_machines.rst:
##########
@@ -1593,39 +1593,54 @@ CloudStack meet the intensive graphical processing requirement by means of the
 high computation power of GPU/vGPU, and CloudStack users can run multimedia
 rich applications, such as Auto-CAD, that they otherwise enjoy at their desk on
 a virtualized environment.
-CloudStack leverages the XenServer support for NVIDIA GRID Kepler 1 and 2 series
-to run GPU/vGPU enabled Instances. NVIDIA GRID cards allows sharing a single GPU cards
-among multiple Instances by creating vGPUs for each Instance. With vGPU technology, the
-graphics commands from each Instance are passed directly to the underlying dedicated
-GPU, without the intervention of the hypervisor. This allows the GPU hardware
-to be time-sliced and shared across multiple Instances. XenServer hosts use the GPU
-cards in following ways:
-
-**GPU passthrough**: GPU passthrough represents a physical GPU which can be
+
+For KVM, CloudStack leverages libvirt's PCI passthrough feature to assign a
+physical GPU to a guest Instance. For vGPU profiles, depending on the vGPU type,
+CloudStack uses mediated devices or Virtual Functions(VF) to assign a virtual
+GPU to a guest Instance. It's the responsibility of the operator to ensure that
+GPU devices are in correct state and are available for use on the host. If the
+operator wants to use vGPU profiles, they need to ensure that the vGPU type is
+supported by the host and has been created on the host.
+
+For XenServer, CloudStack leverages the XenServer support for NVIDIA GRID
+Kepler 1 and 2 series to run GPU/vGPU enabled Instances.
+
+Some NVIDIA cards allows sharing a single GPU card among multiple Instances by
+creating vGPUs for each Instance. With vGPU technology, the graphics commands
+from each Instance are passed directly to the underlying dedicated GPU, without
+the intervention of the hypervisor. This allows the GPU hardware to be
+time-sliced and shared across multiple Instances. The GPU cards are used in the
+following ways:
+
+**passthrough**: GPU passthrough represents a physical GPU which can be
 directly assigned to an Instance. GPU passthrough can be used on a hypervisor alongside
 GRID vGPU, with some restrictions: A GRID physical GPU can either host GRID
 vGPUs or be used as passthrough, but not both at the same time.
 
-**GRID vGPU**: GRID vGPU enables multiple Instances to share a single physical GPU.
+**vGPU**: vGPU enables multiple Instances to share a single physical GPU.
 The Instances run an NVIDIA driver stack and get direct access to the GPU. GRID
 physical GPUs are capable of supporting multiple virtual GPU devices (vGPUs)
-that can be assigned directly to guest Instances. Guest Instances use GRID virtual GPUs in
+that can be assigned directly to guest Instances. Guest Instances use vGPUs in
 the same manner as a physical GPU that has been passed through by the
 hypervisor: an NVIDIA driver loaded in the guest Instance provides direct access to
 the GPU for performance-critical fast paths, and a paravirtualized interface to
-the GRID Virtual GPU Manager, which is used for nonperformant management
-operations. NVIDIA GRID Virtual GPU Manager for XenServer runs in dom0.
+the NVIDIA vGPU Manager, which is used for nonperformant management
+operations. NVIDIA vGPU Manager for XenServer runs in dom0.
+
 CloudStack provides you with the following capabilities:
 
-- Adding XenServer hosts with GPU/vGPU capability provisioned by the administrator.
+- Adding hosts with GPU/vGPU capability provisioned by the administrator.
+  (Supports only XenServer & KVM)
 
-- Creating a Compute Offering with GPU/vGPU capability.
+- Creating a Compute Offering with GPU/vGPU capability. For KVM, it possible to

Review Comment:
   Missing 'is': change 'it possible' to 'it is possible'.
   ```suggestion
   - Creating a Compute Offering with GPU/vGPU capability. For KVM, it is possible to
   ```



##########
source/adminguide/hosts.rst:
##########
@@ -223,6 +223,38 @@ Following hypervisor-specific documentations can be referred for different maxim
    Guest Instance limit check is not done while deploying an Instance on a KVM hypervisor host.
 
 
+.. _discovering-gpu-devices-on-hosts:
+
+Discovering GPU Devices on Hosts
+--------------------------------
+
+For KVM, the user needs to ensure that IOMMU is enabled and the necessary
+drivers are installed. And if vGPU is to be used, the user needs to ensure that
+the vGPU type is supported by the host and has been created on the host. The

Review Comment:
   [nitpick] Redundant 'on the host'; you could drop the second occurrence for clarity.
   ```suggestion
   the vGPU type is supported by the host and has been created. The
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org