Skip to content

Commit 52eaa9a

Browse files
committed
docs(helm): document the Helm repository now that charts.sim.ai serves
Held these back until the hostname actually resolved, because shipping an install command that points at a dead domain is the exact failure this work exists to remove. It resolves now: DNS is in place, GitHub Pages serves the branch, and Let's Encrypt has issued the certificate. Verified end to end rather than assumed: helm repo add sim https://charts.sim.ai helm repo update # Successfully got an update Presents OCI as the preferred path in both places and the repository as the compatibility path, and says plainly that the signature and provenance are attached to the OCI artifact only -- `helm repo add` has no equivalent, and leaving that implicit would let someone believe they had verified something they had not. Bumps to 1.9.3 per the chart's own gate, since this touches helm/sim/.
1 parent 4352ce7 commit 52eaa9a

3 files changed

Lines changed: 63 additions & 15 deletions

File tree

apps/docs/content/docs/platform/self-hosting/kubernetes.mdx

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,12 @@ import { FAQ } from '@/components/ui/faq'
2222
## Installation
2323

2424
The chart is published to GitHub Container Registry as an OCI artifact at
25-
`oci://ghcr.io/simstudioai/charts/sim`. Install it directly — no clone, and no
26-
`helm repo add`.
25+
`oci://ghcr.io/simstudioai/charts/sim`. Install it directly — no clone required.
26+
27+
It is also available from a classic Helm repository at `https://charts.sim.ai`
28+
for tooling that expects one; see [Helm repository](#helm-repository) below.
29+
Prefer OCI where you can, since the signature and provenance are attached to the
30+
OCI artifact.
2731

2832
```bash
2933
# Generate secrets
@@ -36,7 +40,7 @@ POSTGRES_PASSWORD=$(openssl rand -hex 24)
3640

3741
# Install
3842
helm install sim oci://ghcr.io/simstudioai/charts/sim \
39-
--version 1.9.2 \
43+
--version 1.9.3 \
4044
--set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
4145
--set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
4246
--set app.env.INTERNAL_API_SECRET="$INTERNAL_API_SECRET" \
@@ -58,16 +62,36 @@ helm install sim oci://ghcr.io/simstudioai/charts/sim \
5862
This installs the chart's default image tag. For production, **pin `app`, `realtime`, and `migrations` to the same explicit release tag** — see [Upgrades](/platform/self-hosting/upgrades).
5963
</Callout>
6064

65+
## Helm repository
66+
67+
For clusters or GitOps configs that consume `helm repo add` rather than OCI:
68+
69+
```bash
70+
helm repo add sim https://charts.sim.ai
71+
helm repo update
72+
73+
helm install sim sim/sim --version 1.9.3 --namespace simstudio --create-namespace \
74+
--set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
75+
--set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
76+
--set app.env.INTERNAL_API_SECRET="$INTERNAL_API_SECRET" \
77+
--set app.env.API_ENCRYPTION_KEY="$API_ENCRYPTION_KEY" \
78+
--set app.env.CRON_SECRET="$CRON_SECRET" \
79+
--set postgresql.auth.password="$POSTGRES_PASSWORD"
80+
```
81+
82+
It serves the same chart as the OCI registry. The signature and provenance below
83+
apply to the OCI artifact only.
84+
6185
## Verifying the chart
6286

6387
Every published version is signed with Sigstore keyless signing and carries a SLSA build-provenance attestation. Both live in the registry alongside the chart, so they survive a mirror into an internal registry.
6488

6589
```bash
66-
cosign verify oci://ghcr.io/simstudioai/charts/sim:1.9.2 \
90+
cosign verify oci://ghcr.io/simstudioai/charts/sim:1.9.3 \
6791
--certificate-identity-regexp '^https://github.com/simstudioai/sim/' \
6892
--certificate-oidc-issuer https://token.actions.githubusercontent.com
6993

70-
gh attestation verify oci://ghcr.io/simstudioai/charts/sim:1.9.2 --repo simstudioai/sim
94+
gh attestation verify oci://ghcr.io/simstudioai/charts/sim:1.9.3 --repo simstudioai/sim
7195
```
7296

7397
Signing is Sigstore-only — there is no GPG `.prov` file, so `helm install --verify` does not apply.
@@ -88,7 +112,7 @@ SIM_RELEASE=v0.8.24
88112
curl -fsSLO "https://raw.githubusercontent.com/simstudioai/sim/$SIM_RELEASE/helm/sim/examples/values-aws.yaml"
89113

90114
helm upgrade --install sim oci://ghcr.io/simstudioai/charts/sim \
91-
--version 1.9.2 \
115+
--version 1.9.3 \
92116
--values values-aws.yaml \
93117
--set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
94118
--set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
@@ -209,7 +233,7 @@ kubectl port-forward deployment/sim-app 3000:3000 -n simstudio
209233
kubectl logs -l app.kubernetes.io/component=app -n simstudio --tail=100
210234
211235
# Upgrade (always pin the target chart version)
212-
helm upgrade sim oci://ghcr.io/simstudioai/charts/sim --version 1.9.2 --namespace simstudio
236+
helm upgrade sim oci://ghcr.io/simstudioai/charts/sim --version 1.9.3 --namespace simstudio
213237
214238
# Uninstall
215239
helm uninstall sim --namespace simstudio

helm/sim/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: sim
33
description: A Helm chart for Sim - the open-source AI workspace where teams build, deploy, and manage AI agents
44
type: application
5-
version: 1.9.2
5+
version: 1.9.3
66
appVersion: "v0.8.18"
77
kubeVersion: ">=1.25.0-0"
88
home: https://sim.ai

helm/sim/README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Deploy [Sim](https://sim.ai) — the open-source AI workspace where teams build, deploy, and manage AI agents — on Kubernetes.
44

55
* **Registry:** `oci://ghcr.io/simstudioai/charts/sim`
6+
* **Helm repository:** `https://charts.sim.ai`
67
* **Chart version:** see `Chart.yaml`
78
* **App version:** tracks the upstream Sim release
89
* **Kubernetes:** 1.25+
@@ -22,7 +23,7 @@ export POSTGRES_PASSWORD=$(openssl rand -base64 24 | tr -d '/+=')
2223

2324
# Install from the registry
2425
helm install sim oci://ghcr.io/simstudioai/charts/sim \
25-
--version 1.9.2 \
26+
--version 1.9.3 \
2627
--namespace sim --create-namespace \
2728
--set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
2829
--set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
@@ -106,10 +107,10 @@ immutable once published.
106107

107108
```bash
108109
# List the published versions
109-
helm show chart oci://ghcr.io/simstudioai/charts/sim --version 1.9.2
110+
helm show chart oci://ghcr.io/simstudioai/charts/sim --version 1.9.3
110111

111112
helm install sim oci://ghcr.io/simstudioai/charts/sim \
112-
--version 1.9.2 \
113+
--version 1.9.3 \
113114
--namespace sim --create-namespace \
114115
--set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
115116
--set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
@@ -126,13 +127,36 @@ To mirror the chart into an internal registry — the usual requirement for an
126127
air-gapped or internal-only cluster:
127128

128129
```bash
129-
helm pull oci://ghcr.io/simstudioai/charts/sim --version 1.9.2
130-
helm push sim-1.9.2.tgz oci://registry.internal.example.com/charts
130+
helm pull oci://ghcr.io/simstudioai/charts/sim --version 1.9.3
131+
helm push sim-1.9.3.tgz oci://registry.internal.example.com/charts
131132
```
132133

133134
The container images the chart references are listed in
134135
[`images.yaml`](./images.yaml); mirror those alongside it.
135136

137+
### From the Helm repository
138+
139+
The chart is also published to a classic Helm repository, for clusters and
140+
tooling that consume `helm repo add` rather than OCI.
141+
142+
```bash
143+
helm repo add sim https://charts.sim.ai
144+
helm repo update
145+
146+
helm install sim sim/sim \
147+
--version 1.9.3 \
148+
--namespace sim --create-namespace \
149+
--set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
150+
--set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
151+
--set app.env.INTERNAL_API_SECRET="$INTERNAL_API_SECRET" \
152+
--set app.env.CRON_SECRET="$CRON_SECRET" \
153+
--set postgresql.auth.password="$POSTGRES_PASSWORD"
154+
```
155+
156+
Both paths serve the same chart. Prefer OCI where you can: the signature and
157+
provenance described in [Verifying the chart](#verifying-the-chart) are attached
158+
to the OCI artifact, and `helm repo add` has no equivalent.
159+
136160
### From a checkout
137161

138162
```bash
@@ -177,12 +201,12 @@ the registry next to the chart so they survive a mirror.
177201

178202
```bash
179203
# The signature: proves this chart was signed by a GitHub Actions run in this repo
180-
cosign verify oci://ghcr.io/simstudioai/charts/sim:1.9.2 \
204+
cosign verify oci://ghcr.io/simstudioai/charts/sim:1.9.3 \
181205
--certificate-identity-regexp '^https://github.com/simstudioai/sim/' \
182206
--certificate-oidc-issuer https://token.actions.githubusercontent.com
183207

184208
# The provenance: proves which workflow, commit, and runner produced it
185-
gh attestation verify oci://ghcr.io/simstudioai/charts/sim:1.9.2 --repo simstudioai/sim
209+
gh attestation verify oci://ghcr.io/simstudioai/charts/sim:1.9.3 --repo simstudioai/sim
186210
```
187211

188212
There is no GPG `.prov` file — signing is Sigstore-only, so there is no

0 commit comments

Comments
 (0)