第2章 リリース固有の変更

ホスト名 v2 オプションはデフォルトでサポートされています。古いホスト名オプションは非推奨です。

必要な移行のリスト：

ご覧のとおり、hostname および hostname-admin オプションで *-url の接尾辞が削除されました。オプション hostname は hostname と URL の両方を受け入れますが、hostname-admin は完全な URL のみを受け入れるようになりました。

また、パス や ポート を個別に設定することはできません。hostname および hostname-admin オプションの完全な URL を指定して実現できます。

ポートが URL の一部ではない場合、受信したリクエストヘッダーから動的に解決されます。

hostname および hostname-admin URL の一部でない限り、HTTPS が適用されなくなりました。指定しない場合、使用されるプロトコル(http/https)は受信リクエストから動的に解決されます。hostname-strict-https オプションが削除されます。

# Hostname v1
bin/kc.[sh|bat] start --hostname=mykeycloak.org --https-port=8543 --hostname-path=/auth --hostname-strict-https=true

# Hostname v2
bin/kc.[sh|bat] start --hostname=https://mykeycloak.org:8543/auth

# Hostname v1
bin/kc.[sh|bat] start --hostname=mykeycloak.org --hostname-strict-backchannel=true

# Hostname v2
bin/kc.[sh|bat] start --hostname=mykeycloak.org --hostname-backchannel-dynamic=false

kcadm および kcreg がオプションおよびパラメーターを解析および処理する方法。使用エラー、間違ったオプションまたはパラメーターからのエラーメッセージは、以前のバージョンとは若干異なる可能性があります。また、使用エラーには、1 ではなく終了コードが 2 になります。

Red Hat build of Keycloak は、グループパス内のスラッシュをエスケープしたことはありません。そのため、top の group/slash という名前のグループはフルパス / top /group/slash を使用します。これは明確に誤解を招くものです。このバージョン以降、サーバーを起動して、名前をこれらのスラッシュのエスケープ処理を実行できます。

bin/kc.[sh|bat] start --spi-group-jpa-escape-slashes-in-group-path=true

エスケープ文字はチルダ文字 ~ です。上記の例では、/top/group~/slash パスになります。エスケープは、階層区切り文字ではなく、名前の一部として最後のスラッシュをマークします。

現在、エスケープは動作の変更を表すため、デフォルトでは無効になっています。エスケープを有効にすることを推奨しますが、今後のバージョンではデフォルトになる可能性があります。

master レルムが存在する前に、--import-realm オプションを指定して start または start-dev コマンドを実行すると、インポート資料に存在する場合はインポートされます。以前の動作では、マスターレルムが最初に作成され、次にインポートがスキップされていました。

最適化され た起動オプションでは、最適化されたサーバーイメージを最初に構築する必要があります。これは、最初に kc.sh|bat build を実行するか、他のサーバーコマンド( start、export、importなど)で 最適化 フラグなしで実行できます。

オプション cache、cache-stack、および cache-config-file はビルドオプションではなくなり、ランタイム時のみ指定できます。これにより、ビルドフェーズを実行し、そのためにイメージを再ビルドする必要がなくなります。これらはビルドフェーズで認識されないため、それらを ビルド フェーズから削除し、ランタイム フェーズに追加する必要があります。現在のキャッシュオプションを ランタイム フェーズに追加しない場合、Red Hat build of Keycloak はデフォルトのキャッシュ設定にフォールバックします。

ブローカーなどの一部のシナリオでは、Red Hat build of Keycloak は HTTP を使用して外部サーバーと通信します。これらのプロバイダーが過剰なデータを送信したときにサービス拒否を回避するために、Red Hat build of Keycloak はデフォルトで応答を 10 MB に制限するようになりました。

この制限を設定するには、プロバイダー設定オプション spi-connections-http-client-default-max-consumed-response-size を設定します。

bin/kc.[sh|bat] --spi-connections-http-client-default-max-consumed-response-size=1000000

kc.sh|bat] import コマンドで、プレースホルダーの置換が有効になりました。以前は、プレースホルダーの置換は起動時にレルムのインポートに対してのみ有効でした。

import コマンドのプレースホルダー置換を無効にする場合は、システム property -Dkeycloak.migration.replace-placeholders=falseを追加します。