Upgrading Tyk On Cloud SaaS
Last updated: 2 minutes read.
The following guide explains how to upgrade your Tyk deployment when using Tyk Cloud.
Preparations
Before proceeding with the upgrade process, ensure that you have thoroughly reviewed and completed the steps outlined in the upgrade guidelines. Once you have adequately prepared, follow the instructions below to upgrade your Tyk components and plugins in this specified order. Adhering to the provided sequence is crucial for a smooth and successful upgrade.
Upgrade Guide Video
Please refer to our upgrade guide video below for visual guidance:
Step #1: Upgrade Control Plane
Follow our guide for upgrading Cloud Control Planes.
Step #2: Upgrade Go Plugins
Follow our guide for deploying 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 (Gateway)
- 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 (Gateway). 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, as the Gateway now should have loaded the plugin for the target version automatically.
Step #3: Upgrade Cloud Data Plane
Follow our guide for upgrading Cloud Data Planes.