このコンテンツは選択した言語では利用できません。

Chapter 6. Migrating Apicurio Registry data


Use the export and import APIs to migrate persisted content from Apicurio Registry 2.6 to a new Apicurio Registry 3.x deployment. The APIs preserve artifact identifiers, metadata, and references, ensuring downstream Kafka payloads remain compatible.

Important

You must use the export/import procedure for migration. Apicurio Registry 3.x cannot directly read 2.6 storage because the underlying data structures have changed significantly:

  • SQL storage: The v3 database schema is completely redesigned and incompatible with v2. The data model changes (separate artifact and version metadata, new branch support) require a different table structure.
  • KafkaSQL storage: The v3 Kafka journal topic uses a new event journaling format that is incompatible with v2. The v2 topic cannot be reused.

Export data from v2 and import it into v3 using the export/import APIs. The import process automatically transforms the data to the v3 format.

Apicurio Registry 3.x accepts the export archive generated from a 2.6 instance. Capture the archive from your existing deployment, provision the 3.x environment, and import the archive into the new cluster.

Prerequisites

  • Ensure both the source Apicurio Registry 2.6 server and the destination 3.x server are currently running.
  • Administrative credentials that allow access to the /apis/registry/v2/admin/export and /apis/registry/v3/admin/import endpoints.
  • If using OAuth2 authentication, valid client credentials with admin role (for example, sr-admin).

Procedure

The migration scripts automate the export, import, and validation process. They support OAuth2 authentication and provide detailed error handling.

  1. Export all data from Apicurio Registry 2.6 using the export script:

    ./apicurio-export-registry-data.sh
    Copy to Clipboard Toggle word wrap

    The script:

    • Connects to your 2.6 deployment
    • Exports all artifacts, versions, metadata, and rules
    • Saves the data to a ZIP file (default: registry-export.zip)
    • Validates the export file format and size
    • Reports export duration and file details

      For detailed configuration options and OAuth2 authentication setup, see Migration scripts reference.

  2. Import the export archive into Apicurio Registry 3.x using the import script:

    ./apicurio-import-registry-data.sh
    Copy to Clipboard Toggle word wrap

    The script:

    • Validates the import ZIP file exists and is valid
    • Checks Apicurio Registry 3.x accessibility and version
    • Imports all data from the export file
    • Verifies artifact counts before and after import
    • Reports global rules configuration

      For detailed configuration options, see Migration scripts reference.

  3. Validate the imported data using the verification script:

    ./apicurio-verify-registry-version.sh
    Copy to Clipboard Toggle word wrap

    The script performs comprehensive validation:

    • Health endpoint verification
    • System information and version check
    • Artifact count comparison
    • Global rules validation
    • v2 API backward compatibility check (optional)

      For detailed configuration options, see Migration scripts reference.

Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2026 Red Hat
トップに戻る