Upgrading Tyk On Hybrid SaaS

Last updated: Jun 18, 2024 2 minutes read.

A Hybrid SaaS deployment is a shared responsibility model where Tyk is responsible for hosting the Control Plane while the client is responsible hosting their Data Plane, be it hosted on a public cloud provider or on their own infrastructure.

The control plane includes the following components:

Tyk Dashboard
Tyk Control Plane
MDCB
MongoDB
Redis (Master Instance)

The self-managed data plane includes the following components:

Hybrid Gateway(s)
Redis instance
Tyk Pump (optional)

After following the guidelines for preparing for upgrade, follow the instructions below to upgrade your self-managed Tyk components and plugins.

Upgrade order

Upgrade the control plane on Tyk Cloud
Upgrade your Tyk self-managed data plane. When upgrading your data plane, upgrade the components in the following order:
1. Go Plugins (if applicable)
2. Hybrid Pump (if applicable)
3. Hybrid Gateway(s)

1. Upgrade your control plane

See Tyk Guide for how to upgrade Control Planes

2.1. Upgrade Go plugins

Follow our guide for upgrading your Go plugins on Tyk Cloud. Subsequently, follow the steps below according to the target upgrade version of the Gateway.

Gateway Versions < 4.1.0

Proceed with upgrading your Tyk Data Plane Hybrid Gateways.
Update the custom_middleware_bundle field in the API Definitions of all APIs that use your plugin. The field should be updated to use the new bundle file containing your upgrade plugin.
Validate that your plugin is working per your expectations.

Gateway Versions >= 4.1.0

Update the custom_middleware_bundle field in the API Definitions of all APIs that use your plugin. The field should be updated to use the new bundle file containing your upgraded plugin.
Validate that your plugin is working per your expectations as at this stage, your Gateway will be running the plugin for your current version still.

Note

This step is a sanity check to catch any potential issues with the bundle for the current version and will ensure that any requests that your Gateway processes prior to being upgraded are able to invoke the plugin as you expect.

Proceed with upgrading your Tyk Data Plane Hybrid Gateways. Given that you loaded your target version plugin in step 1, this version will be loaded automatically once you upgrade.
Validate that your plugin is working per your expectations.

3. Upgrade your Tyk Data Plane Hybrid Gateway(s)

Follow the instructions for component deployment type:

Upgrade Guide Video

Please refer to our video for further supporting with upgrading Tyk Self-Managed (RPM).