camunda-platform-helm

Camunda Platform Helm

The Camunda Platform Helm repo, contains and host Camunda Platform related helm charts.

The charts can be accessed by adding the following Helm repo to your Helm setup:

helm repo add camunda https://helm.camunda.io
helm repo update

ToC

• Architecture
• Installing Charts
• Configure Charts
• Uninstalling Charts
• Deprecation of zeebe charts
• Issues
• Contributing

Architecture

Installing Charts

You can install the Helm Charts by running:

helm install <YOUR HELM RELEASE NAME> camunda/camunda-platform

Per default the following will be installed:

• camunda-platform
  • Zeebe
  • Zeebe Gateway
  • Operate
  • Tasklist
  • Optimize
  • Identity
    • Keycloak
    • PostgreSQL
  • ElasticSearch

Follow the instructions in the Camunda Platform documentation to install Camunda Platform to a K8s cluster.

Note: check the kind/camunda-platform-core-kind-values file to get camunda-platform running with kind

Configure Charts

Helm charts can be configured via using extra values files or directly via the --set option. make sure to check out the Camunda Platform Helm Charts Readme for more information.

Example to enable the prometheus servicemonitor for Zeebe:

helm install <YOUR HELM RELEASE NAME> camunda/camunda-platform --set zeebe.prometheusServiceMonitor.enabled=true

Uninstalling Charts

You can remove these charts by running:

helm uninstall <YOUR HELM RELEASE NAME>

Notice that all the services and pods will be deleted, but not the Persistence Volume Claims which are used to hold the storage for the data generated by the cluster and Elasticsearch. In order to free up the storage you need to manually delete all the Persistent Volume Claims. You can do this by running:

kubectl get pvc

Then delete the ones that you don’t want to keep:

kubectl delete pvc <PVC ids here>

Or delete the related kubernetes namespace, which contains the resources.

Deprecation of zeebe charts

With the creation of the Camunda Platform Helm charts (previously known as ccsm-helm), the old zeebe-* charts have been deprecated. This means they are no longer part of the repository and no longer maintained. The packaged charts are still available for download.

The following charts are deprecated:

• zeebe-full-helm
• zeebe-cluster-helm
• zeebe-operate-helm
• zeebe-tasklist-helm

The new camunda-platform chart is a full replacement of zeebe-full-helm and replaces (contains) all other charts as sub-charts. All sub-charts in camunda-platform are per default enabled.

For a complete migration guide see here.

Issues

Please create new issues if you find problems with these charts. This repository is hosted using GitHub Pages and the source code repository can be found here.

Contributing

Please familiar yourself with the contribution guide to find out how to contribute to this project. Please also make sure to check the Camunda Platform Helm Charts Readme to find more information about configuring and developing the charts.

This site is open source. Improve this page.