Skip to content

Commit b1fbfe7

Browse files
author
quarkusbot
committed
Sync web site with Quarkus documentation
1 parent a163594 commit b1fbfe7

File tree

11 files changed

+37
-23
lines changed

11 files changed

+37
-23
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50060,7 +50060,7 @@ Environment variable: `+++QUARKUS_MONGODB_DNS_SERVER_PORT+++`
5006050060
endif::add-copy-button-to-env-var[]
5006150061
--
5006250062
|int
50063-
|`53`
50063+
|
5006450064

5006550065
a| [[quarkus-mongodb-client_quarkus-mongodb-dns-lookup-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-dns-lookup-timeout[`quarkus.mongodb.dns.lookup-timeout`]##
5006650066

_generated-doc/3.15/config/quarkus-mongodb-client.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ Environment variable: `+++QUARKUS_MONGODB_DNS_SERVER_PORT+++`
508508
endif::add-copy-button-to-env-var[]
509509
--
510510
|int
511-
|`53`
511+
|
512512

513513
a| [[quarkus-mongodb-client_quarkus-mongodb-dns-lookup-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-dns-lookup-timeout[`quarkus.mongodb.dns.lookup-timeout`]##
514514

_generated-doc/3.15/config/quarkus-mongodb-client_quarkus.mongodb.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ Environment variable: `+++QUARKUS_MONGODB_DNS_SERVER_PORT+++`
508508
endif::add-copy-button-to-env-var[]
509509
--
510510
|int
511-
|`53`
511+
|
512512

513513
a| [[quarkus-mongodb-client_quarkus-mongodb-dns-lookup-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-dns-lookup-timeout[`quarkus.mongodb.dns.lookup-timeout`]##
514514

_generated-doc/3.15/infra/quarkus-maven-plugin-goals.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3672,7 +3672,7 @@ a| [[quarkus-maven-plugin-goal-track-config-changes-quarkus.recorded-build-confi
36723672
|`${basedir}/.quarkus`
36733673

36743674
a| [[quarkus-maven-plugin-goal-track-config-changes-quarkus.recorded-build-config.file]] quarkus.recorded-build-config.file
3675-
|`File`
3675+
|`String`
36763676
|
36773677

36783678
a| [[quarkus-maven-plugin-goal-track-config-changes-repoSession]] repoSession

_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.4
4+
:quarkus-version: 3.15.5
55
:quarkus-platform-groupid: io.quarkus.platform
66
// .
77
:maven-version: 3.9.8

_versions/3.15/guides/gradle-tooling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ The entries are relative to the root of the generated Uber-Jar. You can specify
579579
By default, Quarkus will not discover CDI beans inside another module.
580580

581581
The best way to enable CDI bean discovery for a module in a multi-module project would be to include a `META-INF/beans.xml` file,
582-
unless it is the main application module already configured with the quarkus-maven-plugin, in which case it will be indexed automatically.
582+
unless it is the main application module already configured with the `io.quarkus` Gradle plugin, in which case it will be indexed automatically.
583583

584584
Alternatively, there is some unofficial link:https://plugins.gradle.org/search?term=jandex[Gradle Jandex plugins] that can be used instead of the `META-INF/beans.xml` file.
585585

_versions/3.15/guides/rest.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1597,7 +1597,7 @@ public User userPrivate() {
15971597
}
15981598
----
15991599

1600-
When the result the `userPublic` method is serialized, the `id` field will not be contained in the response as the `Public` view does not include it.
1600+
When the result of the `userPublic` method is serialized, the `id` field will not be contained in the response as the `Public` view does not include it.
16011601
The result of `userPrivate` however will include the `id` as expected when serialized.
16021602

16031603
===== Reflection-free Jackson serialization

_versions/3.15/guides/security-ldap.adoc

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -160,22 +160,36 @@ quarkus.security.ldap.enabled=true
160160
161161
quarkus.security.ldap.dir-context.principal=uid=admin,ou=system
162162
quarkus.security.ldap.dir-context.url=ldaps://ldap.server.local <1>
163+
%test.quarkus.security.ldap.dir-context.url=ldap://127.0.0.1:10389 <2>
163164
quarkus.security.ldap.dir-context.password=secret
164165
165166
quarkus.security.ldap.identity-mapping.rdn-identifier=uid
166167
quarkus.security.ldap.identity-mapping.search-base-dn=ou=Users,dc=quarkus,dc=io
167168
168169
quarkus.security.ldap.identity-mapping.attribute-mappings."0".from=cn
169-
quarkus.security.ldap.identity-mapping.attribute-mappings."0".filter=(member=uid={0},ou=Users,dc=quarkus,dc=io) <2>
170+
quarkus.security.ldap.identity-mapping.attribute-mappings."0".filter=(member=uid={0},ou=Users,dc=quarkus,dc=io) <3>
170171
quarkus.security.ldap.identity-mapping.attribute-mappings."0".filter-base-dn=ou=Roles,dc=quarkus,dc=io
171-
172-
%test.quarkus.security.ldap.dir-context.url=ldap://127.0.0.1:10389 <3>
173172
----
174173
<1> You need to provide the URL to an LDAP server. This example requires the LDAP server to have imported link:{quarkus-blob-url}/test-framework/ldap/src/main/resources/quarkus-io.ldif[this LDIF file].
175-
<2> `{0}` is substituted by the `uid`.
176-
<3> The URL used by our test resource. Tests may leverage `LdapServerTestResource` provided by Quarkus as link:{quickstarts-blob-url}/security-ldap-quickstart/src/test/java/org/acme/elytron/security/ldap/ElytronLdapExtensionTestResources.java[we do] in the test coverage of the example application.
174+
<2> The URL used by our test resource. Tests may leverage `LdapServerTestResource` provided by Quarkus as link:{quickstarts-blob-url}/security-ldap-quickstart/src/test/java/org/acme/elytron/security/ldap/ElytronLdapExtensionTestResources.java[we do] in the test coverage of the example application.
175+
<3> `{0}` is substituted by the `uid`.
176+
177+
The `quarkus-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.
178+
179+
[TIP]
180+
====
181+
By default, Quarkus doesn't cache the credentials obtained from the LDAP directory.
182+
Every request to your service will cause an additional roundtrip to the LDAP server.
183+
184+
It is a common practice to cache these results to improve performance, but the tradeoff is that there will be a delay before the changes in the LDAP get effective in your service.
185+
186+
To enable the cache, set `quarkus.security.ldap.cache.enabled=true` in your configuration file.
187+
188+
The default cache max-age is `60s`.
189+
It can be configured by setting `quarkus.security.ldap.cache.max-age`.
177190
178-
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.
191+
The number of cache entries is limited by `quarkus.security.ldap.cache.size`, which defaults to `100`.
192+
====
179193

180194
=== Map LDAP groups to `SecurityIdentity` roles
181195

_versions/3.15/guides/stylesheet/config.css

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ table.configuration-reference.tableblock td.tableblock > .content > :last-child
105105
margin-bottom: inherit;
106106
}
107107

108-
input#config-search-0 {
108+
input[id^="config-search-"] {
109109
-webkit-appearance: none;
110110
display: block;
111111
width: 100%;
@@ -127,8 +127,8 @@ input#config-search-0 {
127127
letter-spacing: 1.5px;
128128
}
129129

130-
input#config-search-0:hover,
131-
input#config-search-0:focus {
130+
input[id^="config-search-"]:hover,
131+
input[id^="config-search-"]:focus {
132132
padding: 12px 2px;
133133
outline: 0;
134134
border: 1px solid transparent;

_versions/3.15/guides/telemetry-micrometer.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ include::_attributes.adoc[]
1010
:categories: observability
1111
:summary: Use Micrometer to collect metrics produced by Quarkus, its extensions, and your application.
1212
:base-units: https://github.com/micrometer-metrics/micrometer/blob/main/micrometer-core/src/main/java/io/micrometer/core/instrument/binder/BaseUnits.java
13-
:concepts: https://micrometer.io/docs/concepts
13+
:concepts: https://docs.micrometer.io/micrometer/reference/concepts
1414
:topics: observability,micrometer
1515
:extensions: io.quarkus:quarkus-micrometer
1616

@@ -186,7 +186,7 @@ For hierarchical systems that only support a flat metric name, Micrometer will f
186186

187187
Tags can be specified when a meter is registered with a `MeterRegistry` or using a <<meter-filter,Meter Filter>>.
188188

189-
See the Micrometer documentation for additional advice on link:{concepts}#_tag_naming[tag naming].
189+
See the Micrometer documentation for additional advice on link:{concepts}/naming[tag naming].
190190

191191
IMPORTANT: Each unique combination of metric name and dimension produces a unique time series.
192192
Using an unbounded set of dimensional data can lead to a "cardinality explosion", an exponential increase in the creation of new time series.
@@ -277,7 +277,7 @@ Gauge.builder("jvm.threads.peak", threadBean, ThreadMXBean::getPeakThreadCount)
277277
<4> Associate <<define-tags,tags>> with the gauge
278278
<5> Register the Gauge with the MeterRegistry
279279

280-
See link:{concepts}#_gauges[Gauges] in the Micrometer documentation for more information and examples.
280+
See link:{concepts}/gauges[Gauges] in the Micrometer documentation for more information and examples.
281281
Of note are two special cases: `TimeGauge` for measuring time, and a `MultiGauge` for reporting several criteria together.
282282

283283
NOTE: Micrometer does not create strong references to the objects it observes by default.
@@ -334,7 +334,7 @@ void countThisMethod(){
334334
<1> A CDI interceptor will create and register a counter called `counted.method`
335335
<2> The interceptor-created counter will have the "extra" dimension tag with value "annotated"
336336

337-
See link:{concepts}#_counters[Counters] in the Micrometer documentation for more information and examples, including the less common `FunctionCounter` that can be used to measure the result returned by an always increasing function.
337+
See link:{concepts}/counters[Counters] in the Micrometer documentation for more information and examples, including the less common `FunctionCounter` that can be used to measure the result returned by an always increasing function.
338338

339339
When should you use a counter?
340340
Use a counter if you are doing something that can not be either timed or summarized.
@@ -476,7 +476,7 @@ sample.stop(registry.timer("my.timer", "response", response.status())); // <3>
476476
==== Histograms and percentiles
477477

478478
Both timers and distribution summaries can be configured to emit additional statistics, like histogram data, precomputed percentiles, or service level objective (SLO) boundaries.
479-
See link:{concepts}#_timers[Timers] and link:{concepts}#_distribution_summaries[Distribution Summaries] in the Micrometer documentation for more information and examples, including memory footprint estimation for both types.
479+
See link:{concepts}/timers[Timers] and link:{concepts}/distribution-summaries[Distribution Summaries] in the Micrometer documentation for more information and examples, including memory footprint estimation for both types.
480480

481481
[IMPORTANT]
482482
====

0 commit comments

Comments
 (0)