External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-09 23:12:06 -03:30
Code Issues Packages Projects Releases Wiki Activity

Tune the caching guide for the upcoming release

Browse Source 
Closes #36039

Co-authored-by: Pedro Ruivo <pruivo@users.noreply.github.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
Alexander Schwartz 2024-12-19 11:04:43 +01:00 committed by Alexander Schwartz
parent 56246096e0
commit 4a924f6c94
8 changed files with 35 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/guides/server/caching.adoc
View File

@ -221,7 +221,7 @@ To apply a specific cache stack, enter this command:
<@kc.start parameters="--cache-stack=<stack>"/>
The default stack is set to `jdbc-ping` when distributed caches are enabled, which is backwards compatible with the 26.x release stream of {project_name}.
The default stack is set to `jdbc-ping` when distributed caches are enabled, which is backwards compatible with the defaults in the 26.x release stream of {project_name}.
=== Available transport stacks
@ -231,8 +231,8 @@ The following table shows transport stacks that are available without any furthe
|===
|Stack name|Transport protocol|Discovery
|`jdbc-ping`|TCP|Database registry - `JDBC_PING2` protocol.
|`jdbc-ping-udp` (deprecated)|UDP|Database registry - `JDBC_PING2` protocol.
|`jdbc-ping`|TCP|Database registry using the JGroups `JDBC_PING2` protocol.
|`jdbc-ping-udp` (deprecated)|UDP|Database registry using the JGroups `JDBC_PING2` protocol.
|===
The following table shows transport stacks that are available using the `--cache-stack` runtime option and a minimum configuration:
@ -241,11 +241,16 @@ The following table shows transport stacks that are available using the `--cache
|===
|Stack name|Transport protocol|Discovery
|`kubernetes`|TCP|Dns resolution - `DNS_PING` protocol. It requires `-Djgroups.dns.query=<headless-service-FQDN>` to be added to your `JAVA_OPTS_APPEND` environment variable.
|`tcp` (deprecated)|TCP|IP multicast - `MPING` protocol. See below on how to configure a unique `jgroups.mcast_addr` or `jgroups.mcast_port` for each cluster.
|`udp` (deprecated)|UDP|IP multicast - `PING` protocol. See below on how to configure a unique `jgroups.mcast_addr` or `jgroups.mcast_port` for each cluster.
|`kubernetes`|TCP|DNS resolution using the JGroups `DNS_PING` protocol. It requires to set `jgroups.dns.query` to the headless service FQDN.
|`tcp` (deprecated)|TCP|IP multicast using the JGroups `MPING` protocol. See below on how to configure a unique `jgroups.mcast_addr` or `jgroups.mcast_port` for each cluster.
|`udp` (deprecated)|UDP|IP multicast using the JGroups `PING` protocol. See below on how to configure a unique `jgroups.mcast_addr` or `jgroups.mcast_port` for each cluster.
|===
When using the `tcp`, `udp` or `jdbc-ping-udp` stack, each cluster must use a different multicast address and/or port so that their nodes form distinct clusters.
By default, {project_name} uses `239.6.7.8` as multicast address for `jgroups.mcast_addr` and `46655` for the multicast port `jgroups.mcast_port`.
NOTE: Use `-D<property>=<value>` to pass the properties via the `JAVA_OPTS_APPEND` environment variable or in the CLI command.
====
*Additional Stacks*

2
docs/guides/templates/options.adoc
View File

@ -1,7 +1,7 @@
<#macro expectedValues option>
<#assign optionObj = ctx.options.getOption(option) />
<#list optionObj.expectedValues as expectedValue>
* ${expectedValue} <#if optionObj.defaultValue?has_content && expectedValue == optionObj.defaultValue> (default)</#if>
* `+${expectedValue}+` <#if optionObj.defaultValue?has_content && expectedValue == optionObj.defaultValue> (default)</#if> <#if optionObj.deprecated?has_content && optionObj.deprecated.deprecatedValues?seq_contains(expectedValue)> (deprecated)</#if>
</#list>
</#macro>

6
quarkus/config-api/src/main/java/org/keycloak/config/CachingOptions.java
View File

@ -44,11 +44,11 @@ public class CachingOptions {
.build();
public enum Stack {
jdbc_ping,
kubernetes,
jdbc_ping_udp,
tcp,
udp,
jdbc_ping,
jdbc_ping_udp,
kubernetes,
ec2,
azure,
google;

8
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt vendored
View File

@ -89,10 +89,10 @@ Cache:
only when remote host is set.
--cache-stack <stack>
Define the default stack to use for cluster communication and node discovery.
Possible values are: tcp (deprecated), udp (deprecated), jdbc-ping,
jdbc-ping-udp (deprecated), kubernetes, ec2 (deprecated), azure
(deprecated), google (deprecated), or a custom one. Default: jdbc-ping.
Available only when 'cache' type is set to 'ispn'.
Possible values are: jdbc-ping, kubernetes, jdbc-ping-udp (deprecated), tcp
(deprecated), udp (deprecated), ec2 (deprecated), azure (deprecated), google
(deprecated), or a custom one. Default: jdbc-ping. Available only when
'cache' type is set to 'ispn'.
Config:

8
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelp.approved.txt vendored
View File

@ -70,10 +70,10 @@ Cache:
Required when feature 'multi-site' or 'clusterless' is set.
--cache-stack <stack>
Define the default stack to use for cluster communication and node discovery.
Possible values are: tcp (deprecated), udp (deprecated), jdbc-ping,
jdbc-ping-udp (deprecated), kubernetes, ec2 (deprecated), azure
(deprecated), google (deprecated), or a custom one. Default: jdbc-ping.
Available only when 'cache' type is set to 'ispn'.
Possible values are: jdbc-ping, kubernetes, jdbc-ping-udp (deprecated), tcp
(deprecated), udp (deprecated), ec2 (deprecated), azure (deprecated), google
(deprecated), or a custom one. Default: jdbc-ping. Available only when
'cache' type is set to 'ispn'.
Config:

8
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt vendored
View File

@ -90,10 +90,10 @@ Cache:
only when remote host is set.
--cache-stack <stack>
Define the default stack to use for cluster communication and node discovery.
Possible values are: tcp (deprecated), udp (deprecated), jdbc-ping,
jdbc-ping-udp (deprecated), kubernetes, ec2 (deprecated), azure
(deprecated), google (deprecated), or a custom one. Default: jdbc-ping.
Available only when 'cache' type is set to 'ispn'.
Possible values are: jdbc-ping, kubernetes, jdbc-ping-udp (deprecated), tcp
(deprecated), udp (deprecated), ec2 (deprecated), azure (deprecated), google
(deprecated), or a custom one. Default: jdbc-ping. Available only when
'cache' type is set to 'ispn'.
Config:

8
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelp.approved.txt vendored
View File

@ -70,10 +70,10 @@ Cache:
Required when feature 'multi-site' or 'clusterless' is set.
--cache-stack <stack>
Define the default stack to use for cluster communication and node discovery.
Possible values are: tcp (deprecated), udp (deprecated), jdbc-ping,
jdbc-ping-udp (deprecated), kubernetes, ec2 (deprecated), azure
(deprecated), google (deprecated), or a custom one. Default: jdbc-ping.
Available only when 'cache' type is set to 'ispn'.
Possible values are: jdbc-ping, kubernetes, jdbc-ping-udp (deprecated), tcp
(deprecated), udp (deprecated), ec2 (deprecated), azure (deprecated), google
(deprecated), or a custom one. Default: jdbc-ping. Available only when
'cache' type is set to 'ispn'.
Config:

8
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt vendored
View File

@ -90,10 +90,10 @@ Cache:
only when remote host is set.
--cache-stack <stack>
Define the default stack to use for cluster communication and node discovery.
Possible values are: tcp (deprecated), udp (deprecated), jdbc-ping,
jdbc-ping-udp (deprecated), kubernetes, ec2 (deprecated), azure
(deprecated), google (deprecated), or a custom one. Default: jdbc-ping.
Available only when 'cache' type is set to 'ispn'.
Possible values are: jdbc-ping, kubernetes, jdbc-ping-udp (deprecated), tcp
(deprecated), udp (deprecated), ec2 (deprecated), azure (deprecated), google
(deprecated), or a custom one. Default: jdbc-ping. Available only when
'cache' type is set to 'ispn'.
Config: