Configuring your Gateway server extensions

You can add extra IBM® DataPower® enforcement capabilities to a Gateway service by uploading an IBM DataPower exported configuration .zip file.

About this task

Important: If you are using IBM API Connect for IBM Cloud (the SaaS offering), the capability described in this topic is not available.
Depending on your company requirements, you can extend the behavior of the Gateway servers in a Gateway service to provide extra enforcement capabilities. For more information, see Extending the Gateway server behavior.

Procedure

  1. In the Cloud Manager, click Services.
  2. Navigate to the required Gateway service, and click the Service Settings icon The Service Settings icon.
    The DataPower Gateway Service window opens.
  3. In the API Gateway Extension section, click Browse, if no extensions configuration file has yet been uploaded, or Replace this extension, if a file has been previously uploaded.
  4. Select the IBM DataPower exported .zip file that you want to upload.
    Note: The export.xml file created by DataPower in the .zip must have a <file> element that declares extensions.xml as part of the configuration. You must manually add this <file> element if it is not in the export.xml file.
  5. [V5.0.8 or later](From API Connect version 5.0.8.4 onward) Use the Automatically refresh extension on gateway servers check box to specify whether you want the servers in the Gateway service to be automatically refreshed, or whether you want to refresh the servers manually. By refreshing the servers manually, you can determine the timing and order of the updates and can more easily coordinate the activity with an external load balancer, giving you more control over potential downtime of API runtime traffic on gateway servers.

    If you select the check box, server refresh is automatic. If you clear the check box, you must manually delete and re-add each server to refresh it; for details, see Gateway resynchronization. With the manual option selected, within several minutes of an update to the gateway extension, the status of gateway servers in this service will include an Out of Sync indicator until the servers are manually refreshed.

  6. When you are finished, click Save.

Results

The extensions are uploaded and applied to each of the servers in the Gateway service, and the associated enforcement capabilities are applied to all incoming API resource requests.

[V5.0.8 or later](From API Connect version 5.0.8.3 onward) The gateway servers in the updated gateway service are refreshed based on the ascending order of the Address field of each gateway server. The Address (either hostname or IP address) of the gateway server was configured when adding it in Cloud Manager. The status of the server changes from REFRESH to ACTIVE as the extensions on each gateway server are applied.