第21章 すべての設定

cache

高可用性のためのキャッシュメカニズムを定義します。

実稼働モードのデフォルトでは、複数のサーバーノード間のクラスターは ispn キャッシュを使用して作成されます。開発モードのデフォルトでは、local キャッシュはクラスタリングを無効にし、開発とテスト目的で使用されます。

CLI: --cache
Env: KC_CACHE

ispn (デフォルト)、local

cache-config-file

キャッシュ設定のロード元となるファイルを定義します。

設定ファイルは conf/ ディレクトリーに相対です。

CLI: --cache-config-file
Env: KC_CACHE_CONFIG_FILE

cache-config-mutate

デフォルトのキャッシュ設定への変更が許可されるかどうかを決定します。

これは、デフォルトのキャッシュ設定に問題があることが証明されている高度なユースケースにのみ推奨されます。デフォルトのキャッシュ設定を変更する唯一のサポートされている方法は、他の cache-…​ オプションを使用することです。

CLI: --cache-config-mutate
Env: KC_CACHE_CONFIG_MUTATE

true、false (デフォルト)

cache-embedded-authorization-max-count

認可キャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-authorization-max-count
Env: KC_CACHE_EMBEDDED_AUTHORIZATION_MAX_COUNT

cache-embedded-client-sessions-max-count

clientSessions キャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-client-sessions-max-count
Env: KC_CACHE_EMBEDDED_CLIENT_SESSIONS_MAX_COUNT

組み込み Infinispan クラスターが設定されている場合にのみ使用可能

cache-embedded-crl-max-count

CRL キャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-crl-max-count
Env: KC_CACHE_EMBEDDED_CRL_MAX_COUNT

cache-embedded-keys-max-count

キーキャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-keys-max-count
Env: KC_CACHE_EMBEDDED_KEYS_MAX_COUNT

cache-embedded-mtls-enabled

Keycloak サーバー間のネットワーク通信を暗号化します。

キーストアとトラストストアに関する追加のパラメーターが指定されていない場合は、一時的なキーペアと証明書が自動的に作成され、ローテーションされます。これは標準設定に推奨されます。

CLI: --cache-embedded-mtls-enabled
Env: KC_CACHE_EMBEDDED_MTLS_ENABLED

TCP ベースのキャッシュスタックが使用されている場合にのみ使用可能

true (デフォルト)、false

cache-embedded-mtls-key-store-file

キーストアファイルのパス。

キーストアには、TLS プロトコルが使用する証明書が含まれている必要があります。デフォルトでは、conf/ディレクトリーの下にある cache-mtls-keystore.p12 が検索されます。

CLI: --cache-embedded-mtls-key-store-file
Env: KC_CACHE_EMBEDDED_MTLS_KEY_STORE_FILE

プロパティー 'cache-embedded-mtls-enabled' が有効な場合にのみ使用可能です

cache-embedded-mtls-key-store-password

キーストアにアクセスするためのパスワード。

CLI: --cache-embedded-mtls-key-store-password
Env: KC_CACHE_EMBEDDED_MTLS_KEY_STORE_PASSWORD

プロパティー 'cache-embedded-mtls-enabled' が有効な場合にのみ使用可能です

cache-embedded-mtls-rotation-interval-days

自動 JGroups MTLS 証明書のローテーション期間 (日数)。

CLI: --cache-embedded-mtls-rotation-interval-days
Env: KC_CACHE_EMBEDDED_MTLS_ROTATION_INTERVAL_DAYS

プロパティー 'cache-embedded-mtls-enabled' が有効な場合にのみ使用可能です

30 (デフォルト)

cache-embedded-mtls-trust-store-file

トラストストアファイルのパス。

トラストストアには、信頼済み証明書または証明書に署名した認証局が含まれている必要があります。デフォルトでは、conf/ ディレクトリーの下にある cache-mtls-truststore.p12 が検索されます。

CLI: --cache-embedded-mtls-trust-store-file
Env: KC_CACHE_EMBEDDED_MTLS_TRUST_STORE_FILE

プロパティー 'cache-embedded-mtls-enabled' が有効な場合にのみ使用可能です

cache-embedded-mtls-trust-store-password

トラストストアにアクセスするためのパスワード。

CLI: --cache-embedded-mtls-trust-store-password
Env: KC_CACHE_EMBEDDED_MTLS_TRUST_STORE_PASSWORD

プロパティー 'cache-embedded-mtls-enabled' が有効な場合にのみ使用可能です

cache-embedded-network-bind-address

クラスタリングトランスポートで使用される IP アドレス。

デフォルトでは SITE_LOCAL が使用されます。

CLI: --cache-embedded-network-bind-address
Env: KC_CACHE_EMBEDDED_NETWORK_BIND_ADDRESS

Infinispan クラスター化された埋め込みが有効になっている場合のみ使用可能

cache-embedded-network-bind-port

クラスタリングトランスポートがバインドするポート。

デフォルトでは、ポート 7800 が使用されます。

CLI: --cache-embedded-network-bind-port
Env: KC_CACHE_EMBEDDED_NETWORK_BIND_PORT

Infinispan クラスター化された埋め込みが有効になっている場合のみ使用可能

cache-embedded-network-external-address

クラスター内の他のインスタンスがこのノードに接続するために使用する必要がある IP アドレス。

このインスタンスがファイアウォールの内側にある場合などに、cache-embedded-network-bind-address とは異なる場合にのみ設定します。

CLI: --cache-embedded-network-external-address
Env: KC_CACHE_EMBEDDED_NETWORK_EXTERNAL_ADDRESS

Infinispan クラスター化された埋め込みが有効になっている場合のみ使用可能

cache-embedded-network-external-port

クラスター内の他のインスタンスがこのノードとの通信に使用する必要があるポート。

このインスタンスがファイアウォールの内側にある場合など、cache-embedded-network-bind-port とは異なる場合にのみ設定します

CLI: --cache-embedded-network-external-port
Env: KC_CACHE_EMBEDDED_NETWORK_EXTERNAL_PORT

Infinispan クラスター化された埋め込みが有効になっている場合のみ使用可能

cache-embedded-offline-client-sessions-max-count

offlineClientSessions キャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-offline-client-sessions-max-count
Env: KC_CACHE_EMBEDDED_OFFLINE_CLIENT_SESSIONS_MAX_COUNT

組み込み Infinispan クラスターが設定されている場合にのみ使用可能

cache-embedded-offline-sessions-max-count

offlineSessions キャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-offline-sessions-max-count
Env: KC_CACHE_EMBEDDED_OFFLINE_SESSIONS_MAX_COUNT

組み込み Infinispan クラスターが設定されている場合にのみ使用可能

cache-embedded-realms-max-count

レルムキャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-realms-max-count
Env: KC_CACHE_EMBEDDED_REALMS_MAX_COUNT

cache-embedded-sessions-max-count

セッションキャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-sessions-max-count
Env: KC_CACHE_EMBEDDED_SESSIONS_MAX_COUNT

組み込み Infinispan クラスターが設定されている場合にのみ使用可能

cache-embedded-users-max-count

ユーザーキャッシュによってメモリー内に保存できるエントリーの最大数。

CLI: --cache-embedded-users-max-count
Env: KC_CACHE_EMBEDDED_USERS_MAX_COUNT

cache-metrics-histograms-enabled

組み込みキャッシュのメトリクスのヒストグラムを有効にします。

CLI: --cache-metrics-histograms-enabled
Env: KC_CACHE_METRICS_HISTOGRAMS_ENABLED

メトリクスが有効になっている場合にのみ使用可能

true、false (デフォルト)

cache-remote-host

外部 Infinispan クラスターのホスト名。

機能の マルチサイト または クラスターレス が設定されている場合にのみ利用できます。

CLI: --cache-remote-host
Env: KC_CACHE_REMOTE_HOST

cache-remote-password

外部 Infinispan クラスターへの認証用のパスワード。

安全でない外部 Infinispan クラスターに接続する場合はオプションです。オプションを指定する場合は、cache-remote-username も必要です。

CLI: --cache-remote-password
Env: KC_CACHE_REMOTE_PASSWORD

リモートホストが設定されている場合にのみ使用可能

cache-remote-port

外部 Infinispan クラスターのポート。

CLI: --cache-remote-port
Env: KC_CACHE_REMOTE_PORT

リモートホストが設定されている場合にのみ使用可能

11222 (デフォルト)

cache-remote-tls-enabled

TLS サポートを有効にして、保護されたリモート Infinispan サーバーと通信します。

実稼働環境では有効にすることを推奨します。

CLI: --cache-remote-tls-enabled
Env: KC_CACHE_REMOTE_TLS_ENABLED

リモートホストが設定されている場合にのみ使用可能

true (デフォルト)、false

cache-remote-username

外部 Infinispan クラスターへの認証用のユーザー名。

安全でない外部 Infinispan クラスターに接続する場合はオプションです。オプションを指定する場合は、cache-remote-password も必要です。

CLI: --cache-remote-username
Env: KC_CACHE_REMOTE_USERNAME

リモートホストが設定されている場合にのみ使用可能

cache-stack

クラスター通信とノード検出に使用するデフォルトのスタックを定義します。

設定されていない場合のデフォルトは jdbc-ping です。

CLI: --cache-stack
Env: KC_CACHE_STACK

'cache' タイプが 'ispn' に設定されている場合にのみ使用可能です。

非推奨の値を未設定のままにして、jdbc-ping を使用してください( azure、ec2、google、jdbc-ping-udp、kubernetes、tcp、udp)。

jdbc-ping、kubernetes （非推奨）、jdbc-ping-udp （非推奨）、tcp （非推奨）、udp （非推奨）、ec2 （非推奨）、azure （非推奨）、Google （非推奨）、または any