Kubernetes

​

Pre-requisite

• A Plane One license
  If you don’t have a license, get it here
• A working Kubernetes cluster
• kubectl and helm on the client system that you will use to install our Helm charts

​

Installing Plane One

1. Open Terminal or any other command-line app that has access to Kubernetes tools on your local system.

2. Set the following environment variables.

   Copy the format of constants below, paste it on Terminal to start setting environment variables, set values for each variable, and hit ENTER or RETURN.

   You will get the values for the variables from prime.plane.so under the Kuberntes tab of your license’s details page. When installing Plane One for the first time, remember to specify a domain name.

   LICENSE_KEY=<your_license_key>
   REG_USER_ID=<license-XXXXX+XXXX-XXXX-XXX-XXXXX>
   REG_PASSWORD=<******>
   PLANE_VERSION=<v1.xx.x>
   DOMAIN_NAME=<subdomain.domain.tld or domain.tld>
   

3. Add Plane helm chart repo

   Continue to be on the same Terminal window as with the previous steps, copy the code below, paste it on Terminal, and hit ENTER or RETURN.

   helm repo add plane https://helm.plane.so/
   helm repo update
   

4. Set-up and customization

   • Quick set-up

     This is the fastest way to deploy Plane with 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 this, see Custom ingress routes below.

     Continue to be on the same Terminal window as you have so far, copy the code below, and paste it on your Terminal screen.

     helm install one-app plane/plane-enterprise \
         --create-namespace \
         --namespace plane-one \
         --set dockerRegistry.loginid=${REG_USER_ID} \
         --set dockerRegistry.password=${REG_PASSWORD} \
         --set license.licenseKey=${LICENSE_KEY} \
         --set license.licenseDomain=${DOMAIN_NAME} \
         --set license.licenseServer=https://prime.plane.so \
         --set planeVersion=${PLANE_VERSION} \
         --set ingress.ingressClass=nginx \
         --set env.storageClass=longhorn \
         --timeout 10m \
         --wait \
         --wait-for-jobs
     

     This is the minimum required to set up Plane One. You can change the default namespace from plane-one, the default appname from one-app, the default storage class from env.storageClass, and the default ingress class from ingress.ingressClass to whatever you would like to.

     You can also pass other settings referring to Configuration Settings section.

   • Advance set-up

     For more control over your set-up, run the script below to download the values.yaml file and and edit using any editor like Vim or Nano.

     helm  show values plane/plane-enterprise > values.yaml
     vi values.yaml
     

     Make sure you set the minimum required values as below.

     • planeVersion: <v1.xx.x>
     • dockerRegistry.loginid: <REG_USER_ID as on prime.plane.so>
     • dockerRegistry.password: <REG_PASSWORD as on prime.plane.so>
     • license.licenseKey: <LICENSE_KEY as on prime.plane.so>
     • license.licenseDomain: <The domain you have specified to host Plane>
     • license.licenseServer: https://prime.plane.so
     • ingress.ingressClass: <nginx or any other ingress class configured in your cluster>
     • env.storageClass: <longhorn or any other storage class configured in your cluster>
     See Available customizations for more details.

     After saving the values.yaml file, continue to be on the same Terminal window as on the previous steps, copy the code below, and paste it on your Terminal screen.

     helm install one-app plane/plane-enterprise \
         --create-namespace \
         --namespace plane-one \
         -f values.yaml \
         --timeout 10m \
         --wait \
         --wait-for-jobs 
     

​

Available customizations

​

Docker registry

​

License

​

Postgres

​

Redis Setup

​

Doc Store (Minio/S3) Setup

​

Web Deployment

​

Space Deployment

​

Admin Deployment

​

API Deployment

​

Worker Deployment

​

Beat-Worker deployment

​

Ingress and SSL Setup

​

Common Environment Settings

​

Custom Ingress Routes

If you are planning to use 3rd party ingress providers, here is the available route configuration