Skip to content

docs: add container deployment guides #695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
binaryaaron merged 5 commits into from
Aug 5, 2026
Merged

docs: add container deployment guides #695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e693cc7
docs: add container deployment guides
binaryaaron Aug 3, 2026
d4ee40b
docs: restore Docker debugging shell
binaryaaron Aug 3, 2026
b5830ef
docs: clarify published container image
binaryaaron Aug 3, 2026
f47ef7e
docs: clarify runtime credential handling
binaryaaron Aug 4, 2026
b8c0641
docs: fix derived workload runtime paths
binaryaaron Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ make setup # installs pinned mise, pinned tools from mise.lock, and .venv
mise run bootstrap-nss cuda
```

### Run the public container

The published GPU runtime is available from [GitHub Container Registry](https://github.com/NVIDIA-NeMo/Safe-Synthesizer/pkgs/container/safe-synthesizer) at `ghcr.io/nvidia-nemo/safe-synthesizer`.
It runs the CLI without a local Python installation; see the [Docker guide](https://nvidia-nemo.github.io/Safe-Synthesizer/user-guide/docker/) for image tags, mounts, GPU access, and configuration.

Development tools (`dprint`, `ruff`, `ty`, `yq`, `gh`, etc.) are managed via [mise](https://mise.jdx.dev/). Tool versions are declared in `.mise.toml` and locked in `mise.lock` (committed). mise also manages environment variables -- place project-local secrets or overrides in `.env` or `.env.local` (both git-ignored, auto-loaded by mise).

For IDEs to discover mise-managed tools, [add mise shims to the `PATH` in your default shell profile](https://mise.jdx.dev/ide-integration.html#adding-shims-to-path-in-your-default-shell).
Expand Down
4 changes: 3 additions & 1 deletion containers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,9 @@ CONTAINER_GPU_PLATFORM=linux/arm64 mise run container:build:gpu
Multi-platform manifests must be pushed to a registry:

```bash
CONTAINER_GPU_REGISTRY=ghcr.io/nvidia-nemo mise run container:build:gpu-multiarch
CONTAINER_GPU_REGISTRY=registry.example.com/team \
CONTAINER_GPU_IMAGE=safe-synthesizer:custom-cu129 \
mise run container:build:gpu-multiarch
```

This builds and pushes `$(CONTAINER_GPU_REGISTRY)/$(CONTAINER_GPU_IMAGE)`.
Expand Down
6 changes: 4 additions & 2 deletions docs/developer-guide/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,15 +277,17 @@ single tag. Clients pull the correct variant automatically. Because
directly to a registry:

```bash
CONTAINER_GPU_REGISTRY=ghcr.io/nvidia-nemo mise run container:build:gpu-multiarch
CONTAINER_GPU_REGISTRY=registry.example.com/team \
CONTAINER_GPU_IMAGE=safe-synthesizer:custom-cu129 \
mise run container:build:gpu-multiarch
```

This runs:

```bash
docker buildx build \
--platform linux/amd64,linux/arm64 \
--tag ghcr.io/nvidia-nemo/nss-gpu:latest \
--tag registry.example.com/team/safe-synthesizer:custom-cu129 \
--target runtime --push \
-f containers/Dockerfile.cuda .
```
Expand Down
Loading
Loading