Skip to content

Commit 9818fda

Browse files
authored
Improve readme
1 parent 427509b commit 9818fda

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

roles/vgpu/README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,41 @@
11
# stackhpc.linux.vgpu
22

3-
## Prerequisites
3+
This role can configure vGPUs or multi instance GPU (MIG) on NVIDIA cards.
44

5-
- [Download Nvidia GRID driver](https://docs.nvidia.com/grid/latest/grid-software-quick-start-guide/index.html#redeeming-pak-and-downloading-grid-software) (This requires a login).
6-
- The location of this file can be customised with the `vgpu_driver_url` variable:
7-
* e.g to use an artifact uploaded to a http server:
8-
`vgpu_driver_url: http://seed/pulp/content/nvidia/NVIDIA-GRID-Linux-KVM-525.85.07-525.85.05-528.24.zip`
9-
* e.g to use file the control host:
10-
`vgpu_driver_url: "{{ lookup('env', 'HOME'}}/NVIDIA-GRID-Linux-KVM-525.85.07-525.85.05-528.24.zip"`
5+
## Prerequisites
116

127
- Enable IOMUU
138
- Make sure the related options are enabled in the BIOS
149
- Intel CPUs require the intel_iommu kernel command line argument
10+
11+
## Drivers
12+
13+
The role will attempt to install a driver from ``vgpu_driver_url``. Currently this only works with
14+
the data center drivers such as the [Nvidia GRID drivers](https://docs.nvidia.com/grid/latest/grid-software-quick-start-guide/index.html#redeeming-pak-and-downloading-grid-software) or the [AI enterprise drivers](https://www.nvidia.com/en-gb/data-center/products/ai-enterprise/); both of which can be obtained from the NVIDIA licensing portal. The use of data centre drivers is not mandatory
15+
if you only want to use MIG without vGPUs.
16+
17+
The location of this file can be customised with the `vgpu_driver_url` variable, e.g to use an artifact uploaded to a http server:
18+
19+
```
20+
vgpu_driver_url: http://seed/pulp/content/nvidia/NVIDIA-GRID-Linux-KVM-525.85.07-525.85.05-528.24.zip
21+
```
22+
23+
e.g to use file the control host:
24+
25+
```
26+
vgpu_driver_url: "{{ lookup('env', 'HOME'}}/NVIDIA-GRID-Linux-KVM-525.85.07-525.85.05-528.24.zip"
27+
```
28+
29+
At this moment in time, the role only supports zip archives, Future work will add support for other packaging formats such as: .deb and .rpm, and .run.
30+
31+
It is possible to install a driver via some other means by setting the ``vgpu_nvidia_driver_install_enabled`` configuration option, e.g:
32+
```
33+
---
34+
vgpu_nvidia_driver_install_enabled: false
35+
```
36+
37+
This will cause the role to assume that the driver is already installed.
38+
1539

1640
## Enabling SR-IOV on dell hardware
1741

0 commit comments

Comments
 (0)