Skip to main content
Version: 8.1

Configuration

Operate is a Spring Boot application. This means every way to configure a Spring Boot application can be applied.

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

Configurations​

Webserver​

Operate supports customizing the context-path using default Spring configuration.

Example for application.yml: server.servlet.context-path: /operate

Example for environment variable: SERVER_SERVLET_CONTEXT_PATH=/operate

The default context-path is /.

Elasticsearch​

Operate stores and reads data in/from Elasticsearch.

Settings to connect​

Operate supports basic authentication for Elasticsearch.

Set the appropriate username/password combination in the configuration to use it.

Settings to connect to a secured Elasticsearch instance​

To connect to a secured (https) Elasticsearch instance, you normally need to only set the URL protocol part to https instead of http. A secured Elasticsearch instance also needs username and password. The other SSL settings should only be used in case of connection problems; for example, in disabling host verification.

note

You may need to import the certificate into JVM runtime.

Either set host and port (deprecated), or url (recommended).

NameDescriptionDefault value
camunda.operate.elasticsearch.indexPrefixPrefix for index namesoperate
camunda.operate.elasticsearch.clusterNameCluster name of Elasticsearchelasticsearch
camunda.operate.elasticsearch.urlURL of Elasticsearch REST APIhttp://localhost:9200
camunda.operate.elasticsearch.usernameUsername to access Elasticsearch REST API-
camunda.operate.elasticsearch.passwordPassword to access Elasticsearch REST API-
camunda.operate.elasticsearch.ssl.certificatePathPath to certificate used by Elasticsearch-
camunda.operate.elasticsearch.ssl.selfSignedCertificate was self-signedfalse
camunda.operate.elasticsearch.ssl.verifyHostnameShould the hostname be validatedfalse

Settings for shards and replicas​

Operate creates the template with index settings named operate-<version>_template that Elasticsearch uses for all Operate indices. These settings can be changed.

The following configuration parameters define the settings:

NameDescriptionDefault value
camunda.operate.elasticsearch.numberOfShardsHow many shards Elasticsearch uses for all Operate indices1
camunda.operate.elasticsearch.numberOfReplicasHow many replicas Elasticsearch uses for all Operate indices0

These values are applied only on first startup of Operate or during version update. After the Operate schema is created, settings may be adjusted directly in the Elasticsearch template, and the new settings are applied to indices created after adjustment.

A snippet from application.yml​

camunda.operate:
  elasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # Url
    url: https://localhost:9200
    ssl:
      selfSigned: true

Zeebe broker connection​

Operate needs a connection to the Zeebe broker to start the import and execute user operations.

Settings to connect​

NameDescriptionDefault value
camunda.operate.zeebe.gatewayAddressGateway address that points to Zeebe as hostname and port.localhost:26500
camunda.operate.zeebe.secureConnection should be secure via Transport Layer Security (TLS).false
camunda.operate.zeebe.certificatePathPath to certificate used by Zeebe. This is necessary when the certificate isn't registered in the operating system-

Additionally, visit Zeebe Secure Client Communication for more details.

A snippet from application.yml​

camunda.operate:
  zeebe:
    # Gateway host and port
    gatewayAddress: localhost:26500

Zeebe Elasticsearch exporter​

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

Therefore, settings for this Elasticsearch 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.

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
NameDescriptionDefault value
camunda.operate.zeebeElasticsearch.clusterNameCluster name of Elasticsearchelasticsearch
camunda.operate.zeebeElasticsearch.urlURL of Zeebe Elasticsearch REST APIhttp://localhost:9200
camunda.operate.zeebeElasticsearch.prefixIndex prefix as configured in Zeebe Elasticsearch exporterzeebe-record
camunda.operate.zeebeElasticsearch.usernameUsername to access Elasticsearch REST API-
camunda.operate.zeebeElasticsearch.passwordPassword to access Elasticsearch REST API-
camunda.operate.zeebeElasticsearch.ssl.certificatePathPath to certificate used by Elasticsearch-
camunda.operate.zeebeElasticsearch.ssl.selfSignedCertificate was self-signedfalse
camunda.operate.zeebeElasticsearch.ssl.verifyHostnameShould the hostname be validatedfalse

A snippet from application.yml:​

camunda.operate:
  zeebeElasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # Url
    url: https://localhost:9200
    # Index prefix, configured in Zeebe Elasticsearch 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.

NameDescriptionDefault value
camunda.operate.operationExecutor.threadsCountHow many threads should be used.3

A snippet from application.yml​

camunda.operate:
  operationExecutor:
    threadsCount: 3

Monitoring Operate​

Operate includes Spring Boot Actuator inside. This provides the number of monitoring possibilities.

Operate uses the following Actuator configuration by default:

# Disable default health indicators
# https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-health-indicators
management.health.defaults.enabled: false
# enable Kubernetes health groups:
# https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-kubernetes-probes
management.health.probes.enabled: true
# enable several Actuator endpoints
management.endpoints.web.exposure.include: health, prometheus, loggers, usage-metrics, backup

With this configuration, the following endpoints are available for use out of the box:

<server>:8080/actuator/prometheus Prometheus metrics

<server>:8080/actuator/health/liveness Liveness probe

<server>:8080/actuator/health/readiness Readiness probe

This configuration may be overwritten by changing the corresponding configuration parameters values.

Versions before 0.25.0​

In versions before 0.25.0, management endpoints look different. Therefore, we recommend reconfiguring for next versions.

NameBefore 0.25.0Starting with 0.25.0
Readiness/api/check/actuator/health/readiness
Liveness/actuator/health/actuator/health/liveness

Logging​

Operate uses the Log4j2 framework for logging. In the distribution archive, as well as inside a Docker image, config/log4j2.xml logging configuration files are included and can be further adjusted to your needs:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">
  <Properties>
    <Property name="LOG_PATTERN">%clr{%d{yyyy-MM-dd HH:mm:ss.SSS}}{faint} %clr{%5p} %clr{${sys:PID}}{magenta} %clr{---}{faint} %clr{[%15.15t]}{faint} %clr{%-40.40c{1.}}{cyan} %clr{:}{faint} %m%n%xwEx</Property>
  </Properties>
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT" follow="true">
      <PatternLayout pattern="${LOG_PATTERN}"/>
    </Console>
    <Console name="Stackdriver" target="SYSTEM_OUT" follow="true">
      <StackdriverJSONLayout/>
    </Console>
  </Appenders>
  <Loggers>
    <Logger name="io.camunda.operate" level="info" />
    <Root level="info">
      <AppenderRef ref="${env:OPERATE_LOG_APPENDER:-Console}"/>
    </Root>
  </Loggers>
</Configuration>

By default, ConsoleAppender is used.

JSON logging configuration​

You can choose to output logs in JSON format (Stackdriver compatible). To enable it, define the environment variable OPERATE_LOG_APPENDER like this:

OPERATE_LOG_APPENDER=Stackdriver

Change logging level at runtime​

Operate supports the default scheme for changing logging levels as provided by Spring Boot.

The log level for Operate can be changed by following the Setting a Log Level section.

Set all Operate loggers to DEBUG​

curl 'http://localhost:8080/actuator/loggers/io.camunda.operate' -i -X POST \
-H 'Content-Type: application/json' \
-d '{"configuredLevel":"debug"}'

An example of application.yml file​

The following snippet represents the default Operate configuration, which is shipped with the distribution. This can be found inside the config folder (config/application.yml) and can be used to adjust Operate to your needs.

# Operate configuration file

camunda.operate:
  # Set operate userId, displayName and password.
  # If user with <userId> does not exists it will be created.
  # Default: demo/demo/demo
  userId: anUserId
  displayName: nameShownInWebpage
  password: aPassword
  roles:
    - OWNER
    - USER
  # ELS instance to store Operate data
  elasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # Url
    url: http://localhost:9200
  # Zeebe instance
  zeebe:
    # Gateway address to zeebe
    gatewayAddress: localhost:26500
  # ELS instance to export Zeebe data to
  zeebeElasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # url
    url: http://localhost:9200
    # Index prefix, configured in Zeebe Elasticsearch exporter
    prefix: zeebe-record