Skip to content

Commit 2f294c9

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 33e83a4 commit 2f294c9

11 files changed

+672
-1704
lines changed

‎_generated-doc/main/config/quarkus-all-config.adoc‎

Lines changed: 187 additions & 564 deletions
Large diffs are not rendered by default.

‎_generated-doc/main/config/quarkus-container-image-podman.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,23 @@ endif::add-copy-button-to-env-var[]
130130
|list of string
131131
|
132132

133+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-tls-verify]] [.property-path]##link:#quarkus-container-image-podman_quarkus-podman-tls-verify[`quarkus.podman.tls-verify`]##
134+
135+
[.description]
136+
--
137+
Require HTTPS and verify certificates when contacting registries
138+
139+
140+
ifdef::add-copy-button-to-env-var[]
141+
Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_TLS_VERIFY+++[]
142+
endif::add-copy-button-to-env-var[]
143+
ifndef::add-copy-button-to-env-var[]
144+
Environment variable: `+++QUARKUS_PODMAN_TLS_VERIFY+++`
145+
endif::add-copy-button-to-env-var[]
146+
--
147+
|boolean
148+
|`true`
149+
133150
|===
134151

135152

‎_generated-doc/main/config/quarkus-container-image-podman_quarkus.podman.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,23 @@ endif::add-copy-button-to-env-var[]
130130
|list of string
131131
|
132132

133+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-tls-verify]] [.property-path]##link:#quarkus-container-image-podman_quarkus-podman-tls-verify[`quarkus.podman.tls-verify`]##
134+
135+
[.description]
136+
--
137+
Require HTTPS and verify certificates when contacting registries
138+
139+
140+
ifdef::add-copy-button-to-env-var[]
141+
Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_TLS_VERIFY+++[]
142+
endif::add-copy-button-to-env-var[]
143+
ifndef::add-copy-button-to-env-var[]
144+
Environment variable: `+++QUARKUS_PODMAN_TLS_VERIFY+++`
145+
endif::add-copy-button-to-env-var[]
146+
--
147+
|boolean
148+
|`true`
149+
133150
|===
134151

135152

‎_generated-doc/main/config/quarkus-reactive-datasource.adoc‎

Lines changed: 62 additions & 536 deletions
Large diffs are not rendered by default.

‎_generated-doc/main/config/quarkus-reactive-datasource_quarkus.datasource.adoc‎

Lines changed: 62 additions & 536 deletions
Large diffs are not rendered by default.

‎_generated-doc/main/config/quarkus-redis-client.adoc‎

Lines changed: 108 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ a| [[quarkus-redis-client_quarkus-redis-hosts]] [.property-path]##link:#quarkus-
8686

8787
[.description]
8888
--
89-
The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.
89+
The Redis hosts to use while connecting to the Redis server. Only the cluster and sentinel modes will consider more than 1 element.
9090

9191
The URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically.
9292

@@ -126,7 +126,7 @@ a| [[quarkus-redis-client_quarkus-redis-timeout]] [.property-path]##link:#quarku
126126

127127
[.description]
128128
--
129-
The maximum delay to wait before a blocking command to redis server times out
129+
The maximum delay to wait before a blocking command to Redis server times out
130130

131131

132132
ifdef::add-copy-button-to-env-var[]
@@ -143,7 +143,7 @@ a| [[quarkus-redis-client_quarkus-redis-client-type]] [.property-path]##link:#qu
143143

144144
[.description]
145145
--
146-
The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.
146+
The Redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.
147147

148148

149149
ifdef::add-copy-button-to-env-var[]
@@ -160,7 +160,7 @@ a| [[quarkus-redis-client_quarkus-redis-master-name]] [.property-path]##link:#qu
160160

161161
[.description]
162162
--
163-
The master name (only considered in HA mode).
163+
The master name (only considered in the Sentinel mode).
164164

165165

166166
ifdef::add-copy-button-to-env-var[]
@@ -177,7 +177,7 @@ a| [[quarkus-redis-client_quarkus-redis-role]] [.property-path]##link:#quarkus-r
177177

178178
[.description]
179179
--
180-
The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.
180+
The role name (only considered in the Sentinel mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.
181181

182182

183183
ifdef::add-copy-button-to-env-var[]
@@ -194,7 +194,7 @@ a| [[quarkus-redis-client_quarkus-redis-replicas]] [.property-path]##link:#quark
194194

195195
[.description]
196196
--
197-
Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.
197+
Whether to use replicas nodes (only considered in Cluster mode and Replication mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.
198198

199199

200200
ifdef::add-copy-button-to-env-var[]
@@ -211,9 +211,9 @@ a| [[quarkus-redis-client_quarkus-redis-password]] [.property-path]##link:#quark
211211

212212
[.description]
213213
--
214-
The default password for cluster/sentinel connections.
214+
The default password for Redis connections.
215215

216-
If not set it will try to extract the value from the current default `++#++hosts`.
216+
If not set, it will try to extract the value from the `hosts`.
217217

218218

219219
ifdef::add-copy-button-to-env-var[]
@@ -230,7 +230,7 @@ a| [[quarkus-redis-client_quarkus-redis-max-pool-size]] [.property-path]##link:#
230230

231231
[.description]
232232
--
233-
The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels {plus} 1)
233+
The maximum size of the connection pool.
234234

235235

236236
ifdef::add-copy-button-to-env-var[]
@@ -264,7 +264,7 @@ a| [[quarkus-redis-client_quarkus-redis-pool-cleaner-interval]] [.property-path]
264264

265265
[.description]
266266
--
267-
The duration indicating how often should the connection pool cleaner executes.
267+
The duration indicating how often should the connection pool cleaner execute.
268268

269269

270270
ifdef::add-copy-button-to-env-var[]
@@ -275,13 +275,13 @@ Environment variable: `+++QUARKUS_REDIS_POOL_CLEANER_INTERVAL+++`
275275
endif::add-copy-button-to-env-var[]
276276
--
277277
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
278-
|
278+
|`30s`
279279

280280
a| [[quarkus-redis-client_quarkus-redis-pool-recycle-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-pool-recycle-timeout[`quarkus.redis.pool-recycle-timeout`]##
281281

282282
[.description]
283283
--
284-
The timeout for a connection recycling.
284+
The timeout for unused connection recycling.
285285

286286

287287
ifdef::add-copy-button-to-env-var[]
@@ -292,7 +292,7 @@ Environment variable: `+++QUARKUS_REDIS_POOL_RECYCLE_TIMEOUT+++`
292292
endif::add-copy-button-to-env-var[]
293293
--
294294
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
295-
|`15S`
295+
|`3M`
296296

297297
a| [[quarkus-redis-client_quarkus-redis-max-waiting-handlers]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-max-waiting-handlers[`quarkus.redis.max-waiting-handlers`]##
298298

@@ -317,7 +317,7 @@ a| [[quarkus-redis-client_quarkus-redis-max-nested-arrays]] [.property-path]##li
317317

318318
[.description]
319319
--
320-
Tune how much nested arrays are allowed on a redis response. This affects the parser performance.
320+
Tune how much nested arrays are allowed on a Redis response. This affects the parser performance.
321321

322322

323323
ifdef::add-copy-button-to-env-var[]
@@ -417,6 +417,46 @@ endif::add-copy-button-to-env-var[]
417417
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
418418
|`1S`
419419

420+
a| [[quarkus-redis-client_quarkus-redis-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-auto-failover[`quarkus.redis.auto-failover`]##
421+
422+
[.description]
423+
--
424+
Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise.
425+
426+
If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels.
427+
428+
Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. After the new master is elected, the connections will automatically fail over and start working again.
429+
430+
431+
ifdef::add-copy-button-to-env-var[]
432+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_AUTO_FAILOVER+++[]
433+
endif::add-copy-button-to-env-var[]
434+
ifndef::add-copy-button-to-env-var[]
435+
Environment variable: `+++QUARKUS_REDIS_AUTO_FAILOVER+++`
436+
endif::add-copy-button-to-env-var[]
437+
--
438+
|boolean
439+
|`false`
440+
441+
a| [[quarkus-redis-client_quarkus-redis-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-topology[`quarkus.redis.topology`]##
442+
443+
[.description]
444+
--
445+
How the Redis topology is obtained. By default, the topology is discovered automatically. This is the only mode for the clustered and sentinel client. For replication client, topology may be set _statically_.
446+
447+
In case of a static topology for replication Redis client, the first node in the list is considered a _master_ and the remaining nodes in the list are considered _replicas_.
448+
449+
450+
ifdef::add-copy-button-to-env-var[]
451+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TOPOLOGY+++[]
452+
endif::add-copy-button-to-env-var[]
453+
ifndef::add-copy-button-to-env-var[]
454+
Environment variable: `+++QUARKUS_REDIS_TOPOLOGY+++`
455+
endif::add-copy-button-to-env-var[]
456+
--
457+
a|`discover`, `static`
458+
|`discover`
459+
420460
a| [[quarkus-redis-client_quarkus-redis-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tls-configuration-name[`quarkus.redis.tls-configuration-name`]##
421461

422462
[.description]
@@ -501,7 +541,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-hosts]] [.property-pat
501541

502542
[.description]
503543
--
504-
The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.
544+
The Redis hosts to use while connecting to the Redis server. Only the cluster and sentinel modes will consider more than 1 element.
505545

506546
The URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically.
507547

@@ -541,7 +581,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-timeout]] [.property-p
541581

542582
[.description]
543583
--
544-
The maximum delay to wait before a blocking command to redis server times out
584+
The maximum delay to wait before a blocking command to Redis server times out
545585

546586

547587
ifdef::add-copy-button-to-env-var[]
@@ -558,7 +598,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-type]] [.proper
558598

559599
[.description]
560600
--
561-
The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.
601+
The Redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.
562602

563603

564604
ifdef::add-copy-button-to-env-var[]
@@ -575,7 +615,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-master-name]] [.proper
575615

576616
[.description]
577617
--
578-
The master name (only considered in HA mode).
618+
The master name (only considered in the Sentinel mode).
579619

580620

581621
ifdef::add-copy-button-to-env-var[]
@@ -592,7 +632,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-role]] [.property-path
592632

593633
[.description]
594634
--
595-
The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.
635+
The role name (only considered in the Sentinel mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.
596636

597637

598638
ifdef::add-copy-button-to-env-var[]
@@ -609,7 +649,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-replicas]] [.property-
609649

610650
[.description]
611651
--
612-
Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.
652+
Whether to use replicas nodes (only considered in Cluster mode and Replication mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.
613653

614654

615655
ifdef::add-copy-button-to-env-var[]
@@ -626,9 +666,9 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-password]] [.property-
626666

627667
[.description]
628668
--
629-
The default password for cluster/sentinel connections.
669+
The default password for Redis connections.
630670

631-
If not set it will try to extract the value from the current default `++#++hosts`.
671+
If not set, it will try to extract the value from the `hosts`.
632672

633673

634674
ifdef::add-copy-button-to-env-var[]
@@ -645,7 +685,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-pool-size]] [.prop
645685

646686
[.description]
647687
--
648-
The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels {plus} 1)
688+
The maximum size of the connection pool.
649689

650690

651691
ifdef::add-copy-button-to-env-var[]
@@ -679,7 +719,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-pool-cleaner-interval]
679719

680720
[.description]
681721
--
682-
The duration indicating how often should the connection pool cleaner executes.
722+
The duration indicating how often should the connection pool cleaner execute.
683723

684724

685725
ifdef::add-copy-button-to-env-var[]
@@ -690,13 +730,13 @@ Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_CLEANER_INTERVA
690730
endif::add-copy-button-to-env-var[]
691731
--
692732
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
693-
|
733+
|`30s`
694734

695735
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-pool-recycle-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-pool-recycle-timeout[`quarkus.redis."redis-client-name".pool-recycle-timeout`]##
696736

697737
[.description]
698738
--
699-
The timeout for a connection recycling.
739+
The timeout for unused connection recycling.
700740

701741

702742
ifdef::add-copy-button-to-env-var[]
@@ -707,7 +747,7 @@ Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_RECYCLE_TIMEOUT
707747
endif::add-copy-button-to-env-var[]
708748
--
709749
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
710-
|`15S`
750+
|`3M`
711751

712752
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-waiting-handlers]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-max-waiting-handlers[`quarkus.redis."redis-client-name".max-waiting-handlers`]##
713753

@@ -732,7 +772,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-nested-arrays]] [.
732772

733773
[.description]
734774
--
735-
Tune how much nested arrays are allowed on a redis response. This affects the parser performance.
775+
Tune how much nested arrays are allowed on a Redis response. This affects the parser performance.
736776

737777

738778
ifdef::add-copy-button-to-env-var[]
@@ -832,6 +872,46 @@ endif::add-copy-button-to-env-var[]
832872
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
833873
|`1S`
834874

875+
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-auto-failover[`quarkus.redis."redis-client-name".auto-failover`]##
876+
877+
[.description]
878+
--
879+
Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise.
880+
881+
If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels.
882+
883+
Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. After the new master is elected, the connections will automatically fail over and start working again.
884+
885+
886+
ifdef::add-copy-button-to-env-var[]
887+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++[]
888+
endif::add-copy-button-to-env-var[]
889+
ifndef::add-copy-button-to-env-var[]
890+
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++`
891+
endif::add-copy-button-to-env-var[]
892+
--
893+
|boolean
894+
|`false`
895+
896+
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-topology[`quarkus.redis."redis-client-name".topology`]##
897+
898+
[.description]
899+
--
900+
How the Redis topology is obtained. By default, the topology is discovered automatically. This is the only mode for the clustered and sentinel client. For replication client, topology may be set _statically_.
901+
902+
In case of a static topology for replication Redis client, the first node in the list is considered a _master_ and the remaining nodes in the list are considered _replicas_.
903+
904+
905+
ifdef::add-copy-button-to-env-var[]
906+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++[]
907+
endif::add-copy-button-to-env-var[]
908+
ifndef::add-copy-button-to-env-var[]
909+
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++`
910+
endif::add-copy-button-to-env-var[]
911+
--
912+
a|`discover`, `static`
913+
|`discover`
914+
835915
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name[`quarkus.redis."redis-client-name".tls-configuration-name`]##
836916

837917
[.description]

0 commit comments

Comments
 (0)