第 2 章 Service Registry 内容规则


本章介绍了用于管理 Service Registry 内容的可选规则,并提供了有关可用规则配置的详情:

2.1. 使用规则管理 Service Registry 内容

要管理添加到 Service Registry 中的工件内容的演进,您可以配置可选规则。在将新工件版本上传到 Service Registry 之前,所有配置的全局规则或工件规则都必须通过。配置的工件规则覆盖任何配置的全局规则。

这些规则的目标是防止将无效内容添加到 Service Registry 中。例如,内容可能会因为以下原因无效:

  • 给定工件类型的无效语法(如 AVROPROTOBUF
  • 有效的语法,但语义违反了规格
  • 不兼容时,当新内容包含相对于当前工件版本的更改时

您可以使用 Service Registry web 控制台、REST API 命令或 Java 客户端应用程序启用可选内容规则。

2.1.1. 应用规则的时间

只有在将内容添加到 Service Registry 时,才会应用规则。这包括以下 REST 操作:

  • 添加工件
  • 更新工件
  • 添加工件版本

如果违反规则,Service Registry 会返回 HTTP 错误。响应正文包括违反的规则,以及显示错误的消息。

2.1.2. 规则优先级

您可以在全局级别和工件级别配置 Service Registry 内容规则。优先级顺序如下:

  • 如果您启用工件规则和等同的全局规则,工件规则会覆盖全局规则。
  • 如果您禁用工件规则,并启用等同的全局规则,则应用全局规则。
  • 如果您在工件级别和全局级别禁用规则,您可以禁用所有工件的规则。
  • 如果您在工件级别上将规则值设置为 NONE,您需要覆盖启用的全局规则。在这种情况下,工件规则值 NONE 具有此工件的优先级,但启用的全局规则仍应用到在工件级别禁用该规则的任何其他工件。

2.1.3. 规则的工作方式

每个规则都有一个名称和配置信息。Service Registry 维护每个工件的规则列表以及全局规则列表。列表中的每一规则都由规则实施的名称和配置组成。

提供了一个规则,其中包含当前版本的工件内容(如果存在),以及要添加的工件的新版本。根据工件是否通过该规则,规则实施会返回 true 或 false。如果没有,Service Registry 会在 HTTP 错误响应中报告原因。有些规则可能无法使用以前的内容版本。例如,兼容性规则使用之前的版本,但语法或语义有效规则不使用。

其他资源

如需了解更多详细信息,请参阅 第 9 章 Service Registry 工件和规则引用

2.1.4. 内容规则配置

您可以为每个工件单独配置规则,也可以全局配置规则。Service Registry 应用为特定工件配置的规则。如果在这个级别上没有配置规则,Service Registry 会应用全局配置的规则。如果没有配置全局规则,则不会应用规则。

配置工件规则

您可以使用 Service Registry web 控制台或 REST API 配置工件规则。详情请查看以下内容:

配置全局规则

您可以通过几种方式配置全局规则:

  • 在 REST API 中使用 /rules 操作
  • 使用 Service Registry web 控制台
  • 使用 Service Registry 应用程序属性设置默认全局规则

配置默认全局规则

您可以在应用程序级别配置 Service Registry,以启用或禁用全局规则。您可以使用以下应用程序属性格式,在安装时配置默认的全局规则,而无需安装后配置:

registry.rules.global.<ruleName>

目前支持以下规则名称:

  • 兼容性
  • 有效期

application 属性的值必须是特定于所配置规则的有效配置选项。

注意

您可以将这些应用程序属性配置为 Java 系统属性,或者在 Quarkus application.properties 文件中包含它们。如需了解更多详细信息,请参阅 Quarkus 文档

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.