Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs-build-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: docs-build-pr

on:
pull_request:
branches: [ main ]
branches: [ main, release-* ]
types: [ opened, synchronize ]

env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
TAG: 0.5.0
TAG: 0.5.1
GH_TOKEN: ${{ github.token }}

concurrency:
Expand Down
4 changes: 2 additions & 2 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
variables:
CONTAINER_TEST_IMAGE: "${CI_REGISTRY_IMAGE}:${CI_COMMIT_REF_SLUG}"
CONTAINER_RELEASE_IMAGE: "${CI_REGISTRY_IMAGE}:0.5.0"
BUILDER_IMAGE: ghcr.io/nvidia/cloud-native-docs:0.5.0
CONTAINER_RELEASE_IMAGE: "${CI_REGISTRY_IMAGE}:0.5.1"
BUILDER_IMAGE: ghcr.io/nvidia/cloud-native-docs:0.5.1
PUBLISHER_IMAGE: "${CI_REGISTRY_PUBLISHER}/publisher:3.1.0"

stages:
Expand Down
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Use the `Dockerfile` in the repository (under the `docker` directory) to generat

1. Build the docs:

Use the alias `build-docs` or the full command:

```bash
./repo docs
```
Expand All @@ -49,6 +51,8 @@ Use the `Dockerfile` in the repository (under the `docker` directory) to generat

The resulting HTML pages are located in the `_build/docs/.../latest/` directory of your repository clone.

If you are using WSL on Windows, the URL looks like <file://wsl.localhost/Ubuntu/home/username/path/to/repo/cloud-native-docs/_build/docs/gpu-operator/latest/index.html>.

More information about the `repo docs` command is available from
<http://omniverse-docs.s3-website-us-east-1.amazonaws.com/repo_docs/0.20.3/index.html>.

Expand Down Expand Up @@ -136,6 +140,20 @@ Always update the openshift docset when there is a new gpu-operator docset versi
The documentation for the older releases is not removed, readers are just
less likely to browse the older releases.

GPU Operator has changed to minor-only version branches.
Consequently, patch releases are documented within the same branch for that minor version.
In the `<component-name>/versions1.json` file, you can use just the first two fields of the semantic version.
For example:

```bash
{
"url": "../25.10",
"version": "25.10"
},
```

The three most-recent minor are supported.

### Tagging for Publication

Changes to the default branch are not published on docs.nvidia.com.
Expand All @@ -147,11 +165,21 @@ Only tags are published to docs.nvidia.com.
*Example*

```text
gpu-operator-v23.3.1
container-toolkit-v1.17.8
```

The first three fields of the semantic version are used.
For a "do over," push a tag like `gpu-operator-v23.3.1-1`.
For a "do over," push a tag like `container-toolkit-v1.17.8-1`.

For GPU Operator, use only the first two fields of the semantic version.

*Example*

```text
gpu-operator-v25.10
```

For a "do over," push a tag like `gpu-operator-v25.10-2`.

Always tag the openshift docset and for each new gpu-operator docset release.

Expand Down
21 changes: 20 additions & 1 deletion css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,23 @@
*/
html[data-theme=light] .highlight .go {
font-style:unset
}
}

.bd-page-width {
max-width: 176rem;
}

.bd-main {
flex: 1 1 auto;
}

.bd-main .bd-content .bd-article-container {
max-width: 100%;
}

.bd-sidebar-secondary {
/* flex: 0 0 auto; */
flex-basis: 15%;
min-width: var(--pst-sidebar-secondary);
}

5 changes: 4 additions & 1 deletion docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ RUN --mount=type=bind,source=.,destination=/x,rw /x/tools/packman/python.sh -m p
-t /tmp/extension \
sphinx-copybutton \
nvidia-sphinx-theme \
pydata-sphinx-theme
pydata-sphinx-theme \
linuxdoc

RUN (cd /tmp/extension; tar cf - . ) | (cd /var/tmp/packman/chk/sphinx/4.5.0.2-py3.7-linux-x86_64/; tar xf -)
RUN rm -rf /tmp/extension

RUN --mount=type=bind,target=/work echo 'alias build-docs="./repo docs"' >> ~/.bashrc
107 changes: 84 additions & 23 deletions gpu-operator/life-cycle-policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The product life cycle and versioning are subject to change in the future.

.. note::

- Upgrades are only supported within a major release or to the next major release.
Upgrades are only supported within a major release or to the next major release.

.. list-table:: Support Status for Releases
:header-rows: 1
Expand Down Expand Up @@ -81,17 +81,31 @@ The following table shows the operands and default operand versions that corresp
When post-release testing confirms support for newer versions of operands, these updates are identified as *recommended updates* to a GPU Operator version.
Refer to :ref:`Upgrading the NVIDIA GPU Operator` for more information.

.. list-table::
:header-rows: 1
**D** = Default driver, **R** = Recommended driver

.. flat-table::
:header-rows: 2

* - Component
- Version
* - :rspan:`1` Component
- :cspan:`4` GPU Operator Version

* - NVIDIA GPU Operator
- ${version}
* - v25.3.4
- v25.3.3
- v25.3.2
- v25.3.1
- v25.3.0

* - NVIDIA GPU Driver |ki|_
- | `580.82.07 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-82-07/index.html>`_ (default, recommended)
- | `580.82.07 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-82-07/index.html>`_ (**D**, **R**)
| `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_
| `570.158.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-158-01/index.html>`_
| `570.148.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-148-08/index.html>`_
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
- | `580.82.07 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-82-07/index.html>`_ (**D**, **R**)
| `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_
Expand All @@ -100,53 +114,100 @@ Refer to :ref:`Upgrading the NVIDIA GPU Operator` for more information.
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
- | `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_ (**R**)
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_ (**D**)
| `570.158.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-158-01/index.html>`_
| `570.148.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-148-08/index.html>`_
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
- | `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_ (**R**)
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_ (**D**)
| `570.158.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-158-01/index.html>`_
| `570.148.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-148-08/index.html>`_
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
- | `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_ (**R**)
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_ (**D**)
| `570.158.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-158-01/index.html>`_
| `570.148.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-148-08/index.html>`_
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_

* - NVIDIA Driver Manager for Kubernetes
- `v0.8.1 <https://ngc.nvidia.com/catalog/containers/nvidia:cloud-native:k8s-driver-manager>`__
- :cspan:`1` `v0.8.1 <https://ngc.nvidia.com/catalog/containers/nvidia:cloud-native:k8s-driver-manager>`__
- :cspan:`2` `v0.8.0 <https://ngc.nvidia.com/catalog/containers/nvidia:cloud-native:k8s-driver-manager>`__

* - NVIDIA Container Toolkit
- `1.17.8 <https://github.com/NVIDIA/nvidia-container-toolkit/releases>`__
- :cspan:`3` `1.17.8 <https://github.com/NVIDIA/nvidia-container-toolkit/releases>`__
- `1.17.5 <https://github.com/NVIDIA/nvidia-container-toolkit/releases>`__

* - NVIDIA Kubernetes Device Plugin
- `0.17.4 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
- :cspan:`1` `0.17.4 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
- `0.17.3 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
- `0.17.2 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
- `0.17.1 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__

* - DCGM Exporter
- `4.3.1-4.4.0 <https://github.com/NVIDIA/dcgm-exporter/releases>`__
- :cspan:`1` `4.3.1-4.4.0 <https://github.com/NVIDIA/dcgm-exporter/releases>`__
- :cspan:`1` `4.2.3-4.1.3 <https://github.com/NVIDIA/dcgm-exporter/releases>`__
- `4.1.1-4.0.4 <https://github.com/NVIDIA/dcgm-exporter/releases>`__

* - Node Feature Discovery
- `v0.17.3 <https://github.com/kubernetes-sigs/node-feature-discovery/releases/>`__
- :cspan:`3` `v0.17.3 <https://github.com/kubernetes-sigs/node-feature-discovery/releases/>`__
- `v0.17.2 <https://github.com/kubernetes-sigs/node-feature-discovery/releases/>`__

* - | NVIDIA GPU Feature Discovery
| for Kubernetes
- `0.17.4 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
- :cspan:`1` `0.17.4 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
- `0.17.3 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
- `0.17.3 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
- `0.17.1 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__

* - NVIDIA MIG Manager for Kubernetes
- `0.12.3 <https://github.com/NVIDIA/mig-parted/blob/main/CHANGELOG.md>`__
- :cspan:`1` `0.12.3 <https://github.com/NVIDIA/mig-parted/blob/main/CHANGELOG.md>`__
- `0.12.2 <https://github.com/NVIDIA/mig-parted/tree/main/deployments/gpu-operator>`__
- :cspan:`1` `0.12.1 <https://github.com/NVIDIA/mig-parted/tree/main/deployments/gpu-operator>`__

* - DCGM
- `4.3.1 <https://docs.nvidia.com/datacenter/dcgm/latest/release-notes/changelog.html>`__
- :cspan:`1` `4.3.1 <https://docs.nvidia.com/datacenter/dcgm/latest/release-notes/changelog.html>`__
- :cspan:`1` `4.2.3 <https://docs.nvidia.com/datacenter/dcgm/latest/release-notes/changelog.html>`__
- `4.1.1-2 <https://docs.nvidia.com/datacenter/dcgm/latest/release-notes/changelog.html>`__

* - Validator for NVIDIA GPU Operator
- ${version}
- v25.3.4
- v25.3.3
- v25.3.2
- v25.3.1
- v25.3.0

* - NVIDIA KubeVirt GPU Device Plugin
- `v1.4.0 <https://github.com/NVIDIA/kubevirt-gpu-device-plugin>`__
- :cspan:`1` `v1.4.0 <https://github.com/NVIDIA/kubevirt-gpu-device-plugin>`__
- :cspan:`2` `v1.3.1 <https://github.com/NVIDIA/kubevirt-gpu-device-plugin>`__

* - NVIDIA vGPU Device Manager
- `v0.4.0 <https://github.com/NVIDIA/vgpu-device-manager>`__
- :cspan:`1` `v0.4.0 <https://github.com/NVIDIA/vgpu-device-manager>`__
- :cspan:`2` `v0.3.0 <https://github.com/NVIDIA/vgpu-device-manager>`__

* - NVIDIA GDS Driver |gds|_
- `2.20.5 <https://github.com/NVIDIA/gds-nvidia-fs/releases>`__
- :cspan:`4` `2.20.5 <https://github.com/NVIDIA/gds-nvidia-fs/releases>`__

* - NVIDIA Kata Manager for Kubernetes
- `v0.2.3 <https://github.com/NVIDIA/k8s-kata-manager>`__
- :cspan:`4` `v0.2.3 <https://github.com/NVIDIA/k8s-kata-manager>`__

* - | NVIDIA Confidential Computing
| Manager for Kubernetes
- v0.1.1
- :cspan:`4` v0.1.1

* - NVIDIA GDRCopy Driver
- `v2.5.1 <https://github.com/NVIDIA/gdrcopy/releases>`__
- :cspan:`1` `v2.5.1 <https://github.com/NVIDIA/gdrcopy/releases>`__
- :cspan:`1` `v2.5.0 <https://github.com/NVIDIA/gdrcopy/releases>`__
- `v2.4.4 <https://github.com/NVIDIA/gdrcopy/releases>`__

.. _known-issue:

Expand Down
3 changes: 2 additions & 1 deletion repo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ sphinx_conf_py_extra = """
]
templates_path = ['${root}/templates']
extensions.extend([
"linuxdoc.rstFlatTable",
"sphinx.ext.autosectionlabel",
"sphinx_copybutton",
])
Expand Down Expand Up @@ -167,7 +168,7 @@ docs_root = "${root}/gpu-operator"
project = "gpu-operator"
name = "NVIDIA GPU Operator"
version = "25.3"
source_substitutions = { version = "v25.3.4", recommended = "580.82.07" }
source_substitutions = { minor_version = "25.3", version = "v25.3.4", recommended = "580.82.07" }
copyright_start = 2020
sphinx_exclude_patterns = [
"life-cycle-policy.rst",
Expand Down