Added a hint to the --cache-config-file config option that you not need to specify the configuration folder

Closes #11302
This commit is contained in:
Kai Josef Schauerte 2022-04-22 21:27:02 +02:00 committed by Bruno Oliveira da Silva
parent e0d7ad1be5
commit 016c28e7a5
6 changed files with 13 additions and 6 deletions

View file

@ -99,6 +99,8 @@ To specify your own cache configuration file, enter this command:
<@kc.build parameters="--cache-config-file=my-cache-file.xml"/> <@kc.build parameters="--cache-config-file=my-cache-file.xml"/>
The configuration file is relative to the `conf/` directory.
== Transport stacks == Transport stacks
Transport stacks ensure that distributed cache nodes in a cluster communicate in a reliable fashion. Transport stacks ensure that distributed cache nodes in a cluster communicate in a reliable fashion.
Keycloak supports a wide range of transport stacks: Keycloak supports a wide range of transport stacks:

View file

@ -34,7 +34,8 @@ final class ClusteringPropertyMappers {
builder().from("cache-config-file") builder().from("cache-config-file")
.mapFrom("cache") .mapFrom("cache")
.to("kc.spi-connections-infinispan-quarkus-config-file") .to("kc.spi-connections-infinispan-quarkus-config-file")
.description("Defines the file from which cache configuration should be loaded from.") .description("Defines the file from which cache configuration should be loaded from. "
+ "The configuration file is relative to the 'conf/' directory.")
.transformer(new BiFunction<String, ConfigSourceInterceptorContext, String>() { .transformer(new BiFunction<String, ConfigSourceInterceptorContext, String>() {
@Override @Override
public String apply(String value, ConfigSourceInterceptorContext context) { public String apply(String value, ConfigSourceInterceptorContext context) {

View file

@ -29,7 +29,8 @@ Cluster:
disables clustering and is intended for development and testing purposes. disables clustering and is intended for development and testing purposes.
Default: ispn. Default: ispn.
--cache-config-file <file> --cache-config-file <file>
Defines the file from which cache configuration should be loaded from. Defines the file from which cache configuration should be loaded from. The
configuration file is relative to the 'conf/' directory.
--cache-stack <stack> --cache-stack <stack>
Define the default stack to use for cluster communication and node discovery. Define the default stack to use for cluster communication and node discovery.
This option only takes effect if 'cache' is set to 'ispn'. Default: udp. This option only takes effect if 'cache' is set to 'ispn'. Default: udp.

View file

@ -29,7 +29,8 @@ Cluster:
disables clustering and is intended for development and testing purposes. disables clustering and is intended for development and testing purposes.
Default: ispn. Default: ispn.
--cache-config-file <file> --cache-config-file <file>
Defines the file from which cache configuration should be loaded from. Defines the file from which cache configuration should be loaded from. The
configuration file is relative to the 'conf/' directory.
--cache-stack <stack> --cache-stack <stack>
Define the default stack to use for cluster communication and node discovery. Define the default stack to use for cluster communication and node discovery.
This option only takes effect if 'cache' is set to 'ispn'. Default: udp. This option only takes effect if 'cache' is set to 'ispn'. Default: udp.
@ -104,4 +105,4 @@ running this command every time you change a configuration:
$ kc.bat start --auto-build <OPTIONS> $ kc.bat start --auto-build <OPTIONS>
By doing that you have an additional overhead when the server is starting. By doing that you have an additional overhead when the server is starting.

View file

@ -21,7 +21,8 @@ Cluster:
disables clustering and is intended for development and testing purposes. disables clustering and is intended for development and testing purposes.
Default: ispn. Default: ispn.
--cache-config-file <file> --cache-config-file <file>
Defines the file from which cache configuration should be loaded from. Defines the file from which cache configuration should be loaded from. The
configuration file is relative to the 'conf/' directory.
--cache-stack <stack> --cache-stack <stack>
Define the default stack to use for cluster communication and node discovery. Define the default stack to use for cluster communication and node discovery.
This option only takes effect if 'cache' is set to 'ispn'. Default: udp. This option only takes effect if 'cache' is set to 'ispn'. Default: udp.

View file

@ -21,7 +21,8 @@ Cluster:
disables clustering and is intended for development and testing purposes. disables clustering and is intended for development and testing purposes.
Default: ispn. Default: ispn.
--cache-config-file <file> --cache-config-file <file>
Defines the file from which cache configuration should be loaded from. Defines the file from which cache configuration should be loaded from. The
configuration file is relative to the 'conf/' directory.
--cache-stack <stack> --cache-stack <stack>
Define the default stack to use for cluster communication and node discovery. Define the default stack to use for cluster communication and node discovery.
This option only takes effect if 'cache' is set to 'ispn'. Default: udp. This option only takes effect if 'cache' is set to 'ispn'. Default: udp.