OpenShift への Apicurio Registry のインストールとデプロイ


Red Hat build of Apicurio Registry 3.1

Apicurio Registry 3.1 のインストール、デプロイ、および設定

Red Hat build of Apicurio Registry Documentation Team

概要

このガイドでは、Streams for Apache Kafka または PostgreSQL データベースのデータストレージオプションを使用して、OpenShift に Apicurio Registry をインストールしてデプロイする方法を説明します。このガイドでは、Apicurio Registry デプロイメントを保護、設定、および管理する方法も説明し、Apicurio Registry と Apicurio Registry Operator の設定リファレンスを提供します。

はじめに

Red Hat ドキュメントへのフィードバック

Red Hat ドキュメントに関するご意見やご感想をお寄せください。

改善を提案するには、Jira 課題を作成し、変更案を説明してください。ご要望に迅速に対応できるよう、できるだけ詳細にご記入ください。

前提条件

  • Red Hat カスタマーポータルのアカウントがある。このアカウントを使用すると、Red Hat Jira Software インスタンスにログインできます。
    アカウントをお持ちでない場合は、アカウントを作成するように求められます。

手順

  1. Create issue にアクセスします。
  2. Summary テキストボックスに、問題の簡単な説明を入力します。
  3. Description テキストボックスに、次の情報を入力します。

    • 問題が見つかったページの URL。
    • 問題の詳細情報。
      他のフィールドの情報はデフォルト値のままにすることができます。
  4. Create をクリックして、Jira 課題をドキュメントチームに送信します。

フィードバックをご提供いただきありがとうございました。

第1章 Service Registry Operator クイックスタート

カスタムリソース定義 (CRD) を使用して、コマンドラインで Service Registry Operator を迅速にインストールできます。

クイックスタートの例では、SQL データベースにストレージを持つ Service Registry インスタンスをデプロイします。

注記

実稼働環境で推奨されるインストールオプションは OpenShift OperatorHub です。推奨されるストレージオプションは、パフォーマンス、安定性、およびデータ管理のための SQL データベースです。

1.1. Quickstart Service Registry Operator のインストール

Service Registry Operator は、ダウンロードしたインストールファイルとサンプル CRD のセットを使用して、Operator Lifecycle Manager を使用せずにコマンドラインで迅速にインストールおよびデプロイできます。

前提条件

  • アクセス権を持つ管理者として OpenShift クラスターにログインしている。
  • OpenShift oc コマンドラインクライアントがインストールされている。詳細は、OpenShift CLI のドキュメント を参照してください。

手順

  1. Red Hat Software Downloads に移動し、製品バージョンを選択して、Service Registry CRD .zip ファイルの例をダウンロードします。
  2. ダウンロードした CRD .zip ファイルを展開して、apicurio-registry-install-examples ディレクトリーに移動します。
  3. Service Registry Operator インストールの OpenShift プロジェクトを作成します。以下に例を示します。

    export NAMESPACE="apicurio-registry"
    oc new-project "$NAMESPACE"
    Copy to Clipboard Toggle word wrap
  4. 以下のコマンドを実行して、install/install.yaml ファイルにサンプル CRD を適用します。

    cat install/install.yaml | sed "s/PLACEHOLDER_NAMESPACE/$NAMESPACE/g" | oc apply -f -
    Copy to Clipboard Toggle word wrap
  5. oc get deployment と入力し、Service Registry Operator の readiness (準備状態) を確認します。たとえば、出力は以下のようになります。

    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 インスタンスのデプロイメントを作成するには、SQL データベースストレージオプションを使用して、既存の PostgreSQL データベースに接続します。

前提条件

  • Service Registry Operator がインストールされていることを確認している。
  • OpenShift クラスターからアクセス可能な PostgreSQL データベースがある。

手順

  1. エディターで examples/apicurioregistry_sql_cr.yaml ファイルを開き、ApicurioRegistry カスタムリソース (CR) を表示します。

    SQL ストレージの CR の例

    apiVersion: registry.apicur.io/v1
    kind: ApicurioRegistry
    metadata:
      name: example-apicurioregistry-sql
    spec:
      configuration:
        persistence: "sql"
        sql:
          dataSource:
            url: "jdbc:postgresql://<service name>.<namespace>.svc:5432/<database name>"
            userName: "postgres"
            password: "<password>" # Optional
    Copy to Clipboard Toggle word wrap

  2. dataSource セクションで、設定例をデータベース接続の詳細に置き換えます。以下に例を示します。

    dataSource:
        url: "jdbc:postgresql://postgresql.apicurio-registry.svc:5432/registry"
        userName: "pgadmin"
        password: "pgpass"
    Copy to Clipboard Toggle word wrap
  3. 以下のコマンドを入力し、Service Registry Operator を使用して namespace に更新された ApicurioRegistry CR を適用し、Service Registry インスタンスがデプロイするまで待機します。

    oc project "$NAMESPACE"
    oc apply -f ./examples/apicurioregistry_sql_cr.yaml
    Copy to Clipboard Toggle word wrap
  4. oc get deployment と入力し、Service Registry インスタンスの readiness (準備状態) を確認します。たとえば、出力は以下のようになります。

    NAME                     	        READY UP-TO-DATE AVAILABLE AGE
    example-apicurioregistry-sql-deployment 1/1   1          1         XmYs
    Copy to Clipboard Toggle word wrap
  5. oc get routes と入力して HOST/PORT URL を取得し、ブラウザーで Service Registry Web コンソールを起動します。以下に例を示します。

    example-apicurioregistry-sql.apicurio-registry.router-default.apps.mycluster.myorg.mycompany.com
    Copy to Clipboard Toggle word wrap

第2章 OpenShift に Apicurio Registry をインストールする

この章では、OpenShift Container Platform に Apicurio Registry をインストールする方法を説明します。

2.1. OpenShift OperatorHub からの Apicurio Registry のインストール

OperatorHub から OpenShift クラスターに Apicurio Registry Operator をインストールできます。OperatorHub は OpenShift Container Platform Web コンソールから使用でき、クラスター管理者が Operator を検出およびインストールするためのインターフェイスを提供します。詳細は、OperatorHub について を参照してください。

注記

環境に応じて、複数の Apicurio Registry レプリカをインストールできます。レプリカ数は、Apicurio Registry に保存されているアーティファクトの数および種類と、選択したストレージオプションによって異なります。

前提条件

  • クラスター管理者として OpenShift クラスターにアクセスできる。

手順

  1. OpenShift Container Platform Web コンソールで、クラスター管理者権限を持つアカウントを使用してログインします。
  2. 新しい OpenShift プロジェクトを作成します。

    1. 左側のナビゲーションメニューで、HomeProjectCreate Project と順にクリックします。
    2. プロジェクト名 (my-project など) を入力し、Create をクリックします。
  3. 左側のナビゲーションメニューで、Operators をクリックした後、OperatorHub をクリックします。
  4. Filter by keyword テキストボックスに registry と入力して、Apicurio Registry Operator を検索します。
  5. Operator に関する情報を読み、Install をクリックして Operator サブスクリプションページを表示します。
  6. サブスクリプション設定を選択します。以下に例を示します。

    • Update Channel: 以下のいずれかを選択します。

      • 2.x: 2.3.0 や 2.0.3 などのすべてのマイナーおよびパッチの更新が含まれます。たとえば、2.0.x へのインストールは 2.3.x にアップグレードされます。
      • 2.0.x: 2.0.1 や 2.0.2 などのパッチの更新のみが含まれます。たとえば、2.0.x へのインストールは 2.3.x を無視します。
    • Installation Mode: 以下のいずれかを選択します。

      • All namespaces on the cluster (default)
      • A specific namespace on the cluster および my-project
    • Approval Strategy: Automatic または Manual を選択します。
  7. Install をクリックし、Operator が使用できるようになるまでしばらく待ちます。

第3章 Apicurio Registry 設定リファレンス

この章では、Apicurio Registry で利用可能な設定オプションに関する参考情報を提供します。

関連情報

3.1. Apicurio Registry 設定オプション

次の Apicurio Registry 設定オプションは、コンポーネントカテゴリーごとに利用できます。

3.1.1. api

Expand
表3.1 API 設定オプション
名前デフォルト利用可能:説明

apicurio.api.errors.include-stack-in-response

boolean

false

2.1.4.Final

エラー応答にスタックトレースを含める

apicurio.apis.v3.base-href

string

_

2.5.0.Final

API ベースの href (URI)

apicurio.disable.apis

optional<list<string>>

 

2.0.0.Final

API の無効化

3.1.2. auth

Expand
表3.2 認証設定オプション
名前デフォルト利用可能:説明

apicurio.auth.admin-override.claim

string

org-admin

2.1.0.Final

認証管理者オーバーライドクレーム

apicurio.auth.admin-override.claim-value

string

true

2.1.0.Final

認証管理者オーバーライドクレーム値

apicurio.auth.admin-override.enabled

boolean

false

2.1.0.Final

有効化されている認証管理者オーバーライド

apicurio.auth.admin-override.from

string

token

2.1.0.Final

認証管理者オーバーライド:

apicurio.auth.admin-override.role

string

sr-admin

2.1.0.Final

認証管理者オーバーライドロール

apicurio.auth.admin-override.type

string

role

2.1.0.Final

認証管理者オーバーライドタイプ

apicurio.auth.admin-override.user

string

admin

3.0.0

認証管理者オーバーライドユーザー名

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

boolean

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

認証ロール管理者

apicurio.auth.roles.developer

string

sr-developer

2.1.0.Final

認証ロール開発者

apicurio.auth.roles.readonly

string

sr-readonly

2.1.0.Final

認証ロール読み取り専用

apicurio.authn.audit.log.prefix

string

audit

2.2.6

アプリケーション監査ロギングに使用される接頭辞。

apicurio.authn.basic-client-credentials.cache-expiration

integer

10

2.2.6.Final

デフォルトのクライアント認証情報トークンの有効期限 (分)。

apicurio.authn.basic-client-credentials.cache-expiration-offset

integer

10

2.5.9.Final

JWT 有効期限からのクライアント認証情報トークンの有効期限オフセット (秒)。

apicurio.authn.basic-client-credentials.enabled

boolean [dynamic]

false

2.1.0.Final

Basic 認証クライアント認証情報の有効化。

apicurio.authn.basic.scope

optional<string>

 

2.5.0.Final

クライアント認証情報のスコープ。

quarkus.http.auth.basic

boolean

false

3.0.0

Basic 認証を有効にします。

quarkus.oidc.client-id

string

 

2.0.0.Final

サーバーが認証に使用するクライアント ID。

quarkus.oidc.client-secret

optional<string>

 

2.1.0.Final

サーバーが認証に使用するクライアントシークレット。

quarkus.oidc.tenant-enabled

boolean

false

2.0.0.Final

認証を有効にします。

quarkus.oidc.token-path

string

 

2.1.0.Final

認証サーバートークンエンドポイント。

3.1.3. cache

Expand
表3.3 キャッシュ設定オプション
名前デフォルト利用可能:説明

apicurio.config.cache.enabled

boolean

true

2.2.2.Final

有効化されているレジストリーキャッシュ

3.1.4. ccompat

Expand
表3.4 ccompat 設定オプション
名前デフォルト利用可能:説明

apicurio.ccompat.group-concat.enabled

boolean

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. download

Expand
表3.5 設定オプションのダウンロード
名前デフォルト利用可能:説明

apicurio.download.href.ttl.seconds

long [dynamic]

30

2.1.2.Final

ダウンロードリンクの有効期限

3.1.6. gitops

Expand
表3.6 gitops 設定オプション
名前デフォルト利用可能:説明

apicurio.gitops.id

string

 

3.0.0

このレジストリーインスタンスの識別子。この識別子を参照するデータのみが読み込まれます。

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. health

Expand
表3.7 ヘルス設定オプション
名前デフォルト利用可能:説明

apicurio.liveness.errors.ignored

optional<list<string>>

 

1.2.3.Final

無視された liveness エラー

apicurio.metrics.persistence-exception-liveness-check.counter-reset-window-duration.seconds

integer

60

1.0.2.Final

永続性 liveness チェックのカウンターリセットウィンドウの期間

apicurio.metrics.persistence-exception-liveness-check.error-threshold

integer

1

1.0.2.Final

永続性の liveness チェックのエラーしきい値

apicurio.metrics.persistence-exception-liveness-check.logging.disabled

boolean

false

2.0.0.Final

永続性の liveness チェックのロギングの無効化

apicurio.metrics.persistence-exception-liveness-check.status-reset-window-duration.seconds

integer

300

1.0.2.Final

永続 liveness チェックのステータスリセットウィンドウの期間

apicurio.metrics.persistence-timeout-readiness-check.error-threshold

integer

5

1.0.2.Final

永続性 readiness チェックのエラーしきい値

apicurio.metrics.persistence-timeout-readiness-check.timeout.seconds

integer

15

1.0.2.Final

永続性 readiness チェックのタイムアウト

apicurio.metrics.persitence-timeout-readiness-check.status-reset-window-duration.seconds

integer

300

1.0.2.Final

永続性 readiness チェックのステータスリセットウィンドウの期間

apicurio.metrics.resonse-error-liveness-check.counter-reset-window-duration.seconds

integer

60

1.0.2.Final

応答 liveness チェックのカウンターリセットウィンドウの期間

apicurio.metrics.response-error-liveness-check.counter-reset-window-duration.seconds

integer

60

1.0.2.Final

永続性の readiness チェックのカウンターリセットウィンドウの期間

apicurio.metrics.response-error-liveness-check.disabled

boolean

false

2.0.0.Final

応答 liveness チェックのロギングの無効化

apicurio.metrics.response-error-liveness-check.error-threshold

integer

1

1.0.2.Final

応答 liveness チェックのエラーしきい値

apicurio.metrics.response-error-liveness-check.status-reset-window-duration.seconds

integer

300

1.0.2.Final

応答 liveness チェックのステータスリセットウィンドウの期間

apicurio.metrics.response-timeout-readiness-check.counter-reset-window-duration.seconds

instance<integer>

60

1.0.2.Final

応答 readiness チェックのカウンターリセットウィンドウの期間

apicurio.metrics.response-timeout-readiness-check.error-threshold

instance<integer>

1

1.0.2.Final

応答 readiness チェックのエラーしきい値

apicurio.metrics.response-timeout-readiness-check.timeout.seconds

instance<integer>

10

1.0.2.Final

応答 readiness チェックのタイムアウト

apicurio.metrics.response-timeout-rediness-check.status-reset-window-duration.seconds

instance<integer>

300

1.0.2.Final

応答 readiness チェックのステータスリセットウィンドウの期間

apicurio.storage.metrics.cache.check-period.ms

long

30000

2.1.0.Final

ストレージメトリクスキャッシュチェック期間

3.1.8. import

Expand
表3.8 設定オプションのインポート
名前デフォルト利用可能:説明

apicurio.import.preserveContentId

boolean

true

3.0.0

true に設定すると、インポートファイルのコンテンツ ID が使用されます (それ以外の場合は新しい ID が生成されます)。デフォルトは 'true' です。

apicurio.import.preserveGlobalId

boolean

true

3.0.0

true に設定すると、インポートファイルのグローバル ID が使用されます (それ以外の場合は新しい ID が生成されます)。デフォルトは 'true' です。

apicurio.import.requireEmptyRegistry

boolean

true

3.0.0

true に設定すると、レジストリーが空の場合にのみデータのインポートが機能します。デフォルトは 'true' です。

apicurio.import.url

optional<url>

 

2.1.0.Final

インポート URL

apicurio.import.work-dir

string

 

3.0.0

データをインポートするときに使用する一時作業ディレクトリー。

3.1.9. limits

Expand
表3.9 制限設定オプション
名前デフォルト利用可能:説明

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

最大アーティファクトプロパティー値のサイズ

apicurio.limits.config.max-requests-per-second

long

-1

2.2.3.Final

1 秒あたりの最大アーティファクトリクエスト

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. リダイレクト

Expand
表3.10 リダイレクト設定オプション
名前デフォルト利用可能:説明

apicurio.redirects

map<string, string>

 

2.1.2.Final

レジストリーのリダイレクト

apicurio.redirects.enabled

boolean

 

2.1.2.Final

リダイレクトの有効化

apicurio.url.override.host

optional<string>

 

2.5.0.Final

外部からアクセス可能な URL の生成に使用されるホスト名をオーバーライドします。ホストとポートのオーバーライドは、HTTPS パススルー Ingress または Route を使用してレジストリーをデプロイするときに役立ちます。このような場合、リクエストはプロキシーされるため、リダイレクトに再利用されるリクエスト URL (およびポート) は、クライアントが使用する実際の外部 URL には属しません。ターゲット URL に到達できないため、リダイレクトは失敗します。

apicurio.url.override.port

optional<integer>

 

2.5.0.Final

外部からアクセス可能な URL の生成に使用されるポートを上書きします。

3.1.11. rest

Expand
表3.11 rest 設定オプション
名前デフォルト利用可能:説明

apicurio.rest.artifact.download.max-size.bytes

int

1000000

2.2.6

URL からダウンロードできるアーティファクトの最大サイズ

apicurio.rest.artifact.download.ssl-validation.disabled

boolean

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

アーティファクトのバージョン変更を有効にする

apicurio.rest.search-results.labels.max-size.bytes

int

512

3.0.3

検索結果内の項目ごとのラベルの最大サイズ (バイト単位)

3.1.12. semver

Expand
表3.12 semver 設定オプション
名前デフォルト利用可能:説明

apicurio.semver.branching.coerce

boolean [dynamic]

false

3.0.0

true の場合、無効なバージョンは、可能であればセマンティックバージョニング 2 形式 (https://semver.org) に強制変換されます。

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

すべてのアーティファクトバージョンがセマンティックバージョニング 2 形式 (https://semver.org) に準拠していることを検証します。

3.1.13. storage

Expand
表3.13 ストレージ設定オプション
名前デフォルト利用可能:説明

apicurio.datasource.blue.db-kind

string

h2

3.0.0

Gitops blue データソース DB の種類

apicurio.datasource.blue.jdbc.initial-size

string

20

3.0.0

Gitops blue データソースプールの初期サイズ

apicurio.datasource.blue.jdbc.max-size

string

100

3.0.0

Gitops blue データソースプールの最大サイズ

apicurio.datasource.blue.jdbc.min-size

string

20

3.0.0

Gitops blue データソースプールの最小サイズ

apicurio.datasource.blue.jdbc.url

string

jdbc:h2:mem:registry_db

3.0.0

Gitops blue データソース JDBC URL

apicurio.datasource.blue.password

string

sa

3.0.0

Gitops blue データソースのパスワード

apicurio.datasource.blue.username

string

sa

3.0.0

Gitops blue データソースのユーザー名

apicurio.datasource.green.db-kind

string

h2

3.0.0

Gitops green データベースの db の種類

apicurio.datasource.green.jdbc.initial-size

string

20

3.0.0

Gitops green データソースプールの初期サイズ

apicurio.datasource.green.jdbc.max-size

string

100

3.0.0

Gitops green データソースプールの最大サイズ

apicurio.datasource.green.jdbc.min-size

string

20

3.0.0

Gitops green データソースプールの最小サイズ

apicurio.datasource.green.jdbc.url

string

jdbc:h2:mem:registry_db

3.0.0

Gitops green データソース JDBC URL

apicurio.datasource.green.password

string

sa

3.0.0

Gitops green データソースパスワード

apicurio.datasource.green.username

string

sa

3.0.0

Gitops green データソースユーザー名

apicurio.events.kafka.topic

string

registry-events

 

ストレージイベントトピック

apicurio.kafkasql.bootstrap.servers

string

  

Kafka sql ストレージブートストラップサーバー

apicurio.kafkasql.consumer.group-prefix

string

apicurio-

 

コンシューマーグループ名の Kafka sql ストレージ接頭辞

apicurio.kafkasql.consumer.poll.timeout

integer

5000

 

Kafka sql ストレージコンシューマーのポーリングタイムアウト

apicurio.kafkasql.coordinator.response-timeout

integer

30000

 

Kafka sql ストレージのコーディネーターの応答タイムアウト

apicurio.kafkasql.security.protocol

optional<string>

  

Kafka sql ストレージのセキュリティープロトコル

apicurio.kafkasql.security.sasl.client-id

string

  

Kafka sql ストレージの sasl クライアント識別子

apicurio.kafkasql.security.sasl.client-secret

string

  

Kafka sql ストレージの sasl クライアントシークレット

apicurio.kafkasql.security.sasl.enabled

boolean

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

optional<string>

  

Kafka sql ストレージの ssl トラストストアの場所

apicurio.kafkasql.security.ssl.truststore.type

optional<string>

  

Kafka sql ストレージの ssl トラストストアタイプ

apicurio.kafkasql.snapshot.every.seconds

string

86400s

3.0.0

Kafka sql ジャーナルトピックのスナップショット

apicurio.kafkasql.snapshots.topic

string

kafkasql-snapshots

3.0.0

Kafka sql ストレージトピック名

apicurio.kafkasql.ssl.key.password

optional<string>

  

Kafka sql ストレージ ssl キーパスワード

apicurio.kafkasql.ssl.keystore.location

optional<string>

  

Kafka sql ストレージの ssl キーストアの場所

apicurio.kafkasql.ssl.keystore.password

optional<string>

  

Kafka sql ストレージの ssl キーストアパスワード

apicurio.kafkasql.ssl.keystore.type

optional<string>

  

Kafka sql ストレージの ssl キーストアタイプ

apicurio.kafkasql.ssl.truststore.password

optional<string>

  

Kafka sql ストレージの ssl トラストストアパスワード

apicurio.kafkasql.topic

string

kafkasql-journal

 

Kafka sql ストレージトピック名

apicurio.kafkasql.topic.auto-create

boolean

true

 

Kafka sql ストレージのトピックの自動作成

apicurio.sql.db-schema

string

*

3.0.6

データベーススキーマ名 (複数のスキーマで、同じデータベースに対して 2 つのレジストリーインスタンスを実行する場合にのみ必要)

apicurio.sql.init

boolean

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

レジストリーストレージの読み取り専用モードを有効にします。

apicurio.storage.snapshot.location

string

./

3.0.0

Kafka sql スナップショットストアの場所

apicurio.storage.sql.kind

string

h2

3.0.0

アプリケーションデータソースのデータベースタイプ

artifacts.skip.disabled.latest

boolean

true

2.4.2

最新のアーティファクトバージョンを取得する際の DISABLED 状態のアーティファクトバージョンをスキップする

3.1.14. system

Expand
表3.14 システム設定オプション
名前デフォルト利用可能:説明

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.15. ui

Expand
表3.15 ui 設定オプション
名前デフォルト利用可能:説明

apicurio.ui.auth.oidc.client-id

string

apicurio-registry-ui

3.0.0

OIDC clientId

apicurio.ui.auth.oidc.logout-url

string

f5

3.0.0

OIDC ログアウト URL

apicurio.ui.auth.oidc.redirect-uri

string

/

3.0.0

OIDC redirectUri

apicurio.ui.auth.oidc.scope

string

openid profile email

3.0.8

UI 認証 OIDC スコープ値

apicurio.ui.contextPath

string

/

3.0.0

UI のコンテキストパス

apicurio.ui.docsUrl

string

/docs/

3.0.0

Documentation コンポーネントの 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 に設定タブを表示できるかどうか

apicurio.ui.navPrefixPath

string

/

3.0.0

すべての UI パスのナビゲーション接頭辞

3.1.16. unknown

Expand
表3.16 不明な設定オプション
名前デフォルト利用可能:説明

apicurio.apis.date-format

unknown

yyyy-MM-dd’T’HH:mm:ss’Z'

  

apicurio.apis.date-format-timezone

unknown

UTC

  

apicurio.app.id

unknown

apicurio-registry

  

apicurio.auth.anonymous-read-access.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.auth.owner-only-authorization.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.auth.owner-only-authorization.limit-group-access.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.authn.basic-client-credentials.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.ccompat.legacy-id-mode.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.ccompat.max-subjects.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.ccompat.use-canonical-hash.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.config.dynamic.allow-all

unknown

true

  

apicurio.config.refresh.every

unknown

1m

  

apicurio.datasource.jdbc.initial-size

unknown

20

  

apicurio.datasource.jdbc.max-size

unknown

100

  

apicurio.datasource.jdbc.min-size

unknown

20

  

apicurio.datasource.password

unknown

sa

  

apicurio.datasource.url

unknown

jdbc:h2:mem:db_${quarkus.uuid}

  

apicurio.datasource.username

unknown

sa

  

apicurio.download.href.ttl.seconds.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.downloads.reaper.every

unknown

60s

  

apicurio.gitops.refresh.every

unknown

30s

  

apicurio.kafkasql.consumer.group.id

unknown

${registry.id}-${quarkus.uuid}

  

apicurio.kafkasql.producer.client.id

unknown

${registry.id}-producer

  

apicurio.limits.config.cache.check-period

unknown

30000

  

apicurio.logconfigjob.delayed

unknown

1s

  

apicurio.logconfigjob.every

unknown

5s

  

apicurio.redirects.root

unknown

/,/apis

  

apicurio.rest.artifact.deletion.enabled

unknown

false

  

apicurio.rest.deletion.artifact-version.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.rest.deletion.artifact.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.rest.deletion.group.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.rest.mutability.artifact-version-content.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.semver.branching.coerce.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.semver.branching.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.semver.validation.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.storage.read-only.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

apicurio.ui.features.read-only.enabled.dynamic.allow

unknown

${apicurio.config.dynamic.allow-all}

  

3.2. Apicurio レジストリーバージョン 2 からバージョン 3 への設定の変更

Apicurio Registry v3 では、設定オプションが簡素化され、さらに重複が削除され、一貫性が向上しました。ほとんどのオプションでは、接頭辞の名前を registry から apicurio に変更するだけです。たとえば、registry.kafkasql.bootstrap.serversapicurio.kafkasql.bootstrap.servers に変更します。

注記

各設定プロパティーは、対応する環境変数 (例: APICURIO_KAFKASQL_BOOTSTRAP_SERVERS) を使用して値をオーバーライドできます。

3.2.1. api

Expand
表3.17 API 設定オプション
名前新規オプション

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.18 認証設定オプション
名前新規オプション

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. cache

Expand
表3.19 キャッシュ設定オプション
名前新規オプション

registry.config.cache.enabled

apicurio.config.cache.enabled

3.2.4. ccompat

Expand
表3.20 ccompat 設定オプション
名前新規オプション

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. download

Expand
表3.21 設定オプションのダウンロード
名前新規オプション

registry.download.href.ttl

apicurio.download.href.ttl.seconds

3.2.6. events

Expand
表3.22 イベント設定オプション
名前新規オプション

registry.events.ksink

削除

3.2.7. health

Expand
表3.23 ヘルス設定オプション
名前新規オプション

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.24 設定オプションのインポート
名前新規オプション

registry.import.url

apicurio.import.url

3.2.9. kafka

Expand
表3.25 kafka 設定オプション
名前新規オプション

registry.events.kafka.topic

apicurio.events.kafka.topic

registry.events.kafka.topic-partition

削除

3.2.10. limits

Expand
表3.26 制限設定オプション
名前新規オプション

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. リダイレクト

Expand
表3.27 リダイレクト設定オプション
名前新規オプション

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.28 rest 設定オプション
名前新規オプション

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.29 ストア設定オプション
名前新規オプション

artifacts.skip.disabled.latest

artifacts.skip.disabled.latest

registry.sql.init

apicurio.sql.init

3.2.14. ui

Expand
表3.30 ui 設定オプション
名前新規オプション

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 サブスクリプションの使用

Apicurio Registry は、ソフトウェアサブスクリプションから提供されます。サブスクリプションを管理するには、Red Hat カスタマーポータルでアカウントにアクセスします。

アカウントへのアクセス

  1. access.redhat.com に移動します。
  2. アカウントがない場合は作成します。
  3. アカウントにログインします。

サブスクリプションのアクティベート

  1. access.redhat.com に移動します。
  2. My Subscriptions に移動します。
  3. Activate a subscription に移動し、16 桁のアクティベーション番号を入力します。

ZIP および TAR ファイルのダウンロード

ZIP または TAR ファイルにアクセスするには、カスタマーポータルを使用して、ダウンロードする関連ファイルを検索します。RPM パッケージを使用している場合、この手順は必要ありません。

  1. ブラウザーを開き、access.redhat.com/downloads で Red Hat カスタマーポータルの Product Downloads ページにログインします。
  2. Integration and Automation カテゴリーで Red Hat Integration エントリーを見つけます。
  3. 目的の Apicurio Registry 製品を選択します。Software Downloads ページが開きます。
  4. コンポーネントの Download リンクをクリックします。

改訂日時: 2025-10-24

法律上の通知

Copyright © 2025 Red Hat, Inc.
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.
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat