Property changes in Camunda 8.10
Changes to component configuration properties introduced in Camunda 8.10.
About unified configuration property changes
The unified configuration work began in Camunda 8.8, continued in 8.9, and is complete in 8.10. This page covers only the property changes introduced in 8.10. Properties added in 8.9 patch releases are not listed.
To learn more about property changes introduced in earlier versions, see:
New properties and backwards compatibility
Backwards compatibility between new Camunda 8.10 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.
|
| 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:
|
| New | New unified property without an existing equivalent legacy property. |
Recommended actions
As part of upgrading to Camunda 8.10, replace any legacy properties shown in the Camunda 8.10 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.schema-manager.retry.maxRetries=5
camunda.operate.elasticsearch.healthCheckEnabled=false
Remove the legacy properties and add the corresponding new properties:
camunda.data.secondary-storage.elasticsearch.retry.max-retries=5
camunda.data.secondary-storage.elasticsearch.health-check-enabled=false
Removed properties and changed defaults
Review the following changes before upgrading to Camunda 8.10.
Removed properties
camunda.processing.enable-async-scheduled-tasksis removed. If still set, it is ignored. Remove this property, and its legacy equivalentzeebe.broker.processingCfg.enableAsyncScheduledTasks, from your configuration.camunda.cluster.send-on-legacy-subjectis removed.camunda.process-instance-creation.business-id-uniqueness-enabledno longer falls back to the legacy propertyzeebe.broker.experimental.engine.processInstanceCreation.businessIdUniquenessEnabled. Set the unified property instead.
Changed defaults
| Property | Previous default | New default |
|---|---|---|
camunda.data.primary-storage.rocksdb.memory-allocation-strategy | PARTITION | FRACTION |
Physical Tenants
Camunda 8.10 adds the camunda.physical-tenants.<tenant-id>.* configuration prefix. See Physical Tenants for details. Each Physical Tenant overlays a camunda.* configuration tree on top of the root configuration. If you do not declare a default Physical Tenant, one is created from the root configuration.
- Some properties, such as cluster topology, system, license, and gRPC API settings, cannot be overridden per Physical Tenant.
- The
assignedpropertiescamunda.document.assigned,camunda.security.authentication.providers.assigned, andcamunda.data.exporters-assignedselect which document stores, OIDC providers, and custom exporters apply to a Physical Tenant. Set them only undercamunda.physical-tenants.<tenant-id>, not at the root.
Camunda 8.10 property changes
The following table shows new unified properties introduced in 8.10 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.
Learn more about new properties (including default values) in the property reference.
| Area | New property (8.10) | Legacy properties (8.9 and earlier) | Type |
|---|---|---|---|
| Cluster | camunda.cluster.zone | N/A | New |
| Cluster | camunda.cluster.partitioning.zone-aware.zones[].name | N/A | New |
| Cluster | camunda.cluster.partitioning.zone-aware.zones[].number-of-brokers | N/A | New |
| Cluster | camunda.cluster.partitioning.zone-aware.zones[].number-of-replicas | N/A | New |
| Cluster | camunda.cluster.partitioning.zone-aware.zones[].priority | N/A | New |
| Cluster | camunda.cluster.partitioning.fixed[].physical-tenant-id | N/A | New |
| Cluster | camunda.cluster.metadata.bootstrap-timeout | N/A | New |
| Cluster | camunda.cluster.node-id-provider.s3.expired-lease-threshold | N/A | New |
| Cluster | camunda.cluster.node-id-provider.s3.resolve-task-id | N/A | New |
| Cluster | camunda.cluster.raft.join-catch-up-timeout | N/A | New |
| Cluster | camunda.cluster.raft.promotion-lag-threshold | N/A | New |
| Cluster | camunda.cluster.raft.rebalance.replication-lag-threshold | N/A | New |
| Cluster | camunda.cluster.raft.rebalance.replication-timeout | N/A | New |
| Cluster | camunda.cluster.raft.rebalance.max-transfer-attempts | N/A | New |
| Cluster | camunda.cluster.raft.rebalance.leader-wait-timeout | N/A | New |
| API | camunda.api.grpc.max-connection-age | N/A | New |
| API | camunda.api.grpc.max-connection-age-grace | N/A | New |
| API | camunda.api.rest.cluster-variable.max-metadata-size | N/A | New |
| Data | camunda.data.wait-states.enabled | N/A | New |
| Data | camunda.data.extension-properties.tool-name-property | N/A | New |
| Data | camunda.data.extension-properties.inbound-connector-type-property | N/A | New |
| Data | camunda.data.extension-properties.tool-properties-prefix | N/A | New |
| Data | camunda.data.export.migration-status-scan-max-records | N/A | New |
| Data | camunda.data.secondary-storage.retention.usage-metrics-minimum-age |
| Direct mapping |
| Data | camunda.data.secondary-storage.elasticsearch.history.usage-metrics-policy-name |
| Breaking change |
| Data | camunda.data.secondary-storage.elasticsearch.history.usage-metrics-rollover-interval | zeebe.broker.exporters.camundaexporter.args.history.usageMetricsRolloverInterval | Direct mapping |
| Data | camunda.data.secondary-storage.elasticsearch.perform-cleanup | N/A | New |
| Data | camunda.data.secondary-storage.elasticsearch.health-check-enabled |
| Direct mapping |
| Data | camunda.data.secondary-storage.elasticsearch.retry.max-retries | camunda.database.schema-manager.retry.maxRetries | Direct mapping |
| Data | camunda.data.secondary-storage.elasticsearch.retry.min-retry-delay | camunda.database.schema-manager.retry.minRetryDelay | Direct mapping |
| Data | camunda.data.secondary-storage.elasticsearch.retry.max-retry-delay | camunda.database.schema-manager.retry.maxRetryDelay | Direct mapping |
| Data | camunda.data.secondary-storage.opensearch.history.usage-metrics-policy-name |
| Breaking change |
| Data | camunda.data.secondary-storage.opensearch.history.usage-metrics-rollover-interval | zeebe.broker.exporters.camundaexporter.args.history.usageMetricsRolloverInterval | Direct mapping |
| Data | camunda.data.secondary-storage.opensearch.perform-cleanup | N/A | New |
| Data | camunda.data.secondary-storage.opensearch.health-check-enabled |
| Direct mapping |
| Data | camunda.data.secondary-storage.opensearch.retry.max-retries | camunda.database.schema-manager.retry.maxRetries | Direct mapping |
| Data | camunda.data.secondary-storage.opensearch.retry.min-retry-delay | camunda.database.schema-manager.retry.minRetryDelay | Direct mapping |
| Data | camunda.data.secondary-storage.opensearch.retry.max-retry-delay | camunda.database.schema-manager.retry.maxRetryDelay | Direct mapping |
| Data | camunda.data.secondary-storage.rdbms.retry.max-retries | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.retry.min-retry-delay | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.retry.max-retry-delay | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.enabled | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.type | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.polling-interval | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.min-sync-replicas | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.max-lag | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.pause-on-max-lag-exceeded | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.delay | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.queue-debounce-time | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.async-replication.queue-capacity | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.connection-pool.leak-detection-threshold | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.connection-pool.keepalive-time | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.connection-pool.validation-timeout | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.rewrite-batched-statements | N/A | New |
| Data | camunda.data.secondary-storage.rdbms.database-vendor-id | N/A | New |
| Processing | camunda.processing.max-recoverable-retries | N/A | New |
| Processing | camunda.processing.max-pending-side-effects | N/A | New |
| Processing | camunda.processing.engine.max-process-depth | zeebe.broker.experimental.engine.maxProcessDepth | Direct mapping |
| Processing | camunda.processing.engine.caches.drg-cache-capacity | zeebe.broker.experimental.engine.caches.drgCacheCapacity | Direct mapping |
| Processing | camunda.processing.engine.caches.form-cache-capacity | zeebe.broker.experimental.engine.caches.formCacheCapacity | Direct mapping |
| Processing | camunda.processing.engine.caches.process-cache-capacity | zeebe.broker.experimental.engine.caches.processCacheCapacity | Direct mapping |
| Processing | camunda.processing.engine.caches.resource-cache-capacity | zeebe.broker.experimental.engine.caches.resourceCacheCapacity | Direct mapping |
| Processing | camunda.processing.engine.caches.authorizations-cache-capacity | zeebe.broker.experimental.engine.caches.authorizationsCacheCapacity | Direct mapping |
| Processing | camunda.processing.engine.caches.authorizations-cache-ttl | zeebe.broker.experimental.engine.caches.authorizationsCacheTtl | Direct mapping |
| Processing | camunda.processing.engine.caches.group-name-cache-capacity | zeebe.broker.experimental.engine.caches.groupNameCacheCapacity | Direct mapping |
| Processing | camunda.processing.engine.caches.candidate-group-name-resolution | zeebe.broker.experimental.engine.caches.candidateGroupNameResolution | Direct mapping |
| Processing | camunda.processing.engine.caches.process-cache-soft-values | N/A | New |
| Processing | camunda.processing.engine.job.timeout-checker-batch-limit | zeebe.broker.experimental.engine.jobs.timeoutCheckerBatchLimit | Direct mapping |
| Processing | camunda.processing.engine.job.timeout-checker-polling-interval | zeebe.broker.experimental.engine.jobs.timeoutCheckerPollingInterval | Direct mapping |
| Processing | camunda.processing.engine.job.include-variables-in-job-completed-event | N/A | New |
| Processing | camunda.processing.engine.messages.ttl-checker-batch-limit | zeebe.broker.experimental.engine.messages.ttlCheckerBatchLimit | Direct mapping |
| Processing | camunda.processing.engine.messages.ttl-checker-interval | zeebe.broker.experimental.engine.messages.ttlCheckerInterval | Direct mapping |
| Processing | camunda.processing.engine.validators.results-output-max-size | zeebe.broker.experimental.engine.validators.resultsOutputMaxSize | Direct mapping |
| Processing | camunda.processing.engine.distribution.pause-command-distribution | zeebe.broker.experimental.engine.distribution.pauseCommandDistribution | Direct mapping |
| Processing | camunda.processing.engine.secrets.interval | N/A | New |
| Processing | camunda.processing.engine.secrets.retry-max-attempts | N/A | New |
| Processing | camunda.processing.engine.secrets.retry-initial-delay | N/A | New |
| Processing | camunda.processing.engine.secrets.retry-max-delay | N/A | New |
| Processing | camunda.processing.engine.secrets.retry-backoff-factor | N/A | New |
| Processing | camunda.processing.engine.secrets.batch-resolution-limit | N/A | New |
| Processing | camunda.processing.engine.secrets.wake-delay | N/A | New |
| Processing | camunda.processing.engine.mappings.input-mode | N/A | New |
| Processing | camunda.processing.engine.mappings.output-mode | N/A | New |
| Processing | camunda.processing.engine.mappings.input-comparison-mode | N/A | New |
| Processing | camunda.processing.engine.mappings.output-comparison-mode | N/A | New |
| Processing | camunda.processing.engine.storage-ordinals.enable-archiverless | N/A | New |
| Processing | camunda.processing.engine.storage-ordinals.fixed-storage-ordinal | N/A | New |
| Process instance creation | camunda.process-instance-creation.message-start-dedup-expiration-sweep-interval | N/A | New |
| Process instance creation | camunda.process-instance-creation.message-start-dedup-expiration-sweep-batch-limit | N/A | New |
| Process instance creation | camunda.process-instance-creation.message-start-ask-retry-interval | N/A | New |
| Process instance creation | camunda.process-instance-creation.message-start-lock-release-poll-interval | N/A | New |
| Process instance creation | camunda.process-instance-creation.message-start-lock-release-poll-batch-limit | N/A | New |
| Monitoring | camunda.monitoring.metrics.usage-metrics.export-interval | zeebe.broker.experimental.engine.usageMetrics.exportInterval | Direct mapping |
| Security | camunda.security.cluster-admin.basic.users[].name | N/A | New |
| Security | camunda.security.cluster-admin.basic.users[].password | N/A | New |
| Security | camunda.security.cluster-admin.oidc.clients[] | N/A | New |
| Security | camunda.security.cluster-admin.oidc.groups[] | N/A | New |
| Security | camunda.security.cluster-admin.oidc.claims[].name | N/A | New |
| Security | camunda.security.cluster-admin.oidc.claims[].value | N/A | New |
| Camunda | camunda.license.key | N/A | New |
| Document | camunda.document.default-store-id | DOCUMENT_DEFAULT_STORE_ID | Direct mapping |
| Document | camunda.document.thread-pool-size | DOCUMENT_THREAD_POOL_SIZE | Direct mapping |
| Document | camunda.document.aws.<store-id>.bucket-name | DOCUMENT_STORE_<STORE_ID>_BUCKET | Direct mapping |
| Document | camunda.document.aws.<store-id>.bucket-path | DOCUMENT_STORE_<STORE_ID>_BUCKET_PATH | Direct mapping |
| Document | camunda.document.aws.<store-id>.region | N/A | New |
| Document | camunda.document.aws.<store-id>.bucket-ttl | DOCUMENT_STORE_<STORE_ID>_BUCKET_TTL | Direct mapping |
| Document | camunda.document.aws.<store-id>.endpoint | DOCUMENT_STORE_<STORE_ID>_ENDPOINT | Direct mapping |
| Document | camunda.document.aws.<store-id>.force-path-style | DOCUMENT_STORE_<STORE_ID>_FORCE_PATH_STYLE | Direct mapping |
| Document | camunda.document.aws.<store-id>.chunked-encoding-enabled | DOCUMENT_STORE_<STORE_ID>_CHUNKED_ENCODING_ENABLED | Direct mapping |
| Document | camunda.document.aws.<store-id>.support-legacy-md5 | DOCUMENT_STORE_<STORE_ID>_SUPPORT_LEGACY_MD5 | Direct mapping |
| Document | camunda.document.gcp.<store-id>.bucket-name | DOCUMENT_STORE_<STORE_ID>_BUCKET | Direct mapping |
| Document | camunda.document.gcp.<store-id>.prefix | DOCUMENT_STORE_<STORE_ID>_PREFIX | Direct mapping |
| Document | camunda.document.azure.<store-id>.container-name | DOCUMENT_STORE_<STORE_ID>_CONTAINER | Direct mapping |
| Document | camunda.document.azure.<store-id>.container-path | DOCUMENT_STORE_<STORE_ID>_CONTAINER_PATH | Direct mapping |
| Document | camunda.document.azure.<store-id>.endpoint | DOCUMENT_STORE_<STORE_ID>_ENDPOINT | Direct mapping |
| Document | camunda.document.azure.<store-id>.connection-string | DOCUMENT_STORE_<STORE_ID>_CONNECTION_STRING | Direct mapping |
| Document | camunda.document.local.<store-id>.path | DOCUMENT_STORE_<STORE_ID>_PATH | Direct mapping |
| Secrets | camunda.secrets.cache.ttl | N/A | New |
| Secrets | camunda.secrets.cache.max-size | N/A | New |
| Secrets | camunda.secrets.max-concurrency | N/A | New |
| Secrets | camunda.secrets.stores.file.default.path | N/A | New |
| Secrets | camunda.secrets.stores.aws.default.region | N/A | New |
| Secrets | camunda.secrets.stores.aws.default.path-prefix | N/A | New |
| Secrets | camunda.secrets.stores.aws.default.batch-enabled | N/A | New |
| Secrets | camunda.secrets.stores.aws.default.batch-size | N/A | New |
| Secrets | camunda.secrets.stores.aws.default.container-secret-id | N/A | New |
| Secrets | camunda.secrets.stores.aws.default.call-timeout | N/A | New |
| Secrets | camunda.secrets.stores.aws.default.attempt-timeout | N/A | New |
| Secrets | camunda.secrets.stores.gcp.default.project-id | N/A | New |
| Secrets | camunda.secrets.stores.gcp.default.path-prefix | N/A | New |
| Secrets | camunda.secrets.stores.gcp.default.endpoint | N/A | New |
| Secrets | camunda.secrets.stores.gcp.default.container-secret-id | N/A | New |
| Secrets | camunda.secrets.stores.gcp.default.call-timeout | N/A | New |