6.2. Keycloak 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:26.1.3

🔒 ビルド時に固定 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 を初期化するために使用されます。このリストの最初の値は、デフォルトのテナント接続プロパティーを初期化するために使用されます。

Keycloak レルムファイルの詳細は、Importing and Exporting Keycloak Realms ドキュメント を参照してください。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH

list of string

🔒 ビルド時に固定 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.features

Keycloak の機能。このプロパティーを使用して、1 つ以上の実験的な Keycloak 機能を有効にします。Keycloak の start-command() もカスタマイズする必要がある場合は、このプロパティーを設定する代わりに、開始コマンドシーケンスの一部として --features オプションを使用できる点に留意してください。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_FEATURES

list of 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.create-client

create-realm プロパティーが true に設定されている場合に、シークレット secret を使用してデフォルトのクライアント ID quarkus-app を作成し、登録するかどうかを指定します。OIDC エクステンション設定プロパティーでは、quarkus.oidc.client.id と quarkus.oidc.credentials.secret が設定されます。OIDC クライアントエクステンション設定プロパティーでは、quarkus.oidc-client.client.id と quarkus.oidc-client.credentials.secret が設定されます。Keycloak 管理コンソールまたは io.quarkus.test.common.QuarkusTestResourceLifecycleManager によって提供される Keycloak 管理 API を使用してクライアントを作成する必要がある場合、または動的に登録する必要がある場合は、false に設定します。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT

boolean

true

🔒 ビルド時に固定 quarkus.keycloak.devservices.start-with-disabled-tenant

デフォルトの OIDC テナントが無効になっている場合でも、コンテナーを起動するかどうかを指定します。マルチテナント OIDC セットアップでは、特に OIDC テナントが動的に作成される場合、このプロパティーを true に設定する必要がある場合があります。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT

boolean

false

🔒 ビルド時に固定 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 コンテナーのメモリー制限

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

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT

MemorySize ℹ️ MemorySize 形式

1250M

🔒 ビルド時に固定 quarkus.keycloak.devservices.web-client-timeout

WebClient のタイムアウト。このプロパティーを使用して、OIDC 開発サービス管理クライアントが使用する HTTP クライアントが、管理トークンを取得してレルムを作成するときに OpenId Connect プロバイダーからの応答を待機する時間を設定します。

環境変数: QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT

Duration ℹ️ 期間のフォーマット

4S