Migrating gateway extensions

Use the appropriate procedure for migrating extensions to either a v10 DataPower® Gateway (v5 compatible) or a v10 DataPower API Gateway.

Migrating gateway extensions to a v10 DataPower Gateway (v5 compatible)

About this task

Follow these steps to migrate gateway extensions to a v10 DataPower Gateway (v5 compatible).

Procedure

Follow all migration utility steps to migrate to a v5-compatible DataPower Gateway. For instructions, see Migration steps.
The gateway extensions are automatically extracted as part of the archive:unpack step. No further manual steps are required.

Results

The v5 extension zip file is pushed to the DataPower Gateway (v5 compatible) service.
Note: Only one gateway extension per gateway service can be used.

Migrating gateway extensions to a v10 DataPower API Gateway

Before you begin

Note: When migrating v5 extensions to v10 API Gateway, the v5-emulation layer is used to ease compatibility for any pre-request or post-response global assemblies it contains. For more information, see v5 policy emulation limitations.
The following limitations apply to migrating gateway extensions to a v10 DataPower API Gateway.
  • Post-request assemblies are not compatible with the API Gateway and cannot be migrated using this process. Pre-request, post-response, and post-error can be migrated using these steps.
  • Any modifications to the DataPower v5 Multiprotocol Gateway cannot be migrated using these steps because the API Gateway does not use a Multiprotocol Gateway. The modifications will still be in the gateway-extension.zip that is pushed to API Manager, and the artifacts might still be imported to DataPower. These artifacts can be deleted from the DataPower appliance.
  • Any load-balancer modifications cannot be migrated using these steps as the load-balancer DataPower object is not used in the same manner in the API Gateway. These artifacts can be deleted from the DataPower appliance.

About this task

You can migrate pre-request and post-response global assemblies contained within v5 extensions to API Gateway using the v5-emulation layer. The migration utility bundles the entire v5 extension file and groups them by gateway service during the port step. During the push step, the v5 extensions are pushed to the Gateway Service, and pre-hook and post-hook global assemblies are enabled using global policy files that were generated previously during the port-to-apigw step. DataPower object modifications or additions that are not v5 framework changes or load-balancer changes are also automatically imported during this step.

Global assemblies that are pre-request or post-response are utilized through the v5-emulation layer as an Assembly Function. They are referenced by the global policy files auto-generated by the migration utility during the port-to-apigw step.

Results

The gateway-extension.zip file is pushed to the DataPower API Gateway service.
Note: Only one gateway extension per gateway service can be used at a time. However, the manifest extension allows a vector of multiple extensions contained within the single gateway-extension.zip that is pushed to the single gateway service.