Skip to content

Commit b21f15c

Browse files
author
quarkusbot
committed
Sync web site with Quarkus documentation
1 parent 186449b commit b21f15c

11 files changed

+70
-26
lines changed

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8812,6 +8812,10 @@ _No Javadoc found_
88128812

88138813
_No Javadoc found_
88148814

8815+
`java.lang.String absolutePath`
8816+
8817+
_No Javadoc found_
8818+
88158819
`io.quarkus.vertx.http.deployment.devmode.ConfiguredPathInfo configuredPathInfo`
88168820

88178821
_No Javadoc found_
@@ -9067,7 +9071,7 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployme
90679071
[.description]
90689072
--
90699073
_No Javadoc found_
9070-
-- a|`java.util.List<String> endpoints`
9074+
-- a|`java.util.Set<String> endpoints`
90719075

90729076
_No Javadoc found_
90739077

_versions/3.15/guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
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.15.3.1
4+
:quarkus-version: 3.15.4
55
:quarkus-platform-groupid: io.quarkus.platform
66
// .
77
:maven-version: 3.9.8

_versions/3.15/guides/building-native-image.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -495,10 +495,15 @@ The project generation has provided a `Dockerfile.native-micro` in the `src/main
495495
----
496496
FROM quay.io/quarkus/quarkus-micro-image:2.0
497497
WORKDIR /work/
498-
COPY target/*-runner /work/application
499-
RUN chmod 775 /work
498+
RUN chown 1001 /work \
499+
&& chmod "g+rwX" /work \
500+
&& chown 1001:root /work
501+
COPY --chown=1001:root --chmod=755 target/*-runner /work/application
502+
500503
EXPOSE 8080
501-
CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]
504+
USER 1001
505+
506+
ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"]
502507
----
503508

504509
[NOTE]
@@ -543,7 +548,7 @@ WORKDIR /work/
543548
RUN chown 1001 /work \
544549
&& chmod "g+rwX" /work \
545550
&& chown 1001:root /work
546-
COPY --chown=1001:root target/*-runner /work/application
551+
COPY --chown=1001:root --chmod=0755 target/*-runner /work/application
547552
548553
EXPOSE 8080
549554
USER 1001

_versions/3.15/guides/databases-dev-services.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,9 +202,9 @@ Login credentials are the same for most databases, except when the database requ
202202
|Database |Username |Password |Database name
203203

204204
|PostgreSQL, MariaDB, MySQL, IBM Db2, H2
205-
|`quarkus` for the default datasource or name of the datasource
206205
|`quarkus`
207206
|`quarkus`
207+
|`quarkus` for the default datasource or name of the datasource
208208

209209
|Microsoft SQL Server
210210
|`SA`

_versions/3.15/guides/native-reference.adoc

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2293,14 +2293,29 @@ One can see which Mandrel version was used to generate a binary by inspecting th
22932293

22942294
[source,bash]
22952295
----
2296-
$ strings target/debugging-native-1.0.0-SNAPSHOT-runner | grep GraalVM
2297-
com.oracle.svm.core.VM=GraalVM 22.0.0.2-Final Java 11 Mandrel Distribution
2296+
$ strings target/debugging-native-1.0.0-SNAPSHOT-runner | \
2297+
grep -e 'com.oracle.svm.core.VM=' -e 'com.oracle.svm.core.VM.Java.Version' -F
2298+
com.oracle.svm.core.VM.Java.Version=21.0.5
2299+
com.oracle.svm.core.VM=Mandrel-23.1.5.0-Final
22982300
----
22992301

23002302
=== How do I enable GC logging in native executables?
23012303

23022304
See <<gc-logging,Native Memory Management GC Logging section>> for details.
23032305

2306+
=== Can I get a thread dump of a native executable?
2307+
2308+
Yes, Quarkus sets up a signal handler for the `SIGQUIT` signal (or `SIGBREAK` on windows) that will result in a thread
2309+
dump being printed when receiving the `SIGQUIT/SIGBREAK` signal.
2310+
You may use `kill -SIGQUIT <pid>` to trigger a thread dump.
2311+
2312+
[NOTE]
2313+
====
2314+
Quarkus uses its own signal handler, to use GraalVM's default signal handler instead you will need to:
2315+
1. Add `-H:+DumpThreadStacksOnSignal` to `quarkus.native.additional-build-args` and rebuild the application.
2316+
2. Set the environment variable `DISABLE_SIGNAL_HANDLERS` before running the app.
2317+
====
2318+
23042319
[[heap-dumps]]
23052320
=== Can I get a heap dump of a native executable? e.g. if it runs out of memory
23062321

_versions/3.15/guides/quarkus-runtime-base-image.adoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ In your `Dockerfile`, just use:
2424
----
2525
FROM quay.io/quarkus/quarkus-micro-image:2.0
2626
WORKDIR /work/
27-
COPY target/*-runner /work/application
28-
RUN chmod 775 /work
27+
COPY --chmod=0755 target/*-runner /work/application
2928
EXPOSE 8080
3029
CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]
3130
----
@@ -51,8 +50,7 @@ COPY --from=BUILD \
5150
/lib64/
5251
5352
WORKDIR /work/
54-
COPY target/*-runner /work/application
55-
RUN chmod 775 /work
53+
COPY --chmod=0755 target/*-runner /work/application
5654
EXPOSE 8080
5755
CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]
5856
----
@@ -95,8 +93,7 @@ COPY --from=BUILD \
9593
/etc/fonts /etc/fonts
9694
9795
WORKDIR /work/
98-
COPY target/*-runner /work/application
99-
RUN chmod 775 /work
96+
COPY --chmod=0755 target/*-runner /work/application
10097
EXPOSE 8080
10198
CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]
10299
----
@@ -117,7 +114,7 @@ WORKDIR /work/
117114
RUN chown 1001 /work \
118115
&& chmod "g+rwX" /work \
119116
&& chown 1001:root /work
120-
COPY --chown=1001:root target/*-runner /work/application
117+
COPY --chown=1001:root --chmod=0755 target/*-runner /work/application
121118
122119
EXPOSE 8080
123120
USER 1001

_versions/3.15/guides/qute-reference.adoc

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2955,10 +2955,9 @@ If there is a message bundle method that accepts a single parameter of an enum t
29552955
@Message <1>
29562956
String methodName(MyEnum enum);
29572957
----
2958-
<1> The value is intentionally not provided. There's also no key for the method in a localized file.
2959-
2960-
Then it receives a generated template:
2958+
<1> The value is intentionally not provided. There's also no key/value pair for this method in a localized file.
29612959

2960+
Then it receives a generated template like:
29622961
[source,html]
29632962
----
29642963
{#when enumParamName}
@@ -2967,15 +2966,27 @@ Then it receives a generated template:
29672966
{/when}
29682967
----
29692968

2970-
Furthermore, a special message method is generated for each enum constant. Finally, each localized file must contain keys and values for all constant message keys:
2969+
Furthermore, a special message method is generated for each enum constant.
2970+
Finally, each localized file must contain keys and values for all enum constants:
29712971

29722972
[source,poperties]
29732973
----
29742974
methodName_CONSTANT1=Value 1
29752975
methodName_CONSTANT2=Value 2
29762976
----
29772977

2978-
In a template, an enum constant can be localized with a message bundle method like `{msg:methodName(enumConstant)}`.
2978+
// We need to escape the first underscore
2979+
// See https://docs.asciidoctor.org/asciidoc/latest/subs/prevent/
2980+
[IMPORTANT]
2981+
.Message keys for enum constants
2982+
====
2983+
By default, the message key consists of the method name followed by the `\_` separator and the constant name.
2984+
If any constant name of a particular enum contains the `_` or the `$` character then the `\_$` separator must be used for all message keys for this enum instead.
2985+
For example, `methodName_$CONSTANT_1=Value 1` or `methodName_$CONSTANT$1=Value 1`.
2986+
A constant of a localized enum may not contain the `_$` separator.
2987+
====
2988+
2989+
In a template, the localized message for an enum constant can be obtained with a message bundle method like `{msg:methodName(enumConstant)}`.
29792990

29802991
TIP: There is also <<convenient-annotation-for-enums,`@TemplateEnum`>> - a convenient annotation to access enum constants in a template.
29812992

_versions/3.15/guides/security-ldap.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,18 @@ quarkus.security.ldap.identity-mapping.attribute-mappings."0".filter-base-dn=ou=
177177

178178
The `elytron-security-ldap` extension requires a dir-context and an identity-mapping with at least one attribute-mapping to authenticate the user and its identity.
179179

180+
=== Map LDAP groups to `SecurityIdentity` roles
181+
182+
Previously described application configuration showed how to map `CN` attribute of the LDAP Distinguished Name group to a Quarkus `SecurityIdentity` role.
183+
More specifically, the `standardRole` CN was mapped to a `SecurityIdentity` role and thus allowed access to the `UserResource#me` endpoint.
184+
However, required `SecurityIdentity` roles may differ between applications and you may need to map LDAP groups to local `SecurityIdentity` roles like in the example below:
185+
186+
[source,properties]
187+
----
188+
quarkus.http.auth.roles-mapping."standardRole"=user <1>
189+
----
190+
<1> Map the `standardRole` role to the application-specific `SecurityIdentity` role `user`.
191+
180192
== Testing the Application
181193

182194
The application is now protected and the identities are provided by our LDAP server.

_versions/3.15/guides/smallrye-fault-tolerance.adoc

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

575575
SmallRye Fault Tolerance has more features than shown here.
576-
Please check the link:https://smallrye.io/docs/smallrye-fault-tolerance/6.3.0/index.html[SmallRye Fault Tolerance documentation] to learn about them.
576+
Please check the link:https://smallrye.io/docs/smallrye-fault-tolerance/6.4.2/index.html[SmallRye Fault Tolerance documentation] to learn about them.
577577

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

@@ -605,7 +605,7 @@ smallrye.faulttolerance.mp-compatibility=true
605605
----
606606
====
607607

608-
The link:https://smallrye.io/docs/smallrye-fault-tolerance/6.3.0/reference/programmatic-api.html[programmatic API] is present, including Mutiny support, and integrated with the declarative, annotation-based API.
608+
The link:https://smallrye.io/docs/smallrye-fault-tolerance/6.4.2/reference/programmatic-api.html[programmatic API] is present, including Mutiny support, and integrated with the declarative, annotation-based API.
609609
You can use the `FaultTolerance` and `MutinyFaultTolerance` APIs out of the box.
610610

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

_versions/3.15/guides/smallrye-graphql-client.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ specify that within the `@GraphQLClientApi` annotation (by setting the `endpoint
222222
or move this over to the configuration file, `application.properties`:
223223

224224
----
225-
quarkus.smallrye-graphql-client.star-wars-typesafe.url=https://swapi-graphql.netlify.app/.netlify/functions/index
225+
quarkus.smallrye-graphql-client.star-wars-typesafe.url=https://swapi-graphql.netlify.app/graphql
226226
----
227227

228228
NOTE: During *tests only*, the URL is an optional property, and if it's not specified, Quarkus will assume
@@ -278,7 +278,7 @@ representations of the GraphQL types and documents. The client API interface is
278278

279279
We still need to configure the URL for the client, so let's put this into `application.properties`:
280280
----
281-
quarkus.smallrye-graphql-client.star-wars-dynamic.url=https://swapi-graphql.netlify.app/.netlify/functions/index
281+
quarkus.smallrye-graphql-client.star-wars-dynamic.url=https://swapi-graphql.netlify.app/graphql
282282
----
283283

284284
We decided to name the client `star-wars-dynamic`. We will use this name when injecting a dynamic client

0 commit comments

Comments
 (0)