mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2025-12-21 06:20:05 -06:00
Code Issues Packages Projects Releases Wiki Activity

Provide CLI Parameters for jgroups.* options

Browse Source 
Closes #40481

Signed-off-by: Ryan Emerson <remerson@redhat.com>
This commit is contained in:
Ryan Emerson
2025-07-07 12:07:45 +01:00
committed by GitHub
parent b70342dda7
commit eb7ce6ae15
16 changed files with 353 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -321,22 +321,25 @@ To ensure a healthy {project_name} clustering, some network ports need to be ope
The table below shows the TCP ports that need to be open for the `jdbc-ping` stack, and a description of the traffic that goes through it.
|===
|Port |Property | Description
|Port |Option| Property | Description
m|7800
m|cache-embedded-network-bind-port
m|jgroups.bind.port
|Unicast data transmission.
m|57800
m|
m|jgroups.fd.port-offset
|Failure detection by protocol `FD_SOCK2`.
It listens to the abrupt closing of a socket to suspect a {project_name} server failure.
The `jgroups.fd.port-offset` property defines the offset from the `jgroups.bind.port`.
The `jgroups.fd.port-offset` property defines the offset from the `cache-embedded-network-bind-port` option or `jgroups.bind.port` property.
By default, the offset is set to 50000, making the failure detection port 57800.
|===
NOTE: Use `-D<property>=<value>` to modify the ports above in your `JAVA_OPTS_APPEND` environment variable or in your CLI command.
NOTE: If an option is not available for the port you require, configure it using a system property `-D<property>=<value>`
in your `JAVA_OPTS_APPEND` environment variable or in your CLI command.
[#network-bind-address]
== Network bind address
@@ -345,11 +348,9 @@ To ensure a healthy {project_name} clustering, the network port must be bound on
By default, it picks a site local (non-routable) IP address, for example, from the 192.168.0.0/16 or 10.0.0.0/8 address range.
To override the address, set the `jgroups.bind.address` property.
To override the address, set the option `cache-embedded-network-bind-address=<IP>`.
NOTE: Use `-Djgroups.bind.address=<IP>` to modify the bind address in your `JAVA_OPTS_APPEND` environment variable or in your CLI command.
The following special values are also recognized for `jgroups.bind.address`:
The following special values are also recognized:
|===
|Value |Description
@@ -399,21 +400,19 @@ For more details about JGroups transport, check the http://jgroups.org/manual5/i
If you run {project_name} instances on different networks, for example behind firewalls or in containers, the different instances will not be able to reach each other by their local IP address.
In such a case, set up a port forwarding rule (sometimes called "`virtual server`") to their local IP address.
When using port forwarding, use the following properties so each node correctly advertises its external address to the other nodes:
When using port forwarding, use the following options so each node correctly advertises its external address to the other nodes:
|===
|Property | Description
|Option | Description
m|jgroups.external_port
m|cache-embedded-network-external-port
|Port that other instances in the {project_name} cluster should use to contact this node.
m|jgroups.external_addr
m|cache-embedded-network-external-address
|IP address that other instances in the {project_name} should use to contact this node.
|===
NOTE: Use `-D<property>=<value>` set this in your `JAVA_OPTS_APPEND` environment variable or in your CLI command.
== Exposing metrics from caches
Metrics from caches are automatically exposed when the metrics are enabled.