このコンテンツは選択した言語では利用できません。
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.
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/exportand/apis/registry/v3/admin/importendpoints. -
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.
Export all data from Apicurio Registry 2.6 using the export script:
./apicurio-export-registry-data.sh
./apicurio-export-registry-data.shCopy to Clipboard Copied! Toggle word wrap Toggle overflow 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.
Import the export archive into Apicurio Registry 3.x using the import script:
./apicurio-import-registry-data.sh
./apicurio-import-registry-data.shCopy to Clipboard Copied! Toggle word wrap Toggle overflow 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.
Validate the imported data using the verification script:
./apicurio-verify-registry-version.sh
./apicurio-verify-registry-version.shCopy to Clipboard Copied! Toggle word wrap Toggle overflow 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.