在 OpenShift 上安装和部署 Apicurio Registry

Red Hat build of Apicurio Registry 3.0

安装、部署和配置 Apicurio Registry 3.0

Red Hat Integration Documentation Team

摘要

本指南介绍了如何在 AMQ Streams 或 PostgreSQL 数据库中使用数据存储选项在 OpenShift 上安装和部署 Apicurio Registry。本指南还演示了如何保护、配置和管理 Apicurio Registry 部署，并为 Apicurio Registry 和 Apicurio Registry Operator 提供配置引用。

前言
复制链接

对红帽文档提供反馈

我们感谢您对我们文档的反馈。

要进行改进，请创建一个 Jira 问题，并描述您推荐的更改。尽可能提供更详细的信息，以便我们快速解决您的请求。

前提条件

您有一个红帽客户门户网站帐户。此帐户允许您登录到 Red Hat Jira Software 实例。
如果您没有帐户，系统会提示您创建一个帐户。

流程

单击以下链接：创建问题。
在 Summary 文本框中，输入问题的简短描述。
在 Description 文本框中，提供以下信息：
- 找到此问题的页面的 URL。
- 有关此问题的详细描述。
  您可以将信息保留在任何其他字段中，使其默认值。
点 Create 将 JIRA 问题提交到文档团队。

感谢您抽出时间提供反馈。

第 1 章 Service Registry Operator quickstart
复制链接

您可以使用自定义资源定义(CRD)在命令行中快速安装 Service Registry Operator。

Quickstart 示例使用 SQL 数据库中的存储部署 Service Registry 实例：

第 1.1 节 “Quickstart Service Registry Operator 安装”
第 1.2 节 “Quickstart Service Registry 实例部署”

注意

生产环境的建议安装选项是 OpenShift OperatorHub。推荐的存储选项是用于性能、稳定性和数据管理的 SQL 数据库。

1.1. Quickstart Service Registry Operator 安装
复制链接

您可以使用下载的安装文件和示例 CRD 在命令行中快速安装和部署 Service Registry Operator，而无需 Operator Lifecycle Manager。

先决条件

已使用管理员访问权限登录到 OpenShift 集群。
已安装 OpenShift oc 命令行客户端。如需了解更多详细信息，请参阅 OpenShift CLI 文档。

流程

浏览 Red Hat Software Downloads，选择产品版本，并在 Service Registry CRD .zip 文件中下载示例。
提取下载的 CRD .zip 文件并更改到 apicurio-registry-install-examples 目录。
为 Service Registry Operator 安装创建一个 OpenShift 项目，例如：
```
export NAMESPACE="apicurio-registry"
oc new-project "$NAMESPACE"
```
```
export NAMESPACE="apicurio-registry"
oc new-project "$NAMESPACE"
```
Copy to Clipboard Toggle word wrap

输入以下命令在 install/install.yaml 文件中应用示例 CRD：

cat install/install.yaml | sed "s/apicurio-registry-operator-namespace/$NAMESPACE/g" | oc apply -f -

cat install/install.yaml | sed "s/apicurio-registry-operator-namespace/$NAMESPACE/g" | oc apply -f -

Copy to Clipboard

Toggle word wrap

输入 oc get deployment 以检查 Service Registry Operator 的就绪情况。例如，输出应如下：

NAME                     	READY   UP-TO-DATE  AVAILABLE   AGE
apicurio-registry-operator  1/1 	1        	1       	XmYs

NAME                     	READY   UP-TO-DATE  AVAILABLE   AGE
apicurio-registry-operator  1/1 	1        	1       	XmYs

Copy to Clipboard

Toggle word wrap

1.2. Quickstart Service Registry 实例部署
复制链接

要创建 Service Registry 实例部署，请使用示例 CR。

先决条件

确保安装了 Service Registry Operator。
您有一个可从 OpenShift 集群访问的 PostgreSQL 数据库。

流程

浏览 Red Hat Software Downloads，选择产品版本，并在 Service Registry CRD .zip 文件中下载示例。
选择一个示例部署。
输入以下命令使用 Service Registry Operator 在命名空间中应用更新的 ApicurioRegistry3 CR，并等待 Service Registry 实例部署：
```
oc project "$NAMESPACE"
oc apply -f <example-yaml>
```
```
oc project "$NAMESPACE"
oc apply -f <example-yaml>
```
Copy to Clipboard Toggle word wrap

输入 oc get deployment 以检查 Service Registry 实例的就绪情况。例如，输出应如下：

NAME                     	        READY UP-TO-DATE AVAILABLE AGE
example-apicurioregistry-sql-deployment 1/1   1          1         XmYs

NAME                     	        READY UP-TO-DATE AVAILABLE AGE
example-apicurioregistry-sql-deployment 1/1   1          1         XmYs

Copy to Clipboard

Toggle word wrap

输入 oc get routes 以获取 HOST/PORT URL，以在浏览器中打开 Service Registry Web 控制台。例如：

example-apicurioregistry-sql.apicurio-registry.router-default.apps.mycluster.myorg.mycompany.com

example-apicurioregistry-sql.apicurio-registry.router-default.apps.mycluster.myorg.mycompany.com

Copy to Clipboard

Toggle word wrap

第 2 章在 OpenShift 上安装 Service Registry
复制链接

本章论述了如何在 OpenShift Container Platform 上安装 Service Registry：

第 2.1 节 “从 OpenShift OperatorHub 安装 Service Registry”

先决条件

阅读 Service Registry 用户指南中的介绍。

2.1. 从 OpenShift OperatorHub 安装 Service Registry
复制链接

您可以从 OperatorHub 在 OpenShift 集群上安装 Service Registry Operator。OperatorHub 位于 OpenShift Container Platform Web 控制台中，为集群管理员提供用于发现和安装 Operator 的界面。如需了解更多详细信息，请参阅了解 OperatorHub。

注意

您可以根据您的环境安装多个 Service Registry 副本。副本数量取决于 Service Registry 中存储的工件数量和类型，以及您选择的存储选项。

先决条件

您必须具有集群管理员对 OpenShift 集群的访问权限。

流程

在 OpenShift Container Platform Web 控制台中，使用具有集群管理员特权的帐户登录。
创建新的 OpenShift 项目：
1. 在左侧导航菜单中，单击 Home,Project，然后单击 Create Project。
2. 输入项目名称，如 my-project，然后单击 Create。
在左侧导航菜单中，点 Operators，然后点 OperatorHub。
在 Filter by keyword 文本框中，输入 registry 以查找 红帽构建的 Apicurio Registry 3 operator。
阅读 Operator 信息，然后点 Install 显示 Operator 订阅页面。
选择您的订阅设置，例如：
选择您的订阅设置，例如：
- 更新频道 ：选择 3.x。
- Installation Mode: 选择以下之一：
  - All namespaces on the cluster (default)
  - 集群中的特定命名空间， 然后是 my-project
- 批准策略 ：选择 Automatic 或 Manual
点 Install，然后等待 Operator 准备就绪。

第 3 章 Service Registry 配置参考
复制链接

本章介绍了可用于 Service Registry 的配置选项的信息。

第 3.1 节 “Service Registry 配置选项”

其他资源

有关将 2.x Apicurio Registry 部署迁移到 3.x 的详情，请参考第 3.2 节 “Service Registry 版本 2 到版本 3 配置更改”
有关使用 Core Registry API 设置配置选项的详情，请参考 Apicurio Registry REST API 文档中的 /admin/config/properties 端点。
有关 Kafka serializers 和 deserializers 的客户端配置选项的详情，请查看 Service Registry 用户指南。

3.1. Service Registry 配置选项
复制链接

每个组件类别都提供了以下 Service Registry 配置选项：

== . 配置选项

Expand

Name	类型	可从以下位置获取
`apicurio.app.date`	`string`	`3.0.4`
`apicurio.app.description`	`string`	`3.0.4`
`apicurio.app.name`	`string`	`3.0.4`
`apicurio.app.version`	`string`	`3.0.4`

3.1.1. api
复制链接

Expand

表 3.1. API 配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.api.errors.include-stack-in-response`	`布尔值`	`false`	`2.1.4.Final`	在错误响应中包含堆栈追踪
`apicurio.apis.v3.base-href`	`string`	`_`	`2.5.0.Final`	API 基本 href (URI)
`apicurio.disable.apis`	`可选<list<string>>`		`2.0.0.Final`	禁用 API

3.1.2. auth
复制链接

Expand

表 3.2. 身份验证配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.auth.admin-override.claim`	`string`	`org-admin`	`2.1.0.Final`	Auth 管理员覆盖声明
`apicurio.auth.admin-override.claim-value`	`string`	`true`	`2.1.0.Final`	Auth 管理员覆盖声明值
`apicurio.auth.admin-override.enabled`	`布尔值`	`false`	`2.1.0.Final`	启用 auth 管理员覆盖
`apicurio.auth.admin-override.from`	`string`	`token`	`2.1.0.Final`	Auth admin 覆盖
`apicurio.auth.admin-override.role`	`string`	`sr-admin`	`2.1.0.Final`	Auth admin 覆盖角色
`apicurio.auth.admin-override.type`	`string`	`role`	`2.1.0.Final`	Auth admin 覆盖类型
`apicurio.auth.admin-override.user`	`string`	`admin`	`3.0.0`	Auth admin 覆盖用户名
`apicurio.auth.anonymous-read-access.enabled`	`boolean [dynamic]`	`false`	`2.1.0.Final`	匿名读取访问
`apicurio.auth.authenticated-read-access.enabled`	`boolean [dynamic]`	`false`	`2.1.4.Final`	验证的读取访问权限
`apicurio.auth.owner-only-authorization`	`boolean [dynamic]`	`false`	`2.0.0.Final`	工件仅所有者授权
`apicurio.auth.owner-only-authorization.limit-group-access`	`boolean [dynamic]`	`false`	`2.1.0.Final`	工件组所有者授权
`apicurio.auth.role-based-authorization`	`布尔值`	`false`	`2.1.0.Final`	启用基于角色的授权
`apicurio.auth.role-source`	`string`	`token`	`2.1.0.Final`	身份验证角色源
`apicurio.auth.role-source.header.name`	`string`		`2.4.3.Final`	标头授权名称
`apicurio.auth.roles.admin`	`string`	`sr-admin`	`2.0.0.Final`	身份验证角色 admin
`apicurio.auth.roles.developer`	`string`	`sr-developer`	`2.1.0.Final`	身份验证角色开发人员
`apicurio.auth.roles.readonly`	`string`	`SR-readonly`	`2.1.0.Final`	Auth 角色只读
`apicurio.authn.audit.log.prefix`	`string`	`audit`	`2.2.6`	用于应用程序审计日志记录的前缀。
`apicurio.authn.basic-client-credentials.cache-expiration`	`整数`	`10`	`2.2.6.Final`	默认客户端凭证令牌过期时间（以分钟为单位）。
`apicurio.authn.basic-client-credentials.cache-expiration-offset`	`整数`	`10`	`2.5.9.Final`	客户端凭据到期来自 JWT 过期的时间，以秒为单位。
`apicurio.authn.basic-client-credentials.enabled`	`boolean [dynamic]`	`false`	`2.1.0.Final`	启用基本身份验证客户端凭证
`apicurio.authn.basic.scope`	`可选<string>`		`2.5.0.Final`	客户端凭据范围。
`quarkus.http.auth.basic`	`布尔值`	`false`	`3.0.0`	启用基本身份验证
`quarkus.oidc.client-id`	`string`		`2.0.0.Final`	服务器用于身份验证的客户端标识符。
`quarkus.oidc.client-secret`	`可选<string>`		`2.1.0.Final`	服务器用于身份验证的客户端机密。
`quarkus.oidc.tenant-enabled`	`布尔值`	`false`	`2.0.0.Final`	启用 auth
`quarkus.oidc.token-path`	`string`		`2.1.0.Final`	身份验证令牌端点。

3.1.3. 缓存
复制链接

Expand

表 3.3. 缓存配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.config.cache.enabled`	`布尔值`	`true`	`2.2.2.Final`	启用 registry 缓存

3.1.4. ccompat
复制链接

Expand

表 3.4. ccompat 配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.ccompat.group-concat.enabled`	`布尔值`	`false`	`2.6.2.Final`	通过主题中的串联（兼容性 API）启用组支持。
`apicurio.ccompat.group-concat.separator`	`string`	`:`	`2.6.2.Final`	启用组串联时要使用的分隔符（兼容性 API）
`apicurio.ccompat.legacy-id-mode.enabled`	`boolean [dynamic]`	`false`	`2.0.2.Final`	传统 ID 模式（兼容性 API）
`apicurio.ccompat.max-subjects`	`integer [dynamic]`	`1000`	`2.4.2.Final`	返回的最大主题数（兼容性 API）
`apicurio.ccompat.use-canonical-hash`	`boolean [dynamic]`	`false`	`2.3.0.Final`	规范哈希模式（兼容性 API）

3.1.5. 下载
复制链接

Expand

表 3.5. 下载配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.download.href.ttl.seconds`	`long [dynamic]`	`30`	`2.1.2.Final`	下载链接到期

3.1.6. GITOPS
复制链接

Expand

表 3.6. GitOps 配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.gitops.id`	`string`		`3.0.0`	此 Registry 实例的标识符。只有引用此标识符的数据才会被加载。
`apicurio.gitops.repo.origin.branch`	`string`	`main`	`3.0.0`	远程 git 存储库中的分支名称，其中包含要加载的数据。
`apicurio.gitops.repo.origin.uri`	`string`		`3.0.0`	包含要加载的数据的远程 git 存储库的 URI。
`apicurio.gitops.workdir`	`string`	`/tmp/apicurio-registry-gitops`	`3.0.0`	用于存储本地 git 存储库的 GitOps 工作目录的路径。

3.1.7. 健康
复制链接

Expand

表 3.7. 健康配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.liveness.errors.ignored`	`可选<list<string>>`		`1.2.3.Final`	忽略的存活度错误
`apicurio.metrics.persistence-exception-liveness-check.counter-reset-window-duration.seconds`	`整数`	`60`	`1.0.2.Final`	计数器重置持久性存活度检查的窗口持续时间
`apicurio.metrics.persistence-exception-liveness-check.error-threshold`	`整数`	`1`	`1.0.2.Final`	持久性存活度检查的错误阈值
`apicurio.metrics.persistence-exception-liveness-check.logging.disabled`	`布尔值`	`false`	`2.0.0.Final`	禁用持久性存活度检查的日志记录
`apicurio.metrics.persistence-exception-liveness-check.status-reset-window-duration.seconds`	`整数`	`300`	`1.0.2.Final`	持久性存活度检查的状态重置窗口持续时间
`apicurio.metrics.persistence-timeout-readiness-check.error-threshold`	`整数`	`5`	`1.0.2.Final`	持久性就绪度检查的错误阈值
`apicurio.metrics.persistence-timeout-readiness-check.timeout.seconds`	`整数`	`15`	`1.0.2.Final`	持久性就绪度检查超时
`apicurio.metrics.persitence-timeout-readiness-check.status-reset-window-duration.seconds`	`整数`	`300`	`1.0.2.Final`	状态重置持久性就绪度检查的窗口持续时间
`apicurio.metrics.resonse-error-liveness-check.counter-reset-window-duration.seconds`	`整数`	`60`	`1.0.2.Final`	计数器重置响应存活度检查的窗口持续时间
`apicurio.metrics.response-error-liveness-check.counter-reset-window-duration.seconds`	`整数`	`60`	`1.0.2.Final`	计数器重置持久性就绪度检查的窗口持续时间
`apicurio.metrics.response-error-liveness-check.disabled`	`布尔值`	`false`	`2.0.0.Final`	禁用响应存活度检查的日志
`apicurio.metrics.response-error-liveness-check.error-threshold`	`整数`	`1`	`1.0.2.Final`	响应存活度检查的错误阈值
`apicurio.metrics.response-error-liveness-check.status-reset-window-duration.seconds`	`整数`	`300`	`1.0.2.Final`	响应存活度检查的状态重置窗口持续时间
`apicurio.metrics.response-timeout-readiness-check.counter-reset-window-duration.seconds`	`instance<integer>`	`60`	`1.0.2.Final`	计数器重置响应就绪度检查的窗口持续时间
`apicurio.metrics.response-timeout-readiness-check.error-threshold`	`instance<integer>`	`1`	`1.0.2.Final`	响应就绪度检查的错误阈值
`apicurio.metrics.response-timeout-readiness-check.timeout.seconds`	`instance<integer>`	`10`	`1.0.2.Final`	响应就绪度检查的超时
`apicurio.metrics.response-timeout-rediness-check.status-reset-window-duration.seconds`	`instance<integer>`	`300`	`1.0.2.Final`	响应就绪度检查的状态重置窗口持续时间
`apicurio.storage.metrics.cache.check-period.ms`	`long`	`30000`	`2.1.0.Final`	存储指标缓存检查周期

3.1.8. import
复制链接

Expand

表 3.8. 导入配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.import.preserveContentId`	`布尔值`	`true`	`3.0.0`	当设置为 true 时，将使用来自导入文件的内容 ID （否则将生成新 ID）。默认值为 'true'。
`apicurio.import.preserveGlobalId`	`布尔值`	`true`	`3.0.0`	当设置为 true 时，将使用导入文件中的全局 ID （否则将生成新 ID）。默认值为 'true'。
`apicurio.import.requireEmptyRegistry`	`布尔值`	`true`	`3.0.0`	当设置为 true 时，只有在 registry 为空时才导入数据。默认值为 'true'。
`apicurio.import.url`	`可选<url>`		`2.1.0.Final`	导入 URL
`apicurio.import.work-dir`	`string`		`3.0.0`	导入数据时使用的临时工作目录。

3.1.9. limits
复制链接

Expand

表 3.9. 限制配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.limits.config.max-artifact-labels`	`long`	`-1`	`2.2.3.final`	最大工件标签
`apicurio.limits.config.max-artifact-properties`	`long`	`-1`	`2.1.0.Final`	最大工件属性
`apicurio.limits.config.max-artifacts`	`long`	`-1`	`2.1.0.Final`	最大工件数
`apicurio.limits.config.max-description-length`	`long`	`-1`	`2.1.0.Final`	最大工件描述长度
`apicurio.limits.config.max-label-size.bytes`	`long`	`-1`	`2.1.0.Final`	最大工件标签大小
`apicurio.limits.config.max-name-length`	`long`	`-1`	`2.1.0.Final`	最大工件名称长度
`apicurio.limits.config.max-property-key-size.bytes`	`long`	`-1`	`2.1.0.Final`	最大工件属性密钥大小
`apicurio.limits.config.max-property-value-size.bytes`	`long`	`-1`	`2.1.0.Final`	max artifact 属性值大小
`apicurio.limits.config.max-requests-per-second`	`long`	`-1`	`2.2.3.Final`	每秒的最大工件请求
`apicurio.limits.config.max-schema-size.bytes`	`long`	`-1`	`2.2.3.Final`	最大模式大小（字节）
`apicurio.limits.config.max-total-schemas`	`long`	`-1`	`2.1.0.Final`	最大总模式
`apicurio.limits.config.max-versions-per-artifact`	`long`	`-1`	`2.1.0.Final`	每个工件的最大版本
`apicurio.storage.metrics.cache.max-size`	`long`	`1000`	`2.4.1.Final`	存储指标缓存最大大小。

3.1.10. Redirect
复制链接

Expand

表 3.10. 重定向配置选项
Name	类型	可从以下位置获取	描述
`apicurio.redirects`	`map<string, string>`	`2.1.2.Final`	registry 重定向
`apicurio.redirects.enabled`	`布尔值`	`2.1.2.Final`	启用重定向
`apicurio.url.override.host`	`可选<string>`	`2.5.0.Final`	覆盖用于生成外部访问 URL 的主机名。在部署带有 HTTPS 透传 Ingress 或 Route 的 Registry 时，主机和端口覆盖很有用。在这些情况下，对重定向重新使用的请求 URL （和端口）不属于客户端使用的实际外部 URL，因为请求会被代理。然后重定向会失败，因为目标 URL 无法访问。
`apicurio.url.override.port`	`optional<integer>`	`2.5.0.Final`	覆盖用于生成外部访问 URL 的端口。

3.1.11. rest
复制链接

Expand

表 3.11. REST 配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.rest.artifact.download.max-size.bytes`	`int`	`1000000`	`2.2.6`	允许从 URL 下载的工件的最大大小
`apicurio.rest.artifact.download.ssl-validation.disabled`	`布尔值`	`false`	`2.2.6`	从 URL 下载工件时跳过 SSL 验证
`apicurio.rest.deletion.artifact-version.enabled`	`boolean [dynamic]`	`false`	`2.4.2`	启用工件版本删除
`apicurio.rest.deletion.artifact.enabled`	`boolean [dynamic]`	`false`	`3.0.0`	启用工件删除
`apicurio.rest.deletion.group.enabled`	`boolean [dynamic]`	`false`	`3.0.0`	启用组删除
`apicurio.rest.mutability.artifact-version-content.enabled`	`boolean [dynamic]`	`false`	`3.0.2`	启用工件版本 mutability
`apicurio.rest.search-results.labels.max-size.bytes`	`int`	`512`	`3.0.3`	搜索结果中每个项目的最大标签大小（以字节为单位）

3.1.12. semver
复制链接

Expand

表 3.12. Semver 配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.semver.branching.coerce`	`boolean [dynamic]`	`false`	`3.0.0`	如果为 true，则无效的版本将与 Semantic Versioning 2 格式合并（如果可能）。
`apicurio.semver.branching.enabled`	`boolean [dynamic]`	`false`	`3.0.0`	为主版本('A.x')和次('A.B.x')工件版本自动创建或更新分支。
`apicurio.semver.validation.enabled`	`boolean [dynamic]`	`false`	`3.0.0`	验证所有工件版本是否都符合 Semantic Versioning 2 格式(https://semver.org)。

3.1.13. storage
复制链接

Expand

表 3.13. 存储配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.datasource.blue.db-kind`	`string`	`h2`	`3.0.0`	GitOps 蓝数据源 db kind
`apicurio.datasource.blue.jdbc.initial-size`	`string`	`20`	`3.0.0`	GitOps 蓝色数据源池初始大小
`apicurio.datasource.blue.jdbc.max-size`	`string`	`100`	`3.0.0`	GitOps 蓝数据源池最大大小
`apicurio.datasource.blue.jdbc.min-size`	`string`	`20`	`3.0.0`	GitOps 蓝色数据源池最小
`apicurio.datasource.blue.jdbc.url`	`string`	`jdbc:h2:mem:registry_db`	`3.0.0`	GitOps 蓝数据源 jdbc url
`apicurio.datasource.blue.password`	`string`	`sa`	`3.0.0`	GitOps 蓝数据源密码
`apicurio.datasource.blue.username`	`string`	`sa`	`3.0.0`	GitOps 蓝数据源用户名
`apicurio.datasource.green.db-kind`	`string`	`h2`	`3.0.0`	GitOps 绿色数据源 db kind
`apicurio.datasource.green.jdbc.initial-size`	`string`	`20`	`3.0.0`	GitOps 绿色数据源池初始大小
`apicurio.datasource.green.jdbc.max-size`	`string`	`100`	`3.0.0`	GitOps 绿色数据源池最大大小
`apicurio.datasource.green.jdbc.min-size`	`string`	`20`	`3.0.0`	GitOps 绿色数据源池最小大小
`apicurio.datasource.green.jdbc.url`	`string`	`jdbc:h2:mem:registry_db`	`3.0.0`	GitOps 绿色数据源 jdbc url
`apicurio.datasource.green.password`	`string`	`sa`	`3.0.0`	GitOps 绿色数据源密码
`apicurio.datasource.green.username`	`string`	`sa`	`3.0.0`	GitOps 绿色数据源用户名
`apicurio.events.kafka.topic`	`string`	`registry-events`		存储事件主题
`apicurio.kafkasql.bootstrap.servers`	`string`			Kafka sql 存储 bootstrap 服务器
`apicurio.kafkasql.consumer.group-prefix`	`string`	`apicurio-`		消费者组名称的 Kafka sql 存储前缀
`apicurio.kafkasql.consumer.poll.timeout`	`整数`	`5000`		Kafka sql 存储消费者轮询超时
`apicurio.kafkasql.coordinator.response-timeout`	`整数`	`30000`		Kafka sql 存储协调器响应超时
`apicurio.kafkasql.security.protocol`	`可选<string>`			Kafka sql 存储安全协议
`apicurio.kafkasql.security.sasl.client-id`	`string`			Kafka sql 存储 sasl 客户端标识符
`apicurio.kafkasql.security.sasl.client-secret`	`string`			Kafka sql 存储 sasl 客户端 secret
`apicurio.kafkasql.security.sasl.enabled`	`布尔值`	`false`		启用 Kafka sql 存储 sasl
`apicurio.kafkasql.security.sasl.login.callback.handler.class`	`string`			Kafka sql 存储 sasl 登录回调处理器
`apicurio.kafkasql.security.sasl.mechanism`	`string`			Kafka sql 存储 sasl 机制
`apicurio.kafkasql.security.sasl.token.endpoint`	`string`			Kafka sql 存储 sasl 令牌端点
`apicurio.kafkasql.security.ssl.truststore.location`	`可选<string>`			Kafka sql 存储 ssl truststore 位置
`apicurio.kafkasql.security.ssl.truststore.type`	`可选<string>`			Kafka sql 存储 ssl truststore 类型
`apicurio.kafkasql.snapshot.every.seconds`	`string`	`86400s`	`3.0.0`	每个 Kafka sql journal 主题快照
`apicurio.kafkasql.snapshots.topic`	`string`	`kafkasql-snapshots`	`3.0.0`	Kafka sql 存储主题名称
`apicurio.kafkasql.ssl.key.password`	`可选<string>`			Kafka sql 存储 ssl 密钥密码
`apicurio.kafkasql.ssl.keystore.location`	`可选<string>`			Kafka sql 存储 ssl keystore 位置
`apicurio.kafkasql.ssl.keystore.password`	`可选<string>`			Kafka sql 存储 ssl keystore password
`apicurio.kafkasql.ssl.keystore.type`	`可选<string>`			Kafka sql 存储 ssl keystore 类型
`apicurio.kafkasql.ssl.truststore.password`	`可选<string>`			Kafka sql 存储 ssl truststore 密码
`apicurio.kafkasql.topic`	`string`	`kafkasql-journal`		Kafka sql 存储主题名称
`apicurio.kafkasql.topic.auto-create`	`布尔值`	`true`		Kafka sql 存储主题自动创建
`apicurio.sql.db-schema`	`string`	`*`	`3.0.6`	数据库架构名称（仅在针对同一数据库运行两个 Registry 实例时，在多个架构中运行）
`apicurio.sql.init`	`布尔值`	`true`	`2.0.0.Final`	SQL init
`apicurio.storage.kind`	`string`		`3.0.0`	应用程序存储变体，如 sql、kafkasql 或 gitops
`apicurio.storage.read-only.enabled`	`boolean [dynamic]`	`false`	`2.5.0.Final`	启用 Registry 存储只读模式
`apicurio.storage.snapshot.location`	`string`	`./`	`3.0.0`	Kafka sql 快照存储位置
`apicurio.storage.sql.kind`	`string`	`h2`	`3.0.0`	应用程序数据源数据库类型
`artifacts.skip.disabled.latest`	`布尔值`	`true`	`2.4.2`	在检索最新工件版本时跳过带有 DISABLED 状态的工件版本

3.1.14. ui
复制链接

Expand

表 3.14. UI 配置选项
Name	类型	default	可从以下位置获取	描述
`apicurio.ui.auth.oidc.client-id`	`string`	`apicurio-registry-ui`	`3.0.0`	OIDC 客户端Id
`apicurio.ui.auth.oidc.logout-url`	`string`	`f5`	`3.0.0`	OIDC 注销 URL
`apicurio.ui.auth.oidc.redirect-uri`	`string`	`/`	`3.0.0`	OIDC 重定向Uri
`apicurio.ui.auth.oidc.scope`	`string`	`OpenID 配置集电子邮件`	`3.0.8`	UI 身份验证 OIDC 范围值
`apicurio.ui.contextPath`	`string`	`/`	`3.0.0`	UI 的上下文路径
`apicurio.ui.docsUrl`	`string`	`/docs/`	`3.0.0`	文档组件的 URL
`apicurio.ui.features.breadcrumbs`	`string`	`true`	`3.0.0`	支持在 UI 中显示面包屑导航栏
`apicurio.ui.features.read-only.enabled`	`string`	`false`	`3.0.0`	启用，将 UI 设置为只读模式
`apicurio.ui.features.settings`	`string`	`true`	`3.0.0`	启用以显示 UI 中的 Settings 选项卡
`apicurio.ui.navPrefixPath`	`string`	`/`	`3.0.0`	所有 UI 路径的导航前缀

3.2. Service Registry 版本 2 到版本 3 配置更改
复制链接

Service Registry v3 简化了配置选项，删除重复并改进一致性。对于大多数选项，唯一更改是从 registry 的 srenaming of prefix from apicurio 标记为 apicurio，将 registry.kafkasql.bootstrap.servers 更改为 apicurio.kafkasql.bootstrap.servers。

注意

对于每个配置属性，您可以使用对应的环境变量覆盖值，例如 APICURIO_KAFKASQL_BOOTSTRAP_SERVERS。

3.2.1. api
复制链接

Expand

表 3.15. API 配置选项
Name	新选项
`registry.api.errors.include-stack-in-response`	`apicurio.api.errors.include-stack-in-response`
`registry.disable.apis`	`apicurio.disable.apis`

3.2.2. auth
复制链接

Expand

表 3.16. 身份验证配置选项
Name	新选项
`registry.auth.admin-override.claim`	`apicurio.auth.admin-override.claim`
`registry.auth.admin-override.claim-value`	`apicurio.auth.admin-override.claim-value`
`registry.auth.admin-override.enabled`	`apicurio.auth.admin-override.enabled`
`registry.auth.admin-override.from`	`apicurio.auth.admin-override.from`
`registry.auth.admin-override.role`	`apicurio.auth.admin-override.role`
`registry.auth.admin-override.type`	`apicurio.auth.admin-override.type`
`registry.auth.anonymous-read-access.enabled`	`apicurio.auth.anonymous-read-access.enabled`
`registry.auth.audit.log.prefix`	`apicurio.authn.audit.log.prefix`
`registry.auth.authenticated-read-access.enabled`	`apicurio.auth.authenticated-read-access.enabled`
`registry.auth.basic-auth-client-credentials.cache-expiration`	`apicurio.authn.basic-client-credentials.cache-expiration`
`registry.auth.basic-auth-client-credentials.cache-expiration-offset`	`apicurio.authn.basic-client-credentials.cache-expiration-offset`
`registry.auth.basic-auth-client-credentials.enabled`	`apicurio.authn.basic-client-credentials.enabled`
`registry.auth.basic-auth.scope`	`apicurio.authn.basic.scope`
`registry.auth.client-id`	`quarkus.oidc.client-id`
`registry.auth.client-secret`	`quarkus.oidc.client-secret`
`registry.auth.enabled`	`quarkus.oidc.tenant-enabled`
`registry.auth.owner-only-authorization`	`apicurio.auth.owner-only-authorization`
`registry.auth.owner-only-authorization.limit-group-access`	`apicurio.auth.owner-only-authorization.limit-group-access`
`registry.auth.role-based-authorization`	`apicurio.auth.role-based-authorization`
`registry.auth.role-source`	`apicurio.auth.role-source`
`registry.auth.role-source.header.name`	`apicurio.auth.role-source.header.name`
`registry.auth.roles.admin`	`apicurio.auth.roles.admin`
`registry.auth.roles.developer`	`apicurio.auth.roles.developer`
`registry.auth.roles.readonly`	`apicurio.auth.roles.readonly`
`registry.auth.tenant-owner-is-admin.enabled`	`删除`
`registry.auth.token.endpoint`	`quarkus.oidc.token-path`

3.2.3. 缓存
复制链接

Expand

表 3.17. 缓存配置选项
Name	新选项
`registry.config.cache.enabled`	`apicurio.config.cache.enabled`

3.2.4. ccompat
复制链接

Expand

表 3.18. ccompat 配置选项
Name	新选项
`registry.ccompat.legacy-id-mode.enabled`	`apicurio.ccompat.legacy-id-mode.enabled`
`registry.ccompat.max-subjects`	`apicurio.ccompat.max-subjects`
`registry.ccompat.use-canonical-hash`	`apicurio.ccompat.use-canonical-hash`

3.2.5. 下载
复制链接

Expand

表 3.19. 下载配置选项
Name	新选项
`registry.download.href.ttl`	`apicurio.download.href.ttl.seconds`

3.2.6. events
复制链接

Expand

表 3.20. 事件配置选项
Name	新选项
`registry.events.ksink`	`删除`

3.2.7. 健康
复制链接

Expand

表 3.21. 健康配置选项
Name	新选项
`registry.liveness.errors.ignored`	`apicurio.liveness.errors.ignored`
`registry.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec`	`apicurio.metrics.response-timeout-readiness-check.counter-reset-window-duration.seconds`
`registry.metrics.PersistenceExceptionLivenessCheck.disableLogging`	`apicurio.metrics.persistence-exception-liveness-check.logging.disabled`
`registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold`	`apicurio.metrics.persistence-exception-liveness-check.error-threshold`
`registry.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec`	`apicurio.metrics.persistence-exception-liveness-check.status-reset-window-duration.seconds`
`registry.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec`	`apicurio.metrics.response-error-liveness-check.counter-reset-window-duration.seconds`
`registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold`	`apicurio.metrics.persistence-timeout-readiness-check.error-threshold`
`registry.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec`	`apicurio.metrics.persitence-timeout-readiness-check.status-reset-window-duration.seconds`
`registry.metrics.PersistenceTimeoutReadinessCheck.timeoutSec`	`apicurio.metrics.persistence-timeout-readiness-check.timeout.seconds`
`registry.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec`	`apicurio.metrics.resonse-error-liveness-check.counter-reset-window-duration.seconds`
`registry.metrics.ResponseErrorLivenessCheck.disableLogging`	`apicurio.metrics.response-error-liveness-check.disabled`
`registry.metrics.ResponseErrorLivenessCheck.errorThreshold`	`apicurio.metrics.response-error-liveness-check.error-threshold`
`registry.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec`	`apicurio.metrics.response-error-liveness-check.status-reset-window-duration.seconds`
`registry.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec`	`apicurio.metrics.response-timeout-readiness-check.counter-reset-window-duration.seconds`
`registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold`	`apicurio.metrics.response-timeout-readiness-check.error-threshold`
`registry.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec`	`apicurio.metrics.response-timeout-rediness-check.status-reset-window-duration.seconds`
`registry.metrics.ResponseTimeoutReadinessCheck.timeoutSec`	`apicurio.metrics.response-timeout-readiness-check.timeout.seconds`
`registry.storage.metrics.cache.check-period`	`apicurio.storage.metrics.cache.check-period.ms`

3.2.8. import
复制链接

Expand

表 3.22. 导入配置选项
Name	新选项
`registry.import.url`	`apicurio.import.url`

3.2.9. kafka
复制链接

Expand

表 3.23. Kafka 配置选项
Name	新选项
`registry.events.kafka.topic`	`apicurio.events.kafka.topic`
`registry.events.kafka.topic-partition`	`删除`

3.2.10. limits
复制链接

Expand

表 3.24. 限制配置选项
Name	新选项
`registry.limits.config.max-artifact-labels`	`apicurio.limits.config.max-artifact-labels`
`registry.limits.config.max-artifact-properties`	`apicurio.limits.config.max-artifact-properties`
`registry.limits.config.max-artifacts`	`apicurio.limits.config.max-artifact`
`registry.limits.config.max-description-length`	`apicurio.limits.config.max-description-length`
`registry.limits.config.max-label-size`	`apicurio.limits.config.max-label-size`
`registry.limits.config.max-name-length`	`apicurio.limits.config.max-name-length`
`registry.limits.config.max-property-key-size`	`apicurio.limits.config.max-property-key-size`
`registry.limits.config.max-property-value-size`	`apicurio.limits.config.max-property-value-size`
`registry.limits.config.max-requests-per-second`	`apicurio.limits.config.max-requests-per-second`
`registry.limits.config.max-schema-size-bytes`	`apicurio.limits.config.max-schema-size-bytes`
`registry.limits.config.max-total-schemas`	`apicurio.limits.config.max-total-schemas`
`registry.limits.config.max-versions-per-artifact`	`apicurio.limits.config.max-versions-per-artifact`
`registry.storage.metrics.cache.max-size`	`apicurio.storage.metrics.cache.max-size`

3.2.11. Redirect
复制链接

Expand

表 3.25. 重定向配置选项
Name	新选项
`registry.enable-redirects`	`apicurio.redirects.enabled`
`registry.redirects`	`apicurio.redirects`
`registry.url.override.host`	`apicurio.url.override.host`
`registry.url.override.port`	`apicurio.url.override.port`

3.2.12. rest
复制链接

Expand

表 3.26. REST 配置选项
Name	新选项
`registry.rest.artifact.deletion.enabled`	`apicurio.rest.artifact.deletion.enabled`
`registry.rest.artifact.download.maxSize`	`apicurio.rest.artifact.download.max-size.bytes`
`registry.rest.artifact.download.skipSSLValidation`	`apicurio.rest.artifact.download.ssl-validation.disabled`

3.2.13. store
复制链接

Expand

表 3.27. 存储配置选项
Name	新选项
`artifacts.skip.disabled.latest`	`artifacts.skip.disabled.latest`
`registry.sql.init`	`apicurio.sql.init`

3.2.14. ui
复制链接

Expand

表 3.28. UI 配置选项
Name	新选项
`registry.ui.config.auth.oidc.client-id`	`apicurio.ui.auth.oidc.client-id`
`registry.ui.config.auth.oidc.redirect-url`	`apicurio.ui.auth.oidc.redirect-uri`
`registry.ui.config.auth.oidc.url`	`quarkus.oidc.auth-server-url`
`registry.ui.config.uiContextPath`	`apicurio.ui.contextPath`
`registry.ui.features.readOnly`	`apicurio.ui.features.read-only.enabled`
`registry.ui.features.settings`	`apicurio.ui.features.settings`

附录 A. 使用您的订阅
复制链接

Service Registry 通过软件订阅提供。要管理您的订阅，请访问红帽客户门户中的帐户。

访问您的帐户

转至 access.redhat.com。
如果您还没有帐户，请创建一个帐户。
登录到您的帐户。

激活订阅

转至 access.redhat.com。
导航到 My Subscriptions。
导航到 激活订阅 并输入您的 16 位激活号。

下载 ZIP 和 TAR 文件

要访问 ZIP 或 TAR 文件，请使用客户门户网站查找要下载的相关文件。如果您使用 RPM 软件包，则不需要这一步。

打开浏览器并登录红帽客户门户网站 产品下载页面，网址为 access.redhat.com/downloads。
在 Integration 和 Automation 类别中找到 Red Hat Integration 条目。
选择所需的 Service Registry 产品。此时会打开 Software Downloads 页面。
单击组件的 Download 链接。

更新于 2025-05-15

法律通告
复制链接

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

在 OpenShift 上安装和部署 Apicurio Registry

安装、部署和配置 Apicurio Registry 3.0

前言复制链接链接已复制到粘贴板!

对红帽文档提供反馈

第 1 章 Service Registry Operator quickstart复制链接链接已复制到粘贴板!

1.1. Quickstart Service Registry Operator 安装复制链接链接已复制到粘贴板!

1.2. Quickstart Service Registry 实例部署复制链接链接已复制到粘贴板!

第 2 章 在 OpenShift 上安装 Service Registry复制链接链接已复制到粘贴板!

2.1. 从 OpenShift OperatorHub 安装 Service Registry复制链接链接已复制到粘贴板!

第 3 章 Service Registry 配置参考复制链接链接已复制到粘贴板!

3.1. Service Registry 配置选项复制链接链接已复制到粘贴板!

3.1.1. api复制链接链接已复制到粘贴板!

3.1.2. auth复制链接链接已复制到粘贴板!

3.1.3. 缓存复制链接链接已复制到粘贴板!

3.1.4. ccompat复制链接链接已复制到粘贴板!

3.1.5. 下载复制链接链接已复制到粘贴板!

3.1.6. GITOPS复制链接链接已复制到粘贴板!

3.1.7. 健康复制链接链接已复制到粘贴板!

3.1.8. import复制链接链接已复制到粘贴板!

3.1.9. limits复制链接链接已复制到粘贴板!

3.1.10. Redirect复制链接链接已复制到粘贴板!

3.1.11. rest复制链接链接已复制到粘贴板!

3.1.12. semver复制链接链接已复制到粘贴板!

3.1.13. storage复制链接链接已复制到粘贴板!

3.1.14. ui复制链接链接已复制到粘贴板!

3.2. Service Registry 版本 2 到版本 3 配置更改复制链接链接已复制到粘贴板!

3.2.1. api复制链接链接已复制到粘贴板!

3.2.2. auth复制链接链接已复制到粘贴板!

3.2.3. 缓存复制链接链接已复制到粘贴板!

3.2.4. ccompat复制链接链接已复制到粘贴板!

3.2.5. 下载复制链接链接已复制到粘贴板!

3.2.6. events复制链接链接已复制到粘贴板!

3.2.7. 健康复制链接链接已复制到粘贴板!

3.2.8. import复制链接链接已复制到粘贴板!

3.2.9. kafka复制链接链接已复制到粘贴板!

3.2.10. limits复制链接链接已复制到粘贴板!

3.2.11. Redirect复制链接链接已复制到粘贴板!

3.2.12. rest复制链接链接已复制到粘贴板!

3.2.13. store复制链接链接已复制到粘贴板!

3.2.14. ui复制链接链接已复制到粘贴板!

附录 A. 使用您的订阅复制链接链接已复制到粘贴板!

访问您的帐户

激活订阅

下载 ZIP 和 TAR 文件

法律通告复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

前言
复制链接

第 1 章 Service Registry Operator quickstart
复制链接

1.1. Quickstart Service Registry Operator 安装
复制链接

1.2. Quickstart Service Registry 实例部署
复制链接

第 2 章在 OpenShift 上安装 Service Registry
复制链接

2.1. 从 OpenShift OperatorHub 安装 Service Registry
复制链接

第 3 章 Service Registry 配置参考
复制链接

3.1. Service Registry 配置选项
复制链接

3.1.1. api
复制链接

3.1.2. auth
复制链接

3.1.3. 缓存
复制链接

3.1.4. ccompat
复制链接

3.1.5. 下载
复制链接

3.1.6. GITOPS
复制链接

3.1.7. 健康
复制链接

3.1.8. import
复制链接

3.1.9. limits
复制链接

3.1.10. Redirect
复制链接

3.1.11. rest
复制链接

3.1.12. semver
复制链接

3.1.13. storage
复制链接

3.1.14. ui
复制链接

3.2. Service Registry 版本 2 到版本 3 配置更改
复制链接

3.2.1. api
复制链接

3.2.2. auth
复制链接

3.2.3. 缓存
复制链接

3.2.4. ccompat
复制链接

3.2.5. 下载
复制链接

3.2.6. events
复制链接

3.2.7. 健康
复制链接

3.2.8. import
复制链接

3.2.9. kafka
复制链接

3.2.10. limits
复制链接

3.2.11. Redirect
复制链接

3.2.12. rest
复制链接

3.2.13. store
复制链接

3.2.14. ui
复制链接

附录 A. 使用您的订阅
复制链接

法律通告
复制链接