Release v24.1 | Summer-Autumn 2025 | Globality release

[raman-m]

Summer-Autumn 2025 (version 24.1) aka Globality release

Milestone: Summer'25
Codenamed: Globality
Read the Docs: Ocelot 24.1 with PDF

ℹ️ About

In this minor release, the Ocelot team put the spotlight on the Configuration feature as part of their semi-annual 2025 effort, with a particular focus on the Global Configuration Schema. This release enhances support for global configurations across both routing modes: the classic static Routing and the service discovery-based Dynamic Routing.

The updated documentation highlights the deprecation of certain options through multiple notes and warnings. This deprecation process will be completed in the upcoming .NET 10 release. With the [Obsolete] attributes in place, C# developers will notice several warnings in the build logs during compilation.

On top of that, this release brings a great enhancement to the Kubernetes provider, also known as the Ocelot.Provider.Kubernetes package.

🆕 What's New?

• Configuration: The "Dynamic routing global configuration" feature has been redesigned by @raman-m and contributors.

  This update brings changes to the Dynamic Route Schema and Global Configuration Schema, while the Route Schema stays the same apart from deprecation updates. All work was coordinated under issue Dynamic routing global configuration #585, which addressed the challenges of configuring Ocelot's most popular features globally before version 24.1, when dynamic routing gained global configuration partial support, but static routing mostly lacked it. A key outcome of Dynamic routing global configuration #585 is the ability to override global configuration options within the DynamicRoutes collection. This ongoing issue will continue to require attention, as adapting static route global configurations for dynamic routing is complex and, in some cases, impossible. This will be a challenge for future Ocelot releases and the community.

• Kubernetes: The "Kubernetes provider based on watch requests" feature by @kick2nick in PR #2168 A brand-new WatchKube provider for Kubernetes service discovery #2174. ⭐

  The Ocelot.Provider.Kubernetes package now features a new WatchKube provider for Kubernetes service discovery. This provider is a great fit for high-load environments where the older Kube and PollKube providers struggle to handle heavy traffic, often leading to increased log errors, HTTP 500 issues, and potential Ocelot instance failures. WatchKube is the next step in the evolution of these providers, leveraging the reactive capabilities of the KubeClient API. For guidance on choosing the right provider for your Kubernetes setup, check out the "Comparing providers" section in the documentation.

• Configuration: The "Routing default timeout" feature by @hogwartsdeveloper in PR #1314 #1869 #2072 Default timeout for all levels, including route, global, and QoS #2073.

  In the past, the Timeout setting in the Route Schema didn't actually stop requests, defaulting instead to a fixed 90 seconds. Custom timeouts were handled using the Quality of Service Timeout strategy, and this only applied if Polly and the Ocelot.Provider.Polly package were used. Now, the Timeout option (in seconds) can be set at the route, global, and QoS levels. The Global Configuration Schema and Dynamic Route Schema also include the new Timeout setting, making it possible to configure default timeouts for dynamic routing as well.

• Quality of Service: The "FailureRatio and SamplingDuration parameters of Polly V8 circuit-breaker" feature by @RaynaldM in PR #2080 Add new FailureRatio and SamplingDuration V8 parameters to fine-tune Polly's circuit-breaker strategy via route-level and global QoS options #2081.

  Starting with version 24.1, two new parameters in QoSOptions, FailureRatio and SamplingDuration, let you fine-tune the behavior of the Circuit Breaker strategy. Both can be configured globally, even with dynamic routing.
  Please note that DurationOfBreak, ExceptionsAllowedBeforeBreaking, and TimeoutValue are now deprecated in 24.1, so check the QoSOptions Schema documentation for details.

🆙 What's Updated?

• Configuration: Several File-model options have been deprecated by @raman-m.

  The updated docs now highlight these deprecated options with multiple notes and warnings. The v24.1 deprecation process will wrap up in the upcoming .NET 10 release. Due to the Obsolete attributes, C# developers will notice several build warnings during compilation.

• Testing: The Ocelot.Testing project was deprecated by @raman-m in PR Deprecate the Ocelot.Testing project in favor of its NuGet package #2295

  The project was removed from the main repo and moved to its own Ocelot.Testing repository. This change allows the Ocelot.Testing package to be shared independently for extension package delivery. The Ocelot team also plans to deprecate more projects and move them to separate repos because: a) despite the fact that a monorepo enables faster builds and quicker delivery; b) but the release process can be delayed by missing versions of integrated libraries in extension packages. The goal is for the Ocelot repo to only contain essential projects, avoiding delays caused by integrated package release schedules. Legacy or abandoned integrated packages should be deprecated and maintained in their own repos with independent release cycles.

• Headers Transformation: Added global configuration by @marklonquist in PR #1658 Add global configuration for Headers Transformation #1659.

  The Global Configuration Schema now includes new DownstreamHeaderTransform and UpstreamHeaderTransform options. These work only with static routes, meaning the Routes collection (see Route Schema). They aren't supported for dynamic routes because they're not part of the Dynamic Route Schema, and Ocelot Core doesn't read global configuration of this feature in dynamic routing mode. This is noted in the Roadmap documentation.

• Authentication: Added global configuration by @jlukawska in PR #842 #1414 Introduce AllowAnonymous authentication option with global AuthenticationOptions configuration #2114.

  The Global Configuration Schema now includes a new AuthenticationOptions property for setting up static routes globally. This also introduces the AllowAnonymous boolean option within AuthenticationOptions to control static route authentication. Later, PR #585 #2316 Authentication global configuration #2336 extended global authentication support to dynamic routes.
  Note: The AuthenticationProviderKey option is deprecated in version 24.1—see the AuthenticationOptions Schema documentation for details.

• Rate Limiting: Re-designed global configuration by @MiladRv and @raman-m in PR #585 #1229 #1598 #1915 Rate limiting global configuration #2294.

  The Global Configuration Schema now includes a new RateLimitOptions property for both static and dynamic routes. Previously, global configuration was available through RateLimitOptions in dynamic routing mode, while route overriding used the now-deprecated RateLimitRule from the Dynamic Route Schema.
  This marks the second major overhaul of the Rate Limiting feature since the first update in PR #1590 Use correct interval for request counting #1592. A new Wait option has been added, replacing the deprecated PeriodTimespan, to enhance the Fixed Window algorithm. The full list of deprecated options can be found in the Deprecated Options documentation.

• Load Balancer: Added global configuration by @raman-m in PR #585 #2319 Load Balancer global configuration #2324.

  The Global Configuration Schema now includes a new LoadBalancerOptions property for both static and dynamic routes. Previously, global configuration was available through LoadBalancerOptions in dynamic routing mode without dynamic route overrides. Starting with version 24.1, the Dynamic Route Schema also supports LoadBalancerOptions for overriding, and global configuration for static routes is now supported as well.

• Caching: Added global configuration by @raman-m in PR #585 #2330 Caching global configuration #2331.

  The Global Configuration Schema now includes a new CacheOptions property for both static and dynamic routes. Global configuration has been available for static routes since version 23.3, but starting with version 24.1, the Dynamic Route Schema also supports CacheOptions for overriding.
  Note that the FileCacheOptions property in the Route Schema (static routes) is deprecated in version 24.1. For more details, see the caching Configuration documentation.

• Http Handler: Added global configuration by @raman-m in PR #585 #2320 Http handler global configuration #2332.

  The Global Configuration Schema now includes a new HttpHandlerOptions property for both static and dynamic routes. Previously, global configuration was available through HttpHandlerOptions in dynamic routing mode without dynamic route overriding. Starting with version 24.1, the Dynamic Route Schema also supports HttpHandlerOptions for overriding, and global configuration is now available for static routes as well.

• Authentication: Added global configuration by @raman-m in PR #585 #2316 Authentication global configuration #2336.

  The Global Configuration Schema now includes a new AuthenticationOptions property for both static and dynamic routes. Starting with version 24.1, the Dynamic Route Schema also supports AuthenticationOptions to override global settings.
  Note that the AuthenticationProviderKey option is deprecated in version 24.1, so check the AuthenticationOptions Schema documentation for details.

• Quality of Service: Added global configuration by @raman-m in PR #585 #2338 Quality of Service global configuration #2339.

  The Global Configuration Schema now includes a new QoSOptions property for both static and dynamic routes. Previously, global configuration was available through QoSOptions in dynamic routing mode without the option for dynamic route overrides. Starting with version 24.1, the Dynamic Route Schema supports QoSOptions for overriding, and global configuration support is now available for static routes as well.
  Note that the DurationOfBreak, ExceptionsAllowedBeforeBreaking, and TimeoutValue options are deprecated in version 24.1. For details, see the QoSOptions Schema documentation.

• DevOps: Stabilized tests and reviewed GH-Actions workflows by @raman-m in PRs Follow-up on #2335 and #2339: Stabilize flaky tests in the CI/CD environment #2342 and Pre-release 24.1 | +semver: patch #2345.

  These efforts kept the CI/CD builds in GitHub Actions stable, targeting the alpha release of version 24.1. The CI/CD environment was set up and tested GH-Actions workflows in advance for the beta release, which is the goal of PR #2343 Release 24.1 Beta | +semver: minor #2347.

📦 Patches

• Websockets: Issue The WebSocket is in an invalid state (Aborted) for this operation. Valid states are: Open, CloseReceived #930 patch by @hogwartsdeveloper in PR #930 Try to close WebSocket destination when state is Open or CloseReceived #2091.
  This update removes the troublesome System.Net.WebSockets.WebSocketException from logs, preventing Ocelot from running into 500 status disasters. The issue stemmed from client-side or network events that Ocelot's WebSocketsProxyMiddleware couldn't anticipate on the server side. The patch now checks for incorrect connection statuses, attempting to close the connection and end server-side tasks gracefully without errors.

• Kubernetes: Issue PollKube doesn't work at first request #2304 patch by @raman-m in PR #2304 Utilize ConcurrentQueue<T> for managing service versions during polling by the PollKube discovery provider #2335.
  This update fixes the PollKube provider to address a bug with the first cold request, where the winning thread got an empty collection before the initial callback was triggered. The solution is to call the integrated discovery provider for the first cold request when the queue is empty.

• Authorization: Issue AllowedScopes does not match string array in JWT scope claim #913 patch by @mehyaa in PR #913 Support RFC 8693 (OAuth 2.0 Token Exchange) for the "scope" claim in ScopesAuthorizer #1478.
  Starting with version 24.1, Ocelot now supports RFC 8693 (OAuth 2.0 Token Exchange) for the scope claim in the ScopesAuthorizer service, also referred to as the IScopesAuthorizer service in the DI container.

Features

• Deprecate the Ocelot.Testing project in favor of its NuGet package #2295
• #930 Try to close WebSocket destination when state is Open or CloseReceived #2091
• #2168 A brand-new WatchKube provider for Kubernetes service discovery #2174
• #1314 #1869 #2072 Default timeout for all levels, including route, global, and QoS #2073
• #2080 Add new FailureRatio and SamplingDuration V8 parameters to fine-tune Polly's circuit-breaker strategy via route-level and global QoS options #2081
• #1658 Add global configuration for Headers Transformation #1659
• Use the appropriate class name as a type parameter to create a named logger through the factory in the ConfigurationMiddleware constructor #2306
• #842 #1414 Introduce AllowAnonymous authentication option with global AuthenticationOptions configuration #2114
• #585 #1229 #1598 #1915 Rate limiting global configuration #2294
• #1440 Update license file #2318
• #585 #2319 Load Balancer global configuration #2324
• #585 #2330 Caching global configuration #2331
• #585 #2320 Http handler global configuration #2332
• #2304 Utilize ConcurrentQueue<T> for managing service versions during polling by the PollKube discovery provider #2335
• #585 #2316 Authentication global configuration #2336
• #585 #2338 Quality of Service global configuration #2339
• #913 Support RFC 8693 (OAuth 2.0 Token Exchange) for the "scope" claim in ScopesAuthorizer #1478
• Follow-up on #2335 and #2339: Stabilize flaky tests in the CI/CD environment #2342
• Pre-release 24.1 | +semver: patch #2345
• #2343 Release 24.1 Beta | +semver: minor #2347
• #2343 Release 24.1 Beta.1 #2348

Comparing changes 24.0.1...24.1.0-beta.1

Predecessors

• Release v24.0.1 | Hotfix for issue #2299 | .NET 9 release | +semver: patch #2303
• Release v24.0 | Upgrade to net9.0 TFM | .NET 9 release | +semver: breaking #2286

Successor

• Milestone: .NET 10

[raman-m]

@TomPallister @RaynaldM @ggnaegi
OK guys...

🎄 Merry Christmas! 🎅