Skip to content

[DX-1942] Gateway release notes 5.3.11 #6329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[DX-1942] Gateway release notes 5.3.11 #6329

wants to merge 1 commit into from

Conversation

Eopayemi
Copy link
Contributor

@Eopayemi Eopayemi commented Apr 22, 2025 •
edited by github-actions bot
Loading

User description

Preview Link

Checklist

  • Added a preview link
  • Reviewed AI PR Agent suggestions
  • For Tyk Members - Added Jira DX PR ticket to the subject
  • For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors

PR Type

Documentation

Description

  • Added detailed release notes for Gateway version 5.3.11.

  • Documented bug fixes and enhancements in 5.3.11.

  • Updated compatibility matrix and third-party dependencies.

  • Provided upgrade instructions and download links for 5.3.11.

Changes walkthrough 📝

Relevant files
Documentation
gateway.md
Add and document Gateway 5.3.11 release notes and changelog

tyk-docs/content/developer-support/release-notes/gateway.md

  • Added a new section for 5.3.11 release notes.
  • Documented highlights, breaking changes, and deprecations for 5.3.11.
  • Updated compatibility matrix and third-party dependency information.
  • Listed changelog entries for added features and bug fixes in 5.3.11.
    		• +110/-0 
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    •

    @Eopayemi Eopayemi marked this pull request as draft April 22, 2025 10:54
    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Accuracy

    Ensure that all described bug fixes, enhancements, and compatibility matrices accurately reflect the actual changes in Gateway 5.3.11. Pay special attention to the changelog and upgrade instructions for correctness and clarity.

     
    ### 5.3.10 Release Notes

#### Release Date XXX

#### Release Highlights

This release focuses mainly on bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.3.11" >}}) below.

#### Breaking Changes

This release has no breaking changes.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
|----    |---- |---- |
| 5.3.11 | MDCB v2.8.0     | MDCB v2.8.0 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.0    | Sync v2.1.0 |
|         | Helm Chart v3.0  | Helm all versions |
| | EDP v1.13 | EDP all versions |
| | Pump v1.12.0 | Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| ------------------------------------------------------------ | ---------------------- | ---------------------- | -------- | 
| [Go](https://go.dev/dl/)                                     | 1.23  |  1.23  | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.23 | 
| [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 "api-management/gateway-config-tyk-oas" >}}) |

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.3.11}

If you are upgrading to 5.3.11, please follow the detailed [upgrade instructions](#upgrading-tyk).

#### Downloads

- [Docker image to pull](https://hub.docker.com/r/tykio/tyk-gateway/tags?page=&page_size=&ordering=&name=v5.3.11)
  - ```bash
    docker pull tykio/tyk-gateway:v5.3.11
    ``` 
- Helm charts
  - [tyk-charts v3.0.0]({{<ref "developer-support/release-notes/helm-chart#300-release-notes" >}})

- [Source code tarball for OSS projects](https://github.com/TykTechnologies/tyk/releases)

#### Changelog {#Changelog-v5.3.11}

##### Added 

<ul>
<li>
<details>
<summary>Added GODEBUG Flags for Backward Compatibility with Deprecated Ciphers</summary>

We have added GODEBUG flags to enable deprecated insecure ciphers by default for backward compatibility. Existing users will not be affected. New users or those who wish to override these settings can do so at runtime using environment variables.
</details>
</li>
</ul>

##### Fixed

<ul>
<li>
<details>
<summary>Fixed Inconsistent Context Behavior in UDG APIs</summary>

Fixed a bug where headers being sent upstream in UDG APIs were not being cached accurately, ensuring correct and consistent context handling for all requests.
</details>
</li>
<li>
<details>
<summary>Improved Route Matching Logic for API Requests</summary>

Resolved an issue where some API requests were routed incorrectly due to path sorting not prioritizing specific routes over parameterized ones.
</details>
</li>
<li>
<details>
<summary>Resolved Incorrect Timeout Application for Specific API Endpoints</summary>

Fixed an issue where proxy_default_timeout for specific API endpoints were not being applied correctly, causing requests to use the global timeout instead.
</details>
</li>
<li>
<details>
<summary>Fixed race condition in gateway license allocation</summary>

Resolved a race condition in gateway license allocation that occasionally allowed more or fewer gateways than licensed to register and serve traffic.
</details>
</li>
<li>
<details>
<summary>Multi-Value Response Headers in Coprocess Middleware</summary>

Multi-value response headers were previously lost after synchronization with coprocess middleware, as only the first value was retained. This has been resolved, ensuring all response headers are properly synchronized and preserved
</details>
</li>
</ul>
    Consistency of Versioning

    The section header and changelog refer to 5.3.10 and 5.3.11 in close proximity. Confirm that all references to version numbers, release dates, and download links are consistent and correct for 5.3.11.

     
    ### 5.3.10 Release Notes

#### Release Date XXX

#### Release Highlights

This release focuses mainly on bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.3.11" >}}) below.

#### Breaking Changes

This release has no breaking changes.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
|----    |---- |---- |
| 5.3.11 | MDCB v2.8.0     | MDCB v2.8.0 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.0    | Sync v2.1.0 |
|         | Helm Chart v3.0  | Helm all versions |
| | EDP v1.13 | EDP all versions |
| | Pump v1.12.0 | Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| ------------------------------------------------------------ | ---------------------- | ---------------------- | -------- | 
| [Go](https://go.dev/dl/)                                     | 1.23  |  1.23  | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.23 | 
| [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 "api-management/gateway-config-tyk-oas" >}}) |

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.3.11}

If you are upgrading to 5.3.11, please follow the detailed [upgrade instructions](#upgrading-tyk).

#### Downloads

- [Docker image to pull](https://hub.docker.com/r/tykio/tyk-gateway/tags?page=&page_size=&ordering=&name=v5.3.11)
  - ```bash
    docker pull tykio/tyk-gateway:v5.3.11
    ``` 
- Helm charts
  - [tyk-charts v3.0.0]({{<ref "developer-support/release-notes/helm-chart#300-release-notes" >}})

- [Source code tarball for OSS projects](https://github.com/TykTechnologies/tyk/releases)

#### Changelog {#Changelog-v5.3.11}

##### Added 

<ul>
<li>
<details>
<summary>Added GODEBUG Flags for Backward Compatibility with Deprecated Ciphers</summary>

We have added GODEBUG flags to enable deprecated insecure ciphers by default for backward compatibility. Existing users will not be affected. New users or those who wish to override these settings can do so at runtime using environment variables.
</details>
</li>
</ul>

##### Fixed

<ul>
<li>
<details>
<summary>Fixed Inconsistent Context Behavior in UDG APIs</summary>

Fixed a bug where headers being sent upstream in UDG APIs were not being cached accurately, ensuring correct and consistent context handling for all requests.
</details>
</li>
<li>
<details>
<summary>Improved Route Matching Logic for API Requests</summary>

Resolved an issue where some API requests were routed incorrectly due to path sorting not prioritizing specific routes over parameterized ones.
</details>
</li>
<li>
<details>
<summary>Resolved Incorrect Timeout Application for Specific API Endpoints</summary>

Fixed an issue where proxy_default_timeout for specific API endpoints were not being applied correctly, causing requests to use the global timeout instead.
</details>
</li>
<li>
<details>
<summary>Fixed race condition in gateway license allocation</summary>

Resolved a race condition in gateway license allocation that occasionally allowed more or fewer gateways than licensed to register and serve traffic.
</details>
</li>
<li>
<details>
<summary>Multi-Value Response Headers in Coprocess Middleware</summary>

Multi-value response headers were previously lost after synchronization with coprocess middleware, as only the first value was retained. This has been resolved, ensuring all response headers are properly synchronized and preserved
</details>
</li>
</ul>

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @netlify Netlify
    Copy link

    netlify bot commented Apr 22, 2025 •
    edited
    Loading

    ✅ PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 265f63f
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6807757a55e9810009fb86d7
    😎 Deploy Preview https://deploy-preview-6329--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @sharadregoti sharadregoti Awaiting requested review from sharadregoti

    @andyo-tyk andyo-tyk Awaiting requested review from andyo-tyk

    At least 1 approving review is required to merge this pull request.

    Assignees
    No one assigned
    Labels
    5.3.11 Release Notes requires peer review Review effort 2/5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    1 participant
    @Eopayemi