From 082a4eb40aa394dc1c250774c7c856a82c0bfeac Mon Sep 17 00:00:00 2001 From: elizabeth opayemi Date: Wed, 28 Aug 2024 15:40:16 +0100 Subject: [PATCH 1/7] 5.6 RN --- .../tyk-gateway/release-notes/version-5.6.md | 235 ++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md diff --git a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md new file mode 100644 index 0000000000..249c942694 --- /dev/null +++ b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md @@ -0,0 +1,235 @@ +--- +title: Tyk Gateway 5.6 Release Notes +date: 2024-03-27T15:51:11Z +description: "Release notes documenting updates, enhancements, and changes for Tyk Gateway versions within the 5.6.X series." +tags: ["Tyk Gateway", "Release notes", "v5.6", "5.6.0", "5.6", "changelog"] +--- + + + +**Open Source** ([Mozilla Public License](https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md)) + +**This page contains all release notes for version 5.6.X displayed in a reverse chronological order** + +## Support Lifetime + +Our minor releases are supported until our next minor comes out. + +--- + +## 5.6.0 Release Notes + +### Release Date 12 August 2024 + +### Breaking Changes + + +There are no breaking changes in this release. + +### Dependencies {#dependencies-5.6.0} + + +#### Compatibility Matrix For Tyk Components + +| Gateway Version | Recommended Releases | Backwards Compatibility | +|---- |---- |---- | +| 5.6.0 | MDCB v2.7 - TBP | MDCB v2.4.2 | +| | Operator v0.18 - TBP | Operator v0.17 | +| | Sync v1.5 - TBP | Sync v1.4.3 | +| | Helm Chart v1.6 - TBP | Helm all versions | +| | EDP v1.10 | EDP all versions | +| | Pump v1.11 | Pump all versions | +| | TIB (if using standalone) v1.5.1 | TIB all versions | + +#### 3rd Party Dependencies & Tools + + +| Third Party Dependency | Tested Versions | Compatible Versions | Comments | +| ------------------------------------------------------------ | ---------------------- | ---------------------- | -------- | +| [Go](https://go.dev/dl/) | 1.21 | 1.21 | [Go plugins]({{< ref "/plugins/supported-languages/golang" >}}) must be built using Go 1.21 | +| [Redis](https://redis.io/download/) | 6.2.x, 7.x | 6.2.x, 7.x | Used by Tyk Gateway | +| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x | v3.0.x | Supported by [Tyk OAS]({{< ref "/tyk-apis/tyk-gateway-api/oas/x-tyk-oas-doc" >}}) | + +Given the potential time difference between your upgrade and the release of this version, we recommend users verify the ongoing support of third-party dependencies they install, as their status may have changed since the release. + +### Deprecations + +There are no deprecations in this release. + + + + +### Upgrade instructions {#upgrade-5.6.0} +If you are upgrading to 5.6.0, please follow the detailed [upgrade instructions](#upgrading-tyk). + + +### Release Highlights + +Add release highlights here + +### Downloads +- [Docker image to pull](https://hub.docker.com/r/tykio/tyk-gateway/tags?page=&page_size=&ordering=&name=v5.6.0) + - ```bash + docker pull tykio/tyk-gateway:v5.6.0 + ``` +- Helm charts + TBP (To Be Published separately after the release) +- [Source code tarball for OSS projects](https://github.com/TykTechnologies/tyk/releases) + +### Changelog {#Changelog-v5.6.0} + + +#### Added + + + +##### Changed + + + +#### Fixed + + + + +#### Security Fixes + + + + + +--- + + + + + +## Further Information + +### Upgrading Tyk +Please refer to the [upgrading Tyk]({{< ref "upgrading-tyk" >}}) page for further guidance on the upgrade strategy. + +### API Documentation + +- [Tyk Gateway API]({{}}) +- [Postman Collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/overview) + +### FAQ + +Please visit our [Developer Support]({{< ref "/frequently-asked-questions/faq" >}}) page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute. From f0231804986b356e46b3705689ee72493f5dd196 Mon Sep 17 00:00:00 2001 From: elizabeth opayemi Date: Wed, 28 Aug 2024 15:58:08 +0100 Subject: [PATCH 2/7] changes --- .../product-stack/tyk-gateway/release-notes/version-5.6.md | 2 +- tyk-docs/data/menu.yaml | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md index 249c942694..47d4311f5b 100644 --- a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md +++ b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md @@ -23,7 +23,7 @@ Our minor releases are supported until our next minor comes out. ## 5.6.0 Release Notes -### Release Date 12 August 2024 +### Release Date xxx ### Breaking Changes diff --git a/tyk-docs/data/menu.yaml b/tyk-docs/data/menu.yaml index e4193df785..0a08468f4b 100644 --- a/tyk-docs/data/menu.yaml +++ b/tyk-docs/data/menu.yaml @@ -2421,6 +2421,10 @@ menu: path: /product-stack/tyk-gateway/release-notes/overview category: page show: True + - title: "Tyk Gateway v5.6" + path: /product-stack/tyk-gateway/release-notes/version-5.6 + category: Page + show: True - title: "Tyk Gateway v5.5" path: /product-stack/tyk-gateway/release-notes/version-5.5 category: Page From e2c86b3b9a1afb39dd211d2bcea0e4a3c26b6b45 Mon Sep 17 00:00:00 2001 From: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com> Date: Wed, 18 Sep 2024 11:45:22 +0200 Subject: [PATCH 3/7] Update version-5.6.md --- .../tyk-gateway/release-notes/version-5.6.md | 41 ++++++++++--------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md index 47d4311f5b..c340bdcafa 100644 --- a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md +++ b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md @@ -114,16 +114,16 @@ Each change log item should be expandable. The first line summarises the changel
  • -Changelog item summary +Endpoint-Level Rate Limits for Client Control -Add a new changelog description +We have introduced support for configuring endpoint-level rate limits in keys and policies. This new feature allows for more granular control over client consumption of API resources, enabling you to manage and optimize API usage more effectively.
  • -Changelog item summary +JSON Format for Gateway Logs -Add a new changelog description +The Tyk Gateway now supports logging in JSON format. To enable this feature, set the environment variable TYK_GW_LOGFORMAT to json. If a different value is provided, the logs will default to the standard format. This enhancement allows for improved log processing and integration with various monitoring tools.
@@ -140,16 +140,9 @@ Each change log item should be expandable. The first line summarises the changel
  • -Changelog item summary +Upgrade to Go 1.22 for Tyk Dashboard -Add a new changelog summary -
    -
    • -
  • -
    -Another changelog item summary - -Add a new changelog summary +The Tyk Gateway and Tyk Dashboard have been upgraded from Golang 1.21 to Golang 1.22, bringing enhanced performance, strengthened security, and access to the latest features available in the new Golang release.
@@ -166,22 +159,30 @@ Each change log item should be expandable. The first line summarises the changel
  • -Changelog item summary +Improved Gateway Synchronization with MDCB for Policies and APIs -Add a new changelog description +We have enhanced the Tyk Gateway's synchronization with MDCB to ensure more reliable loading of policies and APIs. A synchronous initialization process has been implemented to prevent startup failures and reduce the risk of service disruptions caused by asynchronous operations. This update ensures smoother and more consistent syncing of policies and APIs from MDCB.
  • -Another changelog item summary +Quota Limit Respected During Spike Tests -Add a new changelog description +We have fixed an issue where the quota limit was not being consistently respected during spike tests, especially in deployments with multiple gateways. The problem occurred when multiple gateways cached the current and remaining quota counters at the end of quota periods. To address this, a distributed lock mechanism has been implemented, ensuring coordinated quota resets and preventing discrepancies across gateways. +
    +
    • + +
  • +
    +Performance Improvement: Restored Key Creation Speed in Gateway 4.0.13 and Later + +We have addressed a performance regression in gateway versions 4.0.13 and later, where key creation for policies with a large number of APIs (100+) became significantly slower. The operation, which previously took around 1.5 seconds in versions 4.0.0 to 4.0.12, was taking over 20 seconds in versions 4.0.13 and beyond. This issue has been resolved by optimizing Redis operations during key creation, restoring the process to its expected speed of approximately 1.5 seconds, even with a large number of APIs in the policy.
-#### Security Fixes + -
    + --- From c331ea6f497a15ae7bb8bf33af256edde18587a5 Mon Sep 17 00:00:00 2001 From: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com> Date: Wed, 18 Sep 2024 15:02:33 +0200 Subject: [PATCH 4/7] Update version-5.6.md --- .../product-stack/tyk-gateway/release-notes/version-5.6.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md index c340bdcafa..1f696d3ebc 100644 --- a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md +++ b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md @@ -128,7 +128,7 @@ The Tyk Gateway now supports logging in JSON format. To enable this feature, set
-##### Changed +#### Changed -Add release highlights here +We are thrilled to announce new updates and improvements in Tyk 5.6.0, bringing more control, flexibility, and performance. For a comprehensive list of changes, please refer to the changelog below. + +#### Per endpoint Rate Limiting for clients + +We’ve introduced client-level per-endpoint rate limits. Rate limits can now be configured in security policies and keys, and are applicable to both Tyk OAS and Tyk Classic APIs, offering greater control over how resources are accessed. + +#### Gateway logs in JSON format + +You can now output Tyk Gateway system logs in JSON format. This allows for easier integration with logging systems and more structured log data. + +#### Go upgrade to 1.22 + +We’ve upgraded the Tyk Gateway and Tyk Dashboard to Golang 1.22, bringing improved performance, better security, and enhanced stability to the core system. ### Downloads - [Docker image to pull](https://hub.docker.com/r/tykio/tyk-gateway/tags?page=&page_size=&ordering=&name=v5.6.0) From 5f47f664b3b8153cf1d6af7bff16a299ee236ab8 Mon Sep 17 00:00:00 2001 From: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com> Date: Wed, 25 Sep 2024 18:11:00 +0200 Subject: [PATCH 6/7] Update version-5.6.md --- .../product-stack/tyk-gateway/release-notes/version-5.6.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md index 826a486424..229129c59e 100644 --- a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md +++ b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md @@ -96,7 +96,7 @@ You can now output Tyk Gateway system logs in JSON format. This allows for easie #### Go upgrade to 1.22 -We’ve upgraded the Tyk Gateway and Tyk Dashboard to Golang 1.22, bringing improved performance, better security, and enhanced stability to the core system. +We’ve upgraded the Tyk Gateway to Golang 1.22, bringing improved performance, better security, and enhanced stability to the core system. ### Downloads - [Docker image to pull](https://hub.docker.com/r/tykio/tyk-gateway/tags?page=&page_size=&ordering=&name=v5.6.0) From b125eabfe974b20f8cc3589f3410571b0fde8d84 Mon Sep 17 00:00:00 2001 From: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com> Date: Fri, 27 Sep 2024 15:02:10 +0200 Subject: [PATCH 7/7] Update version-5.6.md --- .../product-stack/tyk-gateway/release-notes/version-5.6.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md index 229129c59e..0ca469091d 100644 --- a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md +++ b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md @@ -84,7 +84,7 @@ If you are upgrading to 5.6.0, please follow the detailed [upgrade instructions] This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-vX.Y.0">}}) below. --> -We are thrilled to announce new updates and improvements in Tyk 5.6.0, bringing more control, flexibility, and performance. For a comprehensive list of changes, please refer to the changelog below. +We are thrilled to announce new updates and improvements in Tyk 5.6.0, bringing more control, flexibility, and performance. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.6.0">}}) below. #### Per endpoint Rate Limiting for clients