Release Notes
Tyk Charts Release Notes
Open Source (Mozilla Public License)
This page contains all release notes for Tyk Charts 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.
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.
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
If you need to use a different version for any component, adjust the Helm chart parameters during installation or upgrade.
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
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
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
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
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.3.0 Release Notes
3.0.0 Release Notes
Release Date 02 April 2025
Release Highlights
Tyk Charts 3.0 significantly improves configurability, reliability, and support for Tyk 5.8. This release enhances monitoring capabilities, expands Helm chart flexibility, and resolves key issues related to service availability and configuration management. For a comprehensive list of changes, please refer to the detailed changelog below.Breaking Changes
Tyk Charts 3.0 introduces a breaking configuration changes for Tyk Dashboard: To provide a default secure configuration,security.forbid_admin_view_access_token and security.forbid_admin_reset_access_token are set to true to restrict admin users from being able to view and reset other users’ Dashboard API Access Credentials.
Dependencies
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.30.x, 1.31.x, 1.32.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 | 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard, Pump, and MDCB |
| PostgreSQL | 13.x - 17.x | 13.x - 17.x | Used by Tyk Dashboard, Pump, and MDCB |
Deprecations
There are no deprecation in this release.Upgrade instructions
You can use helm upgrade to upgrade your releaseDownloads
- Source code
- ArtifactHub - tyk-stack
- ArtifactHub - tyk-control-plane
- ArtifactHub - tyk-data-plane
- ArtifactHub - tyk-oss
Changelog
Added
Pump: Readiness and liveness probes
Added readiness and liveness probes using Tyk Pump’s health check service, allowing proactive monitoring to detect failures and improve system reliability.Global: imageRegistry configuration
Added support for a global image registry, making it easier for users to configure private registries and streamline container image management.Gateway: Tyk Gateway startup probes
Added configurable startup probes for Tyk Gateway, improving readiness checks to prevent premature traffic routing during initialization.Gateway: Tyk Gateway access/transaction logs
Added support for configuring access logs in Tyk Gateway 5.8, allowing users to track API transaction logs for enhanced monitoring and debugging.Gateway: OpenTelemetry header from Kubernetes secrets
Added support for retrieving a single OpenTelemetry Authorization header from a Kubernetes secret, enhancing security by preventing exposure of sensitive credentials in Helm values or Kubernetes manifests.Helm chart parameterization
Replaced hardcoded values in Helm charts with configurable parameters, providing greater flexibility in deployment customization.Operator and tyk-bootstrap: Tolerations, affinity, and node selector
Added support for tolerations, affinity, and node selector configurations, enabling users to fine-tune Kubernetes scheduling for better resource allocation and workload distribution.Configurable test pod execution
Added support to enable or disable test pods, allowing users to optimize resource utilization based on their environment needs.
Changed
Fixed
Pump: Pump service annotation issue
Fixed an issue where service annotations for Tyk Pump were not being applied correctly, which caused misconfigurations in Kubernetes deployments. This has been resolved by ensuring annotations are properly processed.Operator liveness and readiness probe failure
Fixed an issue where the Operator’s liveness and readiness probes were failing, causing the service to enter a CrashLoopBackOff state. This has been resolved by adjusting configurations to ensure proper startup and health checks.Incorrect TYK_DB_TYKAPI_HOST and TYK_DB_TYKAPI_PORT values
Fixed an issue where TYK_DB_TYKAPI_HOST and TYK_DB_TYKAPI_PORT environment variables were incorrectly set when the Control API was enabled, leading to connectivity issues. This has been resolved by ensuring the correct values are assigned during configuration.
2.2 Release Notes
2.2.0 Release Notes
Release Date 09 December 2024
Release Highlights
The Tyk Helm Charts v2.2.0 release brings exciting new features, improvements, and crucial fixes to enhance deployment flexibility, customization, and reliability. Here are the highlights:- Sidecar containers support
- Dashboard enhancements: Configurable audit log storage, Open Policy Agent (OPA) settings
- Gateway enhancements: Custom liveness and readiness probes, enhanced logging configuration, customizable HPA behavior
- Operator updates: Custom deployment annotations,
Breaking Changes
This release has no breaking changes.Dependencies
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.30.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 | 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard, Pump, and MDCB |
| PostgreSQL | 12.x - 16.x | 12.x - 16.x | Used by Tyk Dashboard, Pump, and MDCB |
Deprecations
There are no deprecation in this release.Upgrade instructions
You can use helm upgrade to upgrade your releaseDownloads
- Source code
- ArtifactHub - tyk-stack
- ArtifactHub - tyk-control-plane
- ArtifactHub - tyk-data-plane
- ArtifactHub - tyk-oss
Changelog
Added
Global: Configurable Tyk streams setting
User can enable or disable Tyk Streams feature viaglobal.streaming.enabled. This option is enabled by default.Dashboard: Configurable audit log storage
Introduced new configuration options to manage audit logging for the Tyk Dashboard. This enhancement allows users to enable, customize, and specify how audit logs are stored and formatted.To configure, see Tyk Stack documentation.Dashboard: Configurable Open Policy Agent (OPA) settings
Introduced new options to enable and manage Open Policy Agent (OPA) support directly from the Helm chart. This feature simplifies the configuration process, guiding users to use the correct settings without relying on extraEnvs.To configure, see Tyk Stack documentation.Gateway: Configurable liveness and readiness probes
Support for configuring liveness and readiness probes for the Tyk Gateway via Helm charts.Users can now define custom configurations for these probes, providing more flexibility and control over health checks in Kubernetes deployments. Defaults are provided if custom configurations are not specified.This enhancement improves deployment reliability and ensures better integration with Kubernetes health monitoring systems.To configure, see Tyk Stack documentation.Gateway: Enhanced log configuration
Support for configuring the Tyk Gateway logging level and format through new fields under.Values.gateway.login the Helm chart values.yaml.This enhancement enables fine-tuned control over logging behavior directly from the Helm chart, simplifying deployment customization.Gateway: Customizable HPA behavior
Users can now define custom HPA behavior settings directly in the Helm values file via a new field a new field:.Values.gateway.autoscaling.behavior.This enhancement provides more flexibility in configuring HPA scaling behavior, allowing tailored performance tuning for Gateway deployments.Operator: Support for adding custom annotations to the Tyk Operator deployment
Users can now specify annotations directly in the Helm values field.Values.annotations, enabling better integration with external tools and systems that rely on metadata annotations.Configurable sidecar containers
Support for adding sidecar containers for Tyk components, enhancing flexibility and integration capabilities. This feature allows for the addition of auxiliary containers throughextraContainersfield to the following components:- Tyk Gateway
- Tyk Dashboard
- Tyk MDCB
- Tyk Pump
- Tyk Enterprise Developer Portal
Changed
Fixed
Gateway: Corrected template name for OpenTelemetry caFilePath
Corrected the template name for the OpenTelemetry caFilePath in the Gateway configuration. Updated template reference fromotel-CAPathtootel-tlsCAPathto ensure proper functionality. This fix addresses misconfigurations related to the OpenTelemetry TLS CA path and ensures accurate rendering of Gateway templates.MDCB: Fixed MDCB service configuration when using LoadBalancer as the service type
TheexternalTrafficPolicyfield is now correctly set under the spec section instead of selectors. This fix ensures proper functionality and alignment with Kubernetes service configuration requirements.Tyk Operator license key handling in tyk-oss chart
Resolved an issue where the Tyk OSS chart did not set the Operator license key in the secret created for the Operator. This fix ensures seamless configuration of the license key when deploying Tyk Operator.
2.1 Release Notes
2.1.0 Release Notes
Release Date 10 Oct 2024
Release Highlights
Added the ability to specify a static IP for Kubernetes LoadBalancer services, giving users more control over network configurations for the Tyk Gateway and Dashboard. Added an option to configure the Dashboard container port, addressing issues with restricted port permissions. Updated the default versions of Tyk components. For a comprehensive list of changes, please refer to the detailed changelog below.Breaking Changes
This release has no breaking changes. However, if you are upgrading to Tyk Operator v1.0 using the Helm Chart, please read the license requirement and Tyk Operator installation and upgrade instructions carefully.Dependencies
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.30.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 | 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard, Pump, and MDCB |
| PostgreSQL | 12.x - 16.x | 12.x - 16.x | Used by Tyk Dashboard, Pump, and MDCB |
Deprecations
There are no deprecation in this release.Upgrade instructions
For users currently on v2.0.x, we strongly recommend promptly upgrading to the latest release.You can use helm upgrade to upgrade your release
Downloads
- Source code
- ArtifactHub - tyk-stack
- ArtifactHub - tyk-control-plane
- ArtifactHub - tyk-data-plane
- ArtifactHub - tyk-oss
Changelog
Added
Ability to specify static IP for Kubernetes LoadBalancer service
Added an optionalloadBalancerIPparameter in the chart that allows users to set a static IP for Tyk Gateway and Dashboard services when using theLoadBalancerservice type. This update provides enhanced control over IP configuration, useful for network stability in environments with multiple load balancers.Tyk gateway service configuration:tyk-gateway.gateway.service.loadBalancerIP(default to "")
tyk-dashboard.dashboard.service.loadBalancerIP(default to "")
Ability to configure Dashboard container port
Enables specifying an alternate port for the container while using standard ports in the service. This option resolves permission issues associated with restricted ports, such as port 443, within containers.From v1.0 Tyk Operator Requires License Key
Starting from Tyk Operator v1.0, a license key is required to use the Tyk Operator. You can provide it while installing Tyk Stack, Tyk Control Plane, or Tyk OSS helm chart by settingglobal.license.operatorfield. You can also set license key via a Kubernetes secret usingglobal.secrets.useSecretNamefield. The secret should contain a key calledOperatorLicense.
Changed
2.0 Release Notes
2.0.0 Release Notes
Release Date 26 September 2024
Breaking Changes
1. URL Path Matching Configuration Changes
Tyk Charts v2.0 introduces a breaking change related to URL path matching behavior in the Tyk Gateway. If you are using Tyk Gateway versions 5.0.14 (2023 LTS), 5.3.5 (2024 LTS), or 5.5.1 (latest feature branch) or above, two new configuration options have been added to the Gateway:http_server_options.enable_path_prefix_matchinghttp_server_options.enable_path_suffix_matching
true, Tyk enforces “exact” path matching. By default, these options are set to false in the Gateway to avoid breaking existing configurations.
However, starting with Tyk Charts v2.0, these options will be set to true by default, enforcing stricter security by requiring precise path matches. This change applies to new installations or upgrades via Tyk Charts v2.0 and above.
From this version of Tyk Charts we also set the following configuration option to true by default as part of the stricter path matching:
http_server_options.enable_strict_routes
- The change is backward-compatible for users upgrading their Tyk Gateway directly (i.e. not via Helm Chart), because by default, these features will not be active. This ensures that existing configurations are not affected if you update the Gateway manually.
- However, if you install or upgrade via Tyk Charts v2.0, these options will be set to
trueby default. This means stricter URL path matching will be enforced automatically, which could impact your existing routes or configurations if you’re not prepared for it. Please ensure you understand and test these new configurations before upgrading your production environment.
- Familiarize yourself with URL matching in Tyk here.
- For production setup guidance, see this guide.
- Configure the new options via the Helm chart, and test the changes in a non-production environment before upgrading.
2. Default Tyk Component Versions
This release changes the default component versions in Tyk Charts v2.0 to Long-Term Support (LTS) versions for greater stability in production environments. The new defaults are:| Tyk Component | Default Version | Customization Parameter |
|---|---|---|
| Tyk Gateway | 5.3.5 LTS | --set tyk-gateway.gateway.image.tag=<desired-version> |
| Tyk Dashboard | 5.3.5 LTS | --set tyk-dashboard.dashboard.image.tag=<desired-version> |
| Tyk Pump | 1.11.0 | --set tyk-pump.pump.image.tag=<desired-version> |
| Tyk MDCB | 2.7.0 | --set tyk-mdcb.mdcb.image.tag=<desired-version> |
| Tyk Developer Portal | 1.10.0 | --set tyk-dev-portal.image.tag=<desired-version> |
| Tyk Operator | 0.18.0 | --set tyk-operator.image.tag=<desired-version> |
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.30.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 | 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard, Pump, and MDCB |
| PostgreSQL | 12.x - 16.x | 12.x - 16.x | Used by Tyk Dashboard, Pump, and MDCB |
Deprecations
There are no deprecation in this release.Upgrade instructions
For users currently on v1.x.x, we strongly recommend promptly upgrading to the latest release.You can use helm upgrade to upgrade your release
Release Highlights
Support Gateway configuration for URL path matching
The default Gateway configuration in the Helm chart will set Tyk’s URL path matching to exact mode. This ensures that the request URL must exactly match the listen path and endpoint patterns configured in the API definition.Updated default Tyk versions
Tyk Charts 2.0 will install the following Tyk component versions by default.- Tyk Gateway v5.3.5
- Tyk Dashboard v5.3.5
- Tyk Pump v1.11.0
- Tyk MDCB v2.7.0
- Tyk Developer Portal v1.10.0
- Tyk Operator v0.18.0
Downloads
- Source code
- ArtifactHub - tyk-stack
- ArtifactHub - tyk-control-plane
- ArtifactHub - tyk-data-plane
- ArtifactHub - tyk-oss
Changelog
Added
Changed
1.6 Release Notes
1.6.0 Release Notes
Release Date 14 August 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.30.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 | 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard, Pump, and MDCB |
| PostgreSQL | 12.x - 16.x | 12.x - 16.x | Used by Tyk Dashboard, Pump, and MDCB |
Deprecations
There are no deprecation in this release.Upgrade instructions
For users currently on v1.4.x, we strongly recommend promptly upgrading to the latest release.You can use helm upgrade to upgrade your release
Release Highlights
Updated MDCB Health check probes
MDCB v2.7.0 release introduces/liveness and /readiness probes which give more accurate and detail health check information. MDCB deployment has been updated to use the new endpoints. See MDCB Health Check section for information about the new probes.
Updated default Tyk versions
Tyk Charts 1.6 will install the following Tyk component versions by default.- Tyk Gateway v5.5.0
- Tyk Dashboard v5.5.0
- Tyk Pump v1.11.0
- Tyk MDCB v2.7.0
- Tyk Developer Portal v1.10.0
- Tyk Operator v0.18.0
Downloads
- Source code
- ArtifactHub - tyk-stack
- ArtifactHub - tyk-control-plane
- ArtifactHub - tyk-data-plane
- ArtifactHub - tyk-oss
Changelog
Added
Fixed
1.5 Release Notes
1.5.0 Release Notes
Release Date 4 July 2024
Breaking Changes
This release has no breaking changes.3rd Party Dependencies & Tools
With PostgreSQL v11 has reach EOL on November 2023, we can no longer guarantee full compatibility with this version of the database. If you are using PostgreSQL we recommend that you upgrade to a version that we have tested with, as indicated below.| 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 | 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard, Pump, and MDCB |
| PostgreSQL | 12.x - 16.x | 12.x - 16.x | Used by Tyk Dashboard, Pump, and MDCB |
Deprecations
MDCB: Deprecated healthcheck_port and replaced with http_port
Starting with MDCB v2.6.0, the configuration parameterhttp_port has been introduced to replace the original healthcheck_port. This new HTTP port is designed to expose various endpoints for monitoring and debugging MDCB. For consistency and future compatibility, it is recommended to use mdcb.httpPort.
####### Backward compatibility:
The mdcb.httpPort parameter is backward compatible, meaning it will function correctly with all existing MDCB versions, ensuring a smooth transition.
####### Recommendations for users:
- Helm Chart Adjustments: Update your Helm chart configurations to use
mdcb.httpPortinstead ofmdcb.probes.healthcheckPortto define the HTTP port.
Upgrade instructions
For users currently on v1.4.x, we strongly recommend promptly upgrading to the latest release.You can use helm upgrade to upgrade your release
Release Highlights
Updated default Tyk versions
Tyk Charts 1.5 will install the following Tyk component versions by default.- Tyk Gateway v5.4.0
- Tyk Dashboard v5.4.0
- Tyk Pump v1.10.0
- Tyk MDCB v2.6.0
- Tyk Developer Portal v1.9.0
- Tyk Operator v0.18.0
Tyk Operator is covered under the same umbrella
Tyk Operator can now be installed as an optional component alongside any of the following Tyk umbrella charts:- tyk-oss
- tyk-stack
- tyk-control-plane
tyk-operator-conf secret will be automatically configured during the bootstrapping process. This means that the Tyk Operator will be ready for use with just one command, simplifying the deployment and configuration process.
For a comprehensive list of changes, please refer to the detailed changelog below.
Downloads
- Source code
- ArtifactHub - tyk-stack
- ArtifactHub - tyk-control-plane
- ArtifactHub - tyk-data-plane
- ArtifactHub - tyk-oss
Changelog
Added
Gateway: Add option to enable fixed window rate limiter
New fieldgateway.enableFixedWindowRateLimiteradded totyk-gatewaychart.This feature allows users to enable fixed window rate limiter in the Gateway. The fixed window rate limiter feature permits requests up to the configured rate limit within a specified time window, after which any additional requests are blocked until the next window. This method has minimal impact on Redis and is straightforward to implement. However, it should be noted that it does not protect against traffic spikes as it lacks spike arrest behavior. The default value for this setting isfalse.Dashboard and Gateway: Add init containers resources parameters
Optional parametersdashboard.initContainers.initAnalyticsConf.resourcesandgateway.initContainers.setupDirectories.resourcesadded to set resources for init containers in Dashboard and Gateway charts respectively.This feature is introduced to allow the definition of resource parameters for init containers, which is particularly useful in environments with namespace quotas that require specific resource definitions. Users can now specify the resources for init containers to comply with namespace resource quotas, ensuring that the init containers operate within the defined resource limits. The resource parameters can be defined at below locations.Tyk Dashboard chartTyk Gateway chartMDCB: Added SSL configurations for MDCB HTTP server
Addedmdcb.httpServerOptionsfor SSL configuration of the MDCB HTTP server.This feature allows users to enable SSL for the MDCB HTTP server by configuring SSL-specific options. Users can enhance the security of their MDCB HTTP server by enabling SSL. The configuration includes settings such asuseSSL,certificateKeyFile,certificateCertFile, andminVersion. For other HTTP server options, users can utilizeextraEnvsto configure additional parameters.MDCB: Deprecated Healthcheck Port and added HTTP Port
mdcb.httpPortadded to define the port used for accessing MDCB HTTP endpoints.This change deprecates the previous healthcheck port in favor of using a defined HTTP port for accessing MDCB HTTP endpoints. This update streamlines the configuration by consolidating the HTTP endpoints under a single port setting, making it simpler to manage and configure the MDCB health checks.Add tyk-operator dependency to umbrella charts
global.components.operatoradded to determine whether the Tyk Operator component should be installed.This feature adds a dependency on the Tyk Operator to the umbrella charts, facilitating the installation of the Tyk Operator component. Users can now easily install the Tyk Operator component by setting theglobal.components.operatorparameter. Note that the Tyk Operator requirescert-managerto be installed beforehand. It also expects secrettyk-operator-confis present in the installation namespace. You can enable bootstrapping atglobal.components.bootstrapif you are working on a new installation to have this secret created for you. Refer to the Tyk Operator installation guide for detailed information on pre-requisites.Add annotations to Tyk Stack and component Helm Charts
Introducedannotationsvalues to the Tyk stack and component Helm charts to define annotations for Deployments or StatefulSets.This enhancement allows users to define custom annotations for the Deployments or StatefulSets of Tyk components. Annotations are useful for supporting automated reloading of the Gateway or other components using tools like reloader. Previously, the Helm charts did not support any annotations at the deployment level.Users can now add custom annotations to facilitate automation and improve the management of Tyk components. The following annotations have been added:- Dashboard:
dashboard.annotationsfor Tyk Dashboard Deployment/StatefulSet - Dev Portal:
annotationsfor Tyk Developer Portal Deployment/StatefulSet - Gateway:
gateway.annotationsfor Tyk Gateway Deployment/StatefulSet - MDCB:
mdcb.annotationsfor MDCB Deployment/StatefulSet - Pump:
pump.annotationsfor Tyk Pump Deployment
- Dashboard:
Fixed
Dashboard: Fix misconfiguration preventing detail log display with Mongo Pump
This fix addresses a misconfiguration in the Dashboard chart that was causing the Log Browser not showing API activity logs for users utilizing Mongo Pump. The default configurationdashboard.useShardedAnalyticsis now set totrue, ensuring proper log visibility. Users who use Mongo Pump will now be able to view the API activity log as expected. Additionally, the correct Dashboard environment variableTYK_DB_USESHARDEDANLAYTICSis now set usingdashboard.useShardedAnalytics. This enhancement ensures accurate log visibility and improves the overall user experience with the Dashboard by properly configuring sharded analytics.Gateway: Fix issue with control port and `latest` container image tag
Resolved an issue in the Gateway chart that prevented the use of a container image with thelatesttag whengateway.control.enabledis set totrue.This fix addresses a problem in the Gateway chart where enabling the control port (gateway.control.enabled) would cause an error if the container image tag was set tolatest. The helm chart template previously assumed that all images would use semantic versioning.Users can now use thelatesttag for container images even when the control port is enabled. This enhancement removes the restriction and assumption of semantic versioning, providing more flexibility in specifying container image tags.Dev Portal: Fix issue that prevent bootstrap and developer portal to be enabled at the same time
Resolved an issue intyk-stackandtyk-control-planechart that prevented bootstrap and devPortal components to be enabled at the same time.When user deploy Developer Portal usingtyk-stackortyk-control-planeHelm Chart, there was a problem before that bootstrapping and devPortal cannot be enabled at the same time. It was because dev portal was depending on secrettyk-dev-portal-confto start up but the secret can only be created after all pods has been created successfully via the bootstrapping job. This problem arises when user use--waitflag in helm install or use ArgoCD for installation.We have fixed this issue by not passing required org ID and API key as command option during portal startup. The dev portal is configured after Pod creation via Dev Portal API.
1.4 Release Notes
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.
Fixed
1.3. Release Notes
1.3.0 Release Notes
Release Date 05 Apr 2024
Breaking Changes
For MongoDB users: Tyk Charts 1.3.0 usesmongo-go as the default driver to connect to MongoDB. mongo-go driver is compatible with MongoDB 4.4.x and above. For MongoDB versions prior to 4.4, please set global.mongo.driver to mgo. We recommend reading Choose a MongoDB driver when you need to change driver setting.
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 |
| PostgreSQL | 11.x - 15.x LTS | 11.x - 15.x | Used by Tyk Dashboard |
Deprecations
There are no deprecations in this release.Future deprecations
- In
tyk-dashboardchart,dashboard.hashKeysfield will be deprecated in future and be replaced with.global.hashKeys. This is to ensure Dashboard, Gateway, and MDCB always get the same hashKeys configurations. It is recommended users do not setdashboard.hashKeysand only use.global.hashKeysfield.
Upgrade instructions
For users currently on v1.2.x, we strongly recommend promptly upgrading to the latest release.You can use helm upgrade to upgrade your release
Release Highlights
This release primarily focuses on adding support for Tyk v5.3 configurations. Tyk Charts 1.3 will install the following Tyk component versions by default.- Tyk Gateway v5.3.0
- Tyk Dashboard v5.3.0
- Tyk Pump v1.9.0
- Tyk MDCB v2.5.0
- Tyk Developer Portal v1.8.3
Support new features available from Tyk v5.3.0
Tyk Charts 1.3 adds support for a number of new Tyk features available from Tyk 5.3.0. These include: Support use of SSL certificates when connecting to Redis, Configurations for OAS Validate examples and OAS Validate Schema defaults.Graph Pump
Tyk Charts 1.3 adds support for Graph MongoDB Pump, Graph SQL Pump and Graph SQL Aggregate Pump. see Graph Pump setup to learn more about the GraphQL-specific metrics available.Enable Tyk Identity Broker (TIB) in Tyk Dashboard
Tyk Charts 1.3 adds a field to enable Internal Tyk Identity Broker (TIB) in Tyk Dashboard by fieldtyk-dashboard.tib.enabled to true.
Downloads
Changelog
Added
Global config: Support use of SSL certificates when connecting to Redis
Added following fields inglobal.redisto support use of SSL certificates when connecting to Redis.Global config: Added OAS Validate Examples
Added fieldglobal.oasValidateExamples. When set to true, it enables validation of examples in the OAS spec. It is used to setTYK_DB_OAS_VALIDATE_EXAMPLESandTYK_GW_OAS_VALIDATE_EXAMPLES.Global config: Added OAS Validate Schema Defaults
Added fieldglobal.oasValidateSchemaDefaults. When set to true, it enables validation of schema defaults in the OAS spec. It is used to setTYK_DB_OAS_VALIDATE_SCHEMA_DEFAULTSandTYK_GW_OAS_VALIDATE_SCHEMA_DEFAULTS.Global config: Enable/Disable key hashing
Added fieldglobal.hashKeys. When set to true, it enables key hashing in Gateway. Dashboard will also operate in a mode that is compatible with key hashing. Please do not setdashboard.hashKeysor make suredashboard.hashKeysis set to the same value or elsedashboard.hashKeyswill take precedence.Note:dashboard.hashKeyswill be deprecated in future release.Gateway: Added support for PodDisruptionBudget resource
Added built-in support for PodDisruptionBudget resource for Tyk Gateway. This will enhance the reliability and availability of your applications, giving you some control over the disruption caused by scaling operations, updates or maintenance on your pods. To enable it, setgateway.pdb.enabledtotrueand configuregateway.pdb.minAvailableorgateway.pdb.maxUnavailable.Gateway: Added Ingress template for gateway control service
When enabled atgateway.control.ingress.enabled, an Ingress resource will be created to allow external access to gateway’s control service.Gateway: Configure Gateway to work with MDCB synchroniser
Allow users to configure worker gateway to work with Tyk MDCB synchroniser easily by settingglobal.mdcbSynchronizer.enabledintyk-data-plane. The control plane should be deployed with sameglobal.mdcbSynchronizer.enabledvalue too.Gateway: Customize ServiceAccount to be used
Allow users to customizeserviceAccountNamefor gateway, the name of the Service Account that is going to be used by the Pods.Gateway: Make service port name configurable
Users can configure Tyk Gateway service port name and Tyk Gateway control service port name. Default ishttp.Gateway: Make initContainer image configurable
Users can configure Tyk Gateway initContainer image so that it is possible to load busybox image from preferred registry.Dashboard: Added option to enable Tyk Identity Broker (TIB) in Tyk Dashboard
You can enable Internal Tyk Identity Broker (TIB) in Tyk Dashboard by fieldtyk-dashboard.tib.enabledtotrue.Dashboard: Customize ServiceAccount to be used
Allow users to customizeserviceAccountNamefor dashboard, the name of the Service Account that is going to be used by the Pods.Dashboard: Make service port name configurable
Users can configure Tyk Dashboard service port name. Default ishttp.Pump: Added Graph pump support
Graph Pumps will be added when the user addsmongoorpostgrestopump.backend. Whenmongois added topump.backendthe Graph MongoDB Pump will be enabled. Whenpostgresis added topump.backendthe Graph SQL Pump and Graph SQL Aggregate Pump will be enabled.Pump: Customize ServiceAccount to be used
Allow users to customizeserviceAccountNamefor pump, the name of the Service Account that is going to be used by the Pods.Pump: Make service port name configurable
Users can configure Tyk Pump service port name. Default ishttp.Portal: Customize ServiceAccount to be used
Allow users to customizeserviceAccountNamefor portal, the name of the Service Account that is going to be used by the Pods.Portal: Make service port name configurable
Users can configure Tyk Developer Portal service port name. Default ishttp.New component chart to deploy MDCB
A new MDCB component chart has been added to deploy MDCB. It is currently in Beta. For installation instructions and configurations, please read Tyk Control Plane chart.New umbrella chart to deploy Tyk Control Plane
A new Tyk Control Plane umbrella chart has been added to deploy Tyk Control Plane. It is currently in Beta. For installation instructions and configurations, please read Tyk Control Plane chart.