Release Notes
Tyk Charts 1.4 Release Notes
Open Source (Mozilla Public License)
This page contains all release notes for version 1.4.X displayed in a reverse chronological order
Given the time difference between your upgrade and the release of this version, we recommend customers verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.
You can use helm upgrade to upgrade your release
Support Lifetime
Our minor releases are supported until our next minor comes out.1.4.0 Release Notes
Release Date — 6 May 2024
Breaking Changes
This release has no breaking changes.3rd Party Dependencies & Tools
| Third Party Dependency | Tested Versions | Compatible Versions | Comments |
|---|---|---|---|
| Kubernetes | 1.26.x, 1.27.x, 1.28.x, 1.29.x | 1.19+ | |
| Helm | 3.14.x | 3.x | |
| Redis | 6.2.x, 7.x | 6.2.x, 7.x | Used by Tyk Gateway and Dashboard |
| MongoDB | 5.0.x, 6.0.x, 7.0.x | 4.4.x, 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard, Pump, and MDCB |
| PostgreSQL | 11.x - 15.x LTS | 11.x - 15.x | Used by Tyk Dashboard, Pump, and MDCB |
Deprecations
- In the
tyk-dashboardchart, thedashboard.hashKeysfield is deprecated and has been replaced with.global.hashKeys. This is to ensure Dashboard, Gateway, and MDCB always get the same hashKeys configurations. Settingdashboard.hashKeyswill no longer take effect. Please only use.global.hashKeysfield.
Upgrade instructions
For users currently on v1.3.x, we strongly recommend promptly upgrading to the latest release.You can use helm upgrade to upgrade your release
Release Highlights
General availability release of tyk-control-plane chart and tyk-mdcb chart
We’re pleased to announce the official release of the Tyk Helm Charts for Tyk Control Plane and MDCB! Following a successful beta phase, these charts are now stable and ready for production use. With this release, we aim to provide a straightforward solution for deploying and managing Tyk Control Plane and Multi-Data Center Bridge (MDCB) using Helm Charts. Whether you’re looking for our recommended setup configurations or need flexibility to adapt to your architectural requirements, our Helm Charts have you covered. To leverage this stable release and simplify your Tyk deployments, we invite you to explore our example setup for MDCB Control Plane using Helm Chart. Simply follow our MDCB Control Plane setup guide to get started.Updated default Tyk versions
Tyk Charts 1.4 will install the following Tyk component versions by default.- Tyk Gateway v5.3.1
- Tyk Dashboard v5.3.1
- Tyk Pump v1.9.0
- Tyk MDCB v2.5.1
- Tyk Developer Portal v1.8.5
Downloads
- Source code
- ArtifactHub - tyk-stack
- ArtifactHub - tyk-control-plane
- ArtifactHub - tyk-data-plane
- ArtifactHub - tyk-oss
Changelog
Added
OSS: Simplify Tyk Operator setup with Kubernetes Secret creation
When you setoperatorSecret.enabledtotruein thetyk-osschart, a Kubernetes Secret namedtyk-operator-confwill be automatically created in the same namespace. This secret is essential for connecting Tyk Operator to the Gateway, enabling seamless management of Tyk API resources. To learn more about setting up Tyk Operator, check out Tyk Operator installation.MDCB: Enhanced analytics configuration options
We have introduced new configuration options for handling analytics data flow in MDCB deployments. By default, MDCB stores aggregated analytics data from the data plane pump to SQL/Mongo. Additionally, users have the flexibility to enable Pump in the control plane, allowing MDCB to send analytics to Redis instead.Here are the default configurations:Tyk Control Plane: Added option to enable Dashboard hybrid organization
We’ve added a convenient option to enable dashboard hybrid organization during bootstrapping. This eliminates the manual step of calling the Dashboard Admin API post-deployment to enable hybrid organization, which is essential for MDCB deployment.Enhanced security with customizable Pod or Container security context
To harden security, we have made security context of all Pods and Containers customizable. Also, we have setrunAsNonRoot: truein all Pod’ssecurityContext. This prevents the Pods from running as root users, ensuring compatibility with the Restricted Pod Security Policy.Gateway: Allow Gateway to be updated if secret value is updated
We’ve introduced an annotation with a checksum of the secret as a value, triggering a deployment change when the secret is updated. This ensures that pods are replaced promptly, immediately utilizing the new values from the secret. This logic applies ifglobal.secrets.useSecretNameis not set, as the secret is then not part of the chart.Customizable Pod Labels Across All Components
Now, you have the flexibility to customize Pod labels in all component charts. Simply populate thepodLabelsfield with your desired content, and it will be added as pod labels.Portal: Customizable Pod annotations in tyk-dev-portal
We’ve added apodAnnotationsfield to thetyk-dev-portalchart, allowing you to customize pod annotations. Fill in thepodAnnotationsfield with your specific content, and it will be added as pod annotations.
Changed
Gateway/Pump: Removed the command in Gateway and Pump pod templates
We’ve removed unnecessary commands from the Gateway and Pump pod templates, allowing for the utilization of entrypoint scripts.Dashboard: Allow arbitary image tags in tyk-dashboard
Dashboard: Classic portal bootstrapping disabled by default
To avoid confusion with the latest Developer Portal, Classic Portal bootstrapping is now disabled by default in the Dashboard. If you wish to utilize the Classic Portal, simply enable it by settingtyk-bootstrap.bootstrap.portaltotruein either the Tyk Stack or Tyk Control Plane chart.Dashboard: Deprecation of `hashKeys` field
Thedashboard.hashKeysfield is now deprecated. Instead, users should utilize theglobal.hashKeysfield to set key hashing. This ensures configuration alignment across Gateway, Dashboard, and MDCB components.