WSO2 to Tyk API Migration Bash Script

Overview

This Bash script streamlines the migration of APIs from WSO2 API Manager to Tyk API Gateway, automating the transfer of API configurations between the two platforms.

Prerequisites

The script uses the following tools. Make sure they are available before running the script.

• WSO2 API Manager: Version 4.4.0 or higher
• Tyk API Gateway: Version 5.0.0 or higher
• Dependencies:
  • apictl
  • curl
  • jq

Disclaimer

This script is provided as-is, without warranty of any kind. It is intended as an example to assist in migrating API definitions from WSO2 to Tyk.

• Before running the script, ensure you have proper backups of your data.
• Test the script in a non-production environment first.
• Adjustments may be required to meet specific use cases or configurations.

Tyk assumes no liability for any issues arising from the use of this script. Use it at your own risk.

Usage

To use the script, provide the connection details for both the WSO2 environment (source) and the Tyk environment (destination). These details are passed as parameters to the script:

./migrate-api-wso2-tyk.sh <wso2-host> <wso2-username> <wso2-password> <tyk-host> <tyk-token>

Script Parameters

1. wso2-host: WSO2 API Manager hostname
2. wso2-username: WSO2 login username
3. wso2-password: WSO2 login password
4. tyk-host: Tyk Dashboard URL
5. tyk-token: Tyk Dashboard API authorization token

Example

Here’s an example command to use the script. It sets the WSO2 host to https://source-wso2-publisher:9443 and uses admin/admin as the credentials. It also sets the Tyk Dashboard URL to http://target-tyk-dashboard:3000 with an API token of e6110fdeabe94da657f816e2243985a7:

./migrate-api-wso2-tyk.sh \
  --wso2-host https://source-wso2-publisher:9443 \
  --wso2-username admin \
  --wso2-password admin \
  --tyk-host http://target-tyk-dashboard:3000 \
  --tyk-token e6110fdeabe94da657f816e2243985a7

Notes

• WSO2 apictl Environment: The script creates a WSO2 apictl environment named wso2-to-tyk-migration. If the environment already exists, it will reuse it.
• Export Directory Cleanup: Before execution, the script clears the WSO2 apictl export directory located at: ~/.wso2apictl/exported/migration/wso2-to-tyk-migration/tenant-default/apis.
• SSL Verification Bypass: For proof of concept environments with self-signed certificates, the script uses the -k flag with both apictl and curl to bypass SSL verification.
• Duplicate API Handling: The script skips duplicate APIs to avoid importing them multiple times.

Limitations

The script currently migrates the following API attributes:

• Name
• Listen path
• Upstream target (limited to the first production URL)
• Endpoint paths

Other API information, such as policies, security configurations, and documentation, must be migrated manually.

Troubleshooting

If you encounter issues, consider the following:

• Connectivity: Ensure both WSO2 wso2-host and Tyk tyk-host instances are reachable from the machine running the script.
• Authentication: Verify that the wso2-username, wso2-password, and tyk-token credentials are correct.
• Self-Signed Certificates: For APIs migrated with self-signed certificates, verify that Tyk is configured to either trust the certificate or skip SSL verification.
• Invalid Migration Data: For APIs migrated with a localhost target, the migrated data may need to be amended so that the Tyk gateway targets the correct host.