Helm Chart

The official chart is developed in the PLANKA repository. Thanks to Chris-Greaves for the original work.

Basic Usage

1. Add the Repo and Check Availability

   helm repo add planka https://plankanban.github.io/planka/
   helm repo update
   helm search repo planka

2. Generate a Secret Key and Install PLANKA

   export SECRETKEY=$(openssl rand -hex 64)
   helm install planka planka/planka --set secretkey=$SECRETKEY \
   --set admin_email="demo@demo.demo" \
   --set admin_password="demo" \
   --set admin_name="Demo Demo" \
   --set admin_username="demo"

   Note: The command openssl rand -hex 64 generates a random hexadecimal key for PLANKA. On Windows, you can use Git Bash to run that command.

   The chart version follows the application version, so --version 2.3.1 installs PLANKA 2.3.1.

3. Access PLANKA via Port Forwarding

   kubectl port-forward deployment/planka 3000:1337

Accessing Externally

To access PLANKA externally, you can use the following configuration:

1. HTTP Only:

   helm install planka planka/planka --set secretkey=$SECRETKEY \
   --set admin_email="demo@demo.demo" \
   --set admin_password="demo" \
   --set admin_name="Demo Demo" \
   --set admin_username="demo" \
   --set ingress.enabled=true \
   --set ingress.hosts[0].host=planka.example.dev

2. HTTPS:

   helm install planka planka/planka --set secretkey=$SECRETKEY \
   --set admin_email="demo@demo.demo" \
   --set admin_password="demo" \
   --set admin_name="Demo Demo" \
   --set admin_username="demo" \
   --set ingress.enabled=true \
   --set ingress.hosts[0].host=planka.example.dev \
   --set ingress.tls[0].secretName=planka-tls \
   --set ingress.tls[0].hosts[0]=planka.example.dev

Using a values.yaml (Recommended)

It is recommended to create a values.yaml to simplify future upgrades and configurations.

1. Create a values.yaml

   Below is an example of a values.yaml configuration:

   secretkey: "<InsertSecretKey>"
   # The admin section needs to be present for new instances of PLANKA, after the first start you can remove the lines starting with admin_. If you want the admin user to be unchangeable admin_email: has to stay
   # After changing the config you have to run ```helm upgrade  planka . -f values.yaml```
   
   # Admin user
   admin_email: "demo@demo.demo" # Do not remove if you want to prevent this user from being edited/deleted
   admin_password: "demo"
   admin_name: "Demo Demo"
   admin_username: "demo"
   # Admin user
   
   ingress:
     enabled: true
     hosts:
       - host: planka.example.dev
         paths:
           - path: /
             pathType: ImplementationSpecific
   
      # Needed for HTTPS
     tls:
       - secretName: planka-tls # existing TLS secret in k8s
         hosts:
           - planka.example.dev

2. Install PLANKA Using the values.yaml

   helm install planka planka/planka -f values.yaml

Base URL

PLANKA only accepts websocket connections from the address the browser uses, so a wrong one gives you a blank page. The chart works it out: with an ingress, it uses the first host, over https when ingress.tls is set. Without one, it uses defaultBaseUrl (http://localhost:3000). To set it yourself, use baseUrl.

Access PLANKA

Once the services are running, browse to planka.example.dev and log in as admin_email with the password admin_password.

Considerations for Production Hosting

If you plan to host PLANKA in a production environment, here are some things to consider:

• Create a values.yaml with your custom configurations. This makes applying future upgrades easier.
• Generate your secretkey once and store it securely (e.g., in a vault or in the values.yaml) to ensure consistency during upgrades.
• Specify a password for postgresql.auth.password to avoid issues with the PostgreSQL chart generating new passwords, which could lock you out of the data you've already stored. (See this issue).

For any questions or concerns, feel free to raise an issue.

Known Issues

The Bitnami PostgreSQL chart has an issue where setting a new password is ignored if the release is deleted and a persistent volume (PV) already exists with the previous password. The warning from Bitnami is as follows:

Warning! Setting a password will be ignored on new installation in the case when previous Posgresql release was deleted through the helm command. In that case, old PVC will have an old password, and setting it through helm won't take effect. Deleting persistent volumes (PVs) will solve the issue. Refer to issue 2061 for more details.

If you want to fully uninstall the chart including the data, follow these steps from the Bitnami Chart's documentation.