Skip to content

Commit 05b6f73

Browse files
committed
docs: correct bundled-component defaults and object-storage config keys
1 parent 07ca2d2 commit 05b6f73

1 file changed

Lines changed: 8 additions & 11 deletions

File tree

docs/self-hosting/kubernetes.mdx

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ flowchart TD
3535
workers --> reg
3636
```
3737

38-
Each component maps to a top-level key in `values.yaml`: `webapp`, `supervisor`, `postgres`, `redis`, `clickhouse`, `minio`/`s3`, `registry`, and `s2`. Bundled datastores carry a `deploy: true` default; setting `deploy: false` and an `external` block swaps in your own. Webapp and supervisor behaviour is driven by `config` and `extraEnvVars`.
38+
Each component maps to a top-level key in `values.yaml`: `webapp`, `supervisor`, `postgres`, `redis`, `electric`, `clickhouse`, `s3` (object storage), `s2`, and `registry`. The datastores default to `deploy: true` and run in-cluster; set `deploy: false` with an `external` block to bring your own. The registry is the exception - it defaults to `deploy: false`, so you point it at an external one. Webapp and supervisor behaviour is driven by `config` and `extraEnvVars`.
3939

4040
## Requirements
4141

@@ -91,7 +91,7 @@ Bundled datastores let you run the whole stack with a single command and no exte
9191
--create-namespace
9292
```
9393

94-
The chart deploys the webapp, supervisor, and bundled Postgres, Redis, ClickHouse, MinIO, registry, and s2-lite.
94+
The chart deploys the webapp, supervisor, and bundled Postgres, Redis, Electric, ClickHouse, MinIO, and s2-lite. The registry is not deployed by default - configure an external one before deploying tasks.
9595
</Step>
9696

9797
<Step title="Port-forward the webapp">
@@ -121,7 +121,7 @@ Confirm every component reached a healthy state:
121121
kubectl get pods -n trigger
122122
```
123123

124-
The webapp, supervisor, and each bundled datastore pod should report `Running` with all containers `READY`, and the bootstrap and migration jobs should show `Completed`. If a pod is stuck in `Pending` or `CrashLoopBackOff`, jump to [Troubleshooting](#troubleshooting).
124+
The webapp, supervisor, and each bundled datastore pod should report `Running` with all containers `READY`. Migrations and bootstrap run inside the webapp pod rather than as separate jobs, so if the webapp stays unready, check its logs. If a pod is stuck in `Pending` or `CrashLoopBackOff`, jump to [Troubleshooting](#troubleshooting).
125125

126126
Once you can sign in and trigger a run, you've validated the stack. For a deployment that survives restarts, upgrades, and load, move on to the production install.
127127

@@ -363,9 +363,8 @@ Object storage holds deploy artifacts and large payloads. See the [Docker object
363363
**Direct configuration:**
364364

365365
```yaml
366-
minio:
367-
deploy: false
368366
s3:
367+
deploy: false
369368
external:
370369
endpoint: "https://s3.amazonaws.com"
371370
accessKeyId: "my-access-key"
@@ -375,16 +374,14 @@ s3:
375374
**Using existing secrets (recommended):**
376375

377376
```yaml
378-
minio:
379-
deploy: false
380377
s3:
378+
deploy: false
381379
external:
382380
endpoint: "https://s3.amazonaws.com"
383381
existingSecret: "s3-credentials"
384-
# Optional: Use secretKeys to specify the key names in the secret
385-
# secretKeys:
386-
# accessKeyIdKey: "access-key-id" # default
387-
# secretAccessKeyKey: "secret-access-key" # default
382+
# Optional: override the key names in the secret
383+
# existingSecretAccessKeyIdKey: "access-key-id" # default
384+
# existingSecretSecretAccessKeyKey: "secret-access-key" # default
388385
```
389386

390387
### PostgreSQL SSL with custom CA certificates

0 commit comments

Comments
 (0)