Estimated reading time:
This is the documentation for the Kong Enterprise 2.1.x beta.
To see the documentation for the latest stable version of Kong Enterprise, go to 1.5.x.
These release notes apply to Kong Enterprise Release 2.1.x (beta) and provide a high-level overview of new features and updates. For more detailed information about this release, including features, fixes, and known issues, see the Changelog.
Kong Enterprise now supports a new deployment method called Hybrid mode, also known as Control Plane / Data Plane Separation (CP/DP).
In this mode, Kong nodes in a cluster are split into two roles: Control Plane (CP), which centrally manages Kong Enterprise cluster configuration, and Data Plane (DP), which serves traffic for the proxy. Each DP node is connected to one of the CP nodes. Instead of accessing the database contents directly as in the traditional deployment method, the DP nodes maintain connection with CP nodes, and receive the latest configuration. All nodes in a cluster are configured with generated certificates, ensuring each Data Plane node is calling back to securely pair with the Control Plane.
You can manage Kong Enterprise add-ons including Kong Manager, Developer Portal, Vitals, Immunity, and Brain from a single Control Plane that spans multiple clusters across different data centers and platforms. This means that you can distribute Kong Enterprise instances in Data Plane mode over any of Kong’s supported environments, while still connecting back to the Control Plane.
Here’s a sample configuration with one central Control Plane and three Data Plane nodes, as well as Kong Manager and Developer Portal enabled on the Control Plane:
For more information, check out the following links:
Developer Portal Application Registration with External IDP Support
Authentication is decoupled from the Application Registration plugin, and support is added for third-party OAuth providers. Developers now have the flexibility to choose from either Kong or a third-party identity provider (IdP) as the system of record for application credentials. With third-party OAuth support, developers can centralize application credential management with the supported IdP of their choice.
For more information, see:
Developer Portal Markdown Support
The Developer Portal now supports GitHub Markdown as an alternative to Developer Portal templates. To use the feature, create a markdown file and call the new markdown layout module. You can use the default CSS or customize it for more control over the Dev Portal skin.
For more information, see the Developer Portal Markdown topic.
Go Language Support for Custom Plugins
The Go Plugin Development Kit for Kong Enterprise allows users to tap into the Go ecosystem with custom plugins. The Kong Go PDK directly parallels the existing Kong PDK for Lua plugins.
For more information, see the Go PDK topic.
Kong Vitals Reports
A new interface in Kong Manager lets you view usage dashboards and generate reports, with easier access to all metrics collected by Kong Vitals over a greater period of time. Use the reports feature to browse, filter, and view your metrics in a time-series generated report, and export the report as a comma-separated values (CSV) file.
For more information, see the Vitals Overview and Vitals Reports topics.
Kong for Kubernetes Enterprise (K4K8s) is not currently available for use with Kong Enterprise 2.1.x beta. It will be released within the beta timeframe.
What’s New in the Docs
In addition to the features listed above, updates to Kong’s user documentation and Docs site include:
- decK documentation has moved to docs.konghq.com.
- Improved Vitals section, including new Overview, Reports, and Metrics topics.
- New Plugin topics:
- Plugin Overview introduces the most basic things you need to know to get started with plugins: what they are, why you might use them, terminology, and information on creating your own plugins and plugin documentation.
- Plugin Compatibility Matrix compares the various Kong Gateway deployment modes.
- New Deployment topics:
- Improved Kubernetes topics:
- Installation topics reorganized.
- New Version Support information and matrix.
- New Doc site improvements, including: table of contents rework; collapsible sub-sections; mobile layout fixes; images expand on click; ability to copy code snippets; ability to stay on same topic when navigating between versions; right-hand navigation “On this page” redesign with collapse and reopen feature; scroll to the top button; and resizable table columns.
This beta release is intended for testing purposes only. No upgrades from the previous versions are supported. See the Beta definition for more information.
The Key Authentication - Encrypted (
key-auth-enc) plugin does not support
ttl (time-to-live) in Hybrid mode deployments.
Setting your Kong password (
Kong_Password) using a value containing four ticks (for example,
KONG_PASSWORD="a''a'a'a'a") causes a Postgres syntax error on bootstrap. To work around this issue, do not use special characters in your password.
run_on is removed from plugins, as it has not been used for a long time but compatibility was kept in 1.x. Any plugin with
run_on will now break because the schema no longer contains that entry. If testing custom plugins against this beta release, update the plugin’s schema.lua file and remove the
The Correlation ID (
correlation-id) plugin has a higher priority than in CE. This is an incompatible change with CE in case
correlation-id is configured against a Consumer.
The ability to share an entity between Workspaces is no longer supported. The new method requires a copy of the entity to be created in the other Workspaces.
For a complete list of features, fixes, and changes, see the Kong Enterprise 2.1.0(beta) Changelog.