第19章 レルムのインポートとエクスポート

以下の export および import コマンドを使用する場合、Red Hat build of Keycloak は、レルム、クライアント、ユーザー、およびその他のエンティティーに関する情報が保存されているデータベースに接続する方法を認識している必要があります。Red Hat build of Keycloak の設定 で説明されているように、その情報はコマンドラインパラメーター、環境変数、または設定ファイルとして提供できます。使用可能なオプションを確認するには、各コマンドに対して --help コマンドラインオプションを使用します。

設定オプションの一部は、ビルド時の設定オプションです。デフォルトでは、Red Hat build of Keycloak は、ビルド時のパラメーターにおける変更を検出すると、export および import コマンドに対して自動的に再ビルドします。

Red Hat build of Keycloak の設定 で説明されているように、build コマンドを使用して Red Hat build of Keycloak の最適化バージョンをビルドした場合は、コマンドラインオプション --optimized を使用して、起動時間を短縮するために Red Hat build of Keycloak がビルドチェックをスキップするようにします。その際には、コマンドラインからビルド時オプションを削除し、実行時オプションのみを保持します。

レルムをエクスポートするには、export コマンドを使用します。このコマンドを呼び出すときに、Red Hat build of Keycloak サーバーインスタンスを開始しないでください。

bin/kc.[sh|bat] export --help

レルムをディレクトリーにエクスポートするには、--dir <dir> オプションを使用できます。

bin/kc.[sh|bat] export --dir <dir>

レルムをディレクトリーにエクスポートすると、サーバーはエクスポートされるレルムごとに個別のファイルを作成します。

bin/kc.[sh|bat] export --dir <dir> --users different_files --users-per-file 100

レルムをファイルにエクスポートするには、--file <file> オプションを使用できます。

bin/kc.[sh|bat] export --file <file>

レルムをファイルにエクスポートする場合、サーバーは同じファイルを使用して、エクスポートされるすべてのレルムの設定を保存します。

エクスポートする特定のレルムを指定しない場合、すべてのレルムがエクスポートされます。単一のレルムをエクスポートする場合、次のように --realm オプションを使用できます。

bin/kc.[sh|bat] export [--dir|--file] <path> --realm my-realm

レルムをエクスポートするときには、特定のファイル名規則が使用されます。これは、ディレクトリーからのインポートや起動時のインポートにも使用する必要があります。インポートするレルムファイルの名前は、<realm name>-realm.json にする必要があります。レルムに関連付けられた通常ユーザーファイルとフェデレーションユーザーファイルの名前は、<realm-name>-users-<file number>.json および <realm-name>-federated-users-<file number>.json にする必要があります。この規則を使用しないと、エラーが発生したり、ユーザーファイルがインポートされなかったりします。

レルムをインポートするには、import コマンドを使用できます。このコマンドを呼び出すときに、Red Hat build of Keycloak サーバーインスタンスを開始しないでください。

bin/kc.[sh|bat] import --help

レルムをディレクトリーにエクスポートした後、次のように --dir <dir> オプションを使用してレルムをサーバーにインポートし直すことができます。

bin/kc.[sh|bat] import --dir <dir>

import コマンドを使用してレルムをインポートする場合、既存のレルムをスキップするかどうか、または新しい設定で既存のレルムをオーバーライドするかどうかを設定できます。そのためには、次のように --override オプションを設定します。

bin/kc.[sh|bat] import --dir <dir> --override false

デフォルトでは、--override オプションは true に設定されているため、レルムは常に新しい設定でオーバーライドされます。

以前に単一のファイルでエクスポートしたレルムをインポートするには、次のように --file <file> オプションを使用できます。

bin/kc.[sh|bat] import --file <file>

プレースホルダーを使用して、任意のレルム設定の環境変数の値を解決できます。

{
    "realm": "${MY_REALM_NAME}",
    "enabled": true,
    ...
}

上記の例では、MY_REALM_NAME 環境変数に設定された値が realm プロパティーの設定に使用されます。