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

Simplify Cache Configuration file by removing built-in cache configurations

Browse Source 
Closes #41559

Signed-off-by: Ryan Emerson <remerson@ibm.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
Ryan Emerson
2025-08-15 17:16:56 +01:00
committed by GitHub
parent 4526d2d445
commit 168d9cc090
24 changed files with 271 additions and 233 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -24,12 +24,10 @@ When you start {project_name} in development mode, by using the `start-dev` comm
The `local` cache mode is intended only for development and testing purposes.
== Configuring caches
{project_name} provides a cache configuration file with sensible defaults located at `conf/cache-ispn.xml`.
{project_name} provides a regular {infinispan_configuring_docs}[Infinispan configuration file] located at `conf/cache-ispn.xml`.
This file contains the default configuration used for the cache-container and JGroups transport.
The cache configuration is a regular {infinispan_configuring_docs}[Infinispan configuration file].
The following table gives an overview of the specific caches {project_name} uses.
You configure these caches in `conf/cache-ispn.xml`:
The following table gives an overview of the specific caches {project_name} uses:
[%autowidth]
|===
@@ -172,6 +170,21 @@ To specify your own cache configuration file, enter this command:
The configuration file is relative to the `conf/` directory.
=== Modifying cache configuration defaults
{project_name} automatically creates all required caches with the expected configurations. You can add additional caches or override the default cache configurations in `conf/cache-ispn.xml` or in your own file provided via `--cache-config-file`.
[WARNING]
====
While overriding the default cache configurations via XML is technically possible, it is not supported.
This is only recommended for advanced use-cases where the default cache configurations are proven to be problematic.
The only supported way to change the default cache configurations is via the `+cache-...+` options.
====
In order to prevent a warning being logged when a modified default cache configuration is detected, add the following option:
<@kc.start parameters="--cache-config-mutate=true"/>
=== CLI options for remote server
For configuration of {project_name} server for high availability and multi-node clustered setup there was introduced following CLI options `cache-remote-host`, `cache-remote-port`, `cache-remote-username` and `cache-remote-password` simplifying configuration within the XML file.