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.

Sign up for GitHub

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

Changelog & upgrade: clarify declarative config + update release date #4420

Merged
merged 3 commits into from
Sep 9, 2022
Merged

Changelog & upgrade: clarify declarative config + update release date #4420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c40f0e
add callouts for declarative config and general breaking changes in r…
lena-larionova Sep 9, 2022
7e5f72e
Apply suggestions from code review
lena-larionova Sep 9, 2022
12af3f6
apply fix to other file
lena-larionova Sep 9, 2022
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
14 changes: 12 additions & 2 deletions app/gateway/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ no_version: true
<!-- vale off -->

## 3.0.0.0
**Release Date** 2022/08/31
**Release Date** 2022/09/09

{:.important}
> **Important**: Kong Gateway 3.0.0.0 is a major release and contains breaking changes.
Review the [breaking changes and deprecations](#breaking-changes-and-deprecations) and the [known limitations](#known-limitations) before attempting to upgrade.

### Features

Expand Down Expand Up @@ -354,7 +358,13 @@ Debian 8 [reached end-of-life in June 30, 2020](https://www.debian.org/News/2020
The migration process should automatically convert the regex paths when upgrading from 2.x to 3.0.
[#9027](https://github.com/Kong/kong/pull/9027)
* Bumped the version number (`_format_version`) of declarative configuration to `3.0` for changes on `route.path`.
Declarative configurations with older versions are upgraded to `3.0` automatically.
Declarative configurations using older versions are upgraded to `3.0` during migrations.

{:.important}
> **Do not sync (`deck sync`) declarative configuration files from 2.8 or earlier to 3.0.**
Old configuration files will overwrite the configuration and create compatibility issues.
To grab the updated configuration, `deck dump` the 3.0 file after migrations are completed.

[#9078](https://github.com/Kong/kong/pull/9078)
* Tags may now contain space characters.
[#9143](https://github.com/Kong/kong/pull/9143)
Expand Down
7 changes: 6 additions & 1 deletion src/gateway/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,12 @@ write all other characters without percent-encoding.
### Declarative and DB-less

The version number (`_format_version`) of declarative configuration has been bumped to `3.0` for changes on `route.path`.
Declarative configurations with older versions will be upgraded to `3.0` automatically.
Declarative configurations with older versions will be upgraded to `3.0` during migrations.

{:.important}
> **Do not sync (`deck sync`) declarative configuration files from 2.8 or earlier to 3.0.**
Old configuration files will overwrite the configuration and create compatibility issues.
To grab the updated configuration, `deck dump` the 3.0 file after migrations are completed.

It is no longer possible to use the `.lua` format to import a declarative configuration file from the `kong`
CLI tool. Only JSON and YAML formats are supported. If your update procedure with {{site.base_gateway}} involves
Expand Down