第2章 Service Registry のコンテンツルール
この章では、Service Registry のコンテンツを管理するために使用されるオプションのルールを紹介し、利用可能なルール設定の詳細を提供します。
2.1. ルールを使用して、Service Registry コンテンツを管理する
Service Registry に追加されたアーティファクトコンテンツのデプロイメントを管理するために、オプションのルールを設定できます。新しいアーティファクトバージョンを Service Registry にアップロードする前に、設定済みのすべてのグローバルルールまたはアーティファクト固有のルールはパスする必要があります。設定されたアーティファクト固有のルールは、設定されたグローバルルールをオーバーライドします。
これらのルールの目的は、無効なコンテンツが Service レジストリーに追加されないようにすることです。たとえば、次の理由でコンテンツが無効になる可能性があります。
-
特定のアーティファクトタイプ (
AVROやPROTOBUFなど) の構文が無効 - 有効な構文で、セマンティクスが仕様に違反している
- 新しいコンテンツに現在のアーティファクトバージョンに関連する変更の違反が含まれる場合の非互換性
- アーティファクト参照の整合性 (重複または存在しないアーティファクト参照マッピングなど)
Service Registry Web コンソール、REST API コマンド、または Java クライアントアプリケーションを使用して、任意のコンテンツルールを有効にできます。
2.1.1. ルールの適用時
ルールは、コンテンツが Service Registry に追加された場合のみ、適用されます。これには、以下の REST 操作が含まれます。
- アーティファクトの追加
- アーティファクトの更新
- アーティファクトバージョンの追加
ルールに違反した場合、Service Registry は HTTP エラーを返します。応答本文には、違反したルールと、何が問題だったのかを示すメッセージが含まれます。
2.1.2. ルールの優先順位
アーティファクト固有のルールとグローバルルールの優先順位は次のとおりです。
- アーティファクト固有のルールを有効にし、同等のグローバルルールが有効になっている場合、アーティファクトルールはグローバルルールをオーバーライドします。
- アーティファクト固有のルールを無効にし、同等のグローバルルールが有効になっている場合は、グローバルルールが適用されます。
- アーティファクト固有のルールを無効にし、同等のグローバルルールが無効になっている場合、そのルールはすべてのアーティファクトに対して無効になります。
-
アーティファクトレベルでルール値を
NONEに設定すると、有効なグローバルルールがオーバーライドされます。この場合、アーティファクトルール値NONEがこのアーティファクトでは優先されますが、有効なグローバルルールは、ルールがアーティファクトレベルで無効になっている他のすべてのアーティファクトに引き続き適用されます。
2.1.3. ルールの仕組み
各ルールには、名前と設定情報があります。Service Registry は、各アーティファクトのルールのリストとグローバルルールのリストを維持します。リスト内の各ルールは、ルール実装の名前と設定で構成されます。
アーティファクトの現在のバージョン (存在する場合) および追加されるアーティファクトの新しいバージョンのコンテンツを含むルールが提供されます。ルール実装は、アーティファクトがルールを渡すかどうかに応じて true または false を返します。そうでない場合、Service Registry は HTTP エラー応答で理由を報告します。一部のルールは、コンテンツの以前のバージョンを使用しない場合があります。たとえば、互換性ルールは以前のバージョンを使用しますが、構文またはセマンティック妥当性ルールは使用しません。
関連情報
詳細は、10章Service Registry コンテンツルールのリファレンス を参照してください。
2.1.4. コンテンツルールの設定
管理者は、Service Registry のグローバルルールとアーティファクト固有のルールを設定できます。開発者は、アーティファクト固有のルールのみを設定できます。
Service Registry は、特定のアーティファクトに設定したルールを適用します。そのレベルでルールが設定されていない場合、Service Registry はグローバルに設定されたルールを適用します。グローバルルールが設定されていない場合は、ルールが適用されません。
アーティファクトルールの設定
Service Registry Web コンソールまたは REST API を使用してアーティファクトルールを設定できます。詳細は以下を参照してください。
グローバルルールの設定
管理者は、いくつかの方法でグローバルルールを設定できます。
-
REST API で
admin/rules操作を使用する方法 - Service Registry Web コンソールを使用する方法
- Service Registry アプリケーションプロパティーを使用してデフォルトのグローバルルールを設定する方法
デフォルトのグローバルルールの設定
開発者は、アプリケーションレベルで Service Registry を設定して、グローバルなルールを有効または無効にすることができます。以下のアプリケーションプロパティー形式を使用して、インストール後の設定を行わずに、インストール時にデフォルトのグローバルルールを設定できます。
registry.rules.global.<ruleName>
現在、以下のルール名がサポートされています。
-
compatibility -
validity -
integrity
application プロパティーの値は、設定されたルールに固有の有効な設定オプションである必要があります。
これらのアプリケーションプロパティーは、Java システムプロパティーとして設定することも、Quarkus application.properties ファイルに含めることもできます。詳細は、Quarkus のドキュメント を参照してください。
