Skip to main content
Version: 8.8

Helm chart Elasticsearch/OpenSearch indices prefix

Overview​

Elasticsearch and OpenSearch prefixes allow you to append a unique identifier to each index, making it easier to organize and retrieve relevant information by structuring your data. With a consistent prefix, all related indices are easily identifiable, simplifying queries and data management.

Using index prefixes in Camunda ensures data isolation by allowing multiple Camunda instances to run on a shared cluster without accessing each other’s data. This is crucial for maintaining separation in multi-instance and multi-tenant environments, and when testing different configurations.

note

Changing the index prefix after a Camunda instance has been running will create new empty indices with the new prefix. There is no built-in migration support between old and new prefixes.

Usage​

Elasticsearch​

# zeebe-records indices prefix
ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_INDEX_PREFIX=custom-zeebe

# unified camunda indices prefix
CAMUNDA_DATA_SECONDARYSTORAGE_ELASTICSEARCH_INDEXPREFIX=custom-camunda

# only if the operate importer is enabled
CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_INDEXPREFIX=custom-zeebe
# only if the tasklist importer is enabled
CAMUNDA_TASKLIST_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe

# optimize indices prefix
CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize
CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe

OpenSearch​

# zeebe-records indices prefix
ZEEBE_BROKER_EXPORTERS_OPENSEARCH_ARGS_INDEX_PREFIX=custom-zeebe

# unified camunda indices prefix
CAMUNDA_DATA_SECONDARYSTORAGE_OPENSEARCH_INDEXPREFIX=custom-camunda

# only if the operate importer is enabled
CAMUNDA_OPERATE_ZEEBEOPENSEARCH_INDEXPREFIX=custom-zeebe
# only if the tasklist importer is enabled
CAMUNDA_TASKLIST_ZEEBEOPENSEARCH_PREFIX=custom-zeebe

# optimize indices prefix
CAMUNDA_OPTIMIZE_OPENSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize
CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe