Tyk Charts 2.2 Release Notes

Open Source (Mozilla Public License)

This page contains all release notes for version 2.2.X displayed in a reverse chronological order

Support Lifetime

Our minor releases are supported until our next minor comes out.

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,

For a comprehensive list of changes, please refer to the detailed changelog below.

Breaking Changes

This release has no breaking changes.

Dependencies

3rd Party Dependencies & Tools

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.

Deprecations

There are no deprecation in this release.

Upgrade instructions

You can use helm upgrade to upgrade your release

helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
helm repo update

helm upgrade [RELEASE_NAME] tyk-helm/[CHART_NAME]

Downloads

• 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 via global.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.log in 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 through extraContainers field to the following components:

  • Tyk Gateway
  • Tyk Dashboard
  • Tyk MDCB
  • Tyk Pump
  • Tyk Enterprise Developer Portal

Changed

• Updated default versions of Tyk components

  Tyk Charts 2.2 will install the following Tyk component versions by default.

  • Tyk Gateway v5.3.8
  • Tyk Dashboard v5.3.8
  • Tyk Pump v1.11.1
  • Tyk MDCB v2.7.2
  • Tyk Developer Portal v1.12.0
  • Tyk Operator v1.1.0

Fixed

• Gateway: Corrected template name for OpenTelemetry caFilePath

  Corrected the template name for the OpenTelemetry caFilePath in the Gateway configuration. Updated template reference from otel-CAPath to otel-tlsCAPath to 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

  The externalTrafficPolicy field 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.

Further Information

Upgrading Tyk

Please refer to the upgrading Tyk page for further guidance on the upgrade strategy.

FAQ

Please visit our Developer Support page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.