From e4e18fc4c1e765da6ad779026ba73f251ec42f5f Mon Sep 17 00:00:00 2001 From: Petros Savvidis Date: Wed, 4 Sep 2024 15:56:49 +0300 Subject: [PATCH 1/6] chore(quarkus-integration): Update Quarkus 3.14 Properties - generic-config suffix is added to process-engine, job-executor properties Related-to: https://github.com/camunda/camunda-bpm-platform/issues/4163 --- .../quarkus-integration/configuration.md | 39 ++++++++++--------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/content/user-guide/quarkus-integration/configuration.md b/content/user-guide/quarkus-integration/configuration.md index 0e966e4936..8f128c9f06 100644 --- a/content/user-guide/quarkus-integration/configuration.md +++ b/content/user-guide/quarkus-integration/configuration.md @@ -99,9 +99,10 @@ You can set any process engine configuration properties under the `quarkus.camun convert any property names from `camelCase` to the `kebab-case` format, like in the following example: ```properties -quarkus.camunda.cmmn-enabled=false -quarkus.camunda.dmn-enabled=false -quarkus.camunda.history=none +quarkus.camunda.generic-config.cmmn-enabled=false +quarkus.camunda.generic-config.dmn-enabled=false +quarkus.camunda.generic-config.history=none +quarkus.camunda.generic-config.initialize-telemetry=false ``` ### Programmatic Configuration @@ -125,7 +126,7 @@ In the above example, a `QuarkusProcessEngineConfiguration` CDI bean defines "cu However, if you define the following in an `application.properties` file ```properties -quarkus.camunda.process-engine-name=quarkusEngine +quarkus.camunda.generic-config.process-engine-name=quarkusEngine ``` then "quarkusEngine" will be used as the process engine name since Quarkus config sources have a higher ordinal than a @@ -139,10 +140,10 @@ page documents all the available properties. Convert any property names you inte `kebab-case` format, like in the following example: ```properties -quarkus.camunda.job-executor.max-jobs-per-acquisition=5 -quarkus.camunda.job-executor.lock-time-in-millis=500000 -quarkus.camunda.job-executor.wait-time-in-millis=7000 -quarkus.camunda.job-executor.max-wait=65000 +quarkus.camunda.job-executor.generic-config.max-jobs-per-acquisition=5 +quarkus.camunda.job-executor.generic-config.lock-time-in-millis=500000 +quarkus.camunda.job-executor.generic-config.wait-time-in-millis=7000 +quarkus.camunda.job-executor.generic-config.max-wait=65000 ``` ## Quarkus Extension Configuration @@ -176,7 +177,7 @@ the Quarkus-specific properties in the following table: Job Executor - quarkus.camunda.job-executor.thread-pool + quarkus.camunda.job-executor.generic-config.thread-pool .max-pool-size Sets the maximum number of threads that can be present in the thread pool. 10 @@ -217,18 +218,18 @@ engine configuration, job executor and data source: ```properties # process engine configuration -quarkus.camunda.cmmn-enabled=false -quarkus.camunda.dmn-enabled=false -quarkus.camunda.history=none +quarkus.camunda.generic-config.cmmn-enabled=false +quarkus.camunda.generic-config.dmn-enabled=false +quarkus.camunda.generic-config.history=none # job executor configuration -quarkus.camunda.job-executor.thread-pool.max-pool-size=12 -quarkus.camunda.job-executor.thread-pool.queue-size=5 -quarkus.camunda.job-executor.max-jobs-per-acquisition=5 -quarkus.camunda.job-executor.lock-time-in-millis=500000 -quarkus.camunda.job-executor.wait-time-in-millis=7000 -quarkus.camunda.job-executor.max-wait=65000 -quarkus.camunda.job-executor.backoff-time-in-millis=5 +quarkus.camunda.job-executor.generic-config.thread-pool.max-pool-size=12 +quarkus.camunda.job-executor.generic-config.thread-pool.queue-size=5 +quarkus.camunda.job-executor.generic-config.max-jobs-per-acquisition=5 +quarkus.camunda.job-executor.generic-config.lock-time-in-millis=500000 +quarkus.camunda.job-executor.generic-config.wait-time-in-millis=7000 +quarkus.camunda.job-executor.generic-config.max-wait=65000 +quarkus.camunda.job-executor.generic-config.backoff-time-in-millis=5 # custom data source configuration and selection quarkus.datasource.my-datasource.db-kind=h2 From af8a3248a2d6858dec15b0e9f3dccd1bd38e19be Mon Sep 17 00:00:00 2001 From: Petros Savvidis Date: Wed, 4 Sep 2024 16:40:20 +0300 Subject: [PATCH 2/6] chore(721-to-722): Add Quarkus Update to the Migration Guide Related-to: https://github.com/camunda/camunda-bpm-platform/issues/4163 --- content/update/minor/721-to-722/_index.md | 27 +++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/content/update/minor/721-to-722/_index.md b/content/update/minor/721-to-722/_index.md index dec1020f3e..1a28d35701 100644 --- a/content/update/minor/721-to-722/_index.md +++ b/content/update/minor/721-to-722/_index.md @@ -28,6 +28,7 @@ This document guides you through the update from Camunda `7.21.x` to `7.22.0` an 1. For administrators and developers: [Update to Groovy 4.0](#update-to-groovy-4) 1. For administrators and developers: [Sending telemetry feature removed](#sending-telemetry-feature-removed) 1. For administrators: [Database transaction isolation level `READ_COMMITTED` is enforced](#database-transaction-isolation-level-read-committed-is-enforced) +1. For developers: [Quarkus 3.14 Extension Update](#quarkus-3-14-extension-update) This guide covers mandatory migration steps and optional considerations for the initial configuration of new functionality included in Camunda 7.22. @@ -264,3 +265,29 @@ When starting the engine, a check is performed in order to determine if the tran This behaviour can be disabled by setting the `skipIsolationLevelCheck` flag to `true`. Doing this will prevent an exception from being thrown and a warning message will be logged instead. [See here]({{< ref "/reference/deployment-descriptors/tags/process-engine.md#configuration-properties" >}}) for more details about this and other properties. + +# Quarkus 3.14 Extension Update + +The Quarkus Extension has been updated to use Quarkus `3.14`. This version brings its own features and changes. +For a complete list, see the [Quarkus 3.14 Release](https://quarkus.io/blog/quarkus-3-14-1-released) blog post. + +## Breaking Changes + +`Quarkus 3.14` extensions introduce **breaking changes** in the way the Quarkus runtime treats configuration. As a result, we decided +to perform a config migration at this point to be consistent with the new behaviour of the framework. + +The change affects the configuration of the process engine and the job executor. + +## Property Examples + +- `quarkus.camunda.enforce-history-time-to-live` **becomes** `quarkus.camunda.generic-config.enforce-history-time-to-live` + +- `quarkus.camunda.job-executor.thread-pool.max-pool-size` **becomes** `quarkus.camunda.job-executor.generic-config.thread-pool.max-pool-size` + +## Configuration Page Update + +For a detailed guide on the new Quarkus properties, you can visit the updated [Quarkus Configuration]({{< ref "/user-guide/quarkus-integration/configuration.md" >}}) page + +## References + +If you want to read more on how Quarkus Extensions treat configuration differently, checkout the [Quarkus 3.14 Migration Guide](https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.14#for-extension-developers). \ No newline at end of file From d54c1215fed0e4938ccc65bbeb40e00b63311360 Mon Sep 17 00:00:00 2001 From: psavidis <69160690+psavidis@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:05:36 +0300 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: Miklas Boskamp <20189772+mboskamp@users.noreply.github.com> --- content/update/minor/721-to-722/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/update/minor/721-to-722/_index.md b/content/update/minor/721-to-722/_index.md index 1a28d35701..71aa4a8779 100644 --- a/content/update/minor/721-to-722/_index.md +++ b/content/update/minor/721-to-722/_index.md @@ -268,8 +268,8 @@ This behaviour can be disabled by setting the `skipIsolationLevelCheck` flag to # Quarkus 3.14 Extension Update -The Quarkus Extension has been updated to use Quarkus `3.14`. This version brings its own features and changes. -For a complete list, see the [Quarkus 3.14 Release](https://quarkus.io/blog/quarkus-3-14-1-released) blog post. +The Camunda Quarkus Extension has been updated to use Quarkus `3.14`. This version brings its own features and changes. +For a complete list, see the [Quarkus 3.14.2 Release](https://quarkus.io/blog/quarkus-3-14-2-released) blog post. ## Breaking Changes From ca490710ad31772c450ed6abbeb872107d9519bc Mon Sep 17 00:00:00 2001 From: Petros Savvidis Date: Fri, 6 Sep 2024 13:43:05 +0300 Subject: [PATCH 4/6] chore(721-to-722): Add extra explanation under property examples --- content/update/minor/721-to-722/_index.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/content/update/minor/721-to-722/_index.md b/content/update/minor/721-to-722/_index.md index 71aa4a8779..ce9f5bfc44 100644 --- a/content/update/minor/721-to-722/_index.md +++ b/content/update/minor/721-to-722/_index.md @@ -273,10 +273,13 @@ For a complete list, see the [Quarkus 3.14.2 Release](https://quarkus.io/blog/qu ## Breaking Changes -`Quarkus 3.14` extensions introduce **breaking changes** in the way the Quarkus runtime treats configuration. As a result, we decided -to perform a config migration at this point to be consistent with the new behaviour of the framework. +`Quarkus 3.14` extensions introduce **breaking changes** in the way the Quarkus runtime treats configuration. -The change affects the configuration of the process engine and the job executor. +As a result, we decided to accept a config migration at this point to be consistent with the new behaviour of the framework (see [property examples](#property-examples) below) + +The config properties will now follow a similar scheme to the [Camunda Spring Boot Starter Configuration]({{< ref "/user-guide/spring-boot-integration/configuration.md#generic-properties" >}}). + +The change affects the configuration of the [process engine]({{< ref "/reference/deployment-descriptors/tags/process-engine.md#configuration-properties" >}}) and the [job executor]({{< ref "/reference/deployment-descriptors/tags/job-executor.md" >}}). ## Property Examples @@ -284,6 +287,9 @@ The change affects the configuration of the process engine and the job executor. - `quarkus.camunda.job-executor.thread-pool.max-pool-size` **becomes** `quarkus.camunda.job-executor.generic-config.thread-pool.max-pool-size` +**Reason for Change**: The Quarkus migration guide encourages using named `ConfigMappings`, and we chose to adopt it to future-proof the extension. +This requires using the new namespace `generic-config`. + ## Configuration Page Update For a detailed guide on the new Quarkus properties, you can visit the updated [Quarkus Configuration]({{< ref "/user-guide/quarkus-integration/configuration.md" >}}) page From 2149826561ed66b91f013cde790fa4fcfa3d4d4c Mon Sep 17 00:00:00 2001 From: Petros Savvidis Date: Mon, 9 Sep 2024 17:06:46 +0300 Subject: [PATCH 5/6] chore(721-to-722): Fix code review points --- content/update/minor/721-to-722/_index.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/content/update/minor/721-to-722/_index.md b/content/update/minor/721-to-722/_index.md index ce9f5bfc44..1f1c744517 100644 --- a/content/update/minor/721-to-722/_index.md +++ b/content/update/minor/721-to-722/_index.md @@ -281,19 +281,13 @@ The config properties will now follow a similar scheme to the [Camunda Spring Bo The change affects the configuration of the [process engine]({{< ref "/reference/deployment-descriptors/tags/process-engine.md#configuration-properties" >}}) and the [job executor]({{< ref "/reference/deployment-descriptors/tags/job-executor.md" >}}). -## Property Examples +**Reason for Change**: The Quarkus migration guide encourages using named `ConfigMappings`, and we chose to adopt it to future-proof the extension. +This requires using the new namespace `generic-config`. - `quarkus.camunda.enforce-history-time-to-live` **becomes** `quarkus.camunda.generic-config.enforce-history-time-to-live` - `quarkus.camunda.job-executor.thread-pool.max-pool-size` **becomes** `quarkus.camunda.job-executor.generic-config.thread-pool.max-pool-size` -**Reason for Change**: The Quarkus migration guide encourages using named `ConfigMappings`, and we chose to adopt it to future-proof the extension. -This requires using the new namespace `generic-config`. - -## Configuration Page Update - For a detailed guide on the new Quarkus properties, you can visit the updated [Quarkus Configuration]({{< ref "/user-guide/quarkus-integration/configuration.md" >}}) page -## References - If you want to read more on how Quarkus Extensions treat configuration differently, checkout the [Quarkus 3.14 Migration Guide](https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.14#for-extension-developers). \ No newline at end of file From 5e5eaba1ccdd6c75fbcb8a4624fb979aa4bc20d8 Mon Sep 17 00:00:00 2001 From: psavidis <69160690+psavidis@users.noreply.github.com> Date: Thu, 12 Sep 2024 15:56:35 +0300 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Cole Isaac <82131455+conceptualshark@users.noreply.github.com> --- content/update/minor/721-to-722/_index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/update/minor/721-to-722/_index.md b/content/update/minor/721-to-722/_index.md index 1f1c744517..b99ecbbb2d 100644 --- a/content/update/minor/721-to-722/_index.md +++ b/content/update/minor/721-to-722/_index.md @@ -275,9 +275,9 @@ For a complete list, see the [Quarkus 3.14.2 Release](https://quarkus.io/blog/qu `Quarkus 3.14` extensions introduce **breaking changes** in the way the Quarkus runtime treats configuration. -As a result, we decided to accept a config migration at this point to be consistent with the new behaviour of the framework (see [property examples](#property-examples) below) +A config migration is required to remain consistent with the new behavior of the framework (see [property examples](#property-examples) below). -The config properties will now follow a similar scheme to the [Camunda Spring Boot Starter Configuration]({{< ref "/user-guide/spring-boot-integration/configuration.md#generic-properties" >}}). +The config properties now follow a similar scheme to the [Camunda Spring Boot Starter Configuration]({{< ref "/user-guide/spring-boot-integration/configuration.md#generic-properties" >}}). The change affects the configuration of the [process engine]({{< ref "/reference/deployment-descriptors/tags/process-engine.md#configuration-properties" >}}) and the [job executor]({{< ref "/reference/deployment-descriptors/tags/job-executor.md" >}}). @@ -288,6 +288,6 @@ This requires using the new namespace `generic-config`. - `quarkus.camunda.job-executor.thread-pool.max-pool-size` **becomes** `quarkus.camunda.job-executor.generic-config.thread-pool.max-pool-size` -For a detailed guide on the new Quarkus properties, you can visit the updated [Quarkus Configuration]({{< ref "/user-guide/quarkus-integration/configuration.md" >}}) page +For a detailed guide on the new Quarkus properties, visit the updated [Quarkus Configuration]({{< ref "/user-guide/quarkus-integration/configuration.md" >}}) page. -If you want to read more on how Quarkus Extensions treat configuration differently, checkout the [Quarkus 3.14 Migration Guide](https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.14#for-extension-developers). \ No newline at end of file +To read more on how Quarkus extensions treat configuration differently, see the [Quarkus 3.14 Migration Guide](https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.14#for-extension-developers). \ No newline at end of file