第 3 章 Service Registry 配置参考


本章介绍了可用于 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类型default可从以下位置获取描述

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 路径的导航前缀

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat