管理インターフェースの設定

管理インターフェースは、何かが公開されるとオンになります。メトリクスとヘルスが有効になっている場合、/metrics や /health などの管理エンドポイントは、デフォルトの管理ポート 9000 で公開されます。管理インターフェースは、一連のオプションを提供し、完全に構成可能です。

管理インターフェースのプロパティが明示的に設定されていない場合、それらの値はデフォルトのHTTPサーバーから自動的に継承されます。

ポート

管理インターフェースのポートを変更するには、Keycloakオプション http-management-port を使用できます。

相対パス

管理エンドポイントのプレフィックスパスは異なる可能性があるため、管理インターフェースの相対パスを変更できます。これは、Keycloakオプション http-management-relative-path を使用して実現できます。

たとえば、CLIオプション --http-management-relative-path=/management を設定した場合、メトリクスとヘルスエンドポイントは /management/metrics および /management/health パスでアクセスできるようになります。

相対パスが指定されている場合、ユーザーはKeycloakがホストされているパスに自動的にリダイレクトされます。つまり、相対パスが /management に設定されている場合、ユーザーが localhost:9000/ にアクセスすると、ページは localhost:9000/management にリダイレクトされます。

明示的に値を設定しない場合、http-relative-path プロパティの値が使用されます。たとえば、CLIオプション --http-relative-path=/auth を設定した場合、これらのエンドポイントは /auth/metrics および /auth/health パスでアクセスできます。

TLSサポート

デフォルトのKeycloakサーバーにTLSが設定されている場合、管理インターフェースはHTTPS経由でもアクセスできるようになります。管理インターフェースは、メインサーバーのようにHTTPまたはHTTPSのいずれかでのみ実行でき、両方では実行できません。

https-management-* というプレフィックスが付いた特定のKeycloak管理インターフェースオプションは、管理HTTPサーバーに異なるTLSパラメータを設定するために提供されています。これらの機能は、メインHTTPサーバーの対応するものと同様です。詳細については、TLSの設定を参照してください。これらのオプションが明示的に設定されていない場合、TLSパラメータはデフォルトのHTTPサーバーから継承されます。

管理インターフェースの無効化

管理インターフェースは、何も公開されていない場合、自動的にオフになります。現在、ヘルスチェックとメトリクスのみが管理インターフェースで公開されています。管理インターフェースでの公開を無効にする場合は、Keycloakプロパティ legacy-observability-interface を true に設定してください。

セキュリティ上の理由から、デフォルトサーバーでヘルスおよびメトリクスエンドポイントを公開することはお勧めしません。常に管理インターフェースを使用する必要があります。注意してください、legacy-observability-interface オプションは非推奨であり、将来のリリースで削除される予定です。これは、移行のための時間を稼ぐためだけに使用できます。

管理インターフェースの設定