Repository navigation
Conversation
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>
|
🌿 Preview your docs: https://nvidia-preview-pr-5825.docs.buildwithfern.com/openshell |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
oci://ghcr.io/nvidia/openshell/helm-chartbecomesoci://quay.io/ai-openshell/charts/openshell,oci://ghcr.io/nvidia/openshell/openshell-workspacebecomesoci://quay.io/ai-openshell/charts/openshell-workspace, andghcr.io/nvidia/openshell/{gateway,supervisor,sandbox}becomesquay.io/ai-openshell/.... This covers installation, the Kubernetes pages, the support matrix, container deployment, image verification and the examples indocs/how-it-works/gateways/configuration.mdx.docs/upgrade/registry-move.mdxunder Upgrade Guides. It lists the new locations, says that releases from before the move stay only atghcr.io/nvidia/openshelland are not copied to Quay, says thelatestanddevtags 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) andhelm upgradeacross the chart rename.deploy/rpmQUICKSTART, CONFIGURATION and TROUBLESHOOTING: Quay host and images. The pinned-version example uses<version>instead ofv0.0.37, which is not on Quay.skills/debug-openshell-cluster: the sandbox runtime image default, and the pod selectorapp.kubernetes.io/name=helm-chartbecomesopenshell. The chart has always labelled podsopenshell, so the old selector matched nothing..agents/skills/sbom, the SPIFFE Podman example and the.trivyignore.yamljustification: Quay image references.TESTING.mdkeepsskopeo 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. Theconfiguration.mdxMDX warning also appears onmain; the other two warnings are the skipped redirect check (no network access to FDR) and accent color contrast.bash -non the edited example scripts.Not verified: no Fern preview render, and the SPIFFE example was not run.
Checklist