From 71faa3294246947f6bd212979ceb31e793ae0604 Mon Sep 17 00:00:00 2001 From: Ryan Borstelmann Date: Thu, 3 Oct 2024 01:16:37 -0500 Subject: [PATCH] docs: nvidia proprietary/oss hardware requirement Update NVIDIA docs on proprietary/OSS driver requirements. Signed-off-by: Ryan Borstelmann Documentation didn't outline why one would use OSS vs Proprietary Nvidia drivers, so added details for each. Biggest issue is hardware support, which differs between the two. Signed-off-by: Noel Georgi --- .../configuration/nvidia-gpu-proprietary.md | 11 +++++++++++ .../v1.8/talos-guides/configuration/nvidia-gpu.md | 11 +++++++++++ .../configuration/nvidia-gpu-proprietary.md | 11 +++++++++++ .../v1.9/talos-guides/configuration/nvidia-gpu.md | 11 +++++++++++ 4 files changed, 44 insertions(+) diff --git a/website/content/v1.8/talos-guides/configuration/nvidia-gpu-proprietary.md b/website/content/v1.8/talos-guides/configuration/nvidia-gpu-proprietary.md index 70c2fde2b8..70a9e53f43 100644 --- a/website/content/v1.8/talos-guides/configuration/nvidia-gpu-proprietary.md +++ b/website/content/v1.8/talos-guides/configuration/nvidia-gpu-proprietary.md @@ -21,6 +21,17 @@ Create the [boot assets]({{< relref "../install/boot-assets" >}}) which includes > Make sure the driver version matches for both the `nonfree-kmod-nvidia` and `nvidia-container-toolkit` extensions. > The `nonfree-kmod-nvidia` extension is versioned as `-` and the `nvidia-container-toolkit` extension is versioned as `-`. +## Proprietary vs OSS Nvidia Driver Support + +The NVIDIA Linux GPU Driver contains several kernel modules: `nvidia.ko`, `nvidia-modeset.ko`, `nvidia-uvm.ko`, `nvidia-drm.ko`, and `nvidia-peermem.ko`. +Two "flavors" of these kernel modules are provided, and both are available for use within Talos: + +- Proprietary, This is the flavor that NVIDIA has historically shipped. +- Open, i.e. source-published/OSS, kernel modules that are dual licensed MIT/GPLv2. + With every driver release, the source code to the open kernel modules is published on https://github.com/NVIDIA/open-gpu-kernel-modules and a tarball is provided on https://download.nvidia.com/XFree86/. + +The choice between Proprietary/OSS may be decided after referencing the Official [NVIDIA announcement](https://developer.nvidia.com/blog/nvidia-transitions-fully-towards-open-source-gpu-kernel-modules/). + ## Enabling the NVIDIA modules and the system extension Patch Talos machine configuration using the patch `gpu-worker-patch.yaml`: diff --git a/website/content/v1.8/talos-guides/configuration/nvidia-gpu.md b/website/content/v1.8/talos-guides/configuration/nvidia-gpu.md index 71161b713a..4a34b7ec44 100644 --- a/website/content/v1.8/talos-guides/configuration/nvidia-gpu.md +++ b/website/content/v1.8/talos-guides/configuration/nvidia-gpu.md @@ -19,6 +19,17 @@ Create the [boot assets]({{< relref "../install/boot-assets" >}}) which includes > Make sure the driver version matches for both the `nvidia-open-gpu-kernel-modules` and `nvidia-container-toolkit` extensions. > The `nvidia-open-gpu-kernel-modules` extension is versioned as `-` and the `nvidia-container-toolkit` extension is versioned as `-`. +## Proprietary vs OSS Nvidia Driver Support + +The NVIDIA Linux GPU Driver contains several kernel modules: `nvidia.ko`, `nvidia-modeset.ko`, `nvidia-uvm.ko`, `nvidia-drm.ko`, and `nvidia-peermem.ko`. +Two "flavors" of these kernel modules are provided, and both are available for use within Talos: + +- Proprietary, This is the flavor that NVIDIA has historically shipped. +- Open, i.e. source-published/OSS, kernel modules that are dual licensed MIT/GPLv2. + With every driver release, the source code to the open kernel modules is published on https://github.com/NVIDIA/open-gpu-kernel-modules and a tarball is provided on https://download.nvidia.com/XFree86/. + +The choice between Proprietary/OSS may be decided after referencing the Official [NVIDIA announcement](https://developer.nvidia.com/blog/nvidia-transitions-fully-towards-open-source-gpu-kernel-modules/). + ## Enabling the NVIDIA OSS modules Patch Talos machine configuration using the patch `gpu-worker-patch.yaml`: diff --git a/website/content/v1.9/talos-guides/configuration/nvidia-gpu-proprietary.md b/website/content/v1.9/talos-guides/configuration/nvidia-gpu-proprietary.md index 70c2fde2b8..70a9e53f43 100644 --- a/website/content/v1.9/talos-guides/configuration/nvidia-gpu-proprietary.md +++ b/website/content/v1.9/talos-guides/configuration/nvidia-gpu-proprietary.md @@ -21,6 +21,17 @@ Create the [boot assets]({{< relref "../install/boot-assets" >}}) which includes > Make sure the driver version matches for both the `nonfree-kmod-nvidia` and `nvidia-container-toolkit` extensions. > The `nonfree-kmod-nvidia` extension is versioned as `-` and the `nvidia-container-toolkit` extension is versioned as `-`. +## Proprietary vs OSS Nvidia Driver Support + +The NVIDIA Linux GPU Driver contains several kernel modules: `nvidia.ko`, `nvidia-modeset.ko`, `nvidia-uvm.ko`, `nvidia-drm.ko`, and `nvidia-peermem.ko`. +Two "flavors" of these kernel modules are provided, and both are available for use within Talos: + +- Proprietary, This is the flavor that NVIDIA has historically shipped. +- Open, i.e. source-published/OSS, kernel modules that are dual licensed MIT/GPLv2. + With every driver release, the source code to the open kernel modules is published on https://github.com/NVIDIA/open-gpu-kernel-modules and a tarball is provided on https://download.nvidia.com/XFree86/. + +The choice between Proprietary/OSS may be decided after referencing the Official [NVIDIA announcement](https://developer.nvidia.com/blog/nvidia-transitions-fully-towards-open-source-gpu-kernel-modules/). + ## Enabling the NVIDIA modules and the system extension Patch Talos machine configuration using the patch `gpu-worker-patch.yaml`: diff --git a/website/content/v1.9/talos-guides/configuration/nvidia-gpu.md b/website/content/v1.9/talos-guides/configuration/nvidia-gpu.md index 71161b713a..4a34b7ec44 100644 --- a/website/content/v1.9/talos-guides/configuration/nvidia-gpu.md +++ b/website/content/v1.9/talos-guides/configuration/nvidia-gpu.md @@ -19,6 +19,17 @@ Create the [boot assets]({{< relref "../install/boot-assets" >}}) which includes > Make sure the driver version matches for both the `nvidia-open-gpu-kernel-modules` and `nvidia-container-toolkit` extensions. > The `nvidia-open-gpu-kernel-modules` extension is versioned as `-` and the `nvidia-container-toolkit` extension is versioned as `-`. +## Proprietary vs OSS Nvidia Driver Support + +The NVIDIA Linux GPU Driver contains several kernel modules: `nvidia.ko`, `nvidia-modeset.ko`, `nvidia-uvm.ko`, `nvidia-drm.ko`, and `nvidia-peermem.ko`. +Two "flavors" of these kernel modules are provided, and both are available for use within Talos: + +- Proprietary, This is the flavor that NVIDIA has historically shipped. +- Open, i.e. source-published/OSS, kernel modules that are dual licensed MIT/GPLv2. + With every driver release, the source code to the open kernel modules is published on https://github.com/NVIDIA/open-gpu-kernel-modules and a tarball is provided on https://download.nvidia.com/XFree86/. + +The choice between Proprietary/OSS may be decided after referencing the Official [NVIDIA announcement](https://developer.nvidia.com/blog/nvidia-transitions-fully-towards-open-source-gpu-kernel-modules/). + ## Enabling the NVIDIA OSS modules Patch Talos machine configuration using the patch `gpu-worker-patch.yaml`: