Skip to content
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.

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

[DX-1781] Release notes for 5.3.9 #5826

Open
wants to merge 40 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
2166409
5.3.9
Eopayemi Dec 16, 2024
925e681
Update tyk-docs/content/developer-support/release-notes/dashboard.md
sharadregoti Dec 17, 2024
55372fb
Merge branch 'master' into release-5.3.9
sharadregoti Dec 17, 2024
03152ef
change log
Eopayemi Dec 18, 2024
4c34b17
Update tyk-docs/content/developer-support/release-notes/dashboard.md
Eopayemi Dec 18, 2024
70c81b7
Update tyk-docs/content/developer-support/release-notes/gateway.md
Eopayemi Dec 18, 2024
78b0210
chng
Eopayemi Dec 18, 2024
d25c070
chng
Eopayemi Dec 18, 2024
e4cbc5a
add
Eopayemi Dec 18, 2024
38abd4b
Update tyk-docs/content/developer-support/release-notes/dashboard.md
Eopayemi Dec 19, 2024
494b1fb
Update tyk-docs/content/developer-support/release-notes/dashboard.md
Eopayemi Dec 19, 2024
1117a28
Update tyk-docs/content/developer-support/release-notes/dashboard.md
Eopayemi Dec 19, 2024
c64bf32
Update tyk-docs/content/developer-support/release-notes/dashboard.md
Eopayemi Dec 19, 2024
0302655
Update tyk-docs/content/developer-support/release-notes/dashboard.md
Eopayemi Dec 19, 2024
918ba99
Update tyk-docs/content/developer-support/release-notes/dashboard.md
Eopayemi Dec 19, 2024
e3e5b87
Update tyk-docs/content/developer-support/release-notes/dashboard.md
Eopayemi Dec 19, 2024
0129d1c
Update tyk-docs/content/developer-support/release-notes/gateway.md
Eopayemi Dec 19, 2024
0310e6a
Update tyk-docs/content/developer-support/release-notes/gateway.md
Eopayemi Dec 19, 2024
32b1356
Update tyk-docs/content/developer-support/release-notes/gateway.md
Eopayemi Dec 19, 2024
3f275b1
Update tyk-docs/content/developer-support/release-notes/gateway.md
Eopayemi Dec 19, 2024
a913461
Update gateway.md
Eopayemi Dec 19, 2024
1cbda79
Update tyk-docs/content/developer-support/release-notes/gateway.md
Eopayemi Dec 19, 2024
dabb48f
Update tyk-docs/content/developer-support/release-notes/gateway.md
Eopayemi Dec 19, 2024
f0f19c1
Update tyk-docs/content/developer-support/release-notes/gateway.md
Eopayemi Dec 19, 2024
e6d7e1d
Update gateway.md
Eopayemi Dec 19, 2024
763e4d8
Update gateway.md
Eopayemi Dec 19, 2024
103fd85
Update gateway.md
Eopayemi Dec 19, 2024
4d82b7d
Update dashboard.md
Eopayemi Dec 19, 2024
52ad016
add
Eopayemi Dec 19, 2024
05e063b
r
Eopayemi Dec 19, 2024
198b031
l
Eopayemi Dec 19, 2024
894c8e9
Update dashboard.md
Eopayemi Dec 19, 2024
d6195a0
o
Eopayemi Dec 19, 2024
2bbfb3d
Update gateway.md
Eopayemi Dec 19, 2024
8d02916
Update dashboard.md
Eopayemi Dec 19, 2024
978f48d
Update dashboard.md
Eopayemi Dec 19, 2024
7f7cd1d
Update gateway.md
Eopayemi Dec 19, 2024
f3b86cc
Update tyk-docs/content/developer-support/release-notes/dashboard.md
andyo-tyk Dec 20, 2024
2a019d9
Update gateway.md
Eopayemi Dec 20, 2024
dd1fc75
Update gateway.md
Eopayemi Dec 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions tyk-docs/content/developer-support/release-notes/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -1073,6 +1073,105 @@ Fixed the following high priority CVEs identified in the Tyk Dashboard, providin


## 5.3 Release Notes

### 5.3.9 Release Notes
sharadregoti marked this conversation as resolved.
Show resolved Hide resolved

#### Release Date xxx

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

#### Breaking Changes

This release has no breaking changes.

#### Dependencies {#dependencies-5.3.9}

##### Compatibility Matrix For Tyk Components
<!-- Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. -->
| Dashboard Version | Recommended Releases | Backwards Compatibility |
|---- |---- |---- |
| 5.3.9 | MDCB v2.5.1 | MDCB v2.5.1 |
| | Operator v0.17 | Operator v0.16 |
| | Sync v1.4.3 | Sync v1.4.3 |
| | Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v2.0.0 | Helm all versions |
| | EDP v1.8.3 | EDP all versions |
| | Pump v1.9.0 | Pump all versions |
| | TIB (if using standalone) v1.5.1 | TIB all versions |


##### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.3.9}
<!-- Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. -->

| Third Party Dependency | Tested Versions | Compatible Versions | Comments |
| ---------------------------------------------------------- | ---------------------- | ---------------------- | -------- |
| [GoLang](https://go.dev/dl/) | 1.22 | 1.22 | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 |
| [Redis](https://redis.io/download/) | 6.2.x, 7.x | 6.2.x, 7.x | Used by Tyk Dashboard |
| [MongoDB](https://www.mongodb.com/try/download/community) | 5.0.x, 6.0.x, 7.0.x | 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard |
| [PostgreSQL](https://www.postgresql.org/download/) | 12.x - 16.x LTS | 12.x - 16.x | Used by Tyk Dashboard |
| [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 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
We have deprecated the obsolescent `http_server_options.prefer_server_ciphers` configuration option. This legacy control no longer has any effect on the underlying library and users are advised to remove this setting from their configurations.

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

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

#### Changelog {#Changelog-v5.3.9}
<!-- Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" -->

##### Fixed
<!-- This section should be a bullet point list of new features. Explain:

- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. -->

<ul>
<li>
<details>
<summary>Fixed Issue with Restore Zooming in API Activity Dashboard</summary>

Resolved a bug where clicking "Restore zooming to initial state" in the API Activity Dashboard would cause the graph to show blank instead of resetting to the initial zoom level. This fix ensures that users can now correctly restore the default zoom state in all charts on the Dashboard.
</details>
</li>
<li>
<details>
<summary>Deprecation of http_server_options.prefer_server_ciphers</summary>

This option has been marked as deprecated due to its obsolescence in the underlying library functions used by Tyk. Users are advised to remove this configuration from their setups as it no longer has any effect.
</details>
</li>
<li>
<details>
<summary>CVE-2020-8911 resolved in Tyk Dashboard</summary>

Resolved CVE-2020-8911 by updating the Tyk Dashboard's email driver to use AWS SDK v2, addressing a medium-severity security vulnerability identified in version 5.3.8. This update ensures enhanced security for the Dashboard while maintaining functionality.
</details>
</li>
</ul>

---

### 5.3.8 Release Notes

#### Release Date 07 November 2024
Expand Down
149 changes: 149 additions & 0 deletions tyk-docs/content/developer-support/release-notes/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -1333,6 +1333,155 @@ links to API documentation and FAQs. You can copy it from the previous release.

## 5.3 Release Notes

### 5.3.9 Release Notes

#### Release Date xxx

#### Release Highlights

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

#### Breaking Changes

This release has no breaking changes.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
| --------------- | ------------------------------------------------------------------ | ----------------------- |
| 5.3.9 | MDCB v2.5.1 | MDCB v2.5.1 |
| | Operator v0.17 | Operator v0.16 |
| | Sync v1.4.3 | Sync v1.4.3 |
| | Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v2.0.0 | Helm all versions |
| | EDP v1.8.3 | EDP all versions |
| | Pump v1.9.0 | 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.22 (GW) | 1.22 (GW) | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 |
| [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

If you are upgrading to 5.3.9, 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.9)
- ```bash
docker pull tykio/tyk-gateway:v5.3.9
```
- Helm charts
- [tyk-charts v2.0.0]({{<ref "developer-support/release-notes/helm-chart#200-release-notes">}})
- [Source code tarball for OSS projects](https://github.com/TykTechnologies/tyk/releases)

#### Changelog {#Changelog-v5.3.9}

##### Fixed

<ul>
<li>
<details>
<summary>Incomplete traffic logs generated if custom response plugin adjusts the payload length</summary>

Resolved an issue where the response body could be only partially recorded in the traffic log if a custom response plugin modified the payload. This was due to Tyk using the original, rather than the modified, content-length of the response when identifying the data to include in the traffic log.
</details>
</li>
<li>
<details>
<summary>Fixed OAuth client creation issue for custom plugin APIs in multi-data plane deployments</summary>

Fixed a bug that prevented the control plane Gateway from loading APIs that use custom plugin bundles. The control plane Gateway is used to register OAuth clients and generate access tokens so this could result in an API being loaded to the data plane Gateways but clients unable to obtain access tokens. This issue was introduced in v5.3.1 as a side-effect of a change to address a potential security issue where APIs could be loaded without their custom plugins.
</details>
</li>
<li>
<details>
<summary>Accurate debug logging restored for middleware</summary>

Addressed an issue where shared loggers caused debug logs to misidentify the middleware source, complicating debugging. Log entries now correctly indicate which middleware generated the log, ensuring clearer and more reliable diagnostics
</details>
</li>
<li>
<details>
<summary>Fixed Payload Issue with Transfer-Encoding: chunked Header</summary>

Resolved an issue where APIs using the Transfer-Encoding: chunked header alongside URL Rewrite or Validate Request middleware would lose the response payload body. The payload now processes correctly, ensuring seamless functionality regardless of header configuration.
</details>
</li>
<li>
<details>
<summary>API Keys remain active after all linked partitioned policies are deleted</summary>

Resolved an issue where API access keys remained valid even if all associated policies were deleted. The Gateway now attempts to apply all linked policies to the key when it is presented with a request. Warning logs are generated if any policies cannot be applied (for example, if they are missing). If no linked policy can be applied, the Gateway will reject the key to ensure no unauthorized access.
</details>
</li>
<li>
<details>
<summary>Resolved API routing issue with trailing slashes and overlapping listen paths</summary>
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
sharadregoti marked this conversation as resolved.
Show resolved Hide resolved

Fixed a routing issue that caused incorrect API matching when dealing with APIs that lacked a trailing slash, used custom domains, or had similar listen path patterns. Previously, the router prioritized APIs with longer subdomains and shorter listen paths, leading to incorrect matches when listen paths shared prefixes. This fix ensures accurate API matching, even when subdomains and listen paths overlap.
</details>
</li>
<li>
<details>
<summary>Improved Stability for APIs with Malformed Listen Paths</summary>

Fixed an issue where a malformed listen path could cause the Gateway to crash. Now, such listen paths are properly validated, and if validation fails, an error is logged, and the API is skipped—preventing Gateway instability.
</details>
</li>
<li>
<details>
<summary>Resolved Variable Input Handling for Custom Scalars in GraphQL Queries</summary>

Fixed an issue where GraphQL queries using variables for custom scalar types, such as UUID, failed due to incorrect input handling. Previously, the query would return an error when a variable was used but worked when the value was directly embedded in the query. This update ensures that variables for custom scalar types are correctly inferred and processed, enabling seamless query execution.
</details>
</li>
<li>
<details>
<summary>Fixed Gateway panic and SSE streaming issue with OpenTelemetry</summary>

Resolved a bug that prevented upstream server-sent events (SSE) from being sent when OpenTelemetry was enabled, and fixed a gateway panic that occurred when detailed recording was active while SSE was in use. This ensures stable SSE streaming in configurations with OpenTelemetry.
</details>
</li>
<li>
<details>
<summary>Fixed an issue where OAuth 2.0 access tokens would not be issued if the data plane was disconnected from the control plane</summary>

OAuth 2.0 access tokens can now be issued even when data plane gateways are disconnected from the control plane. This is achieved by saving OAuth clients locally within the data plane when they are pulled from RPC.
</details>
</li>
<li>
<details>
<summary>Tyk Now Supports RSA-PSS Signed JWTs</summary>

Tyk now supports RSA-PSS signed JWTs (PS256, PS384, PS512), enhancing security while maintaining backward compatibility with RS256. No configuration changes are needed—just use RSA public keys, and Tyk will validate both algorithms seamlessly.
</details>
</li>
<li>
<details>
<summary>Request size limit middleware would block any request without a payload (for example GET, DELETE)</summary>

Resolved a problem in the request size limit middleware that caused GET and DELETE requests to fail validation.The middleware incorrectly expected a request body (payload) for these methods and blocked them when none was present.
</details>
</li>
</ul>

---

### 5.3.8 Release Notes

#### Release Date 07 November 2024
Expand Down
Loading