Configuration

As a Spring Boot application, Operate supports any standard Spring configuration method.

By default, the configuration for Operate is stored in a YAML file (application.yml). All Operate-related settings are prefixed with camunda.operate.

note

Configuration properties can be defined as environment variables using Spring Boot conventions. To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (.) with _.

For example, the property camunda.operate.elasticsearch.clustername is represented by the environment variable CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME.

The following parts are configurable:

Licensing

See the core settings documentation.

Webserver and security

See the core settings documentation.

Elasticsearch or OpenSearch

See the secondary storage documentation and core settings documentation.

Zeebe Elasticsearch or OpenSearch exporter

note

Version 8.8+: The Importer is required only for migration scenarios (upgrades from 8.7). Keep it enabled until all remaining 8.7 records have been imported. After that, the Camunda Exporter takes over and writes directly to the Operate indices. The Importer can then be safely disabled for subsequent restarts or deployments.

New 8.8+ installations do not need to enable or configure the Importer. Its only purpose is to temporarily support migrations from 8.7 data.

For Elasticsearch, Operate imports data from indices created and filled in by the Zeebe Elasticsearch exporter.

For OpenSearch, Operate imports data from indices created and filled in by the Zeebe OpenSearch exporter.

Therefore, settings for this Elasticsearch or OpenSearch connection must be defined and must correspond to the settings on the Zeebe side.

Settings to connect and import

See also settings to connect to a secured Elasticsearch instance or settings to connect to a secured OpenSearch instance.

note

You may need to import the certificate keystore into the JVM runtime.

# Kubernetes example:
zeebe:
  …
  javaOpts: >-
    …
    -Djavax.net.ssl.trustStore=/path/to/certificates/elasticsearch.jks

Name	Description	Default value
camunda.operate.zeebeElasticsearch.clusterName	Cluster name of Elasticsearch	elasticsearch
camunda.operate.zeebeElasticsearch.url	URL of Zeebe Elasticsearch REST API	http://localhost:9200
camunda.operate.zeebeElasticsearch.prefix	Index prefix as configured in Zeebe Elasticsearch exporter	zeebe-record
camunda.operate.zeebeElasticsearch.username	Username to access Elasticsearch REST API	-
camunda.operate.zeebeElasticsearch.password	Password to access Elasticsearch REST API	-
camunda.operate.zeebeElasticsearch.ssl.certificatePath	Path to certificate used by Elasticsearch	-
camunda.operate.zeebeElasticsearch.ssl.selfSigned	Certificate was self-signed	false
camunda.operate.zeebeElasticsearch.ssl.verifyHostname	Should the hostname be validated	false

Snippet from application.yml for Elasticsearch

camunda.operate:
  zeebeElasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # Url
    url: https://localhost:9200
    # Index prefix, configured in Zeebe Elasticsearch exporter
    prefix: zeebe-record

Example for OpenSearch:

Name	Description	Default value
camunda.operate.zeebeOpensearch.clusterName	Cluster name of OpenSearch	opensearch
camunda.operate.zeebeOpensearch.url	URL of Zeebe OpenSearch REST API	http://localhost:9200
camunda.operate.zeebeOpensearch.prefix	Index prefix as configured in Zeebe OpenSearch exporter	zeebe-record
camunda.operate.zeebeOpensearch.username	Username to access OpenSearch REST API	-
camunda.operate.zeebeOpensearch.password	Password to access OpenSearch REST API	-
camunda.operate.zeebeOpensearch.ssl.certificatePath	Path to certificate used by OpenSearch	-
camunda.operate.zeebeOpensearch.ssl.selfSigned	Certificate was self-signed	false
camunda.operate.zeebeOpensearch.ssl.verifyHostname	Should the hostname be validated	false

Snippet from application.yml for OpenSearch

camunda.operate:
  zeebeOpensearch:
    # Cluster name
    clusterName: opensearch
    # Url
    url: https://localhost:9200
    # Index prefix, configured in Zeebe OpenSearch exporter
    prefix: zeebe-record

Operation executor

Operations are user operations, like cancellation of process instance(s) or updating the variable value.

Operations are executed in a multi-threaded manner.

Name	Description	Default value
camunda.operate.operationExecutor.threadsCount	How many threads should be used.	3

Snippet from application.yml

camunda.operate:
  operationExecutor:
  	threadsCount: 3

Monitoring Operate

See the core settings documentation.

Logging

See the core settings documentation.

Backups

See the core settings documentation.