Skip to content

Commit 483438b

Browse files
committed
fix: thix fixes formatting issues on K8's deployment page
1 parent 5f49351 commit 483438b

File tree

1 file changed

+59
-64
lines changed

1 file changed

+59
-64
lines changed

docs/self-hosting/methods/kubernetes.md

Lines changed: 59 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -48,70 +48,65 @@ When configuring the PLANE_VERSION environment variable, **do not** set it to `s
4848
helm repo add plane https://helm.plane.so/
4949
```
5050

51-
4. Use one of the following ways to deploy Plane: - **Quick setup**:
52-
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).
53-
54-
Run the following command to deploy Plane:
55-
56-
```bash
57-
helm upgrade --install plane-app plane/plane-enterprise \
58-
--create-namespace \
59-
--namespace plane \
60-
--set license.licenseDomain=${DOMAIN_NAME} \
61-
--set license.licenseServer=https://prime.plane.so \
62-
--set planeVersion=${PLANE_VERSION} \
63-
--set ingress.enabled=true \
64-
--set ingress.ingressClass=nginx \
65-
--set env.storageClass=longhorn \
66-
--timeout 10m \
67-
--wait \
68-
--wait-for-jobs
69-
```
70-
71-
::: info
72-
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/>
73-
To use a custom StorageClass, add `--set env.storageClass=<your-storageclass-name>` to the command above.<br/> <br/>
74-
You can also pass other settings referring to the **Configuration Settings** toggle section below.
75-
:::
76-
77-
- **Advanced setup**:
78-
::: warning
79-
When self-hosting Plane for production use, it is strongly recommended to configure [external database and storage](/self-hosting/methods/kubernetes#configuration-settings). This ensures that your data remains secure and accessible even if the local machine crashes or encounters hardware issues. Relying solely on local storage for these components increases the risk of data loss and service disruption.
80-
:::
81-
82-
For more control over your setup, follow the steps below:
83-
84-
i. Run the script below to download the `values.yaml` file and and edit using any editor like Vim or Nano.
85-
86-
Make sure you set the required environment variables listed below:
87-
- `planeVersion: v2.3.1`
88-
- `license.licenseDomain: <The domain you have specified to host Plane>`
89-
- `license.licenseServer: https://prime.plane.so`
90-
- `ingress.enabled: <true | false>`
91-
- `ingress.ingressClass: <nginx or any other ingress class configured in your cluster>`
92-
- `env.storageClass: <longhorn or any other storage class configured in your cluster>`
93-
94-
Make sure you set the required environment variables listed below:
95-
- `planeVersion: v2.2.1`
96-
- `license.licenseDomain: <The domain you have specified to host Plane>`
97-
- `license.licenseServer: https://prime.plane.so`
98-
- `ingress.enabled: <true | false>`
99-
- `ingress.ingressClass: <nginx or any other ingress class configured in your cluster>`
100-
- `env.storageClass: <longhorn or any other storage class configured in your cluster>`
101-
102-
See the **Configuration settings** toggle section for more details.
103-
104-
```bash
105-
helm upgrade --install plane-app plane/plane-enterprise \
106-
--create-namespace \
107-
--namespace plane \
108-
-f values.yaml \
109-
--timeout 10m \
110-
--wait \
111-
--wait-for-jobs
112-
```
113-
114-
iii. If you've purchased a paid plan, [activate your license key](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) to unlock premium features.
51+
4. Use one of the following ways to deploy Plane:
52+
53+
- **Quick setup**:
54+
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).
55+
56+
Run the following command to deploy Plane:
57+
58+
```
59+
helm upgrade --install plane-app plane/plane-enterprise \
60+
--create-namespace \
61+
--namespace plane \
62+
--set license.licenseDomain=${DOMAIN_NAME} \
63+
--set license.licenseServer=https://prime.plane.so \
64+
--set planeVersion=${PLANE_VERSION} \
65+
--set ingress.enabled=true \
66+
--set ingress.ingressClass=nginx \
67+
--set env.storageClass=longhorn \
68+
--timeout 10m \
69+
--wait \
70+
--wait-for-jobs
71+
```
72+
73+
::: info
74+
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/>
75+
To use a custom StorageClass, add `--set env.storageClass=<your-storageclass-name>` to the command above.<br/> <br/>
76+
You can also pass other settings referring to the **Configuration Settings** toggle section below.
77+
:::
78+
79+
- **Advanced setup**:
80+
81+
::: warning
82+
When self-hosting Plane for production use, it is strongly recommended to configure [external database and storage](/self-hosting/methods/kubernetes#configuration-settings). This ensures that your data remains secure and accessible even if the local machine crashes or encounters hardware issues. Relying solely on local storage for these components increases the risk of data loss and service disruption.
83+
:::
84+
85+
For more control over your setup, follow the steps below:
86+
87+
i. Run the script below to download the `values.yaml` file and edit using any editor like Vim or Nano.
88+
89+
Make sure you set the required environment variables listed below:
90+
- `planeVersion: v2.3.1`
91+
- `license.licenseDomain: <The domain you have specified to host Plane>`
92+
- `license.licenseServer: https://prime.plane.so`
93+
- `ingress.enabled: <true | false>`
94+
- `ingress.ingressClass: <nginx or any other ingress class configured in your cluster>`
95+
- `env.storageClass: <longhorn or any other storage class configured in your cluster>`
96+
97+
See the **Configuration settings** toggle section for more details.
98+
99+
```bash
100+
helm upgrade --install plane-app plane/plane-enterprise \
101+
--create-namespace \
102+
--namespace plane \
103+
-f values.yaml \
104+
--timeout 10m \
105+
--wait \
106+
--wait-for-jobs
107+
```
108+
109+
ii. If you've purchased a paid plan, [activate your license key](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) to unlock premium features.
115110
116111
## Configuration settings
117112

0 commit comments

Comments
 (0)