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

chore: 3.10 breaking changes doc #8566

Merged
merged 4 commits into from
Mar 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions app/_data/docs_nav_gateway_3.10.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,13 @@ items:
absolute_url: true
- text: Breaking Changes
items:
- text: Kong Gateway 3.8.x
- text: Kong Gateway 3.10.x
url: /breaking-changes/
src: /gateway/breaking-changes/38x
src: /gateway/breaking-changes/310x
- text: Kong Gateway 3.9.x
url: /breaking-changes/39x/
- text: Kong Gateway 3.8.x
url: /breaking-changes/38x/
- text: Kong Gateway 3.7.x
url: /breaking-changes/37x/
- text: Kong Gateway 3.6.x
Expand Down
46 changes: 46 additions & 0 deletions app/_src/gateway/breaking-changes/310x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Kong Gateway 3.10.x breaking changes
content_type: reference
book: breaking-changes
chapter: 12
---

Before upgrading, review any configuration or breaking changes in this version and prior versions that
affect your current installation.

You may need to adopt different [upgrade paths](/gateway/{{page.release}}/upgrade/#guaranteed-upgrade-paths) depending on your
deployment methods, set of features in use, or custom plugins, for example.

Review the [changelog](/gateway/changelog/#31000) for all the changes in this release.

## Breaking changes and deprecations

### AI plugins: metrics key

The serialized log key of AI metrics has changed from `ai.ai-proxy` to `ai.proxy` to avoid conflicts with metrics generated from plugins other than AI Proxy and AI Proxy Advanced.
If you are using any [logging plugins](/hub/?category=logging) to log AI metrics (for example, File Log, HTTP Log, and so on),
you will have to update metrics pipeline configurations to reflect this change.

### AI plugins: deprecated settings

The following settings have been deprecated in all [AI plugins](/hub/?category=ai), and will be removed in a future release.
Use the following replacement settings instead:

| Deprecated setting | New setting |
|--------------------|-------------|
| `preserve` mode in `config.route_type` | `config.llm_format` |
| `config.model.options.upstream_path` | `config.model.options.upstream_url` |

### AI Rate Limiting Advanced plugin: multiple providers and limits

The plugin's `config.llm_providers.window_size` and `config.llm_providers.limit` parameters now require an array of numbers instead of a single number.
If you configured the plugin before 3.10 and [upgrade to 3.10 using `kong migrations`](/gateway/{{page.release}}/upgrade/), it will be automatically migrated to use an array.

### kong.service PDK module changes

Changed the encoding of spaces in query arguments from `+` to `%20` in the [`kong.service.request.clear_query_arg`](/gateway/{{page.release}}/plugin-development/pdk/kong.service.request/#kongservicerequestclear_query_argname) PDK module.
While the `+` character represents the correct encoding of space in query strings, Kong uses `%20` in many other APIs, which is inherited from Nginx/OpenResty.

### Free mode

Free mode is no longer available. Running {{site.base_gateway}} without a license will now behave the same as running it with an expired license.
Loading