Camunda 8.8 property changes

Changes to component configuration properties introduced in Camunda 8.8.

About unified configuration property changes

In Camunda 8.8, the unified configuration for Orchestration Cluster components is introduced.

• Cluster and component behavior is defined in a single, centralized configuration system.
• This means some configuration properties have changed or are replaced with new properties.
• For example, the new camunda.system.cpu-thread-count property replaces zeebe.broker.threads.cpuThreadCount.

Camunda 8.9 unified configuration breaking changes

Only the first partial set of unified configuration properties is introduced in Camunda 8.8.

• All remaining unified property changes will be completed by Camunda 8.9.
• This remaining work will result in future breaking changes. For example, the secondary database properties will be unified into a secondary-storage properties section.

New properties and backwards compatibility

Backwards compatibility between new Camunda 8.8 unified properties and existing legacy properties is as follows:

Type	Description
Breaking change	New unified property with an existing equivalent legacy property or set of properties. Backwards compatibility is not supported. You should move legacy properties marked with breaking change to the new unified set before upgrading to Camunda 8.8. You can keep legacy properties in your configuration file as long as they match the new unified configuration equivalent property. However, this is not recommended as it can lead to misconfiguration. If the values do not match, the application will not start, and an error will be logged.
Direct mapping	New unified property with a direct mapping to an existing equivalent legacy property or set of properties. Backwards compatibility is supported as follows: If you have defined the new property, it is used. If you have not defined the new property, the legacy property is used.
New	New unified property without an existing equivalent legacy property.

Recommended actions

As part of upgrading to Camunda 8.8, replace any legacy properties shown in the Camunda 8.8 property changes table below with the equivalent new unified configuration property.

You can define configuration properties 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:

Property	Environment variable
camunda.api.grpc.address	CAMUNDA_API_GRPC_ADDRESS
camunda.api.grpc.min-keep-alive-interval	CAMUNDA_API_GRPC_MINKEEPALIVEINTERVAL

Example

In this example, an application uses the following legacy configuration:

camunda.database.url=http://prod-db.com:54321
camunda.operate.opensearch.url=http://prod-db.com:54321
camunda.tasklist.opensearch.url=http://prod-db.com:54321

Remove the legacy properties and add the corresponding new property:

camunda.data.secondary-storage.opensearch.url=http://prod-db.com:54321

Camunda 8.8 property changes

The following table shows new unified properties introduced in 8.8 and their equivalent legacy properties.

• Use the search box to find a specific property or set of properties matching your search term.
• Apply filter badges to filter the table by property change type.
• Sort the table alphabetically using the column headers.

info

Learn more about new properties (including default values) in the property reference.

AllBreaking changeDirect mappingNew

Area	New property (8.8)	Legacy properties (8.7 and earlier)	Type
API	camunda.api.grpc.address	zeebe.gateway.network.host zeebe.broker.gateway.network.host	Direct mapping
API	camunda.api.grpc.port	zeebe.gateway.network.port zeebe.broker.gateway.network.port	Direct mapping
API	camunda.api.grpc.min-keep-alive-interval	zeebe.gateway.network.minKeepAliveInterval zeebe.broker.gateway.network.minKeepAliveInterval	Direct mapping
API	camunda.api.grpc.max-message-size	zeebe.gateway.network.maxMessageSize zeebe.broker.gateway.network.maxMessageSize	Direct mapping
API	camunda.api.grpc.ssl.enabled	zeebe.gateway.security.enabled zeebe.broker.gateway.security.enabled	Direct mapping
API	camunda.api.grpc.ssl.certificate	zeebe.gateway.security.certificateChainPath zeebe.broker.gateway.security.certificateChainPath	Direct mapping
API	camunda.api.grpc.ssl.certificate-private-key	zeebe.gateway.security.privateKeyPath zeebe.broker.gateway.security.privateKeyPath	Direct mapping
API	camunda.api.grpc.ssl.key-store.file-path	zeebe.gateway.security.keyStore.filePath zeebe.broker.gateway.security.keyStore.filePath	Direct mapping
API	camunda.api.grpc.ssl.key-store.password	zeebe.gateway.security.keyStore.password zeebe.broker.gateway.security.keyStore.password	Direct mapping
API	camunda.api.grpc.interceptors[].id	zeebe.gateway.interceptors.[x].id zeebe.broker.gateway.interceptors.[x].id	Direct mapping
API	camunda.api.grpc.interceptors[].jar-path	zeebe.gateway.interceptors.[x].jarPath zeebe.broker.gateway.interceptors.[x].jarPath	Direct mapping
API	camunda.api.grpc.interceptors[].class-name	zeebe.gateway.interceptors.[x].className zeebe.broker.gateway.interceptors.[x].className	Direct mapping
API	camunda.api.grpc.management-threads	zeebe.gateway.threads.managementThreads zeebe.broker.gateway.threads.managementThreads	Direct mapping
API	camunda.api.long-polling.enabled	zeebe.gateway.longPolling.enabled zeebe.broker.gateway.longPolling.enabled	Direct mapping
API	camunda.api.long-polling.timeout	zeebe.gateway.longPolling.timeout zeebe.broker.gateway.longPolling.timeout	Direct mapping
API	camunda.api.long-polling.probe-timeout	zeebe.gateway.longPolling.probeTimeout zeebe.broker.gateway.longPolling.probeTimeout	Direct mapping
API	camunda.api.long-polling.min-empty-responses	zeebe.gateway.longPolling.minEmptyResponses zeebe.broker.gateway.longPolling.minEmptyResponses	Direct mapping
API	camunda.api.rest.filters[].id	zeebe.gateway.filters.[x].id zeebe.broker.gateway.filters.[x].id	Direct mapping
API	camunda.api.rest.filters[].jar-path	zeebe.gateway.filters.[x].jarPath zeebe.broker.gateway.filters.[x].jarPath	Direct mapping
API	camunda.api.rest.filters[].class-name	zeebe.gateway.filters.[x].className zeebe.broker.gateway.filters.[x].className	Direct mapping
API	camunda.api.rest.process-cache.max-size	camunda.rest.processCache.maxSize	Direct mapping
API	camunda.api.rest.process-cache.expiration-idle	camunda.rest.processCache.expirationIdleMillis	Direct mapping
API	camunda.api.rest.executor.core-pool-size-multiplier	camunda.rest.apiExecutor.corePoolSizeMultiplier	Direct mapping
API	camunda.api.rest.executor.max-pool-size-multiplier	camunda.rest.apiExecutor.maxPoolSizeMultiplier	Direct mapping
API	camunda.api.rest.executor.keep-alive	camunda.rest.apiExecutor.keepAliveSeconds	Direct mapping
API	camunda.api.rest.executor.queue-capacity	camunda.rest.apiExecutor.queueCapacity	Direct mapping
Cluster	camunda.cluster.metadata.sync-delay	zeebe.broker.cluster.configManager.gossip.syncDelay	Direct mapping
Cluster	camunda.cluster.metadata.sync-request-timeout	zeebe.broker.cluster.configManager.gossip.syncRequestTimeout	Direct mapping
Cluster	camunda.cluster.metadata.gossip-fanout	zeebe.broker.cluster.configManager.gossip.gossipFanout	Direct mapping
Cluster	camunda.cluster.network.host	zeebe.gateway.cluster.host zeebe.broker.network.host	Direct mapping
Cluster	camunda.cluster.node-id	zeebe.broker.cluster.nodeId	Direct mapping
Cluster	camunda.cluster.partition-count	zeebe.broker.cluster.partitionsCount	Direct mapping
Cluster	camunda.cluster.replication-factor	zeebe.broker.cluster.replicationFactor	Direct mapping
Cluster	camunda.cluster.size	zeebe.broker.cluster.clusterSize	Direct mapping
Cluster	camunda.cluster.raft.priority-election-enabled	zeebe.broker.cluster.raft.enablePriorityElection	Direct mapping
Cluster	camunda.cluster.raft.flush-enabled	zeebe.broker.cluster.raft.flush.enabled	Direct mapping
Cluster	camunda.cluster.raft.flush-delay	zeebe.broker.cluster.raft.flush.delay	Direct mapping
Cluster	camunda.cluster.raft.heartbeat-interval	zeebe.broker.cluster.heartbeatInterval	Direct mapping
Cluster	camunda.cluster.raft.election-timeout	zeebe.broker.cluster.electionTimeout	Direct mapping
Data	camunda.data.snapshot-period	zeebe.broker.data.snapshotPeriod	Direct mapping
Data	camunda.data.export.distribution-interval	zeebe.broker.exporting.distributionInterval	Direct mapping
Data	camunda.data.export.skip-records	zeebe.broker.exporting.skipRecords	Direct mapping
Data	camunda.data.backup.repository-name Note: Starting with 8.8, the same repository must be used for both Operate and Tasklist.	camunda.operate.backup.repositoryName camunda.tasklist.backup.repositoryName	Breaking change
Data	camunda.data.backup.snapshot-timeout	camunda.operate.backup.snapshotTimeout	Direct mapping
Data	camunda.data.backup.incomplete-check-timeout	camunda.operate.backup.incompleteCheckTimeoutInSeconds	Direct mapping
Data	camunda.data.backup.store	zeebe.broker.data.backup.store	Direct mapping
Data	camunda.data.backup.s3.bucket-name	zeebe.broker.data.backup.s3.bucketName	Direct mapping
Data	camunda.data.backup.s3.endpoint	zeebe.broker.data.backup.s3.endpoint	Direct mapping
Data	camunda.data.backup.s3.endpoint	zeebe.broker.data.backup.s3.endpoint	Direct mapping
Data	camunda.data.backup.s3.region	zeebe.broker.data.backup.s3.region	Direct mapping
Data	camunda.data.backup.s3.access-key	zeebe.broker.data.backup.s3.accessKey	Direct mapping
Data	camunda.data.backup.s3.secret-key	zeebe.broker.data.backup.s3.secretKey	Direct mapping
Data	camunda.data.backup.s3.api-call-timeout	zeebe.broker.data.backup.s3.apiCallTimeout	Direct mapping
Data	camunda.data.backup.s3.force-path-style-access	zeebe.broker.data.backup.s3.forcePathStyleAccess	Direct mapping
Data	camunda.data.backup.s3.compression:	zeebe.broker.data.backup.s3.compression:	Direct mapping
Data	camunda.data.backup.s3.max-concurrent-connections:	zeebe.broker.data.backup.s3.maxConcurrentConnections	Direct mapping
Data	camunda.data.backup.s3.connection-acquisition-timeout	zeebe.broker.data.backup.s3.connectionAcquisitionTimeout	Direct mapping
Data	camunda.data.backup.s3.base-path	zeebe.broker.data.backup.s3.basePath	Direct mapping
Data	camunda.data.backup.s3.support-legacy-md5	zeebe.broker.data.backup.s3.supportLegacyMd5	Direct mapping
Data	camunda.data.backup.gcs.bucket-name	zeebe.broker.data.backup.gcs.bucketName	Direct mapping
Data	camunda.data.backup.gcs.host	zeebe.broker.data.backup.gcs.host	Direct mapping
Data	camunda.data.backup.gcs.auth	zeebe.broker.data.backup.gcs.auth	Direct mapping
Data	camunda.data.backup.azure.endpoint	zeebe.broker.data.backup.azure.endpoint	Direct mapping
Data	camunda.data.backup.azure.account-name	zeebe.broker.data.backup.azure.accountName	Direct mapping
Data	camunda.data.backup.azure.account-key	zeebe.broker.data.backup.azure.accountKey	Direct mapping
Data	camunda.data.backup.azure.connection-string	zeebe.broker.data.backup.azure.connectionString	Direct mapping
Data	camunda.data.backup.azure.base-path	zeebe.broker.data.backup.azure.basePath	Direct mapping
Data	camunda.data.backup.azure.create-container	zeebe.broker.data.backup.azure.createContainer	Direct mapping
Data	camunda.data.backup.azure.sas-token.type	zeebe.broker.data.backup.azure.sasToken.type	Direct mapping
Data	camunda.data.backup.azure.sas-token.value	zeebe.broker.data.backup.azure.sasToken.value	Direct mapping
Data	camunda.data.backup.filesystem.base-path	zeebe.broker.data.backup.filesystem.basePath	Direct mapping
Data	camunda.data.secondary-storage.type	camunda.database.type camunda.operate.database camunda.tasklist.database	Breaking change
Data	camunda.data.secondary-storage.autoconfigure-camunda-exporter	N/A	New
Data	camunda.data.secondary-storage.elasticsearch.url	camunda.database.url camunda.operate.elasticsearch.url camunda.tasklist.elasticsearch.url zeebe.broker.exporters.camundaexporter.args.connect.url	Breaking change
Data	camunda.data.secondary-storage.elasticsearch.cluster-name	camunda.database.clusterName camunda.operate.elasticsearch.clusterName camunda.tasklist.elasticsearch.clusterName	Breaking change
Data	camunda.data.secondary-storage.elasticsearch.username	camunda.database.username camunda.operate.elasticsearch.username camunda.tasklist.elasticsearch.username	Breaking change
Data	camunda.data.secondary-storage.elasticsearch.password	camunda.database.password camunda.operate.elasticsearch.password camunda.tasklist.elasticsearch.password	Breaking change
Data	camunda.data.secondary-storage.elasticsearch.security.enabled	N/A	New
Data	camunda.data.secondary-storage.elasticsearch.security.certificate-path	N/A	New
Data	camunda.data.secondary-storage.elasticsearch.security.verify-hostname	N/A	New
Data	camunda.data.secondary-storage.elasticsearch.security.self-signed	N/A	New
Data	camunda.data.secondary-storage.elasticsearch.index-prefix	camunda.database.indexPrefix camunda.tasklist.elasticsearch.indexPrefix camunda.operate.elasticsearch.indexPrefix	Breaking change
Data	camunda.data.secondary-storage.opensearch.url	camunda.database.url camunda.operate.opensearch.url camunda.tasklist.opensearch.url zeebe.broker.exporters.camundaexporter.args.connect.url	Breaking change
Data	camunda.data.secondary-storage.opensearch.cluster-name	camunda.database.clusterName camunda.operate.opensearch.clusterName camunda.tasklist.opensearch.clusterName	Breaking change
Data	camunda.data.secondary-storage.opensearch.username	camunda.database.username camunda.operate.opensearch.username camunda.tasklist.opensearch.username	Breaking change
Data	camunda.data.secondary-storage.opensearch.password	camunda.database.password camunda.operate.opensearch.password camunda.tasklist.opensearch.password	Breaking change
Data	camunda.data.secondary-storage.opensearch.security.enabled	camunda.database.security.enabled	Breaking change
Data	camunda.data.secondary-storage.opensearch.security.certificate-path	camunda.database.security.certificatePath camunda.tasklist.opensearch.ssl.certificatePath camunda.operate.opensearch.ssl.certificatePath	Breaking change
Data	camunda.data.secondary-storage.opensearch.security.verify-hostname	camunda.database.security.verifyHostname camunda.tasklist.opensearch.ssl.verifyHostname camunda.operate.opensearch.ssl.verifyHostname	Breaking change
Data	camunda.data.secondary-storage.opensearch.security.self-signed	camunda.database.security.selfSigned camunda.tasklist.elasticsearch.ssl.selfSigned camunda.operate.elasticsearch.ssl.selfSigned	Breaking change
Data	camunda.data.secondary-storage.opensearch.index-prefix	camunda.database.indexPrefix camunda.tasklist.opensearch.indexPrefix camunda.operate.opensearch.indexPrefix	Breaking change
Data	camunda.data.primary-storage.directory	zeebe.broker.data.directory	Direct mapping
Data	camunda.data.primary-storage.runtime-directory	zeebe.broker.data.runtimeDirectory	Direct mapping
Data	camunda.data.primary-storage.disk.monitoring-interval	zeebe.broker.data.disk.monitoringInterval	Direct mapping
Data	camunda.data.primary-storage.disk.monitoring-enabled	zeebe.broker.data.disk.enableMonitoring	Direct mapping
Data	camunda.data.primary-storage.disk.free-space.processing	zeebe.broker.data.disk.freeSpace.processing	Direct mapping
Data	camunda.data.primary-storage.disk.free-space.replication	zeebe.broker.data.disk.freeSpace.replication	Direct mapping
Data	camunda.data.primary-storage.logstream.log-segment-size	zeebe.broker.data.logSegmentSize	Direct mapping
Data	camunda.data.primary-storage.logstream.log-index-density	zeebe.broker.data.logIndexDensity	Direct mapping
Data	camunda.data.primary-storage.rocksdb.statistics-enabled	zeebe.broker.experimental.rocksdb.enableStatistics	Direct mapping
Data	camunda.data.primary-storage.rocksdb.access-metrics	zeebe.broker.experimental.rocksdb.accessMetrics	Direct mapping
Data	camunda.data.primary-storage.rocksdb.memory-limit	zeebe.broker.experimental.rocksdb.memoryLimit	Direct mapping
Data	camunda.data.primary-storage.rocksdb.max-open-files	zeebe.broker.experimental.rocksdb.maxOpenFiles	Direct mapping
Data	camunda.data.primary-storage.rocksdb.max-write-buffer-number	zeebe.broker.experimental.rocksdb.maxWriteBufferNumber	Direct mapping
Data	camunda.data.primary-storage.rocksdb.min-write-buffer-number-to-merge	zeebe.broker.experimental.rocksdb.minWriteBufferNumberToMerge	Direct mapping
Data	camunda.data.primary-storage.rocksdb.io-rate-bytes-per-second	zeebe.broker.experimental.rocksdb.ioRateBytesPerSecond	Direct mapping
Data	camunda.data.primary-storage.rocksdb.wal-disabled	zeebe.broker.experimental.rocksdb.disableWal	Direct mapping
Data	camunda.data.primary-storage.rocksdb.column-family-options	zeebe.broker.experimental.rocksdb.columnFamilyOptions	Direct mapping
Data	camunda.data.primary-storage.rocksdb.sst-partitioning-enabled	zeebe.broker.experimental.rocksdb.enableSstPartitioning	Direct mapping
System	camunda.system.cpu-thread-count	zeebe.broker.threads.cpuThreadCount	Direct mapping
System	camunda.system.io-thread-count	zeebe.broker.threads.ioThreadCount	Direct mapping
System	camunda.system.clock-controlled	zeebe.clock.controlled	Direct mapping
System	camunda.system.actor.idle.max-spins	zeebe.actor.idle.maxSpins	Direct mapping
System	camunda.system.actor.idle.max-yields	zeebe.actor.idle.maxYields	Direct mapping
System	camunda.system.actor.idle.max-park-period	zeebe.actor.idle.maxParkPeriod	Direct mapping
System	camunda.system.upgrade.enable-version-check	zeebe.broker.experimental.versionCheckRestrictionEnabled	Direct mapping
Spring Profile	spring.profiles.active	N/A	New
Server	server.address	N/A	New
Server	server.port	N/A	New
Server	server.ssl.enabled	N/A	New
Server	server.ssl.certificate	N/A	New
Server	server.ssl.certificate-private-key	N/A	New
Server	management.server	N/A	New
Server	management.server.address	N/A	New
Server	management.server.port	N/A	New
Server	management.server.ssl.enabled	N/A	New
Server	management.endpoint	N/A	New
Licensing	camunda.license.key	N/A	New