Skip to content

Add short cu12/cu13 Docker tag aliases and update docs#1370

Open
rgsl888prabhu wants to merge 2 commits into
mainfrom
docs/simplify-docker-image-tags
Open

Add short cu12/cu13 Docker tag aliases and update docs#1370
rgsl888prabhu wants to merge 2 commits into
mainfrom
docs/simplify-docker-image-tags

Conversation

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator

Publishes short cu<major> Docker image tags (latest-cu12, latest-cu13, <version>-cu12/cu13) as aliases of the existing fully-qualified -cuda<minor>-py<py> tags, matching the pip/conda wheel suffix convention. The fully-qualified tags are unchanged — this is purely additive on the publish side.

Docs (README, install-selector, NIM operator examples, gRPC examples) and the regression config now lead with the short tags.

Note: short aliases only exist for builds after this change lands (26.6.0+). Skill docs/evals are tracked in #1369.

🤖 Generated with Claude Code

Publish short `cu<major>` image tags (latest-cu12, latest-cu13,
<version>-cu12/cu13) as aliases of the existing fully-qualified
`-cuda<minor>-py<py>` tags, matching the pip/conda wheel suffix
convention. The fully-qualified tags are kept unchanged.

Update the user-facing docs (README, install-selector, NIM operator
examples, gRPC examples) and the regression config to lead with the
short tags. Skill docs/evals are tracked separately in #1369.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Jun 2, 2026

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@rgsl888prabhu rgsl888prabhu self-assigned this Jun 3, 2026
@rgsl888prabhu rgsl888prabhu added breaking Introduces a breaking change improvement Improves an existing functionality labels Jun 3, 2026
@rgsl888prabhu rgsl888prabhu marked this pull request as ready for review June 3, 2026 20:09
@rgsl888prabhu rgsl888prabhu requested review from a team as code owners June 3, 2026 20:09
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR standardizes cuOpt Docker image tagging from verbose CUDA/Python-specific formats to simplified tags based on CUDA major version (cu12, cu13). The manifest generation script creates the new tags, documentation explains the scheme, interactive tooling generates commands using the new tags, and deployment examples demonstrate their usage.

Changes

Docker image tagging scheme migration from CUDA/Python-suffixed to simplified tags

Layer / File(s) Summary
Multi-architecture manifest generation for simplified tags
ci/docker/create_multiarch_manifest.sh
Docker manifest script derives CUDA_MAJOR from CUDA_SHORT and generates additional multi-architecture manifest tags ending with -cu${CUDA_MAJOR} for both Docker Hub and NVCR staging, alongside existing per-architecture cuda${CUDA_SHORT}-py${PYTHON_SHORT} image references.
Documentation of new tagging scheme
README.md, docs/cuopt/source/cuopt-grpc/advanced.rst, docs/cuopt/source/cuopt-server/nim-operator/configuration.rst
README.md documents the new latest-cu12/latest-cu13 and <version>-cu12/<version>-cu13 tagging scheme with nightly variants. Advanced gRPC and NIM operator configuration documentation updated with example tags using the new format.
Install selector command generation updates
docs/cuopt/source/_static/install-selector.js
Install selector JavaScript updates container command templates to generate docker pull and docker run commands with new stable tags (latest-cu12/latest-cu13) and nightly tags for both library and server interfaces, with default fallback tag updated to latest-cu12.
Deployment configurations and examples
docs/cuopt/source/cuopt-server/nim-operator/guide/cuopt-nimservice-full.yaml, docs/cuopt/source/cuopt-server/nim-operator/guide/cuopt-nimservice.yaml, docs/cuopt/source/cuopt-server/nim-operator/guide/deploy.sh, regression/config.sh
NIM operator YAML manifests, deployment script, and regression test configuration updated to use the new versioned image tags (26.6.0-cu12 for stable, 26.6.0a-cu12 for nightly).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested labels

doc, non-breaking

Suggested reviewers

  • bdice
  • Iroy30
  • tmckayus
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding short cu12/cu13 Docker tag aliases and updating documentation to use them.
Description check ✅ Passed The description clearly explains the changeset: publishing short Docker tag aliases for CUDA versions alongside existing fully-qualified tags, and updating docs to use the new tags.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/simplify-docker-image-tags

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
README.md (1)

139-141: ⚡ Quick win

Consider clarifying Python version selection for short tags.

The documentation explains the new simplified tags but doesn't specify which Python version the short tags (e.g., latest-cu12, 26.6.0-cu12) correspond to when multiple Python versions are supported. Users may need to know whether latest-cu12 uses Python 3.13, 3.14, or the latest supported version.

Consider adding a sentence like: "Short tags use the latest supported Python version for that release" or similar guidance.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 139 - 141, Clarify which Python version short Docker
tags map to by adding a sentence in the README where you describe short tags
(references: "latest", "<version>-cu12", "<version>-cu13", and examples like
"26.6.0-cu12"); state that short tags implicitly use the latest supported Python
minor for that CUDA/release (e.g., "Short tags use the latest supported Python
version for that release") and optionally add a note pointing readers to the
fully-qualified tags (e.g., "26.6.0-cuda12.9-py3.14") if they need to pin a
specific Python version.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@README.md`:
- Around line 139-141: Clarify which Python version short Docker tags map to by
adding a sentence in the README where you describe short tags (references:
"latest", "<version>-cu12", "<version>-cu13", and examples like "26.6.0-cu12");
state that short tags implicitly use the latest supported Python minor for that
CUDA/release (e.g., "Short tags use the latest supported Python version for that
release") and optionally add a note pointing readers to the fully-qualified tags
(e.g., "26.6.0-cuda12.9-py3.14") if they need to pin a specific Python version.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 0f0aab88-406d-4e9e-ad46-d557fe362748

📥 Commits

Reviewing files that changed from the base of the PR and between c4e878d and b9e4eb6.

📒 Files selected for processing (9)
  • README.md
  • ci/docker/create_multiarch_manifest.sh
  • docs/cuopt/source/_static/install-selector.js
  • docs/cuopt/source/cuopt-grpc/advanced.rst
  • docs/cuopt/source/cuopt-server/nim-operator/configuration.rst
  • docs/cuopt/source/cuopt-server/nim-operator/guide/cuopt-nimservice-full.yaml
  • docs/cuopt/source/cuopt-server/nim-operator/guide/cuopt-nimservice.yaml
  • docs/cuopt/source/cuopt-server/nim-operator/guide/deploy.sh
  • regression/config.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking Introduces a breaking change improvement Improves an existing functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant