6.2. Keycloak Dev Services の設定

設定プロパティー

型

デフォルト

Dev Services

型

デフォルト

quarkus.keycloak.devservices.enabled

Dev Services を有効 (デフォルト) または無効にするフラグ。有効にすると、Dev Services for Keycloak は、Docker の実行時に、Keycloak を開発モードまたはテストモードで自動的に設定して起動します。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED

boolean

true

quarkus.keycloak.devservices.image-name

Dev Services プロバイダーのコンテナーイメージ名。デフォルトでは、Quarkus ベースの Keycloak イメージになります。WildFly ベースのディストリビューションの場合は、quay.io/keycloak/keycloak:19.0.3-legacy のようなイメージを使用します。Keycloak Quarkus と WildFly イメージは異なる方法で初期化されます。Dev Services for Keycloak は、イメージバージョンが -legacy で終わっていない限り、それが Keycloak Quarkus イメージであると想定します。quarkus.keycloak.devservices.keycloak-x-image を使用したオーバーライド。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME

string

quay.io/keycloak/keycloak:25.0.6

quarkus.keycloak.devservices.keycloak-x-image

Keycloak-X イメージが使用されているかどうかを示します。デフォルトでは、イメージはイメージ名の keycloak-x によって識別されます。カスタムイメージの場合は、quarkus.keycloak.devservices.keycloak-x-image を使用したオーバーライドです。デフォルトのチェックが機能する場合は、このプロパティーを設定する必要はありません。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE

boolean

quarkus.keycloak.devservices.shared

Keycloak コンテナーが共有されているかどうかを決定します。共有されると、Quarkus はラベルベースのサービス検出を使用して実行中の Keycloak コンテナーを見つけて再利用するため、2 番目のコンテナーは起動しません。一致するコンテナーが見つからない場合は、新しいコンテナーが起動します。サービス検出では、quarkus-dev-service-label ラベルが使用されます。このラベルの値は、service-name プロパティーによって設定されます。コンテナー共有は開発モードでのみ利用可能です。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_SHARED

boolean

true

quarkus.keycloak.devservices.service-name

Keycloak コンテナーを識別するための quarkus-dev-service-keycloak ラベルの値。共有モードで使用され、このラベルを持つ既存のコンテナーを検索します。見つからない場合は、このラベルで新しいコンテナーが初期化されます。開発モードでのみ適用されます。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME

string

quarkus

quarkus.keycloak.devservices.realm-path

Keycloak レルムファイルへのクラスまたはファイルシステムパスのコンマ区切りリスト。このリストは Keycloak を初期化するために使用されます。このリストの最初の値は、デフォルトのテナント接続プロパティーを初期化するために使用されます。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH

文字列のリスト

quarkus.keycloak.devservices.resource-aliases."alias-name"

Keycloak を初期化するために使用される追加のクラスまたはファイルシステムリソースへのエイリアス。各マップエントリーは、エイリアスとクラスまたはファイルシステムリソースパス間のマッピングを表します。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_

Map<String,String>

quarkus.keycloak.devservices.resource-mappings."resource-name"

Keycloak を初期化するために使用される追加のクラスまたはファイルシステムリソース。各マップエントリーは、クラスまたはファイルシステムリソースパスエイリアスと Keycloak コンテナーの場所間のマッピングを表します。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_

Map<String,String>

quarkus.keycloak.devservices.java-opts

keycloak JVM に渡される JAVA_OPTS

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS

string

quarkus.keycloak.devservices.show-logs

"Keycloak:" という接頭辞が付いた Keycloak ログメッセージを表示します。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS

boolean

false

quarkus.keycloak.devservices.start-command

Keycloak 開始コマンド。このプロパティーを使用して、Keycloak の起動オプションを試してください。https://www.keycloak.org/server/all-config を参照してください。注意: 従来の Keycloak WildFly イメージをロードする場合は無視されます。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND

string

quarkus.keycloak.devservices.realm-name

Keycloak レルムの名前。このプロパティーは、realm-path プロパティーによって指定されたレルムファイルが存在しない場合に、レルムを作成するために使用されます。この場合のデフォルト値は quarkus です。Dev Services for Keycloak がレルムファイルを解析せずにレルム名を識別できるように、このプロパティーを常に設定することを推奨します。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME

string

quarkus.keycloak.devservices.create-realm

realm-path にレルムファイルが見つからない場合に Keycloak レルムを作成するかどうかを指定します。Keycloak 管理コンソールまたは io.quarkus.test.common.QuarkusTestResourceLifecycleManager によって提供される Keycloak 管理 API を使用してレルムを作成する場合は、false に設定します。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM

boolean

true

quarkus.keycloak.devservices.users."users"

Keycloak ユーザー名とパスワードのマップ。空の場合、デフォルトのユーザー alice と bob が作成され、その名前がパスワードとして使用されます。このマップは、realm-path にレルムファイルが見つからない場合にユーザーの作成に使用されます。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_

Map<String,String>

quarkus.keycloak.devservices.roles."role-name"

Keycloak ユーザーのロールのマップ。空の場合、デフォルトのロールが割り当てられます。alice には admin ロールと user ロールが割り当てられ、他のユーザーには user ロールが割り当てられます。このマップは、realm-path にレルムファイルが見つからない場合にロールの作成に使用されます。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_

Map<String,List<String>>

quarkus.keycloak.devservices.port

開発サービスがリッスンする特定のポート。

指定しない場合はランダムなポートが選択されます。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_PORT

int

quarkus.keycloak.devservices.container-env."environment-variable-name"

コンテナーに渡される環境変数。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_

Map<String,String>

quarkus.keycloak.devservices.container-memory-limit

Keycloak コンテナーのメモリー制限

指定しない場合は、750 MiB がデフォルトのメモリー制限になります。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT

MemorySize

750M