You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: self-hosting/methods/kubernetes.mdx
+39-35Lines changed: 39 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
17
17
1. Open terminal or any other command-line app that has access to Kubernetes tools on your local system.
18
18
2. Set the following environment variables:
19
19
```bash
20
-
PLANE_VERSION=<v1.xx.x>
20
+
PLANE_VERSION=<v1.3.1>
21
21
```
22
22
```bash
23
23
DOMAIN_NAME=<subdomain.domain.tld or domain.tld>
@@ -31,29 +31,28 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
31
31
32
32
4. Use one of the following ways to deploy Plane:
33
33
-**Quick setup**:
34
-
This is the fastest way to deploy Plane with the default settings. This will create stateful deployments for Postgres, Redis, and Minio with a persistent volume claim using the `longhorn` storage class. This also sets up the Ingress routes for you using `nginx` ingress class. To customize these settings, see the **Custom ingress routes** section on this page.
34
+
This is the fastest way to deploy Plane with the default settings. This will create stateful deployments for Postgres, Redis/Valkey, and Minio with a persistent volume claim using the `longhorn` storage class. This also sets up the Ingress routes for you using `nginx` ingress class. To customize these settings, see the [Custom ingress routes](#custom-ingress-routes).
This is the minimum required to set up Plane Commercial edition. You can change the default namespace from `plane`, the default app name from `plane-app`, the default storage class from `longhorn`, and the default ingress class from `nginx` to
55
-
whatever you would like to.<br/> <br/>
56
-
You can also pass other settings referring to `Configuration Settings` section.
54
+
This is the minimum required to set up Plane Commercial edition. You can change the default namespace from `plane`, the default app name from `plane-app`, the default storage class from `longhorn`, and the default ingress class from `nginx` to whatever you would like to.<br/> <br/>
55
+
You can also pass other settings referring to the **Configuration Settings** toggle section below.
57
56
</Note>
58
57
59
58
-**Advanced setup**:
@@ -68,45 +67,36 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
68
67
```
69
68
70
69
Make sure you set the required environment variables listed below:
71
-
-`planeVersion: <v1.xx.x>`
70
+
-`planeVersion: <v1.3.1>`
72
71
-`license.licenseDomain: <The domain you have specified to host Plane>`
73
72
-`license.licenseServer: https://prime.plane.so`
74
73
-`ingress.enabled: <true | false>`
75
74
-`ingress.ingressClass: <nginx or any other ingress class configured in your cluster>`
76
75
-`env.storageClass: <longhorn or any other storage class configured in your cluster>`
77
76
78
-
See the **Configuration settings** section for more details.
77
+
See the **Configuration settings**toggle section for more details.
79
78
80
79
2. After saving the `values.yaml` file, run the following command to deploy Plane:
81
80
82
81
```bash
83
82
helm install plane-app plane/plane-enterprise \
84
-
--create-namespace \
85
-
--namespace plane \
86
-
-f values.yaml \
87
-
--timeout 10m \
88
-
--wait \
89
-
--wait-for-jobs
83
+
--create-namespace \
84
+
--namespace plane \
85
+
-f values.yaml \
86
+
--timeout 10m \
87
+
--wait \
88
+
--wait-for-jobs
90
89
```
91
90
5. If you want to upgrade to a paid plan, see [Plane upgrades](/workspaces-and-users/upgrade-plan).
92
91
93
92
<AccordionGroup>
94
93
<Accordiontitle="Configuration settings">
95
94
96
-
#### Docker registry
97
-
98
-
| Setting | Default | Required | Description |
99
-
|---|:---:|:---:|---|
100
-
| dockerRegistry.enabled | false || Plane uses a private Docker registry which needs authenticated login. This must be set to `true` to install Plane Commerical edition. |
101
-
| dockerRegistry.registry | registry.plane.tools| Yes | The host that will serve the required Docker images; Don't change this. |
102
-
| dockerRegistry.loginid || Yes | Sets the `loginid` for the Docker registry. This is the same as the REG_USER_ID value on prime. plane.so |
103
-
| dockerRegistry.password || Yes | Sets the `password` for the Docker registry. This is the same as the REG_PASSWORD value on prime.plane.so|
104
-
105
95
#### License
106
96
107
97
| Setting | Default | Required | Description |
108
98
|---|:---:|:---:|---|
109
-
| planeVersion | v1.2.1| Yes | Specifies the version of Plane to be deployed. Copy this from prime.plane.so. |
99
+
| planeVersion | v1.3.1 | Yes | Specifies the version of Plane to be deployed. Copy this from `prime.plane.so.`|
110
100
| license.licenseServer |`https://prime.plane.so`| Yes | Sets the value of the `licenseServer` that gets you your license and validates it periodically. Don't change this. |
111
101
| license.licenseDomain | 'plane.example.com' | Yes | The fully-qualified domain name (FQDN) in the format `sudomain.domain.tld` or `domain.tld` that the license is bound to. It is also attached to your `ingress` host to access Plane. |
112
102
@@ -125,7 +115,7 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
125
115
| services.postgres.assign_cluster_ip | false || Set it to `true` if you want to assign `ClusterIP` to the service |
126
116
| env.pgdb_remote_url ||| Users can also decide to use the remote hosted database and link to Plane deployment. Ignoring all the above keys, set `services.postgres.local_setup` to `false` and set this key with remote connection url. |
127
117
128
-
#### Redis Setup
118
+
#### Redis/Valkey Setup
129
119
130
120
| Setting | Default | Required | Description |
131
121
|---|:---:|:---:|---|
@@ -183,6 +173,19 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
183
173
| services.admin.image|`registry.plane.tools/plane/admin-enterprise`|| This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
184
174
| services.admin.assign_cluster_ip | false || Set it to `true` if you want to assign `ClusterIP` to the service |
185
175
176
+
#### Live Service Deployment
177
+
178
+
| Setting | Default | Required | Description |
179
+
|---|:---:|:---:|---|
180
+
| services.live.replicas | 1 | Yes | Kubernetes helps you with scaling up\/down the deployments. You can run 1 or more pods for each deployment. This key helps you setting up number of replicas you want to run for this deployment. It must be >=1 |
181
+
| services.live.memoryLimit | 1000Mi || Every deployment in kubernetes can be set to use maximum memory they are allowed to use. This key sets the memory limit for this deployment to use.|
182
+
| services.live.cpuLimit | 500m || Every deployment in kubernetes can be set to use maximum cpu they are allowed to use. This key sets the cpu limit for this deployment to use.|
183
+
| services.live.image| registry.plane.tools/plane/live-enterprise || This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
184
+
| env.live_sentry_dsn ||| (optional) Live service deployment comes with some of the preconfigured integration. Sentry is one among those. Here user can set the Sentry provided DSN for this integration.|
185
+
| env.live_sentry_environment ||| (optional) Live service deployment comes with some of the preconfigured integration. Sentry is one among those. Here user can set the Sentry environment name (as configured in Sentry) for this integration.|
186
+
| env.live_sentry_traces_sample_rate ||| (optional) Live service deployment comes with some of the preconfigured integration. Sentry is one among those. Here user can set the Sentry trace sample rate (as configured in Sentry) for this integration.|
187
+
| services.live.assign_cluster_ip | false || Set it to `true` if you want to assign `ClusterIP` to the service |
188
+
186
189
#### Monitor Deployment
187
190
188
191
| Setting | Default | Required | Description |
@@ -461,6 +464,7 @@ To install our Community Edition, please follow these steps below.
0 commit comments