Skip to content

Commit b5bf55b

Browse files
authored
Merge pull request #226 from makeplane/update-ai-docs-k8s
Update Plane AI documentation with deployment instructions
2 parents a06d881 + 8096665 commit b5bf55b

File tree

3 files changed

+146
-59
lines changed

3 files changed

+146
-59
lines changed

docs/self-hosting/govern/plane-ai.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ Embedding models power semantic search. Plane AI supports:
6060

6161
## Enable Plane AI services
6262

63+
:::tip
64+
For other deployment methods such as Coolify, Portainer, Docker Swarm, and Podman Quadlets, use the same [environment variables](/self-hosting/govern/environment-variables#plane-ai) defined for Docker Compose Setup.
65+
:::
66+
67+
:::tabs key:deployment-method
68+
69+
== Docker Compose {#docker-compose}
70+
6371
Open the `/opt/plane/plane.env` file in your preferred editor and set the replica count for Plane AI services to `1`:
6472

6573
```bash
@@ -69,6 +77,20 @@ PI_WORKER_REPLICAS=1
6977
PI_MIGRATOR_REPLICAS=1
7078
```
7179

80+
== Kubernetes {#kubernetes}
81+
82+
Open your `values.yaml` file and enable the Plane AI service by setting `services.pi.enabled` to `true`:
83+
84+
```yaml
85+
services:
86+
pi:
87+
enabled: true
88+
```
89+
90+
This activates the Plane AI API, worker, beat-worker, and migrator workloads. Replica counts and resource limits for each workload can be configured through the [Plane AI values block](/self-hosting/methods/kubernetes#plane-ai-pi-deployment) in your `values.yaml`.
91+
92+
:::
93+
7294
## Configure an LLM provider
7395

7496
Configure at least one LLM provider. Add the relevant variables to `/opt/plane/plane.env`.

docs/self-hosting/methods/download-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ curl "https://prime.plane.so/api/v2/setup/?version=<version>&airgapped=<true|fal
2020

2121
| Parameter | Required | Default | Description |
2222
| ----------- | -------- | ------- | ---------------------------------------------------------------------------- |
23-
| `version` | Yes || Release tag (e.g., `v2.3.4`) |
23+
| `version` | Yes || Release tag (e.g., `v2.4.04`) |
2424
| `airgapped` | No | `false` | Set to `true` for airgapped compose files |
2525
| `platform` | No | `amd64` | Target architecture: `amd64` or `arm64`. Only applies when `airgapped=true`. |
2626

@@ -41,25 +41,25 @@ curl "https://prime.plane.so/api/v2/setup/?version=<version>&airgapped=<true|fal
4141
**Standard setup**
4242

4343
```bash
44-
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4" -o plane.zip
44+
curl "https://prime.plane.so/api/v2/setup/?version=v2.4.0" -o plane.zip
4545
unzip plane.zip
4646
```
4747

4848
**Airgapped setup (AMD64)**
4949

5050
```bash
51-
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true" -o plane.zip
51+
curl "https://prime.plane.so/api/v2/setup/?version=v2.4.0&airgapped=true" -o plane.zip
5252
unzip plane.zip
5353
```
5454

5555
**Airgapped setup (ARM64)**
5656

5757
```bash
58-
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true&platform=arm64" -o plane.zip
58+
curl "https://prime.plane.so/api/v2/setup/?version=v2.4.0&airgapped=true&platform=arm64" -o plane.zip
5959
unzip plane.zip
6060
```
6161

62-
Replace `v2.3.4` with the version you need. See the [releases page](https://plane.so/changelog?category=self-hosted) for available versions.
62+
Replace `v2.4.0` with the version you need. See the [releases page](https://plane.so/changelog?category=self-hosted) for available versions.
6363

6464
### Error responses
6565

0 commit comments

Comments
 (0)