Skip to content

docs: point image and Helm chart references at Quay - #5825

Draft
SDAChess wants to merge 1 commit into
chore/4554-deploy-quay-images/SDAChessfrom
docs/4554-quay-image-docs/SDAChess
Draft

SDAChess wants to merge 1 commit into
chore/4554-deploy-quay-images/SDAChessfrom
docs/4554-quay-image-docs/SDAChess

Conversation

@SDAChess

Copy link
Copy Markdown
Contributor

Summary

Updates the published docs, RPM guides, skills and examples to install images and Helm charts from quay.io/ai-openshell, and adds an upgrade page for the registry move.

Draft until the transfer is done. It merges after the transfer, together with or after #5822 to #5824, once releases publish to Quay. Stacked on #5824.

Related Issue

Refs #4554

Changes

  • Published docs: oci://ghcr.io/nvidia/openshell/helm-chart becomes oci://quay.io/ai-openshell/charts/openshell, oci://ghcr.io/nvidia/openshell/openshell-workspace becomes oci://quay.io/ai-openshell/charts/openshell-workspace, and ghcr.io/nvidia/openshell/{gateway,supervisor,sandbox} becomes quay.io/ai-openshell/.... This covers installation, the Kubernetes pages, the support matrix, container deployment, image verification and the examples in docs/how-it-works/gateways/configuration.mdx.
  • New docs/upgrade/registry-move.mdx under Upgrade Guides. It lists the new locations, says that releases from before the move stay only at ghcr.io/nvidia/openshell and are not copied to Quay, says the latest and dev tags there no longer update, and covers registry allowlists, mirrors (including the Helm registry and repository split from chore(images): default released images to quay.io/ai-openshell #5822) and helm upgrade across the chart rename.
  • deploy/rpm QUICKSTART, CONFIGURATION and TROUBLESHOOTING: Quay host and images. The pinned-version example uses <version> instead of v0.0.37, which is not on Quay.
  • skills/debug-openshell-cluster: the sandbox runtime image default, and the pod selector app.kubernetes.io/name=helm-chart becomes openshell. The chart has always labelled pods openshell, so the old selector matched nothing.
  • .agents/skills/sbom, the SPIFFE Podman example and the .trivyignore.yaml justification: Quay image references.

TESTING.md keeps skopeo inspect docker://ghcr.io/nvidia/openshell/gateway:${TAG}, because it checks a historical release tag that is not on Quay.

Testing

  • Checks appropriate to the affected code and behavior pass

  • Unit tests added/updated (if applicable)

  • E2E tests added/updated (if applicable)

  • tasks/scripts/check_docs_nav.py: every page URL matches its file path.

  • fern check (fern-api 5.112.0): 0 errors. The configuration.mdx MDX warning also appears on main; the other two warnings are the skipped redirect check (no network access to FDR) and accent color contrast.

  • bash -n on the edited example scripts.

Not verified: no Fern preview render, and the SPIFFE example was not run.

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

Released images and the Helm chart move to quay.io/ai-openshell after
the repository transfer. Update the install, Kubernetes, gateway
configuration, container deployment and image verification pages, the
RPM guides, the debug-openshell-cluster skill, the SBOM skill and the
SPIFFE Podman example.

Add an upgrade page that lists the new locations, says older versions
stay at ghcr.io/nvidia/openshell with frozen latest and dev tags, and
covers registry allowlists, mirrors and the chart rename.

Also fix the debug-openshell-cluster pod selector, which used the
helm-chart name although the chart labels pods
app.kubernetes.io/name=openshell.

Refs #4554

Signed-off-by: Simon Scatton <sscatton@nvidia.com>
@github-actions github-actions Bot added the state:accepted A maintainer decided OpenShell should pursue this issue label Nov 20, 2026
@github-actions

Copy link
Copy Markdown

This branch has not been deployed

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

Labels

state:accepted A maintainer decided OpenShell should pursue this issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant