zhudebin / camunda-platform-helm

Camunda Platform 8 Self-Managed Helm charts

Camunda Platform Helm

• Camunda Platform Helm
  • Overview
  • Installing Charts
    • Local Kubernetes
    • OpenShift
  • Configure Charts
  • Uninstalling Charts
  • Deprecation of zeebe charts
  • Issues
  • Contributing
  • Releasing the Charts
  • License

Overview

Camunda Platform 8 Self-Managed Helm charts repo.

The Camunda Platform components are represented in the following image:

Per default the following components will be installed:

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

Installing Charts

We recommend you to use Kubernetes when deploying Camunda 8 to production self-managed. For more details, please follow the installation instructions in the official Camunda Platform documentation.

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

Then, you can install the Helm charts by running:

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

Local Kubernetes

We recommend to use Helm + KIND for local environments, as the Helm configurations are battle-tested and much closer to production systems.

For more details: Installing the Camunda Helm chart locally using KIND

OpenShift

See the openshift sub-folder on how to get started with the charts on OpenShift.

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>

Note

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 -l app.kubernetes.io/instance=<YOUR HELM RELEASE NAME>
kubectl get pvc -l release=<YOUR HELM RELEASE NAME>

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

kubectl delete pvc -l app.kubernetes.io/instance=<YOUR HELM RELEASE NAME>
kubectl delete pvc -l release=<YOUR HELM RELEASE NAME>

Or you can simply 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.

Releasing the Charts

In order to find out how to release the charts please see the corresponding release guide.

License

Camunda Platform 8 Self-Managed Helm charts are licensed under the open source Apache License 2.0. Please see LICENSE for details.

For Camunda Platform 8 components, please visit licensing information page.