diff --git a/tyk-docs/content/developer-support/release-notes/dashboard.md b/tyk-docs/content/developer-support/release-notes/dashboard.md index 9245297155..9ed7c3ceae 100644 --- a/tyk-docs/content/developer-support/release-notes/dashboard.md +++ b/tyk-docs/content/developer-support/release-notes/dashboard.md @@ -35,6 +35,414 @@ Our minor releases are supported until our next minor comes out. --- +## 5.10 Release Notes + +### 5.10.0 Release Notes + +#### Release Date 13th October 2025 + +#### Release Highlights + +For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.10.0" >}}). + +##### Streamlined API Versioning Experience + +The Tyk Dashboard now provides a completely redesigned versioning experience for Tyk OAS APIs, making API version management intuitive and efficient through guided workflows and centralized controls. + +**Intuitive version creation** + +- **Step-by-step wizard**: Guided process for creating new API versions with clear configuration options at each step +- **Smart configuration cloning**: Choose to inherit settings from existing versions or start fresh +- **Flexible publishing**: Control version activation and Gateway deployment during creation +- **Pre-configuration support**: Set up versioning parameters before creating any versions, preparing APIs for future versioning needs + +**Centralized version management** + +- **Unified "Versions" tab**: Single location to view and manage all aspects of API versioning +- **Clear configuration visibility**: Version identifier settings, proxy options, and version lists displayed in one organized interface +- **Inline editing**: Modify version names and configuration directly without navigating between screens +- **Consistent experience**: Same interface and capabilities whether working with base or child APIs + +**Key benefits** + +- Eliminate confusion around version setup and management +- Reduce time spent navigating between different configuration screens +- Enable proactive versioning preparation for future API evolution +- Provide clear visibility into version configuration and relationships + +Perfect for teams managing multiple API versions or planning version rollout strategies, this enhancement makes API versioning accessible to users of all experience levels while maintaining the power and flexibility that advanced users require. + + +##### Certificate Expiry Monitoring and Notifications + +The Tyk Dashboard now provides proactive certificate lifecycle management to help prevent service outages caused by expired mTLS certificates. + +Proactive monitoring capabilities: +- **Event-driven alerts**: Certificate expiry events are now available in the Tyk OAS API Designer for webhook and event handler configuration +- **Dashboard API notifications**: New endpoint provides programmatic access to certificate status information + - **Smart monitoring**: Automatic detection of certificates approaching expiry or already expired with configurable warning thresholds + - **Duplicate prevention**: Intelligent notification system prevents alert flooding while ensuring visibility + +**Key benefits** + +- Prevent unexpected API outages due to expired certificates +- Enable automated certificate renewal workflows through event handlers +- Provide clear visibility into certificate health across your API infrastructure +- Support integration with existing monitoring and alerting systems + +Perfect for organizations managing multiple certificates across complex API infrastructures where manual certificate tracking becomes impractical. + +For more details, please see the dedicated [Gateway events]({{< ref "api-management/gateway-events" >}}) section. + +#### Breaking Changes + +There are no breaking changes in this release. + +#### Dependencies {#dependencies-5.10.0} + +| Dashboard Version | Recommended Releases | Backwards Compatibility | +|--------|-------------------|-------------| +| 5.10.0 | MDCB v2.8.5 | MDCB v2.8.5 | +| | Operator v1.2.0 | Operator v0.17 | +| | Sync v2.1.3 | Sync v2.1.0 | +| | Helm Chart v4.0 | Helm all versions | +| | EDP v1.14.1 | EDP all versions | +| | Pump v1.12.2 | Pump all versions | +| | TIB (if using standalone) v1.7.0 | TIB all versions | + +##### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.10.0} + +| Third Party Dependency | Tested Versions | Compatible Versions | Comments | +| ---------------------- | --------------- | ------------------- | -------- | +| [GoLang](https://go.dev/dl/) | 1.24 | 1.24 | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.24 | +| [Redis](https://redis.io/download/) | 5.x, 6.x, 7.x | 5.x, 6.x, 7.x | | +| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x | 7.2.x, 8.0.x, 8.1.x | | +| [MongoDB](https://www.mongodb.com/try/download/community) | 6, 7, 8 | 5, 6, 7, 8 | | +| [DocumentDB](https://aws.amazon.com/documentdb/) | 4, 5 | 4, 5 | | +| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x | | +| [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#tyk-vendor-extension-reference" >}})| + +#### Deprecations + +There are no deprecations in this release. + +#### Upgrade instructions {#upgrade-5.10.0} + +If you are upgrading to 5.10.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.10.0) + - ```bash + docker pull tykio/tyk-dashboard:v5.10.0 + ``` +- Helm charts + - [tyk-charts v4.0.0]({{< ref "developer-support/release-notes/helm-chart#400-release-notes" >}}) + +Please note that the Tyk Helm Charts are configured to install the LTS version of Tyk Dashboard. You will need to modify them to install v5.10.0. + +#### Changelog {#Changelog-v5.10.0} + +##### Added + + + +##### Changed + + + + +##### Fixed + + + +##### Security Fixes + + + ## 5.9 Release Notes ### 5.9.2 Release Notes diff --git a/tyk-docs/content/developer-support/release-notes/gateway.md b/tyk-docs/content/developer-support/release-notes/gateway.md index 16aa58deb1..d756639e43 100644 --- a/tyk-docs/content/developer-support/release-notes/gateway.md +++ b/tyk-docs/content/developer-support/release-notes/gateway.md @@ -41,6 +41,417 @@ aliases: Our minor releases are supported until our next minor comes out. --- +## 5.10 Release Notes + +### 5.10.0 Release Notes + +#### Release Date 13th October 2025 + +#### Release Highlights + +For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.10.0" >}}). + +##### OpenAPI Compliant Multi-Authentication for Tyk OAS APIs + +Tyk Gateway now supports true OpenAPI specification compliant authentication workflows, giving developers the flexibility to implement industry-standard security patterns while maintaining backward compatibility. + +OpenAPI compliant authentication brings: + +- **Multiple authentication paths**: Process all entries in the OpenAPI `security` section, not just the first one +- **Flexible security combinations**: Enable authentication scenarios like "OAuth2 OR Auth Token" where clients can choose their preferred method +- **Proprietary method integration**: Seamlessly combine standard OpenAPI authentication with Tyk's proprietary methods (Custom Authentication plugin, HMAC) using the same flexible logic +- **Standards compliance**: Follow OpenAPI security specification patterns that developers expect + +Backward compatibility guaranteed: + +- **Legacy mode preserved**: Existing APIs continue to work unchanged with the current AND-only logic +- **Opt-in enhancement**: Switch to compliant mode via the `securityProcessingMode` configuration when ready +- **No breaking changes**: Existing multi-security configurations remain functional + +**Real-world applications** + +- Support diverse client authentication capabilities within the same API +- Implement progressive authentication strategies (basic → advanced security) +- Align with OpenAPI tooling and documentation expectations +- Reduce integration complexity for API consumers + +Perfect for organizations wanting to leverage standard OpenAPI security patterns while maintaining the flexibility of Tyk's advanced authentication features. + +For more details, please see the dedicated [Multi Auth]({{< ref "basic-config-and-security/security/authentication-authorization/multiple-auth/" >}}) section. + +##### Comprehensive JWT Claim Validation for Tyk OAS APIs + +Tyk Gateway now provides enterprise-grade JWT validation capabilities exclusively for Tyk OAS APIs, enabling complete control over token validation beyond basic expiry and signature checks. + +**Complete registered claim validation** + +- **Multi-Identity Provider support**: Validate issuer, audience, and subject claims against multiple allowed values +- **Flexible claim mapping**: Configure different claim names for subject, policy, and scope mapping to support various Identity Providers (Keycloak, Okta, Auth0, etc.) within the same API +- **JWT ID enforcement**: Require unique token identifiers for enhanced security + +**Advanced custom claim validation** + +- **Flexible validation rules**: Define validation for any JWT claim using required, exact match, or containment rules +- **Rich data type support**: Handle strings, numbers, booleans, and arrays with nested claim access using dot notation +- **Non-blocking validation**: Monitor claim compliance without rejecting requests, perfect for gradual policy enforcement + +**Real-world applications** + +- Role-based access control with custom permission claims +- Department or organization-based API access restrictions +- Multi-tenant scenarios with flexible claim validation +- Gradual migration from legacy authentication systems + +This enhancement makes Tyk's JWT middleware the primary validation mechanism for complex enterprise authentication scenarios, providing the flexibility needed for modern Identity Provider integrations while maintaining backward compatibility. + +Ideal for organizations that require sophisticated JWT validation beyond standard token checks. + +For more details, please see the dedicated [JWT Auth]({{< ref "basic-config-and-security/security/authentication-authorization/json-web-tokens#managing-authorization-with-jwt" >}}) section. + +##### Advanced JWKS Cache Management for Tyk OAS APIs + +Tyk Gateway now provides comprehensive JWKS (JSON Web Key Set) cache control for Tyk OAS APIs, delivering significant performance improvements and operational flexibility for JWT validation workflows with: + +- **Configurable cache timeouts**: Set custom cache durations per Identity Provider to match their key rotation schedules +- **On-demand cache invalidation**: Instantly refresh cached keys for any API (Classic or OAS) when Identity Providers rotate their signing keys +- **Intelligent pre-fetching**: Eliminate first-request latency by fetching JWKS data during Tyk OAS API initialization + +**Key benefits** + +- Faster JWT validation with reduced Identity Provider round-trips +- Zero cold-start delays for JWT-protected endpoints +- Immediate response to Identity Provider key rotations +- Better performance in high-traffic JWT validation scenarios + +This enhancement is particularly valuable for organizations migrating to Tyk OAS APIs or those requiring consistent low-latency JWT validation performance with multiple Identity Providers that have different key rotation policies. + +For more details, please see the [JWT Auth]({{< ref "basic-config-and-security/security/authentication-authorization/json-web-tokens#jwt-signatures" >}}) section. + +##### Centralized External Service Configuration + +Tyk Gateway now provides unified configuration for all external service connections through the new +`external_services` section. This enhancement brings together previously scattered and incomplete configuration options into a single, coherent system that supports: + +- **Proxy configuration**: Apply proxy settings globally or per service, with automatic support for standard environment variables (`HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY`) +- **mTLS certificate management**:Centralized certificate configuration for secure connections to external services +- **Comprehensive service coverage**: Covers all external integrations, including databases, OAuth providers, and webhook endpoints + +This improvement simplifies deployment in enterprise environments where proxy servers and certificate management are critical, while maintaining full backward compatibility with existing configurations. + +**Key benefits** +- Reduced configuration complexity and duplication +- Better security through centralized certificate management +- Simplified proxy configuration for containerized deployments +- Consistent external service connection handling across all Tyk components + +For more details, please see the dedicated [section]({{< ref "configure/external-service" >}}). + +##### Proactive Certificate Expiry Monitoring + +Tyk Gateway now automatically monitors certificate health and proactively alerts administrators before certificates expire, helping prevent service outages caused by expired mTLS certificates. + +The new certificate monitoring system provides: + +- **Early warning notifications**: Configurable alerts when certificates approach expiry (default: 30 days) +- **Immediate expiry detection**: Real-time notifications when expired certificates are detected in use +- **Comprehensive coverage**: Monitors certificates used in both client-to-Gateway and Gateway-to-upstream connections +- **Smart throttling**: Built-in cooldown mechanisms prevent alert flooding while ensuring visibility + +These events integrate seamlessly with existing monitoring and alerting systems through Tyk's standard event framework, enabling teams to set up automated workflows for certificate renewal and replacement. + +**Key benefits** + +- Prevent unexpected API outages due to expired certificates +- Reduce manual certificate monitoring overhead +- Enable proactive certificate lifecycle management +- Improve overall API reliability and uptime + +Perfect for organizations managing multiple certificates across complex API infrastructures where manual tracking becomes impractical. + +For more details, please see the dedicated [Gateway events]({{< ref "api-management/gateway-events" >}}) section. + +#### Breaking Changes + +There are no breaking changes in this release. + +#### Dependencies {#dependencies-5.10.0} + +##### Compatibility Matrix For Tyk Components + +| Gateway Version | Recommended Releases | Backwards Compatibility | +|--------|-------------------|---- | +| 5.10.0 | MDCB v2.8.5 | MDCB v2.8.5 | +| | Operator v1.2.0 | Operator v0.17 | +| | Sync v2.1.3 | Sync v2.1.0 | +| | Helm Chart v4.0 | Helm all versions | +| | Pump v1.12.2 | Pump all versions | + +##### 3rd Party Dependencies & Tools + +| Third Party Dependency | Tested Versions | Compatible Versions | Comments | +| ---------------------- | --------------- | ------------------- | -------- | +| [Go](https://go.dev/dl/) | 1.24 | 1.24 | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.24 | +| [Redis](https://redis.io/download/) | 6.2.x, 7.x, 7.4.x | 6.2.x, 7.x, 7.4.x | | +| [Valkey](https://valkey.io/download/) | 7.2.x, 8.0.x, 8.1.x | 7.2.x, 8.0.x, 8.1.x | | +| [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.10.0} + +If you are upgrading to 5.10.0, 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.10.0) + - ```bash + docker pull tykio/tyk-gateway:v5.10.0 + ``` +- Helm charts + - [tyk-charts v4.0.0]({{}}) + +Please note that the Tyk Helm Charts are configured to install the LTS version of Tyk Gateway. You will need to modify them to install v5.10.0. + +- [Source code tarball of Tyk Gateway v5.10.0](https://github.com/TykTechnologies/tyk/releases/tag/v5.10.0) + +#### Changelog {#Changelog-v5.10.0} + +##### Added + + + +##### Changed + + + +##### Fixed + + ## 5.9 Release Notes diff --git a/tyk-docs/data/releases/dashboard.json b/tyk-docs/data/releases/dashboard.json index 9c480d197b..938cebc6d3 100644 --- a/tyk-docs/data/releases/dashboard.json +++ b/tyk-docs/data/releases/dashboard.json @@ -1,9 +1,13 @@ { "home": "tyk-dashboard", "licensed": true, - "latest": "5.9.2", + "latest": "5.10.0", "lts": "5.8.6", "releaseNotesPath": "developer-support/release-notes/dashboard", + "5.10.0": { + "date": "04/09/2025", + "docker": "https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=1&name=v5.10.0" + }, "5.9.2": { "date": "04/09/2025", "docker": "https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=1&name=v5.9.2" diff --git a/tyk-docs/data/releases/gateway.json b/tyk-docs/data/releases/gateway.json index 25db9c0abb..228318e632 100644 --- a/tyk-docs/data/releases/gateway.json +++ b/tyk-docs/data/releases/gateway.json @@ -1,9 +1,14 @@ { "home": "tyk-oss-gateway", "licensed": false, - "latest": "5.9.2", + "latest": "5.10.0", "lts": "5.8.6", "releaseNotesPath": "developer-support/release-notes/gateway", + "5.10.0": { + "date": "04/09/2025", + "tag": "https://github.com/TykTechnologies/tyk/releases/tag/v5.10.0", + "docker": "https://hub.docker.com/r/tykio/tyk-gateway/tags?page=1&name=v5.10.0" + }, "5.9.2": { "date": "04/09/2025", "tag": "https://github.com/TykTechnologies/tyk/releases/tag/v5.9.2",