Skip to content

Commit 30b68b1

Browse files
committed
fix(shell-docs): correct premium walkthrough on opt-in migrations Job
The Helm chart's `migrations.enabled` value defaults to `false`, but the install walkthrough and overview prose both implied the pre-install migrations Job always runs. Realign the docs with what the chart actually does: - intelligence-platform: rewrite the "Install" prose to describe the Job as conditional on `migrations.enabled: true`. - self-hosting: add a new step in the install walkthrough between "Create secrets" and "Install the chart" that explains how to opt into migrations and when to leave them disabled. Update the "Verify the install" prose so it only claims a Completed Job if the reader opted in, and adjust the `--timeout` rationale to match.
1 parent 4be2770 commit 30b68b1

2 files changed

Lines changed: 16 additions & 3 deletions

File tree

showcase/shell-docs/src/content/docs/premium/intelligence-platform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Every meaningful configuration value that is sensitive — database URL, Redis U
5656

5757
### Install
5858

59-
A `helm install` creates one namespace (by default `copilot-intelligence`), the Deployments above, their Services and ServiceAccounts, PodDisruptionBudgets, HorizontalPodAutoscalers, an Ingress resource, and any `ExternalSecret` resources you enabled. A pre-install `Job` runs schema migrations against your Postgres database; the chart blocks the rollout until migrations complete.
59+
A `helm install` creates one namespace (by default `copilot-intelligence`), the Deployments above, their Services and ServiceAccounts, PodDisruptionBudgets, HorizontalPodAutoscalers, an Ingress resource, and any `ExternalSecret` resources you enabled. If you set `migrations.enabled: true`, a pre-install `Job` runs schema migrations against your Postgres database; the chart blocks the rollout until migrations complete. The Job is opt-in (`migrations.enabled` defaults to `false`) — leave it disabled if you manage migrations out-of-band.
6060

6161
### Runtime lifecycle
6262

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)