23.2. 更新された設定に対する更新ストラテジーの決定


ローリング更新が可能かどうかを確認するには、更新互換性コマンドを実行します。

  1. 古い設定で必要なメタデータを生成します。
  2. 新しい設定でメタデータをチェックして、更新ストラテジーを決定します。
警告

このコマンドは現在、限定された機能のみを提供します。現時点では、ローリング更新が可能かどうかを判断するために、Red Hat build of Keycloak のバージョンと、組み込まれた Infinispan のみが考慮されます。上記に変更がなければ、ローリング更新が可能であることが報告されます。

現在のバージョンでは、設定の変更はまだ検証されておらず、すべての設定変更がローリング更新の対象となると想定されています。カスタム拡張機能やテーマの変更にも同様に適用されます。

これを使用する代表的なユースケースとしては、Red Hat build of Keycloak のテーマやカスタム拡張機能を変更する際にローリングアップデートを行う場合や、Red Hat build of Keycloak のバージョン自体が変更されており、まだローリングアップデートが許可されていない場合にのみ、再作成アップデートを実行するように場合などです。

これらのコマンドを使用する場合は、現在存在する制限事項を認識している必要がありますが、メタデータファイルの内部動作や構造に依存しないようにしてください。今後の内部ロジックの改善によるメリットを得るためにも、ローリングアップデートの可否判断には、check コマンドの終了コードのみをもとに判断するようにしてください。

23.2.1. メタデータの生成

メタデータを生成するには、同じ Red Hat build of Keycloak バージョンと設定オプションを使用して、次のコマンドを実行します。

現在のデプロイメントからメタデータを生成して保存します。

bin/kc.[sh|bat] update-compatibility metadata --file=/path/to/file.json
Copy to Clipboard Toggle word wrap

このコマンドは、start コマンドで使用されるオプションをすべて使用できます。このコマンドは、デバッグの目的で、JSON 形式でメタデータをコンソールに表示します。--file パラメーターを使用すると、メタデータをファイルに保存できます。このファイルを後続の check コマンドで使用します。

警告

上記のコマンドを実行する際は、環境変数か CLI 引数かに関係なく、すべての設定オプションが含まれていることを確認してください。

設定オプションを省略すると、メタデータが不完全になり、次のステップで間違った結果が報告される可能性があります。

23.2.2. メタデータの確認

このコマンドは、前のコマンドによって生成されたメタデータをチェックして、現在の設定と Red Hat build of Keycloak と比較します。新しい Red Hat build of Keycloak バージョンにアップグレードする場合は、このコマンドを新しいバージョンで実行する必要があります。

以前のデプロイメントからのメタデータを確認します。

bin/kc.[sh|bat] update-compatibility check --file=/path/to/file.json
Copy to Clipboard Toggle word wrap

警告
  • コマンドを実行する際は、環境変数か CLI 引数かに関係なく、すべての設定オプションが含まれていることを確認してください。
  • 正しい Red Hat build of Keycloak バージョンが使用されていることを確認します。

これらの要件を満たさない場合、結果は不正確になります。

コマンドは結果をコンソールに出力します。たとえば、ローリング更新が可能な場合は、次のように表示されます。

ローリング更新が可能であることを示すメッセージ

[OK] Rolling Update is available.
Copy to Clipboard Toggle word wrap

ローリング更新が不可能な場合、このコマンドで互換性がない旨の情報が表示されます。

ローリング更新が不可能であることを示すメッセージ

[keycloak] Rolling Update is not available. 'keycloak.version' is incompatible: 26.2.0 -> 26.2.1 
1
Copy to Clipboard Toggle word wrap

1
この例では、Keycloak バージョン 26.2.0 はバージョン 26.2.1 と互換性がなく、ローリング更新は実行できません。

コマンド終了コード

コマンドの終了コードを使用して、自動化パイプラインの更新タイプを判別します。

Expand
終了コード説明

0

ローリング更新が可能です。

1

予期しないエラーが発生しました (メタデータファイルが見つからないか破損しているなど)。

2

無効な CLI オプションです。

3

ローリング更新はできません。新しい設定を適用する前に、デプロイメントをシャットダウンする必要があります。

4

ローリング更新はできません。rolling-updates 機能は無効になっています。

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat