From 4cc392fdab3cd3638e291cf2e11a6c85e8069ba3 Mon Sep 17 00:00:00 2001 From: anilkubn Date: Mon, 25 Aug 2025 20:07:53 +0530 Subject: [PATCH 1/7] Replace ROCm driver with amdgpu driver keyword --- docs/drivers/precompiled-driver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/drivers/precompiled-driver.md b/docs/drivers/precompiled-driver.md index 1d3c71a45..0bcb322a7 100644 --- a/docs/drivers/precompiled-driver.md +++ b/docs/drivers/precompiled-driver.md @@ -15,7 +15,7 @@ Users could prepare pre-compiled driver images in advance and import them into t KMM determines the appropriate driver image based on the combination of: 1. Worker node OS information -2. Requested ROCm driver version +2. Requested amdgpu driver version ### Image Tag Format From fbcc88d63bce265a4789529192d371f511e03f0e Mon Sep 17 00:00:00 2001 From: anilkubn Date: Mon, 25 Aug 2025 20:34:34 +0530 Subject: [PATCH 2/7] "Replace ROCm driver with amdgpu driver keyword" --- docs/drivers/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/drivers/installation.md b/docs/drivers/installation.md index e54ced07b..e4b0b54f4 100644 --- a/docs/drivers/installation.md +++ b/docs/drivers/installation.md @@ -281,7 +281,7 @@ To check the full spec of `DeviceConfig` definition run `kubectl get crds device |---------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | `enable` | Set to true for installing out-of-tree driver.
Set to false to skip driver install and use inbox/pre-installed driver. | `true` | | `blacklist` | Set to true to have the operator init the node labeller DaemonSet and add `amdgpu` to the selected worker nodes' modprobe blacklist.
Set to false to remove `amdgpu` from the selected nodes' modprobe blacklist. | `false` | -| `version` | ROCm driver version (e.g., "6.2.2").
See ROCm Versions: https://rocm.docs.amd.com/en/latest/release/versions.html | Ubuntu: `6.1.3`
CoreOS: `6.2.2` | +| `version` | amdgpu driver version (e.g., "6.2.2").
See ROCm Versions: https://instinct.docs.amd.com/projects/amdgpu-docs/en/latest/release/versions.html | Ubuntu: `6.1.3`
CoreOS: `6.2.2` | | `image` | Registry URL and repository (without tag).
Note: Operator manages tags automatically. | Vanilla k8s: `image-registry:5000/$MOD_NAMESPACE/amdgpu_kmod`
OpenShift: `image-registry.openshift-image-registry.svc:5000/$MOD_NAMESPACE/amdgpu_kmod` | | `imageRegistrySecret.name` | Name of registry credentials secret to pull/push driver image. | | | `imageRegistryTLS.insecure` | If true, check if the container image already exists using plain HTTP. | `false` | From ab7d347a9d34150d594929375d0c11b913f67708 Mon Sep 17 00:00:00 2001 From: yansun1996 Date: Mon, 3 Aug 2026 18:16:55 +0000 Subject: [PATCH 3/7] docs: replace "ROCm driver" with "amdgpu driver" in upgrading guide Completes the terminology fix across docs/. This occurrence in upgrading.md was not covered by #303, #304, #305, or #306. Co-Authored-By: Claude --- docs/drivers/upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/drivers/upgrading.md b/docs/drivers/upgrading.md index c1645ca54..7421fa11a 100644 --- a/docs/drivers/upgrading.md +++ b/docs/drivers/upgrading.md @@ -70,7 +70,7 @@ To check the full spec of upgrade configuration run kubectl get crds deviceconfi | `maxUnavailableNodes` | Maximum number (or Percentage) of nodes which can be unavailable (cordoned) in the cluster | `25%` | | `rebootRequired` | Reboot the node after driver upgrade is done. Waits for 60 mins post reboot before declaring as failed | `true` | -**Warning**: When using ROCm drivers version 6.3 and below, a known issue may prevent the driver upgrade from fully completing unless the node is rebooted. As a workaround, we strongly recommend setting the `rebootRequired` field to `true` in your upgrade policy. This ensures that a reboot is triggered after the driver upgrade, allowing the new driver to be fully loaded. This workaround should be applied until a permanent fix is provided in a future release. +**Warning**: When using amdgpu drivers version 6.3 and below, a known issue may prevent the driver upgrade from fully completing unless the node is rebooted. As a workaround, we strongly recommend setting the `rebootRequired` field to `true` in your upgrade policy. This ensures that a reboot is triggered after the driver upgrade, allowing the new driver to be fully loaded. This workaround should be applied until a permanent fix is provided in a future release. #### `driver.upgradePolicy.nodeDrainPolicy` Parameters From 2034fc3edde59c160627145f554d9903daf39e54 Mon Sep 17 00:00:00 2001 From: anilkubn Date: Mon, 25 Aug 2025 20:39:07 +0530 Subject: [PATCH 4/7] "Replace ROCm driver with amdgpu driver keyword" --- docs/releasenotes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releasenotes.md b/docs/releasenotes.md index 261449683..5f03c8250 100644 --- a/docs/releasenotes.md +++ b/docs/releasenotes.md @@ -346,7 +346,7 @@ The AMD GPU Operator v1.3.0 release introduces new features, most notably of whi - *Root Cause:* DCM does not currently support standalone installation via a Debian package like other standalone components of the GPU Operator. We will be adding a Debian package to support standalone bare metal installations in the next release of DCM. - *Recommendation:* Those wishing to use GPU partitioning in a bare metal environment should instead use the standalone docker image for DCM. Alternatively users can use amd-smi to change partitioning modes. See [amdgpu-docs documentation](https://instinct.docs.amd.com/projects/amdgpu-docs/en/latest/gpu-partitioning/mi300x/quick-start-guide.html) for how to do this. -2. **The GPU Operator will report an error when ROCm driver install version doesn't match the version string in the [Radeon Repo](https://repo.radeon.com/rocm/apt/).** +2. **The GPU Operator will report an error when amdgpu driver install version doesn't match the version string in the [Radeon Repo](https://repo.radeon.com/rocm/apt/).** - *Impact:* The DeviceConfig will report an error if you specify `"6.4.0"` or `"6.3.0"` for the `spec.driver.version`. - *Root Cause:* The version specified in the CR would still have to match the version string on Radeon repo. From aa605eb2e35104e8ec57191dec09222e7993781a Mon Sep 17 00:00:00 2001 From: anilkubn Date: Mon, 25 Aug 2025 20:41:00 +0530 Subject: [PATCH 5/7] "Replace ROCm driver with amdgpu driver keyword" --- docs/knownlimitations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/knownlimitations.md b/docs/knownlimitations.md index baa99604f..e30a60437 100644 --- a/docs/knownlimitations.md +++ b/docs/knownlimitations.md @@ -99,7 +99,7 @@ - *Root Cause:* DCM does not currently support standalone installation via a Debian package like other standalone components of the GPU Operator. We will be adding a Debian package to support standalone bare metal installations in the next release of DCM. - *Recommendation:* Those wishing to use GPU partitioning in a bare metal environment should instead use the standalone docker image for DCM. Alternatively users can use amd-smi to change partitioning modes. See [amdgpu-docs documentation](https://instinct.docs.amd.com/projects/amdgpu-docs/en/latest/gpu-partitioning/mi300x/quick-start-guide.html) for how to do this. -16. **The GPU Operator will report an error when ROCm driver install version doesn't match the version string in the [Radeon Repo](https://repo.radeon.com/rocm/apt/).** +16. **The GPU Operator will report an error when amdgpu driver install version doesn't match the version string in the [Radeon Repo](https://repo.radeon.com/rocm/apt/).** - *Impact:* The DeviceConfig will report an error if you specify `"6.4.0"` or `"6.3.0"` for the `spec.driver.version`. - *Root Cause:* The version specified in the CR would still have to match the version string on Radeon repo. From e2bc3b75b393842b366f6f55c9ab0daf917b1b37 Mon Sep 17 00:00:00 2001 From: yansun1996 Date: Mon, 3 Aug 2026 22:42:37 +0000 Subject: [PATCH 6/7] docs: address review comments on amdgpu driver terminology Fixes from Copilot review on PR #1637: - upgrading.md: "amdgpu drivers version" -> "amdgpu driver versions" - installation.md: link label "See ROCm Versions" -> "See amdgpu Versions" to match the amdgpu-docs link target - releasenotes.md / knownlimitations.md: typo "need to specific" -> "specify" Co-Authored-By: Claude --- docs/drivers/installation.md | 2 +- docs/drivers/upgrading.md | 2 +- docs/knownlimitations.md | 2 +- docs/releasenotes.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/drivers/installation.md b/docs/drivers/installation.md index e4b0b54f4..e7d12c016 100644 --- a/docs/drivers/installation.md +++ b/docs/drivers/installation.md @@ -281,7 +281,7 @@ To check the full spec of `DeviceConfig` definition run `kubectl get crds device |---------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | `enable` | Set to true for installing out-of-tree driver.
Set to false to skip driver install and use inbox/pre-installed driver. | `true` | | `blacklist` | Set to true to have the operator init the node labeller DaemonSet and add `amdgpu` to the selected worker nodes' modprobe blacklist.
Set to false to remove `amdgpu` from the selected nodes' modprobe blacklist. | `false` | -| `version` | amdgpu driver version (e.g., "6.2.2").
See ROCm Versions: https://instinct.docs.amd.com/projects/amdgpu-docs/en/latest/release/versions.html | Ubuntu: `6.1.3`
CoreOS: `6.2.2` | +| `version` | amdgpu driver version (e.g., "6.2.2").
See amdgpu Versions: https://instinct.docs.amd.com/projects/amdgpu-docs/en/latest/release/versions.html | Ubuntu: `6.1.3`
CoreOS: `6.2.2` | | `image` | Registry URL and repository (without tag).
Note: Operator manages tags automatically. | Vanilla k8s: `image-registry:5000/$MOD_NAMESPACE/amdgpu_kmod`
OpenShift: `image-registry.openshift-image-registry.svc:5000/$MOD_NAMESPACE/amdgpu_kmod` | | `imageRegistrySecret.name` | Name of registry credentials secret to pull/push driver image. | | | `imageRegistryTLS.insecure` | If true, check if the container image already exists using plain HTTP. | `false` | diff --git a/docs/drivers/upgrading.md b/docs/drivers/upgrading.md index 7421fa11a..471894142 100644 --- a/docs/drivers/upgrading.md +++ b/docs/drivers/upgrading.md @@ -70,7 +70,7 @@ To check the full spec of upgrade configuration run kubectl get crds deviceconfi | `maxUnavailableNodes` | Maximum number (or Percentage) of nodes which can be unavailable (cordoned) in the cluster | `25%` | | `rebootRequired` | Reboot the node after driver upgrade is done. Waits for 60 mins post reboot before declaring as failed | `true` | -**Warning**: When using amdgpu drivers version 6.3 and below, a known issue may prevent the driver upgrade from fully completing unless the node is rebooted. As a workaround, we strongly recommend setting the `rebootRequired` field to `true` in your upgrade policy. This ensures that a reboot is triggered after the driver upgrade, allowing the new driver to be fully loaded. This workaround should be applied until a permanent fix is provided in a future release. +**Warning**: When using amdgpu driver versions 6.3 and below, a known issue may prevent the driver upgrade from fully completing unless the node is rebooted. As a workaround, we strongly recommend setting the `rebootRequired` field to `true` in your upgrade policy. This ensures that a reboot is triggered after the driver upgrade, allowing the new driver to be fully loaded. This workaround should be applied until a permanent fix is provided in a future release. #### `driver.upgradePolicy.nodeDrainPolicy` Parameters diff --git a/docs/knownlimitations.md b/docs/knownlimitations.md index e30a60437..169e8011c 100644 --- a/docs/knownlimitations.md +++ b/docs/knownlimitations.md @@ -103,7 +103,7 @@ - *Impact:* The DeviceConfig will report an error if you specify `"6.4.0"` or `"6.3.0"` for the `spec.driver.version`. - *Root Cause:* The version specified in the CR would still have to match the version string on Radeon repo. - - *Recommendation:* Although this will be fixed in a future version of the GPU Operator, for the time being you will instead need to specific `"6.4"` or `"6.3"` when installing those versions of the ROCm amdgpu driver. + - *Recommendation:* Although this will be fixed in a future version of the GPU Operator, for the time being you will instead need to specify `"6.4"` or `"6.3"` when installing those versions of the ROCm amdgpu driver. 17. **Device plugin crashes when unable to establish watcher on kubelet device plugin path** diff --git a/docs/releasenotes.md b/docs/releasenotes.md index 5f03c8250..f40ea5299 100644 --- a/docs/releasenotes.md +++ b/docs/releasenotes.md @@ -350,7 +350,7 @@ The AMD GPU Operator v1.3.0 release introduces new features, most notably of whi - *Impact:* The DeviceConfig will report an error if you specify `"6.4.0"` or `"6.3.0"` for the `spec.driver.version`. - *Root Cause:* The version specified in the CR would still have to match the version string on Radeon repo. - - *Recommendation:* Although this will be fixed in a future version of the GPU Operator, for the time being you will instead need to specific `"6.4"` or `"6.3"` when installing those versions of the ROCm amdgpu driver. + - *Recommendation:* Although this will be fixed in a future version of the GPU Operator, for the time being you will instead need to specify `"6.4"` or `"6.3"` when installing those versions of the ROCm amdgpu driver. > **Note:** All current and historical limitations for the GPU Operator, including their latest statuses and any associated workarounds or fixes, are tracked in the following documentation page: [Known Issues and Limitations](https://instinct.docs.amd.com/projects/gpu-operator/en/latest/knownlimitations.html). Please refer to this page regularly for the most up-to-date information. From f6e879964f48d035fbca7c1e6c8ddf333f55b6f7 Mon Sep 17 00:00:00 2001 From: yansun1996 Date: Mon, 3 Aug 2026 22:51:30 +0000 Subject: [PATCH 7/7] docs: fix markdownlint MD060 table alignment in installation.md The "ROCm" -> "amdgpu" label change (+2 chars) shifted the table pipes out of alignment with the header, failing the docs-lint e2e target. Trim 2 padding spaces in the version cell to realign. Verified: markdownlint-cli2 v0.22.0 --config docs/.markdownlint.yaml reports 0 errors. Co-Authored-By: Claude --- docs/drivers/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/drivers/installation.md b/docs/drivers/installation.md index e7d12c016..c97eb8d8b 100644 --- a/docs/drivers/installation.md +++ b/docs/drivers/installation.md @@ -281,7 +281,7 @@ To check the full spec of `DeviceConfig` definition run `kubectl get crds device |---------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | `enable` | Set to true for installing out-of-tree driver.
Set to false to skip driver install and use inbox/pre-installed driver. | `true` | | `blacklist` | Set to true to have the operator init the node labeller DaemonSet and add `amdgpu` to the selected worker nodes' modprobe blacklist.
Set to false to remove `amdgpu` from the selected nodes' modprobe blacklist. | `false` | -| `version` | amdgpu driver version (e.g., "6.2.2").
See amdgpu Versions: https://instinct.docs.amd.com/projects/amdgpu-docs/en/latest/release/versions.html | Ubuntu: `6.1.3`
CoreOS: `6.2.2` | +| `version` | amdgpu driver version (e.g., "6.2.2").
See amdgpu Versions: https://instinct.docs.amd.com/projects/amdgpu-docs/en/latest/release/versions.html | Ubuntu: `6.1.3`
CoreOS: `6.2.2` | | `image` | Registry URL and repository (without tag).
Note: Operator manages tags automatically. | Vanilla k8s: `image-registry:5000/$MOD_NAMESPACE/amdgpu_kmod`
OpenShift: `image-registry.openshift-image-registry.svc:5000/$MOD_NAMESPACE/amdgpu_kmod` | | `imageRegistrySecret.name` | Name of registry credentials secret to pull/push driver image. | | | `imageRegistryTLS.insecure` | If true, check if the container image already exists using plain HTTP. | `false` |