Skip to content

docs: surface official container image provenance #1339

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

Draft
ruirui6946 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: surface official container image provenance #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,20 @@ OpenSandbox is a **general-purpose sandbox platform** for AI applications, offer
- 🔑 **Credential Vault**: Secure credential injection for sandbox outbound requests without exposing real secrets to workloads. See [Credential Vault](docs/guides/credential-vault.md).
- 🏰 **Strong Isolation**: Supports secure container runtimes like gVisor, Kata Containers, and Firecracker microVM for enhanced isolation between sandbox workloads and the host. See [Secure Container Runtime Guide](docs/guides/secure-container.md) for details.

## Official Container Images

OpenSandbox release images are published under the same component name in
three official registries:

- Docker Hub: `docker.io/opensandbox/<component>`
- GitHub Container Registry: `ghcr.io/opensandbox-group/opensandbox/<component>`
- Alibaba Cloud Container Registry: `sandbox-registry.cn-zhangjiakou.cr.aliyuncs.com/opensandbox/<component>`

Tagged release images are signed keylessly with Cosign and include provenance
attestations. Pin production images by digest and follow the
[release verification guide](docs/community/release-verification.md) to verify
the image against the OpenSandbox GitHub Actions identity before deployment.

## SDKs

Python:
Expand Down
32 changes: 24 additions & 8 deletions docs/community/release-verification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ OpenSandbox uses these signing paths:
- Source code releases: the Generic Release workflow uploads an explicit
`opensandbox-<tag>.tar.gz` source archive and `SHA256SUMS` file to the GitHub
Release, then creates GitHub/Sigstore provenance attestations for both files.
- Container images: the component and server image workflows sign Docker Hub
and ACR image digests with `cosign` keyless signing, and publish provenance
attestations to the registries.
- Container images: the component and server image workflows sign Docker Hub,
GitHub Container Registry (GHCR), and Alibaba Cloud Container Registry (ACR)
image digests with `cosign` keyless signing, and publish provenance
attestations to all three registries.
- Python and CLI packages: wheels and source distributions are attested before
`uv publish`.
- JavaScript packages: the workflow runs `pnpm pack`, attests the generated npm
Expand Down Expand Up @@ -83,9 +84,9 @@ If you run the release workflows from a downstream fork, replace
`opensandbox-group/OpenSandbox` in the verification commands with that fork's
`owner/repository` identity.

Private signing material is not stored in GitHub Releases, Docker Hub, ACR,
PyPI, npm, Maven Central, NuGet, or Helm chart downloads. Java/Kotlin Maven
Central signing keys are held only in GitHub Actions secrets.
Private signing material is not stored in GitHub Releases, Docker Hub, GHCR,
ACR, PyPI, npm, Maven Central, NuGet, or Helm chart downloads. Java/Kotlin
Maven Central signing keys are held only in GitHub Actions secrets.

## Verify Source Releases

Expand Down Expand Up @@ -136,6 +137,19 @@ provenance `source-ref` is the ref selected when the workflow was dispatched
Install `cosign` and `gh`, then resolve the image digest. Always verify by
digest, not by mutable tag alone.

Release images are published with the same component name and digest in all
three official registries:

| Registry | Image name pattern |
| --- | --- |
| Docker Hub | `docker.io/opensandbox/<component>` |
| GitHub Container Registry | `ghcr.io/opensandbox-group/opensandbox/<component>` |
| Alibaba Cloud Container Registry | `sandbox-registry.cn-zhangjiakou.cr.aliyuncs.com/opensandbox/<component>` |

The component can be `execd`, `code-interpreter`, `ingress`, `egress`,
`controller`, `task-executor`, or `image-committer`. The server image uses the
component name `server`.

```bash
IMAGE="docker.io/opensandbox/execd"
TAG="v1.0.15"
Expand Down Expand Up @@ -173,10 +187,12 @@ cosign verify "$IMAGE_REF" \
--certificate-identity-regexp "^${WORKFLOW_REPOSITORY_URL}/.github/workflows/publish-server.yml@refs/tags/server/v[0-9].*$"
```

ACR images use the same digest and identity checks with the ACR image name, for
example:
GHCR and ACR images use the same digest and identity checks with their
respective image names, for example:

```bash
IMAGE="ghcr.io/opensandbox-group/opensandbox/execd"
# or
IMAGE="sandbox-registry.cn-zhangjiakou.cr.aliyuncs.com/opensandbox/execd"
```

Expand Down
Loading