From 6428e9698d2f5f8346de8427994c0b2912f27131 Mon Sep 17 00:00:00 2001 From: Eopayemi <157506568+Eopayemi@users.noreply.github.com> Date: Fri, 25 Oct 2024 16:27:48 +0100 Subject: [PATCH] Update 5.0.15 (#5670) * update * updates * updates final * update * Remove unwanted changes --------- Co-authored-by: Sharad Regoti (cherry picked from commit 37d6c08cabfc2ce331db77740501a81638d65c5a) --- .../release-notes/version-5.0.md | 2 +- .../release-notes/version-5.3.md | 2 +- .../release-notes/version-5.6.md | 310 ++++++++++++++++++ .../tyk-gateway/release-notes/version-5.0.md | 15 - 4 files changed, 312 insertions(+), 17 deletions(-) create mode 100644 tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.6.md diff --git a/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.0.md b/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.0.md index 7e2a66e759..7fd50d8a4d 100644 --- a/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.0.md +++ b/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.0.md @@ -274,4 +274,4 @@ Please refer to the [upgrading Tyk]({{< ref "upgrading-tyk" >}}) page for furthe - [Postman Collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/collection/27225007-374cc3d0-f16d-4620-a435-68c53553ca40) ### 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. +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. \ No newline at end of file diff --git a/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.3.md b/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.3.md index aa68041293..f9b4a4ab50 100644 --- a/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.3.md +++ b/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.3.md @@ -1329,4 +1329,4 @@ If there were changes in any of Tyk’s API docs: - [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. +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. \ No newline at end of file diff --git a/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.6.md b/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.6.md new file mode 100644 index 0000000000..e3e0c45091 --- /dev/null +++ b/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.6.md @@ -0,0 +1,310 @@ +--- +title: Tyk Dashboard 5.6 Release Notes +date: 2024-10-08T15:51:11Z +description: "Release notes documenting updates, enhancements, and changes for Tyk Dashboard versions within the 5.6.X series." +tags: ["Tyk Dashboard", "Release notes", "v5.6", "5.6.0", "5.6", "changelog"] +--- + + +**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.1 Release Notes + +### Release Date 18 October 2024 + +### Release Highlights + +This is a version bump to align with Gateway v5.6.1, no changes have been implemented in this release. + +### Breaking Changes + +There are no breaking changes in this release. + +### Dependencies {#dependencies-5.6.1} + +#### Compatibility Matrix For Tyk Components + +| Dashboard Version | Recommended Releases | Backwards Compatibility | +|---- |---- |---- | +| 5.6.1 | MDCB v2.7.1 | MDCB v2.5.1 | +| | Operator v1.0.0 | Operator v0.17 | +| | Sync v2.0 | Sync v1.4.3 | +| | Helm Chart v2.1 | Helm all versions | +| | EDP v1.11 | EDP all versions | +| | Pump v1.11 | Pump all versions | +| | TIB (if using standalone) v1.5.1 | TIB all versions | + +#### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.6.1} + + +| 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" >}})| + +### Deprecations + +There are no deprecations in this release. + +### Upgrade instructions {#upgrade-5.6.1} + +If you are upgrading to 5.6.1, 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.6.1) +- ```bash + docker pull tykio/tyk-dashboard:v5.6.1 + ``` +- Helm charts + - [Tyk Charts v2.0.0]({{}}) + +### Changelog {#Changelog-v5.6.1} + +No changes in this release. + + +--- +## 5.6.0 Release Notes + +### Release Date 10 October 2024 + +### Release Highlights + +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 + +Now you can configure rate limits at the [endpoint level per client]({{< ref "getting-started/key-concepts/rate-limiting#key-level-rate-limiting" >}}), using new configuration options in the access key. Use Tyk's powerful [security policies]({{< ref "getting-started/key-concepts/what-is-a-security-policy" >}}) to create templates to set appropriate rate limits for your different categories of user. + +#### Go upgrade to 1.22 + +We’ve upgraded the Tyk Dashboard to Golang 1.22, bringing improved performance, better security, and enhanced stability to the core system. + +#### Strengthened Role-Based Access Controls (RBAC) to combat privilege escalation risks + +We’ve tightened up the rules that govern a user's ability to create admin users and to reset other users' passwords when using Tyk's RBAC function. Now, only super-admins can create new admins, admin roles can't be assigned to user groups, and only admin users can reset another user's password (and only within their Tyk organization). + +### Breaking Changes + + +There are no breaking changes in this release. + +### Dependencies {#dependencies-5.6.0} + +#### Compatibility Matrix For Tyk Components + +| Dashboard Version | Recommended Releases | Backwards Compatibility | +|---- |---- |---- | +| 5.6.0 | MDCB v2.7.1 | MDCB v2.5.1 | +| | Operator v1.0.0 | Operator v0.17 | +| | Sync v2.0 | Sync v1.4.3 | +| | Helm Chart v2.1 | Helm all versions | +| | EDP v1.11 | EDP all versions | +| | Pump v1.11 | Pump all versions | +| | TIB (if using standalone) v1.5.1 | TIB all versions | + +#### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.6.0} + + +| 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" >}})| + +### 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). + +### Downloads +- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.6.0) +- ```bash + docker pull tykio/tyk-dashboard:v5.6.0 + ``` +- Helm charts + - [tyk-charts v2.1.0]({{}}) + +### Changelog {#Changelog-v5.6.0} + +#### Added + +
    +
  • +
    +Per endpoint client rate limiting + +Building on the [per-endpoint upstream rate limits]({{< ref "getting-started/key-concepts/rate-limiting#api-level-rate-limiting" >}}) introduced in Tyk 5.5.0 we have now added [per-endpoint client rate limits]({{< ref "getting-started/key-concepts/rate-limiting#key-level-rate-limiting" >}}). This new feature allows for more granular control over client consumption of API resources by associating the rate limit with the access key, enabling you to manage and optimize API usage more effectively. +
    +
    • +
+ +#### Changed + + +
    +
  • +
    +Upgrade to Go 1.22 for Tyk Dashboard + +The Tyk Dashboard has 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. +
    +
    • +
  • +
    +Improved documentation and schema for Tyk Dashboard API + +We have updated the swagger.yml schema for Tyk Dashboard API to reflect the latest changes in product endpoints, payloads, and responses. This update includes new fields and endpoints, improved examples, documentation adjustments, and fixes for schema issues. These enhancements aim to improve usability and ensure that the documentation accurately represents the current code state. +
    +
    • + +
  • +
    +Renamed GraphQL "Playground" tab to "Playgrounds" + +The "Playground" tab in the GraphQL API Designer has been renamed to "Playgrounds." This change consolidates access to both internal and external playgrounds within a single section, offering a more streamlined and intuitive experience for API design and testing. +
    +
    • +
+ +#### Fixed + +
    +
  • +
    +Addressed some display issues in Dashboard Analytics and Classic Portal when using PostgreSQL storage + +- Resolved an issue where HTTP 429 status codes were not being displayed on the Activity Overview page. +- Fixed portal graphs by adding a default "day" grouping resolution to the query. +- Corrected issues with the Error Breakdown related to date parameters, ensuring accurate date handling and display. + +
    +
    • + +
  • +
    +Dashboard didn't display correctly if more than 10 policies assigned to a key + +We have resolved an issue where the Keys page would display a blank screen if a key was associated with more than 10 policies. The UI has been fixed to display the page properly, regardless of the number of policies attached to a key. + +
    +
    • + +
  • +
    +Dashboard UI did not prevent multiple versions of a Tyk Classic API from being assigned to a policy + +When working with Tyk Classic APIs, you cannot permit access to multiple versions of the same API from a single policy. We have fixed an issue in the Dashboard UI where users were able to attach multiple versions to a policy leading to an unusable policy. The UI now correctly prevents the addition of multiple versions of an API to a single policy. + +
    +
    • + +
  • +
    +Dashboard didn't correctly record scope to policy mappings for JWTs + +We have fixed an issue in the Dashboard UI when assigning multiple claim to policy mappings while configuring JWT auth for an API. The scope name was incorrectly recorded instead of the policy ID for the second and subsequent JWT scope mappings. The UI now correctly associates the defined claim with the appropriate policy, ensuring accurate JWT scope to policy mappings. + +
    +
    • + +
  • +
    +Gateway logs page not displaying correctly + +We have fixed an issue in the Monitoring section of the Dashboard UI where the *Gateway logs* page was not displaying correctly. The page is now rendered properly, ensuring users with appropriate permissions can view and manage *Gateway logs* as expected. + +
    +
    • + +
+ + + +--- + + + + +## Further Information + +### Upgrading Tyk +Please refer to the [upgrading Tyk]({{< ref "upgrading-tyk" >}}) page for further guidance on the upgrade strategy. + +### API Documentation + +- [OpenAPI Document]({{}}) +- [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. + + + diff --git a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.0.md b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.0.md index 56ff3f1c36..556a7e44b0 100644 --- a/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.0.md +++ b/tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.0.md @@ -67,21 +67,6 @@ In version 5.0.14, Tyk Gateway could encounter panic when attempting to reconnec -#### Security Fixes - -
    -
  • -
    -Strengthened RBAC password reset permissions -We have fixed a privilege escalation vulnerability where a user with certain permissions could potentially reset other users’ passwords, including admin accounts. The following changes have been made to tighten the behavior of the password reset permission: -- All users can reset their own passwords -- A specific permission is required to reset the password of another user within the same Tyk organization -- This permission can only be assigned by an admin or super-admin -- This permission can only be assigned to an admin and cannot be assigned to a user group -
    -
    • -
- --- ## 5.0.14 Release Notes {#rn-v5.0.14}