Skip to content

Commit e947181

Browse files
committed
Sync web site with Quarkus documentation
1 parent a620303 commit e947181

File tree

10 files changed

+106
-28
lines changed

10 files changed

+106
-28
lines changed

_generated-doc/latest/config/quarkus-all-config.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10781,6 +10781,27 @@ endif::add-copy-button-to-env-var[]
1078110781
|Map<String,String>
1078210782
|
1078310783

10784+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-rest-assured-enable-logging-on-failure]] [.property-path]##link:#quarkus-core_quarkus-test-rest-assured-enable-logging-on-failure[`quarkus.test.rest-assured.enable-logging-on-failure`]##
10785+
ifdef::add-copy-button-to-config-props[]
10786+
config_property_copy_button:+++quarkus.test.rest-assured.enable-logging-on-failure+++[]
10787+
endif::add-copy-button-to-config-props[]
10788+
10789+
10790+
[.description]
10791+
--
10792+
Enable logging of both the request and the response if REST Assureds test validation fails
10793+
10794+
10795+
ifdef::add-copy-button-to-env-var[]
10796+
Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_REST_ASSURED_ENABLE_LOGGING_ON_FAILURE+++[]
10797+
endif::add-copy-button-to-env-var[]
10798+
ifndef::add-copy-button-to-env-var[]
10799+
Environment variable: `+++QUARKUS_TEST_REST_ASSURED_ENABLE_LOGGING_ON_FAILURE+++`
10800+
endif::add-copy-button-to-env-var[]
10801+
--
10802+
|boolean
10803+
|`true`
10804+
1078410805
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-arg-line]] [.property-path]##link:#quarkus-core_quarkus-test-arg-line[`quarkus.test.arg-line`]##
1078510806
ifdef::add-copy-button-to-config-props[]
1078610807
config_property_copy_button:+++quarkus.test.arg-line+++[]

_generated-doc/latest/config/quarkus-core_quarkus.test.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,27 @@ endif::add-copy-button-to-env-var[]
384384
|Map<String,String>
385385
|
386386

387+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-rest-assured-enable-logging-on-failure]] [.property-path]##link:#quarkus-core_quarkus-test-rest-assured-enable-logging-on-failure[`quarkus.test.rest-assured.enable-logging-on-failure`]##
388+
ifdef::add-copy-button-to-config-props[]
389+
config_property_copy_button:+++quarkus.test.rest-assured.enable-logging-on-failure+++[]
390+
endif::add-copy-button-to-config-props[]
391+
392+
393+
[.description]
394+
--
395+
Enable logging of both the request and the response if REST Assureds test validation fails
396+
397+
398+
ifdef::add-copy-button-to-env-var[]
399+
Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_REST_ASSURED_ENABLE_LOGGING_ON_FAILURE+++[]
400+
endif::add-copy-button-to-env-var[]
401+
ifndef::add-copy-button-to-env-var[]
402+
Environment variable: `+++QUARKUS_TEST_REST_ASSURED_ENABLE_LOGGING_ON_FAILURE+++`
403+
endif::add-copy-button-to-env-var[]
404+
--
405+
|boolean
406+
|`true`
407+
387408
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-arg-line]] [.property-path]##link:#quarkus-core_quarkus-test-arg-line[`quarkus.test.arg-line`]##
388409
ifdef::add-copy-button-to-config-props[]
389410
config_property_copy_button:+++quarkus.test.arg-line+++[]

_generated-doc/latest/infra/quarkus-all-build-items.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4174,6 +4174,17 @@ _No Javadoc found_
41744174

41754175

41764176

4177+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/DevContextBuildItem.java[`io.quarkus.devui.spi.DevContextBuildItem`, window="_blank"]
4178+
[.description]
4179+
--
4180+
Provides dev mode context as setup in Dev UI
4181+
-- a|`java.lang.String devUIContextRoot`
4182+
4183+
_No Javadoc found_
4184+
4185+
4186+
4187+
41774188
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/buildtime/FooterLogBuildItem.java[`io.quarkus.devui.spi.buildtime.FooterLogBuildItem`, window="_blank"]
41784189
[.description]
41794190
--
@@ -7522,6 +7533,17 @@ If an extension generates this, then Quarkus will make JAX-RS Resources beans as
75227533
-- a|None
75237534
75247535
7536+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest/spi-deployment/src/main/java/io/quarkus/resteasy/reactive/server/spi/TargetJavaVersionBuildItem.java[`io.quarkus.resteasy.reactive.server.spi.TargetJavaVersionBuildItem`, window="_blank"]
7537+
[.description]
7538+
--
7539+
This build item is only used for testing purposes to override the default behavior
7540+
-- a|`org.jboss.resteasy.reactive.common.processor.TargetJavaVersion targetJavaVersion`
7541+
7542+
_No Javadoc found_
7543+
7544+
7545+
7546+
75257547
a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest/spi-deployment/src/main/java/io/quarkus/resteasy/reactive/server/spi/UnwrappedExceptionBuildItem.java[`io.quarkus.resteasy.reactive.server.spi.UnwrappedExceptionBuildItem`, window="_blank"]
75267548
[.description]
75277549
--

_guides/_attributes.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Common attributes.
22
// --> No blank lines (it ends the document header)
33
:project-name: Quarkus
4-
:quarkus-version: 3.25.0
4+
:quarkus-version: 3.25.1
55
:quarkus-platform-groupid: io.quarkus.platform
66
// .
77
:maven-version: 3.9.9
@@ -11,13 +11,13 @@
1111
:mandrel-flavor: jdk-21
1212
:surefire-version: 3.5.3
1313
:gradle-version: 8.14
14-
:elasticsearch-version: 9.0.2
15-
:elasticsearch-image: docker.io/elastic/elasticsearch:9.0.2
14+
:elasticsearch-version: 9.0.4
15+
:elasticsearch-image: docker.io/elastic/elasticsearch:9.0.4
1616
:opensearch-image: docker.io/opensearchproject/opensearch:3.0.0
1717
:infinispan-version: ${infinispan.version}
1818
:infinispan-protostream-version: ${infinispan.protostream.version}
19-
:logstash-image: docker.io/elastic/logstash:9.0.2
20-
:kibana-image: docker.io/elastic/kibana:9.0.2
19+
:logstash-image: docker.io/elastic/logstash:9.0.4
20+
:kibana-image: docker.io/elastic/kibana:9.0.4
2121
:keycloak-docker-image: quay.io/keycloak/keycloak:26.3.0
2222
:jandex-version: 3.3.2
2323
:jandex-gradle-plugin-version: 1.0.0

_guides/datasource.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The `quarkus-jdbc-\*` and `quarkus-reactive-*-client` extensions provide build t
2727

2828
For more information about consuming and using a reactive datasource, see the Quarkus xref:reactive-sql-clients.adoc[Reactive SQL clients] guide.
2929

30-
Additionally, refer to the Quarkus xref:hibernate-orm.adoc[Hibernate ORM] guide for information on consuming and using a JDBC datasource.
30+
Additionally, refer to the Quarkus xref:hibernate-orm.adoc[Hibernate ORM] guide for information about consuming and using a JDBC datasource.
3131

3232

3333
== Get started with configuring `datasources` in Quarkus
@@ -190,7 +190,7 @@ It is possible to use JDBC and a reactive driver simultaneously.
190190

191191
JDBC is the most common database connection pattern, typically needed when used in combination with non-reactive Hibernate ORM.
192192

193-
. To use a JDBC datasource, start with adding the necessary dependencies:
193+
. To use a JDBC datasource, start by adding the necessary dependencies:
194194

195195
.. For use with a built-in JDBC driver, choose and add the Quarkus extension for your relational database driver from the list below:
196196
+
@@ -201,9 +201,9 @@ include::_includes/snip-note-derby.adoc[]
201201
+
202202
[NOTE]
203203
====
204-
H2 and Derby databases can be configured to run in "embedded mode"; however, the Derby extension does not support compiling the embedded database engine into native executables.
204+
You can configure H2 and Derby databases to run in "embedded mode"; however, the Derby extension does not support compiling the embedded database engine into native executables.
205205
206-
Read <<in-memory-databases,Testing with in-memory databases>> for suggestions regarding integration testing.
206+
For suggestions regarding integration testing, see <<in-memory-databases,Testing with in-memory databases>> .
207207
====
208208
* DB2 - `quarkus-jdbc-db2`
209209
* MariaDB - `quarkus-jdbc-mariadb`
@@ -225,10 +225,9 @@ For example, to add the PostgreSQL driver dependency:
225225
[NOTE]
226226
====
227227
Using a built-in JDBC driver extension automatically includes the Agroal extension, which is the JDBC connection pool implementation applicable for custom and built-in JDBC drivers.
228-
However, for custom drivers, Agroal needs to be added explicitly.
228+
However, for custom drivers, you must add Agroal explicitly.
229229
====
230230

231-
232231
.. For use with a custom JDBC driver, add the `quarkus-agroal` dependency to your project alongside the extension for your relational database driver:
233232
+
234233
[source,bash]
@@ -276,8 +275,7 @@ quarkus.datasource.username=scott
276275
quarkus.datasource.password=tiger
277276
----
278277

279-
For all the details about the JDBC configuration options and configuring other aspects,
280-
such as the connection pool size, refer to the <<jdbc-configuration,JDBC configuration reference>> section.
278+
For details about JDBC configuration options and configuring other aspects, such as the connection pool size, refer to the <<jdbc-configuration,JDBC configuration reference>> section.
281279

282280
===== Consuming the datasource
283281

@@ -303,7 +301,7 @@ Because this behavior is unexpected and can lead to data loss, an interceptor ro
303301
However, if you use XA transactions, the transaction manager handles the rollback.
304302

305303
If the behavior introduced in 3.18 causes issues for your workload, disable it by setting the `-Dquarkus-oracle-no-automatic-rollback-on-connection-close` system property to `true`.
306-
Make sure to report your use case in our link:https://github.com/quarkusio/quarkus/issues[issue tracker] so we can adjust this behavior if needed, for example, with more permanent settings.
304+
Make sure to report your use case in the link:https://github.com/quarkusio/quarkus/issues[issue tracker] so we can adjust this behavior if needed, for example, with more permanent settings.
307305

308306

309307
[[reactive-datasource]]
@@ -680,11 +678,12 @@ You can override this by setting the `transactions` configuration property:
680678
* `quarkus.datasource.jdbc.transactions` for default unnamed datasource
681679
* `quarkus.datasource._<datasource-name>_.jdbc.transactions` for named datasource
682680

683-
When a datasource is enabled for XA (by setting `quarkus.datasource[.optional name].jdbc.transactions to xa)` and the transaction recovery system is enabled (by setting the property `quarkus.transaction-manager.enable-recovery` to true) then the datasource is automatically registered for recovery. This is a safe default, but you can override this behaviour on a per-datasource basis by setting `quarkus.datasource.jdbc.enable-recovery`/`quarkus.datasource."datasource-name".jdbc.enable-recovery` to `false`. Only use this for advanced use cases and if you know recovery will not be necessary, otherwise it may result in data loss and/or data unavailability because resources may become locked indefinitely.
681+
When a datasource is enabled for XA (by setting `quarkus.datasource[.optional name].jdbc.transactions` to `xa`) and the transaction recovery system is enabled (by setting the property `quarkus.transaction-manager.enable-recovery` to `true`), then the datasource is automatically registered for recovery.
682+
This is a safe default, but you can override this behaviour on a per-datasource basis by setting `quarkus.datasource.jdbc.enable-recovery` or `quarkus.datasource."datasource-name".jdbc.enable-recovery` to `false`.
683+
Use only for advanced use cases and if you know recovery will not be necessary; otherwise it can result in data loss, data unavailability, or both, because resources can become locked indefinitely.
684684

685685
For more information, see the <<configuration-reference,Configuration reference>> section below.
686-
687-
To facilitate the storage of transaction logs in a database by using JDBC, see xref:transaction.adoc#jdbcstore[Configuring transaction logs to be stored in a datasource] section of the xref:transaction.adoc[Using transactions in Quarkus] guide.
686+
To facilitate the storage of transaction logs in a database by using JDBC, see the xref:transaction.adoc#jdbcstore[Configuring transaction logs to be stored in a datasource] section of the xref:transaction.adoc[Using transactions in Quarkus] guide.
688687

689688
==== Named datasources
690689

_guides/gradle-tooling.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -923,3 +923,14 @@ The current state of compatibility is shown in the following table:
923923
|`addExtension`|❌
924924
|`removeExtension`|❌
925925
|====
926+
927+
== Dependency resolver options
928+
929+
=== Quarkus component variants
930+
931+
`disableQuarkusComponentVariants` project property was introduced in Quarkus 3.25.1 to control whether Quarkus component variants should be added to certain dependencies of a project to enable xref:conditional-extension-dependencies.adoc[Quarkus conditional] and build time (deployment) dependencies. Quarkus component variants are enabled by default since 3.25.1.
932+
933+
The approach to enable Quarkus conditional and extension build time (deployment) dependencies has changed in Quarkus 3.25.1 due to a few issues with the previous implementation.
934+
Specifically, the previous implementation would not apply relevant dependency exclusions to enabled conditional and deployment dependencies. It would also appear to leak devmode-only dependencies into non-devmode classpaths (such as test and prod) in some cases. These issues couldn't be fixed in a reasonable way in the previous implementation, which is why the Quarkus dependency resolution had to be re-implemented based on a different approach using link:https://docs.gradle.org/current/userguide/variant_aware_resolution.html[Gradle component variants].
935+
936+
The previous implementation still remains available for now in case the new one appears to introduce not yet detected regressions and can be enabled by setting `disableQuarkusComponentVariants` project property to `true`.

_guides/logging.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,13 @@ For extension development, use `org.jboss.logging.Logger.getLogger(String)` inst
143143

144144
The injection of a configured `org.jboss.logging.Logger` logger instance with the `@Inject` annotation is another alternative to adding an application logger, but is applicable only to CDI beans.
145145

146-
You can use `@Inject Logger log`, where the logger gets named after the class you inject it to, or `@LoggerName("...") Logger log`, where the logger will receive the specified name. Notice, that `@Inject`
147-
is not required if you already annotated your `Logger` with `@LoggerName("...")`.
148-
146+
You can use `@Inject Logger log`, where the logger gets named after the class you inject it to, or `@LoggerName("...") Logger log`, where the logger receives the specified name.
147+
148+
[NOTE]
149+
====
150+
`@Inject` is not required if you already annotated your `Logger` with `@LoggerName("...")`.
151+
====
152+
149153
Once injected, you can use the `log` object to invoke logging methods.
150154

151155
.An example of two different types of logger injection:

_guides/security-jwt-build.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ SmallRye JWT supports the following properties, which can be used to customize h
370370
|`smallrye.jwt.new-token.issuer` |none |Token issuer used to set an `iss` (issuer) claim value if this claim has not already been set.
371371
|`smallrye.jwt.new-token.audience` |none |Token audience used to set an `aud` (audience) claim value if this claim has not already been set.
372372
|`smallrye.jwt.new-token.override-matching-claims` |`false` | Set this property to `true` for `smallrye.jwt.new-token.issuer` and `smallrye.jwt.new-token.audience` values to override the already initialized `iss` (issuer) and `aud` (audience) claims.
373-
|smallrye.jwt.new-token.add-default-claims|true|Set this property to `false` to disable an automatic addition of the `iat` (issued at), `exp` (expiration time) and `jti` (token identifier) claims when such claims have not already been set.
373+
|`smallrye.jwt.new-token.add-default-claims`|true|Set this property to `false` to disable an automatic addition of the `iat` (issued at), `exp` (expiration time) and `jti` (token identifier) claims when such claims have not already been set.
374374
|`smallrye.jwt.keystore.type` |`JKS` |This property can be used to customize a keystore type if either `smallrye.jwt.sign.key.location` or `smallrye.jwt.encrypt.key.location` or both of these properties point to a `KeyStore` file. If it is not set then the file name will be checked to determine the keystore type before defaulting to `JKS`.
375375
|`smallrye.jwt.keystore.provider` | |This property can be used to customize a `KeyStore` provider if `smallrye.jwt.sign.key.location` or `smallrye.jwt.encrypt.key.location` point to a `KeyStore` file.
376376
|`smallrye.jwt.keystore.password` | |Keystore password. If `smallrye.jwt.sign.key.location` or `smallrye.jwt.encrypt.key.location` point to a `KeyStore` file, this property must be set.

_guides/smallrye-fault-tolerance.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ implementation("io.quarkus:quarkus-smallrye-fault-tolerance")
576576
== Additional resources
577577

578578
SmallRye Fault Tolerance has more features than shown here.
579-
Please check the link:https://smallrye.io/docs/smallrye-fault-tolerance/6.9.1/index.html[SmallRye Fault Tolerance documentation] to learn about them.
579+
Please check the link:https://smallrye.io/docs/smallrye-fault-tolerance/6.9.2/index.html[SmallRye Fault Tolerance documentation] to learn about them.
580580

581581
In Quarkus, you can use the SmallRye Fault Tolerance optional features out of the box.
582582

@@ -608,7 +608,7 @@ quarkus.fault-tolerance.mp-compatibility=true
608608
----
609609
====
610610

611-
The link:https://smallrye.io/docs/smallrye-fault-tolerance/6.9.1/reference/programmatic-api.html[programmatic API] is present and integrated with the declarative, annotation-based API.
611+
The link:https://smallrye.io/docs/smallrye-fault-tolerance/6.9.2/reference/programmatic-api.html[programmatic API] is present and integrated with the declarative, annotation-based API.
612612
You can use the `Guard`, `TypedGuard` and `@ApplyGuard` APIs out of the box.
613613

614614
Support for Kotlin is present (assuming you use the Quarkus extension for Kotlin), so you can guard your `suspend` functions with fault tolerance annotations.

_guides/tls-registry-reference.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ For instance, `quarkus.tls.reload-period` will only be applied to the default TL
5757

5858
[IMPORTANT]
5959
====
60-
As described in detail link:https://github.com/quarkusio/quarkus/blob/main/adr/0004-using-the-tls-registry-for-clients.adoc#configuring-clients-with-the-tls-registry[here], Quarkus client extensions (REST, GRPC, etc) ignore properties, defined in default (ie unnamed) TLS configuration.
61-
The only exception is `quarkus.tls.trust-all` property.
60+
As described in detail link:https://github.com/quarkusio/quarkus/blob/main/adr/0004-using-the-tls-registry-for-clients.adoc#configuring-clients-with-the-tls-registry[here], Quarkus client extensions (such as REST, GRPC, and so on) ignore properties defined in default (that is, unnamed) TLS configurations.
61+
The `quarkus.tls.trust-all` property is the only exception.
6262
====
6363

6464
=== Configuring HTTPS for a HTTP server
@@ -798,7 +798,7 @@ A value of `true` means the reload operation was successful, not necessarily tha
798798

799799
After a `TlsConfiguration` has been reloaded, servers and clients using this configuration may need to perform specific actions to apply the new certificates.
800800

801-
The recommended approach for informing clients and servers about the certificate reload is to fire a CDI event of type `io.quarkus.tls.CertificateUpdatedEvent`.
801+
The preferred approach for informing clients and servers about the certificate reload is to fire a CDI event of type `io.quarkus.tls.CertificateUpdatedEvent`.
802802
To do so, inject a CDI event of this type and fire it when a reload occurs.
803803

804804
.An example of manually reloading a TLS configuration and notifying components by firing a `CertificateUpdatedEvent` and reacting to it:
@@ -854,8 +854,8 @@ quarkus.tls.http.key-store.pem.0.key=tls.key
854854

855855
[IMPORTANT]
856856
====
857-
Impacted servers and clients may need to listen to the `CertificateUpdatedEvent` to apply the new certificates.
858-
This is automatically done for the Quarkus HTTP server, as well as the Quarkus REST server, gRPC server, and WebSocket server, as well as the management interface if it is enabled.
857+
Impacted servers and clients might need to listen to the `CertificateUpdatedEvent` to apply the new certificates.
858+
This is automatically handled for the Quarkus HTTP, REST, gRPC, and WebSocket servers, as well as the management interface if enabled.
859859
On the client side, Quarkus REST Client automatically handles certificate update events.
860860
====
861861

0 commit comments

Comments
 (0)