Skip to content

Commit e5faf92

Browse files
committed
shell-docs: document optional schema migrations Step in self-hosting
The Helm chart supports running schema migrations as a pre-install Job (disabled by default). Document the opt-in path and the verification behavior so operators can decide whether to enable it.
1 parent c5d2a06 commit e5faf92

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

showcase/shell-docs/src/content/docs/premium/self-hosting.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,19 @@ Before starting, make sure the following are in place. The [How the Intelligence
191191
The exact Secret names referenced in your values file must match whatever you create.
192192
</Step>
193193

194+
<Step>
195+
### (Optional) Enable schema migrations
196+
197+
The chart can run database schema migrations as a pre-install `Job`. This is **disabled by default** (`migrations.enabled: false`). If you want the chart to apply migrations for you on install, set the following in `my-values.yaml`:
198+
199+
```yaml title="my-values.yaml"
200+
migrations:
201+
enabled: true
202+
```
203+
204+
With this enabled, `helm install` blocks the rollout until the migrations Job reports `Completed`. Leave it disabled if you manage schema migrations out-of-band (for example, via your existing CI/CD or DBA pipeline).
205+
</Step>
206+
194207
<Step>
195208
### Install the chart
196209

@@ -203,7 +216,7 @@ Before starting, make sure the following are in place. The [How the Intelligence
203216
--timeout 10m
204217
```
205218

206-
`--wait` blocks until the `Deployments` report healthy replicas; `--timeout 10m` allows enough time for image pulls and the initial database migration job.
219+
`--wait` blocks until the `Deployments` report healthy replicas; `--timeout 10m` allows enough time for image pulls and (if you enabled it in the previous step) the initial database migration job.
207220
</Step>
208221

209222
<Step>
@@ -216,7 +229,7 @@ Before starting, make sure the following are in place. The [How the Intelligence
216229
kubectl get ingress -n copilot-intelligence
217230
```
218231

219-
You should see `app-api`, `app-frontend`, and — if enabled — `realtime-gateway` pods running. The migrations `Job` will appear as `Completed`.
232+
You should see `app-api`, `app-frontend`, and — if enabled — `realtime-gateway` pods running. If you opted into migrations (`migrations.enabled: true`, see the values step above), the migrations `Job` will also appear as `Completed`; if you left migrations disabled, no Job is created.
220233

221234
Confirm the API health check reports `ok`:
222235

0 commit comments

Comments
 (0)