docs(gateway-config): fix stale community sandbox image path - #2800
docs(gateway-config): fix stale community sandbox image path#2800lunarwhite wants to merge 2 commits into
Conversation
elezar
left a comment
elezar
left a comment
There was a problem hiding this comment.
As a general nit: Could we use ghcr.io/nvidia/openshell-community/sandboxes/base:latest` everywhere?
The only place we use versions are in tests and I don't think they're relevant there. (I may be missing something though).
e626bd8 to
d957084
Compare
|
Hi @elezar, would you please take a relook at this change? Thank you |
Signed-off-by: Yuedong Wu <dwcn22@outlook.com>
Rebasing onto main surfaced four more instances of the same dead ghcr.io/nvidia/openshell/sandbox path, introduced by commits merged after this branch was opened: three test fixtures (driver-docker, openshell-ocsf, compute::mod) and one user-facing default in the SPIFFE token-exchange Podman demo README. Correct all four to ghcr.io/nvidia/openshell-community/sandboxes/base, consistent with the rest of this fix. Signed-off-by: Yuedong Wu <dwcn22@outlook.com>
d957084 to
41ab22f
Compare
|
Hi @johntmyers, I'd be grateful if you could also review and approve this Docs-Fix PR. It should be straightforward. I just did a fresh rebase and found that the same dead path had been introduced by other commits that were merged while this PR was open. This included a real user-facing default: |
elezar
left a comment
elezar
left a comment
There was a problem hiding this comment.
Reviewed: this consistently replaces the retired sandbox registry path with the canonical community base image. No blocking concerns found.
|
/ok-to-test 41ab22f |
2 participants
Summary
default_image/bootstrap_imageexamples ingateway-config.mdx, RFC, and theopenshell-servertest fixtures point atghcr.io/nvidia/openshell/sandbox, which #267 removed from this repo in favor of NVIDIA/OpenShell-Community. Pulling that path now returns403 denied(confirmed registry-side, not environment-specific: siblinggateway/supervisor/helm-chartimages return200for the same anonymous request).This isn't a narrow doc corner:
default_imageis shared config across all four existing compute drivers (Docker, Podman, Kubernetes, VM) plus any new driver under development, and it's the first non-trivial example value in the "Shared driver defaults" block at the top of the canonical reference doc every driver README points to. I surfaced while building a new experimental compute driver locally. I have verified end-to-end the corrected path passed a full sandbox lifecycle (sandbox create -> exec -> delete) test against a live daemon, on both a cache-miss pull/convert and a cache-hit resolution of the same digest.Related Issue
N/A. No behavior change.
Changes
Changes
docs/reference/gateway-config.mdx: update all 6default_image/bootstrap_imageexamples toghcr.io/nvidia/openshell-community/sandboxes/base:latest,rfc/0003-gateway-configuration/README.md: update the 5default_imageexamples to the same pathcrates/openshell-server/src/config_file.rs: update the doc-comment example and test fixture strings to the corrected path to avoid future confusion:0.9,:0.9.0) fromdefault_imageexamples in favor of:latest(community sandbox images only ever publishlatest/git-SHA tags, not semver)mainsurfaced four more instances of the same dead path added by commits merged while this PR was open, fixed test fixtures incrates/openshell-driver-docker/src/tests.rs,crates/openshell-ocsf/tests/roundtrip.rs, andcrates/openshell-server/src/compute/mod.rs, plus a real, user-facingSANDBOX_IMAGEdefault inexamples/spiffe-token-exchange-demo/podman/README.mdTesting
mise run pre-commitpassesChecklist