keycloak-scim/topics/cache/eviction.adoc

54 lines
2.5 KiB
Text
Raw Normal View History

2016-04-28 23:31:06 +00:00
=== Eviction and Expiration
2016-04-29 20:12:12 +00:00
There are multiple different caches configured for {{book.project.name}}.
2016-04-28 23:31:06 +00:00
There is a realm cache that holds information about secured applications, general security data, and configuration options.
2016-04-29 20:12:12 +00:00
This size of this cache is unbounded and does not have a limit on entries. This might scare you a little bit, but the number of entries
in this cache is pretty low compared to the user cache. There is also a user cache that contains user metadata. It defaults to a maximum of 10000 entries and uses a least recently used eviction strategy.
There are also separate caches for user sessions, offline tokens, and login failures. These caches are unbounded in size as well.
2016-04-28 23:31:06 +00:00
The eviction policy and max entries for these caches can be configured in the _standalone.xml_, _standalone-ha.xml_, or
_domain.xml_ depending on your <<fake/../../operating-mode.adoc#_operating-mode, operating mode>>.
.non-clustered
[source,xml]
----
<subsystem xmlns="urn:jboss:domain:infinispan:4.0">
<cache-container name="keycloak" jndi-name="infinispan/Keycloak">
<local-cache name="realms"/>
<local-cache name="users">
<eviction max-entries="10000" strategy="LRU"/>
</local-cache>
<local-cache name="sessions"/>
<local-cache name="offlineSessions"/>
<local-cache name="loginFailures"/>
<local-cache name="work"/>
<local-cache name="realmVersions">
<transaction mode="BATCH" locking="PESSIMISTIC"/>
</local-cache>
</cache-container>
----
2016-04-28 23:34:34 +00:00
.clustered
2016-04-28 23:31:06 +00:00
[source,xml]
----
<subsystem xmlns="urn:jboss:domain:infinispan:4.0">
<cache-container name="keycloak" jndi-name="infinispan/Keycloak">
<transport lock-timeout="60000"/>
<invalidation-cache name="realms" mode="SYNC"/>
<invalidation-cache name="users" mode="SYNC">
<eviction max-entries="10000" strategy="LRU"/>
</invalidation-cache>
<distributed-cache name="sessions" mode="SYNC" owners="1"/>
<distributed-cache name="offlineSessions" mode="SYNC" owners="1"/>
<distributed-cache name="loginFailures" mode="SYNC" owners="1"/>
<replicated-cache name="work" mode="SYNC"/>
<local-cache name="realmVersions">
<transaction mode="BATCH" locking="PESSIMISTIC"/>
</local-cache>
</cache-container>
----
2016-04-29 20:12:12 +00:00
To limit or expand the number of allowed entries simply add, edit, or remove the `eviction` element from the `invalidation-cache` or
`distributed-cache` declaration you want to change.