Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 28, 2024
1 parent 33e83a4 commit 2f294c9
Show file tree
Hide file tree
Showing 11 changed files with 672 additions and 1,704 deletions.
751 changes: 187 additions & 564 deletions _generated-doc/main/config/quarkus-all-config.adoc

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions _generated-doc/main/config/quarkus-container-image-podman.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,23 @@ endif::add-copy-button-to-env-var[]
|list of string
|

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`]##

[.description]
--
Require HTTPS and verify certificates when contacting registries


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_TLS_VERIFY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_PODMAN_TLS_VERIFY+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`true`

|===


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,23 @@ endif::add-copy-button-to-env-var[]
|list of string
|

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`]##

[.description]
--
Require HTTPS and verify certificates when contacting registries


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_TLS_VERIFY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_PODMAN_TLS_VERIFY+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`true`

|===


Expand Down
598 changes: 62 additions & 536 deletions _generated-doc/main/config/quarkus-reactive-datasource.adoc

Large diffs are not rendered by default.

Large diffs are not rendered by default.

136 changes: 108 additions & 28 deletions _generated-doc/main/config/quarkus-redis-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ a| [[quarkus-redis-client_quarkus-redis-hosts]] [.property-path]##link:#quarkus-

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

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

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

[.description]
--
The maximum delay to wait before a blocking command to redis server times out
The maximum delay to wait before a blocking command to Redis server times out


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

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


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

[.description]
--
The master name (only considered in HA mode).
The master name (only considered in the Sentinel mode).


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

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


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

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


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

[.description]
--
The default password for cluster/sentinel connections.
The default password for Redis connections.

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


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

[.description]
--
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)
The maximum size of the connection pool.


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

[.description]
--
The duration indicating how often should the connection pool cleaner executes.
The duration indicating how often should the connection pool cleaner execute.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -275,13 +275,13 @@ Environment variable: `+++QUARKUS_REDIS_POOL_CLEANER_INTERVAL+++`
endif::add-copy-button-to-env-var[]
--
|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]]
|
|`30s`

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`]##

[.description]
--
The timeout for a connection recycling.
The timeout for unused connection recycling.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -292,7 +292,7 @@ Environment variable: `+++QUARKUS_REDIS_POOL_RECYCLE_TIMEOUT+++`
endif::add-copy-button-to-env-var[]
--
|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]]
|`15S`
|`3M`

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`]##

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

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


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -417,6 +417,46 @@ endif::add-copy-button-to-env-var[]
|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]]
|`1S`

a| [[quarkus-redis-client_quarkus-redis-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-auto-failover[`quarkus.redis.auto-failover`]##

[.description]
--
Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise.

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.

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_AUTO_FAILOVER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS_AUTO_FAILOVER+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

a| [[quarkus-redis-client_quarkus-redis-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-topology[`quarkus.redis.topology`]##

[.description]
--
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_.

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_.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TOPOLOGY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS_TOPOLOGY+++`
endif::add-copy-button-to-env-var[]
--
a|`discover`, `static`
|`discover`

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`]##

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

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

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

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

[.description]
--
The maximum delay to wait before a blocking command to redis server times out
The maximum delay to wait before a blocking command to Redis server times out


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

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


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

[.description]
--
The master name (only considered in HA mode).
The master name (only considered in the Sentinel mode).


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

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


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

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


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

[.description]
--
The default password for cluster/sentinel connections.
The default password for Redis connections.

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


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

[.description]
--
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)
The maximum size of the connection pool.


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

[.description]
--
The duration indicating how often should the connection pool cleaner executes.
The duration indicating how often should the connection pool cleaner execute.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -690,13 +730,13 @@ Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_CLEANER_INTERVA
endif::add-copy-button-to-env-var[]
--
|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]]
|
|`30s`

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`]##

[.description]
--
The timeout for a connection recycling.
The timeout for unused connection recycling.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -707,7 +747,7 @@ Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_RECYCLE_TIMEOUT
endif::add-copy-button-to-env-var[]
--
|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]]
|`15S`
|`3M`

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`]##

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

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


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -832,6 +872,46 @@ endif::add-copy-button-to-env-var[]
|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]]
|`1S`

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`]##

[.description]
--
Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise.

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.

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

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`]##

[.description]
--
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_.

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_.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++`
endif::add-copy-button-to-env-var[]
--
a|`discover`, `static`
|`discover`

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`]##

[.description]
Expand Down
Loading

0 comments on commit 2f294c9

Please sign in to comment.