Pre-requisite

  • A working Kubernetes cluster
  • kubectl and helm on the client system that you will use to install our Helm charts

Installing Plane

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

  2. Add Helm Repo

    helm repo add makeplane https://helm.plane.so/
    helm repo update
    
  3. 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 plane-app makeplane/plane-ce \
            --create-namespace \
            --namespace plane-ce \
            --set planeVersion=stable \
            --set ingress.appHost="plane.example.com" \
            --set ingress.minioHost="plane-minio.example.com" \
            --set ingress.ingressClass=nginx \
            --set postgres.storageClass=longhorn \
            --set redis.storageClass=longhorn \
            --set minio.storageClass=longhorn \
            --timeout 10m \
            --wait \
            --wait-for-jobs
    

    This is the minimum required to set up Plane-CE. You can change the default namespace from plane-ce, the default appname from plane-app, the default storage class from [postgres, redis, minio].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 makeplane/plane-ce > values.yaml
      vi values.yaml
      
      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 plane-app makeplane/plane-ce \
          --create-namespace \
          --namespace plane-ce \
          -f values.yaml \
          --timeout 10m \
          --wait \
          --wait-for-jobs 
      

Configuration Settings Available


Plane Version

SettingDefaultRequiredDescription
planeVersionstableYes

Postgress DB Setup

SettingDefaultRequiredDescription
postgres.local_setuptruePlane uses postgres as the primary database to store all the transactional data. This database can be hosted within kubernetes as part of helm chart deployment or can be used as hosted service remotely (e.g. aws rds or similar services). Set this to true when you choose to setup stateful deployment of postgres. Mark it as false when using a remotely hosted database
postgres.imagepostgres:15.5-alpineUsing this key, user must provide the docker image name to setup the stateful deployment of postgres. (must be set when postgres.local_setup=true)
postgres.servicePort5432This key sets the default port number to be used while setting up stateful deployment of postgres.
postgres.cliConnectPortIf you intend to access the hosted stateful deployment of postgres using any of the client tools (e.g Postico), this key helps you expose the port. The mentioned port must not be occupied by any other applicaiton
postgres.volumeSize5GiWhile setting up the stateful deployment, while creating the persistant volume, volume allocation size need to be provided. This key helps you set the volume allocation size. Unit of this value must be in Mi (megabyte) or Gi (gigabyte)
env.pgdb_usernameplaneDatabase credentials are requried to access the hosted stateful deployment of postgres. Use this key to set the username for the stateful deployment.
env.pgdb_passwordplaneDatabase credentials are requried to access the hosted stateful deployment of postgres. Use this key to set the password for the stateful deployment.
env.pgdb_nameplaneDatabase name to be used while setting up stateful deployment of Postgres
env.pgdb_remote_urlUsers can also decide to use the remote hosted database and link to Plane deployment. Ignoring all the above keys, set postgres.local_setup to false and set this key with remote connection url.
postgres.storageClasslonghornCreating the persitant volumes for the stateful deployments needs the storageClass name. Set the correct value as per your kubernetes cluster configuration.

Redis Setup

SettingDefaultRequiredDescription
redis.local_setuptruePlane uses redis to cache the session authentication and other static data. This database can be hosted within kubernetes as part of helm chart deployment or can be used as hosted service remotely (e.g. aws rds or similar services). Set this to true when you choose to setup stateful deployment of redis. Mark it as false when using a remotely hosted database
redis.imageredis:7.2.4-alpineUsing this key, user must provide the docker image name to setup the stateful deployment of redis. (must be set when redis.local_setup=true)
redis.servicePort6379This key sets the default port number to be used while setting up stateful deployment of redis.
redis.volumeSize1GiWhile setting up the stateful deployment, while creating the persistant volume, volume allocation size need to be provided. This key helps you set the volume allocation size. Unit of this value must be in Mi (megabyte) or Gi (gigabyte)
env.remote_redis_urlUsers can also decide to use the remote hosted database and link to Plane deployment. Ignoring all the above keys, set redis.local_setup to false and set this key with remote connection url.
redis.storageClasslonghornCreating the persitant volumes for the stateful deployments needs the storageClass name. Set the correct value as per your kubernetes cluster configuration.

Doc Store (Minio/S3) Setup

SettingDefaultRequiredDescription
minio.local_setuptruePlane uses minio as the default file storage drive. This storage can be hosted within kubernetes as part of helm chart deployment or can be used as hosted service remotely (e.g. aws S3 or similar services). Set this to true when you choose to setup stateful deployment of postgres. Mark it as false when using a remotely hosted database
minio.imageminio/minio:latestUsing this key, user must provide the docker image name to setup the stateful deployment of minio. (must be set when minio.local_setup=true)
minio.volumeSize5GiWhile setting up the stateful deployment, while creating the persistant volume, volume allocation size need to be provided. This key helps you set the volume allocation size. Unit of this value must be in Mi (megabyte) or Gi (gigabyte)
minio.root_useradminStorage credentials are requried to access the hosted stateful deployment of minio. Use this key to set the username for the stateful deployment.
minio.root_passwordpasswordStorage credentials are requried to access the hosted stateful deployment of minio. Use this key to set the password for the stateful deployment.
env.docstore_bucketuploadsYesStorage bucket name is required as part of configuration. This is where files will be uploaded irrespective of if you are using Minio or external S3 (or compatible) storage service
env.doc_upload_size_limit5242880YesDocument Upload Size Limit (default to 5Mb)
env.aws_access_keyExternal S3 (or compatible) storage service provides access key for the application to connect and do the necessary upload/download operations. To be provided when minio.local_setup=false
env.aws_secret_access_keyExternal S3 (or compatible) storage service provides secret access key for the application to connect and do the necessary upload/download operations. To be provided when minio.local_setup=false
env.aws_regionExternal S3 (or compatible) storage service providers creates any buckets in user selected region. This is also shared with the user as region for the application to connect and do the necessary upload/download operations. To be provided when minio.local_setup=false
env.aws_s3_endpoint_urlExternal S3 (or compatible) storage service providers shares a endpoint_url for the integration purpose for the application to connect and do the necessary upload/download operations. To be provided when minio.local_setup=false
minio.storageClasslonghornCreating the persitant volumes for the stateful deployments needs the storageClass name. Set the correct value as per your kubernetes cluster configuration.

Web Deployment

SettingDefaultRequiredDescription
web.replicas1YesKubernetes 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
web.memoryLimit1000MiEvery 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.
web.cpuLimit500mEvery 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.
web.imagemakeplane/plane-frontendThis deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment

Space Deployment

SettingDefaultRequiredDescription
space.replicas1YesKubernetes 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
space.memoryLimit1000MiEvery 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.
space.cpuLimit500mEvery 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.
space.imagemakeplane/plane-spaceThis deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment

Admin Deployment

SettingDefaultRequiredDescription
admin.replicas1YesKubernetes 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
admin.memoryLimit1000MiEvery 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.
admin.cpuLimit500mEvery 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.
admin.imagemakeplane/plane-adminThis deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment

API Deployment

SettingDefaultRequiredDescription
api.replicas1YesKubernetes 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
api.memoryLimit1000MiEvery 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.
api.cpuLimit500mEvery 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.
api.imagemakeplane/plane-backendThis deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment
env.sentry_dsn(optional) API 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.
env.sentry_environment(optional) API 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.

Worker Deployment

SettingDefaultRequiredDescription
worker.replicas1YesKubernetes 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
worker.memoryLimit1000MiEvery 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.
worker.cpuLimit500mEvery 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.
worker.imagemakeplane/plane-backendThis deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment

Beat-Worker deployment

SettingDefaultRequiredDescription
beatworker.replicas1YesKubernetes 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
beatworker.memoryLimit1000MiEvery 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.
beatworker.cpuLimit500mEvery 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.
beatworker.imagemakeplane/plane-backendThis deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment

Ingress and SSL Setup

SettingDefaultRequiredDescription
ingress.enabledtrueIngress setup in kubernetes is a common practice to expose application to the intended audience. Set it to false if you are using external ingress providers like Cloudflare
ingress.appHost‘plane.example.com’YesThe 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.
ingress.minioHost‘plane-minio.example.com’Based on above configuration, if you want to expose the minio web console to set of users, use this key to set the host mapping or leave it as EMPTY to not expose interface.
ingress.ingressClass‘nginx’YesKubernetes cluster setup comes with various options of ingressClass. Based on your setup, set this value to the right one (eg. nginx, traefik, etc). Leave it to default in case you are using external ingress provider.
ingress.ingress_annotations{ "nginx.ingress.kubernetes.io/proxy-body-size": "5m" }Ingress controllers comes with various configuration options which can be passed as annotations. Setting this value lets you change the default value to user required.
ssl.createIssuerfalseKubernets cluster setup supports creating issuer type resource. After deployment, this is step towards creating secure access to the ingress url. Issuer is required for you generate SSL certifiate. Kubernetes can be configured to use any of the certificate authority to generate SSL (depending on CertManager configuration). Set it to true to create the issuer. Applicable only when ingress.enabled=true
ssl.issuerhttpCertManager configuration allows user to create issuers using http or any of the other DNS Providers like cloudflare, digitalocean, etc. As of now Plane supports http, cloudflare, digitalocean
ssl.tokenTo create issuers using DNS challenge, set the issuer api token of dns provider like cloudflareordigitalocean`(not required for http)
ssl.serverhttps://acme-v02.api.letsencrypt.org/directoryIssuer creation configuration need the certificate generation authority server url. Default URL is the Let's Encrypt server
ssl.emailplane@example.comCertificate generation authority needs a valid email id before generating certificate. Required when ssl.createIssuer=true
ssl.generateCertsfalseAfter creating the issuers, user can still not create the certificate untill sure of configuration. Setting this to true will try to generate SSL certificate and associate with ingress. Applicable only when ingress.enabled=true and ssl.createIssuer=true

Common Environment Settings

SettingDefaultRequiredDescription
env.secret_key60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5YesThis must a random string which is used for hashing/encrypting the sensitive data within the application. Once set, changing this might impact the already hashed/encrypted data

Custom Ingress Routes

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

HostPathService
plane.example.com/http://plane-web.plane-ce:3000
plane.example.com/spaces/*http://plane-space.plane-ce:3000
plane.example.com/god-mode/*http://plane-admin.plane-ce:8000
plane.example.com/api/*http://plane-api.plane-ce:8000
plane.example.com/auth/*http://plane-api.plane-ce:8000
plane.example.com/uploads/*http://plane-minio.plane-ce:9000
plane-minio.example.com/http://plane-minio.plane-ce:9090