Migration overview

The migration process provides tools to extract v5 data, arrange it for v10 formats, and load it onto a v10 system.

Important: The migration utility allows migration from v5 to a v10 v5-compatible gateway or v10 API Gateway. References to conversion of v5-compatible artifacts to v10 API Gateway refer to the v5-compatible artifacts that were initially from a v5 environment and were unpacked by the migration utility.

The migration model is centered around using tooling to bring the contents of Version 5 catalogs onto a Version 10 deployment that is set up to import them. The tooling migrates provider organization configuration information, including APIs, Catalogs, Products, Consumers, subscriptions, user registries and more.

You use a v5 extract command to gather the v5 data, and then use a migration unpack command to convert the data into Version 10 format. This extraction will generate a cloud directory where your v5 data will be represented as YAML files. By viewing the contents of the cloud folder, you can see which structures, such as provider organizations, are needed to support your catalog.

The model recognizes that not all v5 data is applicable to a new Version 10 deployment. To optimize your v10 deployment, you may use a text editor to remove unneeded or obsolete v5 configurations from the converted file. When you install and configure your v10 management server, you manually create those structures. You can then use migration tooling to load the v5 data into the prepared v10 system.

During the migration process you can keep your existing v5 system active while you install and configure a parallel (side-by-side) v10 system. You must have system administrator privileges to complete a migration. You should be familiar with IBM API Connect Version 5 architecture and requirements, and with the deployment configuration that you want to migrate.

The migration process supports migrating v5 data to both v10 DataPower Gateway (v5-compatible) and v10 DataPower® API Gateway.

The following sections in this topic review each step in the migration process. See also Migration considerations.