KoboToolbox Helm Chart

This chart is intended for high availability instances of KoboToolbox. Small and casual instances should use kobo-install.

This chart is still being tested and isn't intended for external use at this time. Versions may change for no reason at all or breaking changes may apply without updating the version.

Design decisions

• As generic as possible, agnostic about the environment variables set for each service
• Supports high availability via k8s's horizontal pod autoscaler (HPA), pod disruption budget (PDB), and topology spread constraints
• Stick to defaults and conventions from helm create when possible
• Every deployment/job should do one thing. Migrate, run uwsgi, run celery, etc

Usage

This chart requires a value for kpi.version - there is no default set for it.

1. Carefully review values.yaml. Set image tag version, if desired. Set databases, secret keys, etc.
2. helm install your-kobo oci://ghcr.io/kobotoolbox/kobo -f your-values.yaml --set kpi.version=VERSION_TO_DEPLOY

Upgrading

This chart requires a value for kpi.version - there is no default set for it.

1. helm repo update
2. helm upgrade your-kobo kobo -f your-values.yaml --set kpi.version=VERSION_TO_DEPLOY

Tip: Consider using helm diff to preview changes first.

Acknowledgements

Includes ideas from:

• https://gitlab.com/burke-software/django-helm-chart
• https://github.com/one-acre-fund/kobo-k8s/
• unicef helm chart