task: update documentation for v26.1.2-rc.1#388
Conversation
Signed-off-by: nvidia-ci-cd <svc-cloud-orch-gh@nvidia.com>
Documentation previewhttps://mellanox.github.io/network-operator-docs/review/pr-388 |
Greptile SummaryThis is an automated documentation update for the v26.1.2-rc.1 release candidate, bumping all image versions and SHA-256 digests from v26.1.1 to v26.1.2-rc.1. Notably, every image registry reference has been changed from the production registries (
Confidence Score: 3/5The RC documentation is internally consistent for the version bump, but the wholesale switch to the staging registry and the malformed LTS driver version string need review before this goes to a wider audience. Two concrete defects exist: the doca-driver-version-lts variable was changed to a string (24.10-0.7.0.0-0) that doesn't follow the doca{version}-... convention used everywhere else and doesn't correspond to any tag visible in the SHA digest table. Additionally, all image repositories now point to nvcr.io/nvstaging/mellanox, a staging registry that is typically not publicly accessible. docs/common/vars.rst is the most important file to verify — particularly the doca-driver-version-lts value and the wholesale switch to nvcr.io/nvstaging/mellanox for all repositories. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Network Operator Docs v26.1.2-rc.1] --> B{Image Registry}
B -->|All components| C[nvcr.io/nvstaging/mellanox]
C --> D[network-operator:v26.1.2-rc.1]
C --> E[doca-driver:doca3.3.0-26.01-1.0.0.0-4]
C --> F[sriov-network-operator:network-operator-v26.1.2-rc.1]
C --> G[k8s-rdma-shared-dev-plugin:network-operator-v26.1.2-rc.1]
C --> H[multus-cni:network-operator-v26.1.2-rc.1]
C --> I[...and 15+ other components]
subgraph Previous Release v26.1.1
J[nvcr.io/nvidia/cloud-native] --> K[network-operator:v26.1.1]
L[nvcr.io/nvidia/mellanox] --> M[all other components:network-operator-v26.1.1]
end
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[Network Operator Docs v26.1.2-rc.1] --> B{Image Registry}
B -->|All components| C[nvcr.io/nvstaging/mellanox]
C --> D[network-operator:v26.1.2-rc.1]
C --> E[doca-driver:doca3.3.0-26.01-1.0.0.0-4]
C --> F[sriov-network-operator:network-operator-v26.1.2-rc.1]
C --> G[k8s-rdma-shared-dev-plugin:network-operator-v26.1.2-rc.1]
C --> H[multus-cni:network-operator-v26.1.2-rc.1]
C --> I[...and 15+ other components]
subgraph Previous Release v26.1.1
J[nvcr.io/nvidia/cloud-native] --> K[network-operator:v26.1.1]
L[nvcr.io/nvidia/mellanox] --> M[all other components:network-operator-v26.1.1]
end
Reviews (1): Last reviewed commit: "task: update documentation for v26.1.2-r..." | Re-trigger Greptile |
| .. |helm-chart-version| replace:: 26.1.2-rc.1 | ||
| .. |doca-driver-version| replace:: doca3.3.0-26.01-1.0.0.0-4 | ||
| .. |doca-driver-repository| replace:: nvcr.io/nvstaging/mellanox | ||
| .. |doca-driver-version-lts| replace:: 24.10-0.7.0.0-0 |
There was a problem hiding this comment.
Staging registry used across all documentation
Every image repository in this PR has been switched from nvcr.io/nvidia/mellanox (or nvcr.io/nvidia/cloud-native) to nvcr.io/nvstaging/mellanox. The nvstaging registry is typically access-restricted and hosts pre-release artifacts — users following these docs or applying the example YAMLs verbatim will attempt to pull from a registry they may not have credentials for, resulting in ImagePullBackOff. This affects all 13 changed files.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| .. |helm-chart-version| replace:: 26.1.2-rc.1 | ||
| .. |doca-driver-version| replace:: doca3.3.0-26.01-1.0.0.0-4 | ||
| .. |doca-driver-repository| replace:: nvcr.io/nvstaging/mellanox | ||
| .. |doca-driver-version-lts| replace:: 24.10-0.7.0.0-0 |
There was a problem hiding this comment.
LTS driver version string format changed unexpectedly
The doca-driver-version-lts value changed from doca3.2.2-25.10-2.4.1.0-4 to 24.10-0.7.0.0-0. Every other driver version string in this PR follows the doca{doca_version}-{kernel_version}-... pattern (e.g. doca3.3.0-26.01-1.0.0.0-4), but the new LTS value drops the doca prefix entirely and does not match any tag format visible in images-sha256.rst. If this variable is used to construct an image reference, the tag 24.10-0.7.0.0-0 would not resolve, leaving LTS driver deployments broken.
| .. |doca-driver-version-lts| replace:: 24.10-0.7.0.0-0 | |
| .. |doca-driver-version-lts| replace:: doca3.2.2-25.10-2.4.1.0-4 |
Created by the docs-ci job in Mellanox/network-operator-docs.