Skip to content

Commit 78b4b91

Browse files
chenopischenopis
authored
25.3 Add patch version columns (#278)
* 25.3 Add patch version columns Signed-off-by: Andrew Chen <[email protected]> * Update README.md for GPU Operator tag instructions Signed-off-by: Andrew Chen <[email protected]> * Add flat-table extension and update container Signed-off-by: Andrew Chen <[email protected]> * fix note Signed-off-by: Andrew Chen <[email protected]> * Fix table formatting Signed-off-by: Andrew Chen <[email protected]> --------- Signed-off-by: Andrew Chen <[email protected]>
1 parent 440fcb5 commit 78b4b91

File tree

8 files changed

+144
-32
lines changed

8 files changed

+144
-32
lines changed

‎.github/workflows/docs-build-pr.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: docs-build-pr
22

33
on:
44
pull_request:
5-
branches: [ main ]
5+
branches: [ main, release-* ]
66
types: [ opened, synchronize ]
77

88
env:

‎.github/workflows/docs-build.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010
env:
1111
REGISTRY: ghcr.io
1212
IMAGE_NAME: ${{ github.repository }}
13-
TAG: 0.5.0
13+
TAG: 0.5.1
1414
GH_TOKEN: ${{ github.token }}
1515

1616
concurrency:

‎.gitlab-ci.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
variables:
22
CONTAINER_TEST_IMAGE: "${CI_REGISTRY_IMAGE}:${CI_COMMIT_REF_SLUG}"
3-
CONTAINER_RELEASE_IMAGE: "${CI_REGISTRY_IMAGE}:0.5.0"
4-
BUILDER_IMAGE: ghcr.io/nvidia/cloud-native-docs:0.5.0
3+
CONTAINER_RELEASE_IMAGE: "${CI_REGISTRY_IMAGE}:0.5.1"
4+
BUILDER_IMAGE: ghcr.io/nvidia/cloud-native-docs:0.5.1
55
PUBLISHER_IMAGE: "${CI_REGISTRY_PUBLISHER}/publisher:3.1.0"
66

77
stages:

‎README.md‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Use the `Dockerfile` in the repository (under the `docker` directory) to generat
3434

3535
1. Build the docs:
3636

37+
Use the alias `build-docs` or the full command:
38+
3739
```bash
3840
./repo docs
3941
```
@@ -49,6 +51,8 @@ Use the `Dockerfile` in the repository (under the `docker` directory) to generat
4951

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

54+
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>.
55+
5256
More information about the `repo docs` command is available from
5357
<http://omniverse-docs.s3-website-us-east-1.amazonaws.com/repo_docs/0.20.3/index.html>.
5458

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

143+
GPU Operator has changed to minor-only version branches.
144+
Consequently, patch releases are documented within the same branch for that minor version.
145+
In the `<component-name>/versions1.json` file, you can use just the first two fields of the semantic version.
146+
For example:
147+
148+
```bash
149+
{
150+
"url": "../25.10",
151+
"version": "25.10"
152+
},
153+
```
154+
155+
The three most-recent minor are supported.
156+
139157
### Tagging for Publication
140158

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

149167
```text
150-
gpu-operator-v23.3.1
168+
container-toolkit-v1.17.8
151169
```
152170

153171
The first three fields of the semantic version are used.
154-
For a "do over," push a tag like `gpu-operator-v23.3.1-1`.
172+
For a "do over," push a tag like `container-toolkit-v1.17.8-1`.
173+
174+
For GPU Operator, use only the first two fields of the semantic version.
175+
176+
*Example*
177+
178+
```text
179+
gpu-operator-v25.10
180+
```
181+
182+
For a "do over," push a tag like `gpu-operator-v25.10-2`.
155183

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

‎css/custom.css‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,23 @@
44
*/
55
html[data-theme=light] .highlight .go {
66
font-style:unset
7-
}
7+
}
8+
9+
.bd-page-width {
10+
max-width: 176rem;
11+
}
12+
13+
.bd-main {
14+
flex: 1 1 auto;
15+
}
16+
17+
.bd-main .bd-content .bd-article-container {
18+
max-width: 100%;
19+
}
20+
21+
.bd-sidebar-secondary {
22+
/* flex: 0 0 auto; */
23+
flex-basis: 15%;
24+
min-width: var(--pst-sidebar-secondary);
25+
}
26+

‎docker/Dockerfile‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ RUN --mount=type=bind,source=.,destination=/x,rw /x/tools/packman/python.sh -m p
2121
-t /tmp/extension \
2222
sphinx-copybutton \
2323
nvidia-sphinx-theme \
24-
pydata-sphinx-theme
24+
pydata-sphinx-theme \
25+
linuxdoc
2526

2627
RUN (cd /tmp/extension; tar cf - . ) | (cd /var/tmp/packman/chk/sphinx/4.5.0.2-py3.7-linux-x86_64/; tar xf -)
2728
RUN rm -rf /tmp/extension
29+
30+
RUN --mount=type=bind,target=/work echo 'alias build-docs="./repo docs"' >> ~/.bashrc

‎gpu-operator/life-cycle-policy.rst‎

Lines changed: 84 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The product life cycle and versioning are subject to change in the future.
4747

4848
.. note::
4949

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

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

84-
.. list-table::
85-
:header-rows: 1
84+
**D** = Default driver, **R** = Recommended driver
85+
86+
.. flat-table::
87+
:header-rows: 2
8688

87-
* - Component
88-
- Version
89+
* - :rspan:`1` Component
90+
- :cspan:`4` GPU Operator Version
8991

90-
* - NVIDIA GPU Operator
91-
- ${version}
92+
* - v25.3.4
93+
- v25.3.3
94+
- v25.3.2
95+
- v25.3.1
96+
- v25.3.0
9297

9398
* - NVIDIA GPU Driver |ki|_
94-
- | `580.82.07 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-82-07/index.html>`_ (default, recommended)
99+
- | `580.82.07 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-82-07/index.html>`_ (**D**, **R**)
100+
| `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_
101+
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
102+
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_
103+
| `570.158.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-158-01/index.html>`_
104+
| `570.148.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-148-08/index.html>`_
105+
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
106+
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
107+
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
108+
- | `580.82.07 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-82-07/index.html>`_ (**D**, **R**)
95109
| `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_
96110
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
97111
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_
@@ -100,53 +114,100 @@ Refer to :ref:`Upgrading the NVIDIA GPU Operator` for more information.
100114
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
101115
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
102116
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
117+
- | `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_ (**R**)
118+
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
119+
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_ (**D**)
120+
| `570.158.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-158-01/index.html>`_
121+
| `570.148.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-148-08/index.html>`_
122+
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
123+
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
124+
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
125+
- | `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_ (**R**)
126+
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
127+
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_ (**D**)
128+
| `570.158.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-158-01/index.html>`_
129+
| `570.148.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-148-08/index.html>`_
130+
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
131+
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
132+
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
133+
- | `580.65.06 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-580-65-06/index.html>`_ (**R**)
134+
| `575.57.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-575-57-08/index.html>`_
135+
| `570.172.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-172-08/index.html>`_ (**D**)
136+
| `570.158.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-158-01/index.html>`_
137+
| `570.148.08 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-570-148-08/index.html>`_
138+
| `550.163.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-550-163-01/index.html>`_
139+
| `535.261.03 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-261-03/index.html>`_
140+
| `535.247.01 <https://docs.nvidia.com/datacenter/tesla/tesla-release-notes-535-247-01/index.html>`_
103141
104142
* - NVIDIA Driver Manager for Kubernetes
105-
- `v0.8.1 <https://ngc.nvidia.com/catalog/containers/nvidia:cloud-native:k8s-driver-manager>`__
143+
- :cspan:`1` `v0.8.1 <https://ngc.nvidia.com/catalog/containers/nvidia:cloud-native:k8s-driver-manager>`__
144+
- :cspan:`2` `v0.8.0 <https://ngc.nvidia.com/catalog/containers/nvidia:cloud-native:k8s-driver-manager>`__
106145

107146
* - NVIDIA Container Toolkit
108-
- `1.17.8 <https://github.com/NVIDIA/nvidia-container-toolkit/releases>`__
147+
- :cspan:`3` `1.17.8 <https://github.com/NVIDIA/nvidia-container-toolkit/releases>`__
148+
- `1.17.5 <https://github.com/NVIDIA/nvidia-container-toolkit/releases>`__
109149

110150
* - NVIDIA Kubernetes Device Plugin
111-
- `0.17.4 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
151+
- :cspan:`1` `0.17.4 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
152+
- `0.17.3 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
153+
- `0.17.2 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
154+
- `0.17.1 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
112155

113156
* - DCGM Exporter
114-
- `4.3.1-4.4.0 <https://github.com/NVIDIA/dcgm-exporter/releases>`__
157+
- :cspan:`1` `4.3.1-4.4.0 <https://github.com/NVIDIA/dcgm-exporter/releases>`__
158+
- :cspan:`1` `4.2.3-4.1.3 <https://github.com/NVIDIA/dcgm-exporter/releases>`__
159+
- `4.1.1-4.0.4 <https://github.com/NVIDIA/dcgm-exporter/releases>`__
115160

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

119165
* - | NVIDIA GPU Feature Discovery
120166
| for Kubernetes
121-
- `0.17.4 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
167+
- :cspan:`1` `0.17.4 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
168+
- `0.17.3 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
169+
- `0.17.3 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
170+
- `0.17.1 <https://github.com/NVIDIA/k8s-device-plugin/releases>`__
122171

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

126177
* - DCGM
127-
- `4.3.1 <https://docs.nvidia.com/datacenter/dcgm/latest/release-notes/changelog.html>`__
178+
- :cspan:`1` `4.3.1 <https://docs.nvidia.com/datacenter/dcgm/latest/release-notes/changelog.html>`__
179+
- :cspan:`1` `4.2.3 <https://docs.nvidia.com/datacenter/dcgm/latest/release-notes/changelog.html>`__
180+
- `4.1.1-2 <https://docs.nvidia.com/datacenter/dcgm/latest/release-notes/changelog.html>`__
128181

129182
* - Validator for NVIDIA GPU Operator
130-
- ${version}
183+
- v25.3.4
184+
- v25.3.3
185+
- v25.3.2
186+
- v25.3.1
187+
- v25.3.0
131188

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

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

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

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

144203
* - | NVIDIA Confidential Computing
145204
| Manager for Kubernetes
146-
- v0.1.1
205+
- :cspan:`4` v0.1.1
147206

148207
* - NVIDIA GDRCopy Driver
149-
- `v2.5.1 <https://github.com/NVIDIA/gdrcopy/releases>`__
208+
- :cspan:`1` `v2.5.1 <https://github.com/NVIDIA/gdrcopy/releases>`__
209+
- :cspan:`1` `v2.5.0 <https://github.com/NVIDIA/gdrcopy/releases>`__
210+
- `v2.4.4 <https://github.com/NVIDIA/gdrcopy/releases>`__
150211

151212
.. _known-issue:
152213

‎repo.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ sphinx_conf_py_extra = """
2828
]
2929
templates_path = ['${root}/templates']
3030
extensions.extend([
31+
"linuxdoc.rstFlatTable",
3132
"sphinx.ext.autosectionlabel",
3233
"sphinx_copybutton",
3334
])
@@ -167,7 +168,7 @@ docs_root = "${root}/gpu-operator"
167168
project = "gpu-operator"
168169
name = "NVIDIA GPU Operator"
169170
version = "25.3"
170-
source_substitutions = { version = "v25.3.4", recommended = "580.82.07" }
171+
source_substitutions = { minor_version = "25.3", version = "v25.3.4", recommended = "580.82.07" }
171172
copyright_start = 2020
172173
sphinx_exclude_patterns = [
173174
"life-cycle-policy.rst",

0 commit comments

Comments
 (0)