Prefix Elasticsearch and OpenSearch indices

Configure Elasticsearch and OpenSearch index prefixes to structure your data and ensure data isolation.

Overview

Index prefixes allow you to append a unique identifier to each search index, such as in Elasticsearch or OpenSearch, 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.

Use index prefixes in Camunda to ensure 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.

Prefix Elasticsearch indices

Environment variables

ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_INDEX_PREFIX=custom-zeebe

CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX=custom
CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe

CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX=custom
CAMUNDA_TASKLIST_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe

CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize
CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe

values.yaml

global:
  elasticsearch:
    prefix: custom-zeebe

operate:
  env:
    - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX
      value: custom-webapp
  migration:
    env:
      - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX
        value: custom-webapp

tasklist:
  env:
    - name: CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX
      value: custom-webapp

optimize:
  env:
    - name: CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX
      value: custom-optimize
  migration:
    env:
      - name: CAMUNDA_OPTIMIZE_ZEEBE_NAME
        value: custom-zeebe

application.yaml

zeebe:
  broker:
    exporters:
      elasticsearch:
        args:
          index:
            prefix: custom-zeebe
camunda:
  operate:
    elasticsearch:
      indexPrefix: custom
    zeebeElasticsearch:
      prefix: custom-zeebe
  tasklist:
    elasticsearch:
      indexPrefix: custom
    zeebeElasticsearch:
      prefix: custom-zeebe
  optimize:
    elasticsearch:
      settings:
        index:
          prefix: custom-optimize
    zeebeElasticsearch:
      prefix: custom-zeebe

Prefix OpenSearch indices

Environment variables

ZEEBE_BROKER_EXPORTERS_OPENSEARCH_ARGS_INDEX_PREFIX=custom-zeebe

CAMUNDA_OPERATE_OPENSEARCH_INDEXPREFIX=custom
CAMUNDA_OPERATE_ZEEBEOPENSEARCH_PREFIX=custom-zeebe

CAMUNDA_TASKLIST_OPENSEARCH_INDEXPREFIX=custom
CAMUNDA_TASKLIST_ZEEBEOPENSEARCH_PREFIX=custom-zeebe

CAMUNDA_OPTIMIZE_OPENSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize
CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe

values.yaml

global:
  opensearch:
    prefix: custom-zeebe

operate:
  env:
    - name: CAMUNDA_OPERATE_OPENSEARCH_INDEXPREFIX
      value: custom-webapp
  migration:
    env:
      - name: CAMUNDA_OPERATE_OPENSEARCH_INDEXPREFIX
        value: custom-webapp

tasklist:
  env:
    - name: CAMUNDA_TASKLIST_OPENSEARCH_INDEXPREFIX
      value: custom-webapp

optimize:
  env:
    - name: CAMUNDA_OPTIMIZE_OPENSEARCH_SETTINGS_INDEX_PREFIX
      value: custom-optimize
  migration:
    env:
      - name: CAMUNDA_OPTIMIZE_ZEEBE_NAME
        value: custom-zeebe

application.yaml

zeebe:
  broker:
    exporters:
      opensearch:
        args:
          index:
            prefix: custom-zeebe
camunda:
  operate:
    opensearch:
      indexPrefix: custom
    zeebeOpensearch:
      prefix: custom-zeebe
  tasklist:
    opensearch:
      indexPrefix: custom
    zeebeOpensearch:
      prefix: custom-zeebe
  optimize:
    opensearch:
      settings:
        index:
          prefix: custom-optimize
    zeebeOpensearch:
      prefix: custom-zeebe