Skip to content

Commit 9a4bfaf

Browse files
committed
update docs
1 parent 078976c commit 9a4bfaf

File tree

1 file changed

+35
-19
lines changed

1 file changed

+35
-19
lines changed

docs/self-hosting/kubernetes.mdx

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ Should the burden ever get too much, we'd be happy to see you on [Trigger.dev cl
1616
### Prerequisites
1717
- Kubernetes cluster 1.19+
1818
- Helm 3.8+
19-
- Kubectl configured with cluster access
19+
- Kubectl with cluster access
2020

21-
### Resource requirements
21+
### Resources
2222

23-
The following are minimum requirements for running the entire Trigger.dev stack on Kubernetes:
23+
The following are minimum requirements for running the entire stack on Kubernetes:
2424

2525
**Cluster resources:**
2626
- 6+ vCPU total
@@ -53,11 +53,15 @@ webapp:
5353
5454
### Quick start
5555
56+
<Note>
57+
The examples in this guide do NOT use the latest chart version. Please check [this page](https://github.com/triggerdotdev/trigger.dev/pkgs/container/charts%2Ftrigger).
58+
</Note>
59+
5660
1. Install with default values (for testing only):
5761
5862
```bash
5963
helm upgrade -n trigger --install trigger \
60-
oci://ghcr.io/triggerdotdev/charts/trigger:4.0.0-beta.3 \
64+
oci://ghcr.io/triggerdotdev/charts/trigger:4.0.0-beta.5 \
6165
--create-namespace
6266
```
6367

@@ -82,8 +86,6 @@ While v4 is in beta, always use `@v4-beta` instead of `@latest`. For example: `n
8286

8387
## Configuration
8488

85-
The default installation uses insecure secrets and is only suitable for testing. You _will_ need to configure your own secrets as a bare minimum.
86-
8789
Most values map directly to the environment variables documented in the [webapp](/self-hosting/env/webapp) and [supervisor](/self-hosting/env/supervisor) environment variable overview.
8890

8991
**Naming convention:**
@@ -100,19 +102,28 @@ config:
100102
appOrigin: "https://trigger.example.com"
101103
```
102104

105+
### Default values
106+
107+
The default values are insecure and are only suitable for testing. You _will_ need to configure your own secrets as a bare minimum. The following commands will display the default values:
108+
109+
```bash
110+
helm show values oci://ghcr.io/triggerdotdev/charts/trigger:4.0.0-beta.5
111+
```
112+
103113
### Custom values
104114

105-
Create a `values-custom.yaml` file. For example:
115+
Create a `values-custom.yaml` file to override the default values. For example:
106116

107117
```yaml
108118
# Generate new secrets with `openssl rand -hex 16`
109-
# WARNING: You should probably use existingSecret instead of hardcoding here
119+
# WARNING: You should probably use an existingSecret instead
110120
secrets:
121+
enabled: true
111122
sessionSecret: "your-32-char-hex-secret-1"
112123
magicLinkSecret: "your-32-char-hex-secret-2"
113124
# ...
114125

115-
# Recommended: Use existing secret - must contain at least the following keys:
126+
# Recommended: existingSecret, must contain at least the following keys:
116127
# - SESSION_SECRET
117128
# - MAGIC_LINK_SECRET
118129
# - ENCRYPTION_KEY
@@ -153,7 +164,7 @@ Deploy with your custom values:
153164
154165
```bash
155166
helm upgrade -n trigger --install trigger \
156-
oci://ghcr.io/triggerdotdev/charts/trigger:4.0.0-beta.3 \
167+
oci://ghcr.io/triggerdotdev/charts/trigger:4.0.0-beta.5 \
157168
--create-namespace \
158169
-f values-custom.yaml
159170
```
@@ -238,7 +249,7 @@ supervisor:
238249
key: "token"
239250
```
240251
241-
## Registry Setup
252+
## Registry setup
242253
243254
See the [Docker registry setup](/self-hosting/docker#registry-setup) for conceptual information. The configuration is specified in your `values.yaml`:
244255

@@ -261,7 +272,7 @@ registry:
261272
The internal registry (`registry.external: false`) is experimental and requires proper TLS setup and additional cluster configuration. Use an external registry for production.
262273
</Note>
263274

264-
## Object Storage
275+
## Object storage
265276

266277
See the [Docker object storage setup](/self-hosting/docker#object-storage) for conceptual information. The defaults will use built-in MinIO, but you can use an external S3-compatible storage. The configuration is specified in your `values.yaml`:
267278

@@ -317,19 +328,23 @@ webapp:
317328
value: "user1@company\\.com|user2@company\\.com"
318329
```
319330

320-
## Version Locking
331+
## Version locking
321332

322333
You can lock versions in two ways:
323334

324-
**Helm Chart Version (recommended):**
335+
**Helm chart version (recommended):**
325336
```bash
326337
# Ensure specific chart version
327338
helm upgrade -n trigger --install trigger \
328-
oci://ghcr.io/triggerdotdev/charts/trigger:4.0.0-beta.3 \
329-
--version 4.0.0-beta.3
339+
oci://ghcr.io/triggerdotdev/charts/trigger:4.0.0-beta.5 \
340+
--version 4.0.0-beta.5
341+
342+
# Check the appVersion, which will be different from the chart version
343+
helm show chart \
344+
oci://ghcr.io/triggerdotdev/charts/trigger:4.0.0-beta.5 | grep appVersion
330345
```
331346

332-
**Specific Image Tags:**
347+
**Specific image tags:**
333348
```yaml
334349
webapp:
335350
image:
@@ -367,7 +382,8 @@ kubectl describe pod <pod-name> -n trigger
367382
# Delete the release
368383
helm uninstall trigger -n trigger
369384
370-
# Delete persistent volumes (if needed) - careful, this will delete all data
385+
# Delete persistent volumes (optional)
386+
# WARNING: This will delete all your data!
371387
kubectl delete pvc -l app.kubernetes.io/instance=trigger -n trigger
372388
373389
# Delete the namespace (optional)
@@ -380,7 +396,7 @@ kubectl delete namespace trigger
380396
- **Pods stuck pending**: Describe the pod and check the events
381397
- **Worker token issues**: Check webapp and supervisor logs for errors
382398

383-
## CLI Usage
399+
## CLI usage
384400

385401
See the [Docker CLI usage](/self-hosting/docker#cli-usage) section, the commands are identical regardless of deployment method.
386402

0 commit comments

Comments
 (0)