Quarkus Platform

Quarkus Platform aggregates extensions from the Quarkus Core repository and a set of other extensions developed by the Quarkus community into a single development stack that targets the primary use-cases of the Quarkus platform. The Quarkus platform includes an integration testsuite to make sure the extensions included into the platform do not create conflicts for each other and can be used in the same application in any combination. More information about how a Quarkus platform is defined can be found in the Platform Guide.

Platform coordination mailing list

If you are a Quarkus Platform participant, it is highly recommended to subscribe to the quarkus-platform-coordination mailing list.

It is a low traffic list which aims to facilitate the coordination of the Platform releases and to share important Platform-related changes.

Platform project

Quarkus platform is a project that brings various Quarkus extensions together aligning their dependency constraints to make sure they do not create conflicts for each other. This project does not include any code at this point but it does use tools that collect the original dependency constraints of each extension as an input and generates a set of platform artifacts that represent a platform build.

Platform members

A platform member represents a Quarkus extension project that includes one or more Quarkus extensions that are integrated into a platform.

Quarkus core

Quarkus Core is an essential member of a platform and is dominant during the dependency constraint alignment in a sense that its dependency constraints are immutable, i.e. other platform members will be adapted to comply with the Quarkus core build and runtime requirements and not the other way around.

Platform member input

Quarkus platform members are expected to provide:

the dependency constraints their extensions require at Quarkus application build and run times (typically in the form of a Maven BOM artifact);
a list of Maven test-jar artifacts that should be added to the Quarkus platform integration testsuite (it would typically be some of the original tests from the extension project that are released along with the extension as Maven test-jar artifacts).

The Quarkus platform BOM generator will perform an alignment across all the platform member dependency constraints and will generate a BOM for each platform member that is compatible with all the other platform members. Once all the member BOMs have been generated, the platform integration testsuite (consisting of the tests contributed by all the members) will be run against the generated platform BOMs. As long as all the platform integration tests pass, the generated platform member BOMs (and a few other related artifacts), representing a single compatible development stack, can be released.

Generated platform member artifacts

The platform project build will generate the following artifacts for each member.

BOM

Member-specific dependency constraints that are aligned with other platform members. Applications developed in compliance with a Quarkus platform will be importing platform member BOMs that belong to the same platform release. E.g. a platform may include extensions from Camel Quarkus and Kogito Runtimes, in which case a platform release will include a quarkus-camel-bom and a quarkus-kogito-bom. Applications using Camel extensions will then be importing the quarkus-camel-bom, applications using Kogito extensions will be importing the quarkus-kogito-bom and applications using Camel and Kogito extensions at the same time will be importing both the quarkus-camel-bom and the quarkus-kogito-bom.

NOTE The ordering of member BOM imports in applications should not be significant, given that member BOMs are aligned as part of the platform build.

JSON descriptor

This artifact contains member extension metadata that is important for the Quarkus devtools used by application developers to discover extensions suitable for their projects.

Properties

At a minimum, this artifact includes information about the platform release. This information is used by the Quarkus application bootstrap mechanism to make sure the platform member BOMs imported by the application belong to the same platform release and fail the build or log a warning in case that is not the case. This is done to make sure application developers do not import member BOMs that belong different platform releases by mistake.

Building and testing the platform project

The platform is currently configured in a single Maven POM file (the root pom.xml) with the exception of a few additional resource files. This POM file includes a few Maven plugin configuration generating the platform artifacts and a platformConfig configuration.

IMPORTANT Maven build process launched from the root project directory will generate the complete platform Maven project (during the process-resources phase) in the generated-platform-project directory. The generated platform project should not be modified manually except for local testing purposes. The project will be re-generated on every platform build launched from the root platform project directory.

The generated-platform-project will refer to the root platform project pom.xml as its parent POM and so may inherit properties and other common configuration from it.

Generating the platform project

./mvnw -Dsync will generate the complete platform project.

The platform project will typically be generated on every build anyway. But this command could be used in case you want to simply (re-)generate the platform project w/o running any other commands on it.

NOTE the way it's currently done is any command launched from the platform project's root dir will be passed to the generated-platform-project, which means ./mvnw -Dsync will not only generate the platform project but will also be executed against it.

Installing the platform

mvn install launched from the platform project's root directory will (re-)generate the generated-platform-project, build, test and (assuming the tests have passed) install the generated platform artifacts into the local Maven repository.

Testing the platform

mvn test or mvn verify launched from the root platform project directory will (re-)generate the generated-platform-project and execute all the JVM tests of all the members.

mvn verify -Dnative launched from the root platform project directory will (re-)generate the generated-platform-project and execute all the JVM and native tests of all the members.

Once the platform project has been generated and installed in the local Maven repository, platform contibutors can analyze the artifacts generated for their extensions and run their testsuite in isolation from the rest of the platform testsuite by navigating to the desired test module and using mvn commands they typically would use to run their extension tests.

Platform configuration

The platform is currently configured in the root POM file under the platformConfig element of the io.quarkus:quarkus-platform-bom-maven-plugin configuration.

Release configuration

The platform release configuration is expressed under the release element, e.g.

  <platformConfig>
    <!-- the platform release info -->
    <release>
      <!-- the platform (dev stack) key (if not specified, defaults to the root project's groudId) -->
      <platformKey>${project.groupId}</platformKey>
      <!-- platform stream id, representing the flow of backward compatible releases
           (if not specified, defaults to the project's major.minor platform version) -->
      <stream>2.0</stream>
      <!-- platform (comparable) version, must be unique in the scope of the stream
           (if not specified, defaults to the micro version of the complete platform version) -->
      <version>0</version>
    </release>

The universal platform

This is the BOM that contains the dependency version constraints of all the platform members. In Quarkus 1.x it is known as the quarkus-universe-bom. Its coordinates can be configured using the bom element, e.g.

  <platformConfig>
    <universal>
      <!-- coordinates of the generated all-inclusive platform BOM -->
      <bom>io.quarkus:quarkus-universe-bom:${project.version}</bom>
      <!-- whether to skip installation of the all-inclusive platform BOM -->
      <skipInstall>false</skipInstall>
    </universal>

The skipInstall element can be used to exclude the all-inclusive BOM from the artifacts to be installed and deployed.

Quarkus core configuration

Quarkus core is an essential member of a platform and is configured in the core element, e.g.

  <core>
    <name>Core</name> <!-- 1 -->
    <bom>io.quarkus:quarkus-bom:${quarkus.version}</bom> <!-- 2 -->
    <release>
      <next>${project.groupId}:quarkus-bom:${project.version}</next> <!-- 3 -->
    </release>
  </core>

Name that is used to refer to the core member in the POMs and other generated resources
The original Quarkus core BOM coordinates the platform is based on
The coordinates under which the generated Quarkus core platform BOM should be installed and deployed

Platform member configuration

Platform members are configured under the member element, e.g.

  <members>
    <member>
      <name>OptaPlanner</name>                                                     <!-- 1 -->
      <bom>org.optaplanner:optaplanner-bom:${optaplanner-quarkus.version}</bom>    <!-- 2 -->
      <enabled>true</enabled>                                                      <!-- 3 -->
      <release>
        <next>${project.groupId}:quarkus-optaplanner-bom:${project.version}</next> <!-- 4 -->
        <!-- updated automatically -->
        <lastDetectedBomUpdate>io.quarkus.platform:quarkus-optaplanner-bom:2.0.0.Final</lastDetectedBomUpdate> <!-- 5 -->
      </release>
      <dependencyManagement>                                                       <!-- 6 -->
        <dependency>org.acme:acme:${acme.version}</dependency>
        <dependencySpec>
          <artifact>org.acme:foo:${acme.version}</artifact>
          <exclusions>
            <exclusion>org.acme:bar</exclusion>
          </exclusions>
        </dependencySpec>
      </dependencyManagement>
      <alignOwnConstraints>false</alignOwnConstraints>                             <!-- 7 -->
      <keepThirdpartyExclusions>true</keepThirdpartyExclusions>                    <!-- 8 -->
      <extensionGroupIds>                                                          <!-- 9 -->
        <groupId>org.acme</groupId>
      </extensionGroupIds>
      <ownGroupIds>                                                                <!-- 10 -->
        <groupId>org.acme</groupId>
        <groupId>org.acme.other</groupId>
      </ownGroupIds>
      <defaultTestConfig>                                                          <!-- 11 -->
        <skip>false</skip>                                                         <!-- 12 -->
      </defaultTestConfig>
      <tests>
        <test> <!-- 13 -->
          <artifact>org.optaplanner:optaplanner-quarkus-jackson-integration-test:${optaplanner-quarkus.version}</artifact>
          <skip>true</skip>                                                        <!-- 14 -->
        </test>
...

Name that is used to refere to the member in the POMs and other generated resources
The original member BOM coordinates representing members build and run times classpath constraints
Whether the member actually participates in the platform build or not (if a member is disabled, the rest of its configuration will be ignored)
The coordinates under which the generated member platform BOM should be installed and deployed
The BOM generator detects whether the generated member BOM has changed since the previous release and records the value of the last release in which the BOM has actually changed. The value of this element is meant to be updated during the release process by the tool itself in case the BOM has actually changed.
Custom dependency management configuration
Whether to align constraints of the member BOM that appear to be originating from the same project on a common/preferred version of that project or keep the original member BOM, the default for this option is false
Whether to keep exclusions found in the member BOM for thirdparty dependencies shared with other members. This option allows each member to have its own exclusions in their BOMs for common dependencies. The default value is true.
Maven artifact groupIds the extension artifacts of this member will have. If not configured, the original member BOM groupId will be the default. This helps optimize identify extension version constraints in the member BOM.
Maven artifact groupIds that member has the exclusive right to manage in the platform that other members will not be allowed to override.
The default configuration options for all the tests of the member
Can be used to skip all the member tests (unless explicitly overridden in a test config)
Specific test configuration will reference a Maven test jar artifact containing the tests that should be run as part of the platform's IT
Whether the test should be skipped during the platform IT run

Platform member test configuration

Besides the mentioned about artifact and skip elements the following test configuration options are available:

  <test>
    <artifact>com.datastax.oss.quarkus:cassandra-quarkus-integration-tests-main:${quarkus-cassandra-client.version}</artifact>

    <!-- skip native test runs (by default a single test is assumed to include both the JVM and the corresponding native test) -->
    <skipNative>true</skipNative>
    <!-- skip JVM test runs but do run the native test -->
    <skipJvm>true</skipJvm>
    
    <!-- while skipping means adding `maven.test.skip` property to the config, excluding means removing the test module for the artifact -->
    <excluded>true</excluded>
    
    <!-- use the failsafe plugin instead of the surefire one (which is the default) for the test-->
    <mavenFailsafePlugin>true</mavenFailsafePlugin>

    <!-- test groups config (applied to both jvm and native tests unless the nativeGroups is present) -->
    <groups>!native</groups>

    <!-- native test groups (applied only to the native groups and overrides 'groups') -->
    <nativeGroups>native</nativeGroups>

    <!-- Test POM propertuies -->
    <pomProperties>
      <test.project.prop1>value1</test.propject.prop1>
    </pomProperties>

    <!-- JVM-only system properties -->
    <jvmSystemProperties>
      <quarkus.http.test-port>$${test.http.port.jvm}</quarkus.http.test-port>
    </jvmSystemProperties>
    <!-- Native-only system properties -->
    <nativeSystemProperties>
      <quarkus.http.test-port>$${test.http.port.native}</quarkus.http.test-port>
    </nativeSystemProperties>
    <!-- JVM and native system property -->
    <systemProperties>
      <prop1>value1</prop1>
    </systemProperties>

    <!-- extra dependencies that should be added to the test application
         WHICH PRACTICALLY SHOULD BE AVOIDED -->
    <dependencies>
      <dependency>io.quarkus:quarkus-jdbc-h2:${quarkus.version}</dependency>
    </dependencies>
    <!-- extra test scope dependencies that should be added to the test application
         WHICH PRACTICALLY SHOULD BE AVOIDED -->
    <testDependencies>
      <dependency>io.quarkus:quarkus-test-h2:${quarkus.version}</dependency>
    </testDependencies>

    <!-- An XSL template that should be applied to the generated test pom.xml to customize the configuration -->
    <transformWith>src/main/resources/xslt/camel/reserve-network-port.xsl</transformWith>

Platform members without a BOM

Platform members are highly encouraged to provide their dependency constraints that represent their runtime and build time classpath requirements in the form of a Maven BOM artifact. If a BOM does not exist yet, it's possible to configure the dependency constraints directly in the member config, e.g.

  <member>
    <name>Debezium-Outbox</name>
    <dependencyManagement>
      <dependency>io.debezium:debezium-quarkus-outbox:${debezium-quarkus-outbox.version}</dependency>
      <dependency>io.debezium:debezium-quarkus-outbox-deployment:${debezium-quarkus-outbox.version}</dependency>
    </dependencyManagement>
...

Generated platform project layout

The generated-platform-project is a multimodule project. It will contain one module per platform member. E.g.

[aloubyansky@localhost quarkus-platform]$ ls generated-platform-project -l
total 48
-rw-rw-r-- 1 aloubyansky aloubyansky 1377 May 27 16:35 pom.xml
drwxrwxr-x 5 aloubyansky aloubyansky 4096 May 27 16:35 quarkus
drwxrwxr-x 6 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-blaze-persistence
drwxrwxr-x 6 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-camel
drwxrwxr-x 6 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-cassandra
drwxrwxr-x 6 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-debezium
drwxrwxr-x 6 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-hazelcast
drwxrwxr-x 6 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-kogito
drwxrwxr-x 3 aloubyansky aloubyansky 4096 May 28 08:32 quarkus-maven-plugin
drwxrwxr-x 6 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-optaplanner
drwxrwxr-x 6 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-qpid-jms
drwxrwxr-x 5 aloubyansky aloubyansky 4096 May 27 16:35 quarkus-universe

The quarkus module represents the Quarkus Core member.
The quarkus-maven-plugin module re-publishes the io.quarkus:quarkus-maven-plugin from the Quarkus Core under the platform's Maven groupId and version to simplify configurations of Quarkus application using the platform.
The quarkus-universe module represents the legacy io.quarkus:quarkus-universe-bom platform.

Other modules above represent actual platform members. Every member module will have the same layout, e.g.

[aloubyansky@localhost quarkus-platform]$ ls generated-platform-project/quarkus-camel -l
total 28
drwxrwxr-x   2 aloubyansky aloubyansky  4096 May 28 08:32 bom
drwxrwxr-x   3 aloubyansky aloubyansky  4096 May 28 08:32 descriptor
drwxrwxr-x 121 aloubyansky aloubyansky 12288 May 28 08:32 integration-tests
-rw-rw-r--   1 aloubyansky aloubyansky   767 May 27 16:35 pom.xml
drwxrwxr-x   4 aloubyansky aloubyansky  4096 May 27 16:35 properties

The bom module will contain a member-specific generate Maven BOM that is aligned with all the other generated member BOMs. This BOM will be a part of the platform release.

The descriptor module will contain a JSON artifact in its target directory which is generated from the member BOM artifact and will be a part of the platform release.

The properties module will contain a properties artifact in its target directory and will be a part of the platform release.

The integration-tests module will contain test modules generated for the tests configured in the root platform pom.xml for the member. There will be one module per each configured test. The tests are excluded from the platform release.

Platform BOM generation

The basic principle of the Quarkus Platform BOM Generator is:

Version constraints defined in io.quarkus:quarkus-bom will not be mutated and will be dominating during the dependency constraint alignment across all the platform members.
Every other platform member BOM will be processed in the following way:
1. if it appears to be importing any version of io.quarkus:quarkus-bom, the set of the dependency version constraints included into that version of io.quarkus:quarkus-bom will be subtracted from the member BOM.
2. The remaining set of the dependency version constraints from the member BOM will be organized into groups. With each group containing artifacts coming from the same origin, i.e. artifacts that appear to be modules of the same multi-module project release.
3. For each group of such artifacts, the generator will check whether the io.quarkus:quarkus-bom the platform is based on includes any artifacts from the same origin. And if it does, it will try to align the versions of those artifacts with the project release version used in the io.quarkus:quarkus-bom (highlighting the differences/conflicts in the generated reports).
4. If the io.quarkus:quarkus-bom did not appear to contain any artifacts from the same origin as the group, then every other imported member BOM is checked for including artifacts from the same origin. If such artifacts are found then the newer version of those artifacts will be preferred.

BOM generator reports

Besides generating the member BOMs, the BOM generator will also generate HTML reports for highlighting how the differences between the original dependency version constraints and the generated ones for every member. The reports can be found under the target/reports directory of the root platform project dir.

Release steps

Use the Maven Release Plugin to tag and deploy to the Sonatype OSS Nexus:

TAG=0.0.5 && ./mvnw release:prepare release:perform -DdevelopmentVersion=999-SNAPSHOT -DreleaseVersion=$TAG -Dtag=$TAG -DperformRelease -Prelease -DskipTests -Darguments=-DskipTests

Go to https://s01.oss.sonatype.org/#stagingRepositories and close the repository there.
Once the checks pass, click on the Release button and wait until it gets percolated to Central

IMPORTANT

Due to the Apache process, it is possible that the Apache Camel artifacts may not be directly available in Maven central, therefore you need to add the following profile to your ~/.m2/settings.xml:

     <profiles>
        <profile>
            <id>camel-staging</id>
            <repositories>
                <repository>
                    <id>apache-camel-staging</id>
                    <url>https://repository.apache.org/content/repositories/orgapachecamel-1161/</url>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                </repository>
            </repositories>
            <pluginRepositories>
                <pluginRepository>
                    <id>apache-camel-staging</id>
                    <url>https://repository.apache.org/content/repositories/orgapachecamel-1161/</url>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                </pluginRepository>
            </pluginRepositories>
        </profile>
    </profiles>
    <activeProfiles>
        <activeProfile>camel-staging</activeProfile>
    </activeProfiles>

brunobat/quarkus-platform