Kong Gateway Changelog

3.4.0.0

Release Date 2023/08/09

Breaking changes and deprecations

• Cassandra DB support removed: Cassandra DB support has been removed. It is no longer supported as a data store for Kong Gateway. #10931.
• Alpine support removed: Alpine packages and Docker images based on Alpine are no longer supported. Starting with Kong Gateway 3.4.0.0, Kong is not building new Alpine images or packages. #10926

• Ubuntu 18.04 support removed: Support for running Kong Gateway on Ubuntu 18.04 (“Bionic”) is now deprecated, as Standard Support for Ubuntu 18.04 has ended as of June 2023. Starting with Kong Gateway 3.4.0.0, Kong is not building new Ubuntu 18.04 images or packages, and Kong will not test package installation on Ubuntu 18.04.

  If you need to install Kong Gateway on Ubuntu 18.04, see the documentation for previous versions.

• Amazon Linux 2022 artifacts are renamed to Amazon Linux 2023, based on AWS’s own renaming.

• LMDB encryption has been disabled. The option declarative_config_encryption_mode has been removed from kong.conf.
• The /consumer_groups/:id/overrides endpoint is deprecated in favor of a more generic plugin scoping mechanism. See the new consumer groups entity.
• Renamed the configuration property admin_api_uri to admin_gui_api_url. The old admin_api_uri property is considered deprecated and will be fully removed in a future version of Kong Gateway.

Features

Enterprise

• Introduced the cascade option for /workspaces, which lets you delete a workspace and all of its entities in one request.

• Consumer groups are now a core entity. With consumer groups, you can apply different configurations to select groups of consumers. The following plugins can now be scoped to consumer groups:

  • Rate Limiting Advanced
  • Request Transformer and Request Transformer Advanced
  • Response Transformer and Response Transformer Advanced

  See the documentation for consumer groups to learn more.

• Added a new ttl option to vault configurations, allowing users to define the interval at which references are automatically re-fetched from the configured vault.

  See the documentation for secrets rotation to learn more.

• The workspace name now appears in the logging payload.

Kong Manager

• Introduced the Kong Manager Open Source Edition (OSS), a free and open-source UI for Kong Gateway OSS! #11131

  Kong Manager OSS allows you to view and edit all Kong Gateway objects using the Admin API. It interacts directly with the Kong Admin API and does not require a separate database. This UI provides a great way to see all of your Kong Gateway configuration at glance.

  Starting with 3.4.0.0, Kong Manager OSS is bundled with Kong Gateway OSS. Install a new Kong Gateway OSS instance to try it out!

  The quickest way to get started is using the quickstart script.

  Check out the Kong Manager OSS repo to learn more about it.

• Enhanced the user experience of editing pages for entities with a refined look and feel.

• Simplified the user path by removing the configuration pages for nested entities.

Core

• Beta feature: Introduced the beta of WebAssembly (proxy-wasm). #11218

  This release integrates Kong/ngx-wasm-module into Kong Gateway.

• The /schemas endpoint now returns additional information about cross-field validation as part of the schema. This should help tools that use the Admin API to perform better client-side validation.

• Enabled the expressions and traditional_compatible router flavors in the stream subsystem. #11071
• The upstream host_header and router preserve_host configuration parameters now work in stream TLS proxy. #11244
• In DB-less mode, the declarative schema is now fully initialized at startup instead of on-demand in the request path. This is most evident in decreased response latency when updating configuration via the /config API endpoint. #10932
• Tracing: Added the new attribute http.route to HTTP request spans. #10981
• Tracing: Added the span attribute net.peer.name, which records the upstream hostname if it’s available in balancer_data.hostname. Thanks @backjo for contributing this change. #10723
• The default value of lmdb_map_size config has been bumped to 2048m from 128m to accommodate most commonly deployed config sizes in DB-less and hybrid modes. #11047
• The default value of cluster_max_payload config has been bumped to 16m from 4m to accommodate most commonly deployed config sizes in hybrid mode. #11090
• Removed Kong branding from the kong HTML error template. #11150

Plugins

• Validation for plugin queue related parameters has been improved. #10840
  • max_batch_size, max_entries, and max_bytes are now declared as integer not number.
  • initial_retry_delay and max_retry_delay must now be numbers greater than 0.001 (in seconds).
• Rate Limiting Advanced (rate-limiting-advanced)
  • The redis strategy now catches strategy connection failures.
• OpenID Connect (openid-connect)
  • This plugin now supports the error reason header. This header can be turned off by setting expose_error_code to false.
  • OpenID Connect now supports adding scope to the token cache key by setting token_cache_key_include_scope to true.
• Kafka Log (kafka-log)
  • The Kafka Log plugin now supports the custom_fields_by_lua configuration for dynamic modification of log fields using Lua code.
• GraphQL Rate Limiting Advanced (graphql-rate-limiting-advanced)
  • The host field of this plugin now accepts Kong upstream targets.
• OpenTelemetry (opentelemetry)
  • Introduced support for the AWS X-Ray propagation header. The field header_typenow accepts the aws value to handle this specific propagation header. #11075
  • The endpoint parameter is now referenceable, and can be stored as a secret in a vault. #11220

• IP Restriction (ip-restriction)

  • Added support for the tcp, tls, grpc, and grpcs protocols.

    Thanks @scrudge for contributing this change. #10245

• Prometheus (prometheus)

• The Prometheus plugin has been optimized to reduce proxy latency impacts during scraping. #10949 #11040 #11065

Fixes

Enterprise

• Fixed a potential memory leak and reconnection problem which could occur when telemetry breaks down due to any exceptions in its send thread.
• Telemetry: Fixed issues that broke the telemetry websocket:
  • Fixed an issue that caused the telemetry websocket to be blocked by latency while flushing Vitals to database. By using a queue as a buffer, the process of receiving Vitals data from the data plane is now decoupled from the process of flushing Vitals to the database on the control plane.
  • Fixed an issue that broke the telemetry websocket in Konnect mode due to unexpected payloads when the counter of requests equals zero.
• Fixed an issue where you could receive an empty request_id when generating audit data.
• Fixed an error that occurred when the header x-datadog-parent-id wasn’t passed to Kong Gateway.
• Fixed a queueing-related issue that broke event hooks in 3.3.0.0.
• Updated the datafile library to make the SAML plugin work when Kong Gateway is controlled by systemd.
• Fixed an issue where a workspace couldn’t attach to the cache’s consumer well.
• Fixed a LuaJIT crash on Arm64 and enabled LuaJIT on M1.
• Fixed an issue where the license couldn’t load when pulling KONG_LICENSE_DATA from a vault.

Kong Manager

• Fixed an issue where Kong Manager didn’t get the latest config when the Enterprise license was posted via the Admin API.
• Fixed incorrect CORS behavior that occurred when Kong Manager was integrated with the Portal GUI.
• Fixed an issue where OIDC in Kong Manager didn’t handle invalid credentials when providing the wrong username.
• Added an alert message in the admins tab page for workspace access while the admin_auth is set to openid-connect.
• Fixed an issue where the custom permission endpoint didn’t work for /services/<service-name-or-id>/application_instances.

Dev Portal

• Fixed an issue on portal documentation pages, where disabling the Application Registration plugin didn’t remove the Register button from a service.
• Fixed an issue with viewing OAS docs in the in the Dev Portal, where the UI would hang when attempting to expand an API.

Core

• Declarative config now performs proper uniqueness checks against its inputs. Previously, it would silently drop entries with conflicting primary/endpoint keys, or accept conflicting unique fields silently. #11199
• Fixed a bug where a worker consuming dynamic log level setting events used the wrong reference for notice logging. #10897
• Added a User= specification to the systemd unit definition so that Kong Gateway can be controlled by systemd again. #11066
• Fixed a bug that caused the sampling rate to be applied to individual spans, producing split traces. #11135
• Fixed a bug that caused the router to fail in traditional_compatible mode when a route with multiple paths and no service was created. #11158
• Fixed an issue where the expressions router couldn’t work correctly when route.protocols is set to grpc or grpcs. #11082
• Fixed an issue where the expressions router couldn’t configure HTTPS redirection. #11166
• Made the kong vault get CLI command work in DB-less mode by injecting the necessary directives into the Kong CLI nginx.conf. #11127 #11291
• Fixed an issue where a crashing Go plugin server process would cause subsequent requests proxied through Kong Gateway to execute Go plugins with inconsistent configurations. The issue only affects scenarios where the same Go plugin is applied to different route or service entities. #11306

Admin API

• Fixed an issue that caused POST /config?flatten_errors=1 to throw an exception and return a 500 error under certain circumstances. #10896
• Fixed an issue where /schemas/plugins/validate endpoint failed to validate valid plugin configuration when the key of custom_fields_by_lua contained dot (.) character(s). #11091

Status API

• Removed the database information from the status API when operating in DB-less mode or on the data plane. #10995

Plugins

• OAuth 2.0 Introspection (oauth2-introspection)
  • Fixed an issue where the plugin failed when processing a request with JSON that is not a table.
• gRPC Gateway (grpc-gateway)
  • Fixed an issue where an array with one element would fail to be encoded.
  • Fixed an issue where empty (all default value) messages couldn’t be unframed correctly. #10836
• Response Transformer (response-transformer) and Request Transformer Advanced (request-transformer-advanced)
  • Fixed an issue where the plugin wouldn’t transform the response body when the upstream returns a Content-Type with a +json suffix at the subtype.
• OpenID Connect (openid-connect)
  • Changed some log levels from notice to error for better visibility.
  • Correctly set the right table key on log and message.
  • If an invalid opaque token is provided but verification fails, print the correct error.
• Mocking (mocking)
  • Fix a bug that the plugin throws an error when the arbitrary elements are defined in the path node.
• mTLS Authentication (mtls-auth)
  • Fixed several revocation verification issues:
    • If revocation_check_mode=IGNORE_CA_ERROR, then the CRL revocation failure will be ignored.
    • Once a CRL is added into the store, it will always do CRL revocation check with this CRL file.
    • OCSP verification failed with no issuer certificate in chain error if the client only sent a leaf certificate.
    • http_timeout wasn’t correctly set.
  • Optimized CRL revocation verification.
  • Fixed a bug that would cause an unexpected error when skip_consumer_lookup is enabled and authenticated_group_by is set to null.
• Kafka Log (kafka-log) and Kafka Upstream (kafka-upstream)
  • Fixed an issue where the plugin could lose connection to a broker when the broker leadership changed.
• OAS Validation (oas-validation)
  • Fixed an issue where the plugin was unable to pass the validation even if path parameter was valid.
  • Fixed an issue where the plugin always validated the request body even if the method spec had no requestBody defined.
  • Fixed an issue where the comparison between large absolute value numbers could be incorrect due to the number being converted to exponential notation.
• Request Validator (request-validator)
  • Optimized the response message for invalid requests.
• ACME (acme)
  • Fixed an issue where the sanity test didn’t work with kong storage in hybrid mode. #10852
• Rate Limiting Advanced
  • Fixed an issue that impacted the accuracy with the redis policy. Thanks @giovanibrioni for contributing this change. #10559
• Zipkin (zipkin)
  • Fixed an issue where traces weren’t being generated correctly when instrumentations were enabled. #10983

Dependencies

• Bumped kong-redis-cluster from 1.5.0 to 1.5.1
• Bumped lua-resty-ljsonschema from 1.1.3 to 1.15
• Bumped lua-resty-kafka from 0.15 to 0.16
• Bumped OpenSSL from 1.1.1t to 3.0.8
• Bumped lua-resty-aws from 1.2.2 to 1.2.3
• Bumped lua-resty-openssl from 0.8.20 to 0.8.23 #10837 #11099
• Bumped kong-lapis from 1.8.3.1 to 1.14.0.2 #10841
• Bumped lua-resty-events from 0.1.4 to 0.2.0 #10883 #11083 #11214
• Bumped lua-resty-session from 4.0.3 to 4.0.4 #11011
• Bumped OpenSSL from 1.1.1t to 3.1.1 #10180 #11140
• Bumped pgmoon from 1.16.0 to 1.16.2 (Kong’s fork) #11181 #11229
• Bumped atc-router from 1.0.5 to 1.2.0 #10100 #11071
• Bumped lua-resty-lmdb from 1.1.0 to 1.3.0 #11227

Known issues

• Some referenceable configuration fields, such as the http_endpoint field of the http-log plugin and the endpoint field of the opentelemetry plugin, do not accept reference values due to incorrect field validation.

3.3.1.0

Release Date 2023/07/03

Fixes

• Fixed a bug that causes POST /config?flatten_errors=1 to throw an exception and return a 500 error under certain circumstances.
• Fixed a bug that would cause an error when the header x-datadog-parent-id is not passed to Kong.
• Fixed a queueing-related bug that meant the event_hooks did not fire and led to errors in the logs.
• Updated the datafile library that meant when Kong was started with systemd, the SAML plugin did not load.
• Fixed a bug that the anonymous report can’t be silenced by setting anonymous_reports=false.
• Fixed a Jenkins issue where kong/kong-gateway:3.3.0.0-alpine was missing resty.dns.resolver patch.
• Fixed an issue addressing occassional issues attaching a workspace with the cache’s consumer well.

Plugins

• Fixed an issue with the Oauth 2.0 Introspection plugin where a request with JSON that is not a table failed.

Deprecations

• Alpine deprecation reminder: Kong has announced our intent to remove support for Alpine images and packages later this year. These images and packages are available in 3.2 and will continue to be available in 3.3. We will stop building Alpine images and packages in Kong Gateway 3.4.

• Cassandra deprecation and removal reminder: Using Cassandra as a backend database for Kong Gateway is deprecated. It is planned for removal with Kong Gateway 3.4.

3.3.0.0

Release Date 2023/05/19

Breaking changes and deprecations

• Alpine deprecation reminder: Kong has announced our intent to remove support for Alpine images and packages later this year. These images and packages are still available in 3.3. We will stop building Alpine images and packages in Kong Gateway 3.4.

• Cassandra deprecation and removal reminder: Using Cassandra as a backend database for Kong Gateway is deprecated. It is planned for removal with Kong Gateway 3.4.

Core

• The traditional_compat router mode has been made more compatible with the behavior of traditional mode by splitting routes with multiple paths into multiple atc routes with separate priorities. Since the introduction of the new router in Kong Gateway 3.0, traditional_compat mode assigned only one priority to each route, even if different prefix path lengths and regular expressions were mixed in a route. This was not how multiple paths were handled in the traditional router and the behavior has now been changed so that a separate priority value is assigned to each path in a route. #10615

• Tracing: tracing_sampling_rate now defaults to 0.01 (trace one of every 100 requests) instead of the previous 1 (trace all requests). Tracing all requests causes unnecessary resource drain for most production systems. #10774

Plugins

• Plugin batch queuing:

  • HTTP Log (http-log), StatsD (statsd), OpenTelemetry (opentelemetry), and Datadog (datadog)

    The queuing system has been reworked, causing some plugin parameters to not function as expected anymore. If you use queues in these plugins, new parameters must be configured. See each plugin’s documentation for details.

  • The module kong.tools.batch_queue has been renamed to kong.tools.queue and the API was changed. If your custom plugin uses queues, it must be updated to use the new API. #10172

• AppDynamics (app-dynamics)

  • The plugin version has been updated to match Kong Gateway’s version.
• HTTP Log (http-log)
  • If the log server responds with a 3xx HTTP status code, the plugin now considers it to be an error and retries according to the retry configuration. Previously, 3xx status codes would be interpreted as a success, causing the log entries to be dropped. #10172
• Serverless Functions (post-function or pre-function)
  • kong.cache now points to a cache instance that is dedicated to the Serverless Functions plugins. It does not provide access to the global Kong Gateway cache. Access to certain fields in kong.conf has also been restricted. #10417
• Zipkin (zipkin) This plugin now uses queues for internal buffering. The standard queue parameter set is available to control queuing behavior. #10753

Features

Enterprise

• When using the data plane resilience feature, the server-side certificate of the backend Amazon S3 or GCP Cloud Storage service will now be validated if it goes through HTTPS.
• When managing secrets with an AWS or GCP backend, the backend server’s certificate is now validated if it goes through HTTPS.
• Kong Enterprise now supports using AWS IAM database authentication to connect to the Amazon RDS (PostgreSQL) database.
• Kong Manager:
  • Kong Manager and Konnect now share the same UI for the navbar, sidebar, and all entity lists.
  • Improved display for the routes list when the expressions router is enabled.
  • CA Certificates and TLS Verify are now supported in the Kong Gateway service form.
  • Added a GitHub star in the free mode navbar.
  • Upgraded the Konnect CTA in free mode.
• SBOM files in SPDX and CycloneDX are now generated for Kong Gateway’s Docker images.

Kong Gateway with Konnect

• You can now configure labels for data planes to provide metadata information for Konnect. #10471
• Sending analytics to Konnect from Kong Gateway DB-less mode is now supported.

Core

• runloop and init error response content types are now compliant with the Accept header value. #10366
• You can now configure custom error templates. #10374
• The maximum number of request headers, response headers, URI arguments, and POST arguments that are parsed by default can now be configured with the following new configuration parameters: lua_max_req_headers, lua_max_resp_headers, lua_max_uri_args, and lua_max_post_args. #10443
• Added PostgreSQL triggers on the core entites and entities in bundled plugins to delete expired rows in an efficient and timely manner. #10389
• Added support for configurable node IDs. #10385

• Request and response buffering options are now enabled for incoming HTTP 2.0 requests.

  Thanks @PidgeyBE for contributing this change. #10204 #10595

• Added KONG_UPSTREAM_DNS_TIME to kong.ctx to record the time it takes for DNS resolution when Kong proxies to an upstream. #10355

• Dynamic log levels now have a default timeout of 60 seconds. #10288

Admin API

• Added a new updated_at field for the following entities: ca_certificates, certificates, consumers, targets, upstreams, plugins, workspaces, clustering_data_planes, consumer_group_consumers, consumer_group_plugins, consumer_groups, credentials, document_objects, event_hooks, files, group_rbac_roles, groups, keyring_meta, legacy_files, login_attempts, parameters, rbac_role_endpoints, rbac_role_entities, rbac_roles, rbac_users, and snis. #10400
• The /upstreams/<upstream>/health?balancer_health=1 endpoint always shows the balancer health through a new attribute: balancer_health. This always returns HEALTHY or UNHEALTHY, reporting the true state of the balancer, even if the overall upstream health status is HEALTHCHECKS_OFF. This is useful for debugging. #5885
• Beta: OpenAPI specs are now available for the Kong Gateway Admin API:
  • Kong Gateway Admin API - OSS spec
  • Kong Gateway Admin API - Enterprise spec

Status API

• The status_listen server has been enhanced with the addition of the /status/ready API for monitoring Kong Gateway’s health. This endpoint provides a 200 response upon receiving a GET request, but only if a valid, non-empty configuration is loaded and Kong Gateway is prepared to process user requests.

  Load balancers frequently utilize this functionality to ascertain Kong Gateway’s availability to distribute incoming requests. #10610 #10787

• Beta: An OpenAPI spec is now available for the Kong Gateway Status API.

PDK

• The PDK now supports getting a plugin’s ID with kong.plugin.get_id. #9903
• Tracing module: Renamed spans to simplify filtering on tracing backends. See kong.tracing for details. #10577

Plugins

• ACME (acme)
  • This plugin now supports configuring an account_key in keys and key_sets. #9746
  • This plugin now supports configuring a namespace for Redis storage, which defaults to an empty string for backwards compatibility. #10562
• Proxy Cache (proxy-cache)
  • Added the configuration parameter ignore_uri_case to allow handling the cache key URI as lowercase. #10453
• Proxy Cache Advanced (proxy-cache-advanced)
  • Added wildcard and parameter match support for content_type.
  • Added the configuration parameter ignore_uri_case to allow handling the cache key URI as lowercase. #10453
• HTTP Log (http-log)
  • Added the application/json; charset=utf-8 option for the Content-Type header to support log collectors that require that character set declaration. #10533
• Datadog (datadog)
  • The host configuration parameter is now referenceable. #10484
• Zipkin (zipkin) and OpenTelemetry (opentelemetry)
  • These plugins now convert traceid in HTTP response headers to hex format. #10534
• OpenTelemetry (opentelemetry)
  • Spans are now correctly correlated in downstream Datadog traces. 10531
  • Added the header_type field. Previously, the header_type was hardcoded to preserve. Now it can be set to one of the following values: preserve, ignore, b3, b3-single, w3c, jaeger, or ot. #10620
  • Added the new span attribute http.client_ip to capture the client IP when behind a proxy. #10723
  • Added the http_response_header_for_traceid configuration parameter. Setting a string value in this field sets a corresponding header in the response. #10379
• AWS Lambda (aws-lambda)
  • Added the configuration parameter disable_https to support scheme configuration on the lambda service API endpoint. #9799
• Request Transformer Advanced (request-transformer-advanced)
  • The plugin now honors the following Kong Gateway configuration parameters: untrusted_lua, untrusted_lua_sandbox_requires, untrusted_lua_sandbox_environment. These parameters apply to advanced templates (Lua expressions).
• Request Validator (request-validator)
  • Errors are now logged for validation failures.
• JWT Signer (jwt-signer)
  • Added the configuration field add_claims, which lets you add extra claims to JWT.

Fixes

Enterprise

• The Kong Enterprise systemd unit was incorrectly renamed to kong.service in 3.2.x.x versions. It has now been reverted back to kong-enterprise-edition.service to keep consistent with previous releases.
• Fixed an issue where Kong Gateway failed to generate a keyring when RBAC was enabled.
• Fixed lua_ssl_verify_depth in FIPS mode to match the same depth of normal mode.
• Removed the email field from the developer registration response.
• Websocket requests now generate balancer spans when tracing is enabled.
• Fixed an issue where management of licenses via the /licenses/ endpoint would fail if the current license is not valid.
• Resolved an issue with the plugin iterator where sorting would become mixed up when dynamic reordering was applied. This fix ensures proper sorting behavior in all scenarios.
• Kong Manager:
  • Fixed an issue where changing the vault name in Kong Manager would throw an error.
  • Fixed an issue with tabs, where vertical tab content became blank when selecting a tab that is currently active.
  • Fixed an issue where the /register route occasionally jumped to /login instead.
  • Removed the Custom Identifier field from the StatsD plugin. This field appeared in Kong Manager under Metrics, but the field doesn’t exist in the plugin’s schema.

Kong Gateway with Konnect

• The standard expired license notification no longer appears in logs for data planes running in Konnect mode (konnect_mode=on), as it does not apply to them.
• New license alert behavior for data planes running in Konnect mode:
  • If there are at least 16 days left before expiration, no alerts are issued.
  • If the license expires within 16 days, a warning level alert is issued every day.
  • If the license is expired, a critical level alert is issued every day.

Core

• Fixed an issue where the upstream keepalive pool had a CRC32 collision. #9856
• Hybrid mode:
  • Fixed an issue where the control plane didn’t downgrade configuration for the AWS Lambda and Zipkin plugins for older versions of data planes. #10346
  • Fixed an issue where the control plane didn’t rename fields correctly for the Session plugin for older versions of data planes. #10352
• Fixed an issue where validation of regex routes was occasionally skipped when the old-fashioned config style was used for DB-less Kong Gateway. #10348
• Fixed an issue where tracing could cause unexpected behavior. #10364
• Fixed an issue where balancer passive healthchecks would use the wrong status code when Kong Gateway changed the status code from the upstream in the header_filter phase. #10325 #10592
• Fixed an issue where schema validations failing in a nested record did not propagate the error correctly. #10449
• Fixed an issue where dangling Unix sockets would prevent Kong Gateway from restarting in Docker containers if it was not cleanly stopped. #10468
• Fixed an issue where the sorting function for traditional router sources or destinations led to invalid order function for sorting errors. #10514
• Fixed the UDP socket leak in resty.dns.client caused by frequent DNS queries. #10691
• Fixed a typo in the mlcache option shm_set_tries. #10712
• Fixed an issue where a slow startup of the Go plugin server caused a deadlock. #10561
• Tracing:
  • Fixed an issue that caused the sampled flag of incoming propagation headers to be handled incorrectly and only affect some spans. #10655
  • Fixed an issue that was preventing http_client spans from being created for OpenResty HTTP client requests. #10680
  • Fixed an approximation issue that resulted in reduced precision of the balancer span start and end times. #10681
  • tracing_sampling_rate now defaults to 0.01 (trace one of every 100 requests) instead of the previous 1 (trace all requests). Tracing all requests causes unnecessary resource drain for most production systems. #10774
• Fixed an issue with vault references, which caused Kong Gateway to error out when trying to stop. #10775
• Fixed an issue where vault configuration stayed sticky and cached even when configurations were changed. #10776
• Fixed the following PostgreSQL TTL clean-up timer issues:
  • Timers will now only run on traditional and control plane nodes that have enabled the Admin API. #10405
  • Kong Gateway now runs a batch delete loop on each TTL-enabled table with a number of 50.000 rows per batch. #10407
  • The cleanup job now runs every 5 minutes instead of every 60 seconds. #10389
  • Kong Gateway now deletes expired rows based on the database server-side timestamp to avoid potential problems caused by the differences in clock time between Kong Gateway and the database server. #10389
• Fixed an issue where an empty value for the URI argument custom_id crashed the /consumer API. #10475

PDK

• request.get_uri_captures now returns the unnamed part tagged as an array for jsonification. #10390
• Fixed an issue for tracing PDK where the sampling rate didn’t work. #10485

Plugins

• JWE Decrypt (jwe-decrypt), OAS Validation (oas-validation), and Vault Authentication (vault-auth)
  • Added the missing schema field protocols for jwe-decrypt, oas-validation, and vault-auth. KAG-754
• Rate Limiting Advanced
  • The redis rate limiting strategy now returns an error when Redis Cluster is down.
  • Fixed an issue where the rate limiting cluster_events broadcast the wrong data in traditional cluster mode.
  • The control plane no longer creates namespace or syncs.
• StatsD Advanced (statsd-advanced)
  • Changed the plugin’s name to statsd-advanced instead of statsd.
• LDAP Authentication Advanced (ldap-auth-advanced)
  • The plugin now performs authentication before authorization, and returns a 403 HTTP code when a user isn’t in the authorized groups.
  • The plugin now supports setting the groups to an empty array when groups are not empty.
• OpenTelemetry (opentelemetry)
  • Fixed an issue where reconfiguring the plugin didn’t take effect.
  • Fixed an issue that caused spans to be propagated incorrectly resulting in the wrong hierarchy being rendered on tracing backends. #10663
• Request Validator (request-validator)
  • Fixed an issue where the validation function for the allowed_content_types parameter was too strict, making it impossible to use media types that contained a - character.
• Forward Proxy (forward-proxy)
  • Fixed an issue which caused the wrong latencies.proxy to be used in the logging plugins. This plugin now evaluates ctx.WAITING_TIME in the forward proxy instead of doing it in the subsequent phase.
• Request Termination (request-termination)
  • Fixed an issue with the echo option, which caused the plugin to not return the uri-captures. #10390
• Request Transformer (request-transformer)
  • Fixed an issue where requests would intermittently be proxied with incorrect query parameters. 10539
  • The plugin now honors the value of the untrusted_lua configuration parameter. #10327
• OAuth2 (oauth2)
  • Fixed an issue where the OAuth2 token was being cached as nil if the wrong service was accessed first. #10522
  • This plugin now prevents an authorization code created by one plugin instance from being exchanged for an access token created by a different plugin instance. #10011
• gRPC Gateway (grpc-gateway)
  • Fixed an issue where having a null value in the JSON payload caused an uncaught exception to be thrown during pb.encode. #10687
  • Fixed an issue where empty arrays in JSON were incorrectly encoded as "{}". They are now encoded as "[]" to comply with standards. #10790

Dependencies

• Updated the datafile library dependency to fix the following issues:
  • Kong Gateway didn’t work when installed on a read-only file system.
  • Kong Gateway didn’t work when started from systemd.
• Bumped lua-resty-session from 4.0.2 to 4.0.3 #10338
• Bumped lua-protobuf from 0.3.3 to 0.5.0 #10137 #10790
• Bumped lua-resty-timer-ng from 0.2.3 to 0.2.5 #10419 #10664
• Bumped lua-resty-openssl from 0.8.17 to 0.8.20 #10463 #10476
• Bumped lua-resty-http from 0.17.0.beta.1 to 0.17.1 #10547
• Bumped lua-resty-aws from 1.1.2 to 1.2.2
• Bumped lua-resty-gcp from 0.0.11 to 0.0.12
• Bumped LuaSec from 1.2.0 to 1.3.1 #10528
• Bumped lua-resty-acme from 0.10.1 to 0.11.0 #10562
• Bumped lua-resty-events from 0.1.3 to 0.1.4 #10634
• Bumped lua-kong-nginx-module from 0.5.1 to 0.6.0 #10288
• Bumped lua-resty-lmdb from 1.0.0 to 1.1.0 #10766
• Bumped kong-openid-connect from 2.5.4 to 2.5.5

Known Issues

• Due to known issues, Kong recommends not enabling page-level LMDB encryption in versions 3.0.x-3.3.x.

  Don’t set declarative_config_encryption_mode; leave it at its default value of off. Continue relying on disk-level encryption to encrypt the configuration on disk.

• When sending an invalid configuration to the /config endpoint while running in DB-less mode and with flatten_errors=1 set, Kong Gateway incorrectly returns a 500. This should be a 400 because the configuration is invalid.

• When the OpenID Connect (OIDC) plugin is configured to reference HashiCorp Vault in the config.client_secret field (for example, {vault://hcv/clientSecret}), it does not look up the secret correctly.

3.2.2.3

Release Date 2023/06/07

Fixes

• Fixed an error with the /config endpoint. If flatten_errors=1 was set and an invalid config was sent to the endpoint, a 500 error was incorrectly returned.

Deprecations

• Alpine deprecation reminder: Kong has announced our intent to remove support for Alpine images and packages later this year. These images and packages are available in 3.2 and will continue to be available in 3.3. We will stop building Alpine images and packages in Kong Gateway 3.4.

3.2.2.2

Release Date 2023/05/19

Fixes

Core

• Fixed the OpenResty ngx.print chunk encoding duplicate free buffer issue that lead to the corruption of chunk-encoded response data. #10816 #10824
• Fixed the UDP socket leak in resty.dns.client caused by frequent DNS queries. #10691

Plugins

• Rate Limiting Advanced (rate-limiting-advanced)
  • Fixed the log flooding issue caused by low sync_rate settings.

3.2.2.1

Release Date 2023/04/03

Fixes

• Fixed the Dynatrace implementation. Due to a build system issue, Kong Gateway 3.2.x packages prior to 3.2.2.1 didn’t contain the debug symbols that Dynatrace requires.

Deprecations

• Alpine deprecation reminder: Kong has announced our intent to remove support for Alpine images and packages later this year. These images and packages are available in 3.2 and will continue to be available in 3.3. We will stop building Alpine images and packages in Kong Gateway 3.4.

3.2.2.0

Release Date 2023/03/22

Fixes

Enterprise

• In Kong 3.2.1.0 and 3.2.1.1, alpine and ubuntu ARM64 artifacts incorrectly handled HTTP/2 requests, causing the protocol to fail. These artifacts have been removed.
• Added the default logrotate file /etc/logrotate.d/kong-enterprise-edition. This file was missing in all 3.x versions of Kong Gateway prior to this release.

Plugins

• SAML (saml)
  • The SAML plugin now works on read-only file systems.
  • The SAML plugin can now handle the field session_auth_ttl (removed since 3.2.0.0).
• Datadog Tracing plugin: We found some late-breaking issues with the Datadog Tracing plugin and elected to remove it from the 3.2 release. We plan to add the plugin back with the issues fixed in a later release.

Known issues

• Due to changes in GPG keys, using yum to install this release triggers a Public key for kong-enterprise-edition-3.2.1.0.rhel7.amd64.rpm is not installed error. The package is signed, however, it’s signed with a different (rotated) key from the metadata service, which triggers the error in yum. To avoid this error, manually download the package from download.konghq.com and install it.

3.2.1.0

Release Date 2023/02/28

Deprecations

• Deprecated Alpine Linux images and packages.

  Kong is announcing our intent to remove support for Alpine images and packages later this year. These images and packages are available in 3.2 and will continue to be available in 3.3. We will stop building Alpine images and packages in Kong Gateway 3.4.

Breaking changes

• The default PostgreSQL SSL version has been bumped to TLS 1.2. In kong.conf:

  • The default pg_ssl_version is now tlsv1_2.
  • Constrained the valid values of this configuration option to only accept the following: tlsv1_1, tlsv1_2, tlsv1_3 or any.

  This mirrors the setting ssl_min_protocol_version in PostgreSQL 12.x and onward. See the PostgreSQL documentation for more information about that parameter.

  To use the default setting in kong.conf, verify that your Postgres server supports TLS 1.2 or higher versions, or set the TLS version yourself. TLS versions lower than tlsv1_2 are already deprecated and considered insecure from PostgreSQL 12.x onward.

• Added the allow_debug_header configuration property to kong.conf to constrain the Kong-Debug header for debugging. This option defaults to off.

  If you were previously relying on the Kong-Debug header to provide debugging information, set allow_debug_header: on to continue doing so.

• JWT plugin (jwt)

  • The JWT plugin now denies any request that has different tokens in the JWT token search locations. #9946

• Sessions library upgrade #10199:

  • The lua-resty-session library has been upgraded to v4.0.0. This version includes a full rewrite of the session library, and is not backwards compatible.

    This library is used by the following plugins: Session, OpenID Connect, and SAML. This also affects any session configuration that uses the Session or OpenID Connect plugin in the background, including sessions for Kong Manager and Dev Portal.

    All existing sessions are invalidated when upgrading to this version. For sessions to work as expected in this version, all nodes must run Kong Gateway 3.2.x or later. For that reason, we recommend that during upgrades, proxy nodes with mixed versions run for as little time as possible. During that time, the invalid sessions could cause failures and partial downtime.

  • Parameters:

    • The new parameter idling_timeout, which replaces cookie_lifetime, now has a default value of 900. Unless configured differently, sessions expire after 900 seconds (15 minutes) of idling.
    • The new parameter absolute_timeout has a default value of 86400. Unless configured differently, sessions expire after 86400 seconds (24 hours).
    • Many session parameters have been renamed or removed. Although your configuration will continue to work as previously configured, we recommend adjusting your configuration to avoid future unexpected behavior. Refer to the upgrade guide for 3.2 for all session configuration changes and guidance on how to convert your existing session configuration.

Features

Core

• When router_flavor is set totraditional_compatible, Kong Gateway verifies routes created using the expression router instead of the traditional router to ensure created routes are compatible. #9987
• In DB-less mode, the /config API endpoint can now flatten all schema validation errors into a single array using the optional flatten_errors query parameter. #10161
• The upstream entity now has a new load balancing algorithm option: latency. This algorithm chooses a target based on the response latency of each target from prior requests. #9787
• The Nginx charset directive can now be configured with Nginx directive injections. Set it in Kong Gateway’s configuration with nginx_http_charset #10111
• The services upstream TLS configuration is now extended to the stream subsystem. #9947
• Added the new configuration parameter ssl_session_cache_size, which lets you set the Nginx directive ssl_session_cache. This configuration parameter defaults to 10m. Thanks Michael Kotten for contributing this change. #10021
• status_listen now supports HTTP2. #9919
• The shared Redis connector now supports username + password authentication for cluster connections, improving on the existing single-node connection support. This automatically applies to all plugins using the shared Redis configuration.

Enterprise

• FIPS Support:

  • The OpenID Connect, Key Authentication - Encrypted, and JWT Signer plugins are now FIPS 140-2 compliant.

    If you are migrating from Kong Gateway 3.1 to 3.2 in FIPS mode and are using the key-auth-enc plugin, you should send PATCH or POST requests to all existing key-auth-enc credentials to re-hash them in SHA256.

  • FIPS-compliant Kong Gateway packages now support PostgreSQL SSL connections.

Kong Manager

• Improved the editor for expression fields. Any fields using the expression router now have syntax highlighting, autocomplete, and route validation.
• Improved audit logs by adding rbac_user_name and request_source. By combining the data in the new request_source field with the path field, you can now determine login and logout events from the logs. See the documentation for more detail on interpreting audit logs.
• License information can now be copied or downloaded into a file from Kong Manager.
• Kong Manager now supports the POST method for OIDC-based authentication.
• Keys and key sets can now be configured in Kong Manager.
• Optimized the color scheme for http method badges.

Plugins

• Plugin entity: Added an optional instance_name field, which identifies a particular plugin entity. #10077

• Zipkin (zipkin)

  • Added support for setting the durations of Kong phases as span tags through the configuration property phase_duration_flavor. #9891
• HTTP Log (http-log)
  • The headers configuration parameter is now referenceable, which means it can be securely stored in a vault. #9948
• AWS Lambda (aws-lambda)
  • Added the configuration parameter aws_imds_protocol_version, which lets you select the IMDS protocol version. This option defaults to v1 and can be set to v2 to enable IMDSv2. #9962
• OpenTelemetry (opentelemetry)
  • This plugin can now be scoped to individual services, routes, and consumers. #10096
• StatsD (statsd)
  • Added the tag_style configuration parameter, which allows the plugin to send metrics with tags. The parameter defaults to nil, which means that no tags are added to the metrics. #10118

• Session (session), OpenID Connect (openid-connect), and SAML (saml)

  • These plugins now use lua-resty-session v4.0.0.

    This update includes new session functionalities such as configuring audiences to manage multiple sessions in a single cookie, global timeout, and persistent cookies.

    Due to this update, there are also a number of deprecated and removed parameters in these plugins. See the invidividual plugin documentation for the full list of changed parameters in each plugin.

    • Session changelog
    • OpenID Connect changelog
    • SAML changelog
• GraphQL Rate Limiting Advanced (graphql-rate-limiting-advanced) and Rate Limiting Advanced (rate-limiting-advanced)
  • In hybrid and DB-less modes, these plugins now support sync_rate = -1 with any strategy, including the default cluster strategy.
• OPA (opa)
  • This plugin can now handle custom messages from the OPA server.
• Canary (canary)
  • Added a default value for the start field in the canary plugin. If not set, the start time defaults to the current timestamp.
• Improved Plugin Documentation
  • Split the plugin compatibility table into a technical compatibility page and a license tiers page.
  • Updated the plugin compatibility information for more clarity on supported network protocols and on entity scopes.
  • Revised docs for the following plugins to include examples:
    • CORS
    • File Log
    • HTTP Log
    • JWT Signer
    • Key Auth
    • OpenID Connect
    • Rate Limiting Advanced
    • SAML
    • StatsD

Fixes

Core

• Added back PostgreSQL FLOOR function when calculating ttl, so ttl is always returned as a whole integer. #9960
• Exposed PostreSQL connection pool configuration. #9603
• Nginx template: The default charset is no longer added to the Content-Type response header when the upstream response doesn’t contain it. #9905
• Fixed an issue where, after a valid declarative configuration was loaded, the configuration hash was incorrectly set to the value 00000000000000000000000000000000. #9911
• Updated the batch queues module so that queues no longer grow without bounds if their consumers fail to process the entries. Instead, old batches are now dropped and an error is logged. #10247
• Fixed an issue where X-Kong-Upstream-Status couldn’t be emitted when a response was buffered. #10056
• Improved the error message for invalid JWK entries. #9904
• Fixed an issue where the # character wasn’t parsed correctly from environment variables and vault references. 10132
• Fixed an issue where control plane didn’t downgrade configuration for the AWS Lambda and Zipkin plugins for older versions of data planes. #10346
• Fixed an issue in DB-less mode, where validation of regex routes could be skipped when using a configuration format older than 3.0. #10348

Enterprise

• Fixed an issue where the forward proxy between the data plane and the control plane didn’t support telemetry port 8006.
• Fix the PostgreSQL mTLS error bad client cert type.
• Fixed issues with the Admin API’s /licenses endpoint:
  • The Enterprise license wasn’t being picked up by other nodes in a cluster.
  • Vitals routes weren’t accessible.
  • Vitals wasn’t showing up in hybrid mode.
• Fixed RBAC issues:
  • Fixed an issue where workspace admins couldn’t add rate limiting policies to consumer groups.
  • Fixed an issue where workspace admins in one workspace would have admin rights in other workspaces. Workspace admins are now correctly restricted to their own workspaces.
  • Fixed a role precedence issue with RBAC. RBAC rules involving deny (negative) rules now correctly take precedence over allow (non-negative) roles.

Vitals

• Fixed an issue where Vitals wasn’t tracking the status codes of service-less routes.
• Fixed the Admin API error /vitals/reports/:entity_type is not available.

Kong Manager

• Fixed an issue where 404 Not Found errors were triggered while updating the service, route, or consumer bound to a scoped plugin.
• Moved the tags field out of the advanced fields section for certificate, route, and upstream configuration pages. The tags field is now visible without needing to expand to see all fields.
• Improved the user interface for Keys and Key Sets entities.
• You can now add tags for consumer groups in Kong Manager.
• Fixed an issue where the plugin Copy JSON button didn’t copy the full configuration.
• Fixed an issue where the password reset form didn’t check for matching passwords and allowed mismatched passwords to be submitted.
• Added a link to the upgrade prompt for Konnect or Enterprise.
• Fixed an issue where any IdP user could log into Kong Manager, regardless of their role or group membership. These users could see the Workspaces Overview dashboard with the default workspace, but they couldn’t do anything else. Now, if IdP users with no groups or roles attempt to log into Kong Manager, they will be denied access.

Plugins

• Zipkin (zipkin)
  • Fixed an issue where the global plugin’s sample ratio overrode the route-specific ratio. #9877
  • Fixed an issue where trace-id and parent-id strings with decimals were not processed correctly.

• JWT (jwt)

  • This plugin now denies requests that have different tokens in the JWT token search locations.

    Thanks Jackson ‘Che-Chun’ Kuo from Latacora for reporting this issue. #9946

• Datadog (datadog),OpenTelemetry (opentelemetry), and StatsD (statsd)

  • Fixed an issue in these plugins’ batch queue processing, where metrics would be published multiple times. This caused a memory leak, where memory usage would grow without limit. #10052 #10044
• OpenTelemetry (opentelemetry)
  • Fixed non-compliances to specification:
    • For http.uri in spans, the field is now the full HTTP URI. #10036
    • http.status_code is now present on spans for requests that have a status code. #10160
    • http.flavor is now a string value, not a double. #10160
  • Fixed an issue with getting the traces of other formats, where the trace ID reported and propagated could be of incorrect length. This caused traces originating from Kong Gateway to incorrectly connect with the target service, causing Kong Gateway and the target service to submit separate traces. #10332
• OAuth2 (oauth2)
  • refresh_token_ttl is now limited to a range between 0 and 100000000 by the schema validator. Previously, numbers that were too large caused requests to fail. #10068
• OpenID Connect (openid-connect)
  • Fixed an issue where it was not possible to specify an anonymous consumer by name.
  • Fixed an issue where the authorization_cookie_httponly and session_cookie_httponly parameters would always be set to true, even if they were configured as false.
• Rate Limiting Advanced (rate-limiting-advanced)
  • Matched the plugin’s behavior to the Rate Limiting plugin. When an HTTP 429 status code was returned, rate limiting related headers were missed from the PDK module kong.response.exit(). This made the plugin incompatible with other Kong components like the Exit Transformer plugin.
• Response Transformer (response-transformer)
  • Fixed an issue where the allow.json configuration parameter couldn’t use nested JSON object and array syntax.
• Mocking (mocking)
  • Fixed UUID pattern matching.
• SAML (saml)
  • Fixed an issue where the session_cookie_httponly parameter would always be set to true, even if it was configured as false.
• Key Authentication Encrypted (key-auth-enc)
  • Fixed the ttl parameter. You can now set ttl for an encrypted key.
  • Fixed an issue where this plugin didn’t accept tags.

Dependencies

• Bumpedlua-resty-openssl from 0.8.15 to 0.8.17
• Bumped libexpat from 2.4.9 to 2.5.0
• Bumped kong-openid-connect from v2.5.0 to v2.5.2
• Bumped openssl from 1.1.1q to 1.1.1t
• libyaml is no longer built with Kong Gateway. System libyaml is used instead.
• Bumped luarocks from 3.9.1 to 3.9.2 #9942
• Bumped atc-router from 1.0.1 to 1.0.5 #9925 #10143 #10208
• Bumped lua-resty-openssl from 0.8.15 to 0.8.17 #9583 #10144
• Bumped lua-kong-nginx-module from 0.5.0 to 0.5.1 #10181
• Bumped lua-resty-session from 3.10 to 4.0.0 #10199 #10230
• Bumped libxml from 2.10.2 to 2.10.3 to resolve CVE-2022-40303 and CVE-2022-40304

3.1.1.4

Release Date 2023/05/16

Features

• Kong Manager with OIDC:
  • Added the configuration option admin_auto_create to enable or disable automatic admin creation. This option is true by default.

Fixes

Core

• Fixed the UDP socket leak in resty.dns.client caused by frequent DNS queries. #10691
• Hybrid mode: Fixed an issue where Vitals/Analytics couldn’t communicate through the cluster telemetry endpoint.
• Fixed an issue where alpine and ubuntu ARM64 artifacts incorrectly handled HTTP/2 requests, causing the protocol to fail.
• Fixed the OpenResty ngx.print chunk encoding duplicate free buffer issue that lead to the corruption of chunk-encoded response data. #10816 #10824
• Fixed the Dynatrace implementation. Due to a build system issue, Kong Gateway 3.1.x packages prior to 3.1.1.4 didn’t contain the debug symbols that Dynatrace requires.

Enterprise

Kong Manager:

• Fixed configuration fields for the StatsD plugin:
  • Added missing metric fields: consumer_identifier, service_identifier, and workspace_identifier.
  • Removed the non-existent custom_identifier field.
• Fixed an issue where the Copy JSON for a plugin didn’t copy the full plugin configuration.
• Fixed an issue where the Zipkin plugin didn’t allow the addition of static_tags through the Kong Manager UI.
• Added missing default values to the Vault configuration page.

• Fixed the broken Konnect link in free mode banners.

• OIDC authentication issues:

  • The /auth endpoint, used by Kong Manager for OIDC authentication, now correctly supports the HTTP POST method.
  • Fixed an issue with OIDC authentication in Kong Manager, where the default roles (workspace-super-admin, workspace-read-only, workspace-portal-admin, and workspace-admin) were missing from any newly created workspace.
  • Fixed an issue where users with newly registered Dev Portal accounts created through OIDC were unable to log into Dev Portal until the Kong Gateway container was restarted. This happened when by_username_ignore_case was set to true, which incorrectly caused consumers to always load from cache.

Plugins

• Request Transformer Advanced (request-transformer-advanced)
  • Fixed an issue that was causing some requests to be proxied with the wrong query parameters.

3.1.1.3

Release Date 2023/01/30

Fixes

Enterprise

• Fixed the accidental removal of the ca-certificates dependency from packages and images. This prevented SSL connections from using common root certificate authorities.

Upgrades

You can now directly upgrade to Kong Gateway 3.1.1.3 from 2.8.x.x. Previously, you had to upgrade to 3.0.x first, then upgrade to the latest 3.x version.

3.1.1.2

Release Date 2023/01/24

Features

Enterprise

• Dev Portal:
  • The Dev Portal API now supports an optional fields query parameter on the /files endpoint. This parameter lets you specify which file object fields should be included in the response.

Core

• When router_flavor is traditional_compatible, verify routes created using the Expression router instead of the traditional router to ensure created routes are actually compatible. #10088

• kong migrations up now reports routes that are incompatible with the 3.0 router and stops the migration progress so that admins have a chance to adjust them.

  #10092 #10101

Fixes

Enterprise

• Kong Manager:
  • Fixed issues with the plugin list:
    • Added missing icons and categories for the TLS Handshake Modifier and TLS Metadata Headers plugins.
    • Removed entries for the following deprecated plugins: Kubernetes Sidecar Injector, Collector, and Upstream TLS.
    • Removed Apache OpenWhisk plugin from Kong Manager. This plugin must be installed manually via LuaRocks.
    • Removed the internal-only Konnect Application Auth plugin.
  • Fixed an issue where Kong Manager would occasionally log out while redirecting to other pages or refreshing the page when OpenID Connect was used as the authentication method.
  • Fixed an issue where 404 Not Found errors were triggered while updating the service, route, or consumer bound to a scoped plugin.
  • Fixed an issue where admins with the permission ['create'] /services/*/plugins couldn’t create plugins under a service.
  • Fixed an issue where viewing a consumer group in any workspace other than default would cause a 404 Not Found error.

Core

• Fixed an issue where regexes generated in inso would not work in Kong Gateway.
• Bumped atc-router to 1.0.2 to address the potential worker crash issue. #9927

Hybrid mode

• Fixed an issue where Vitals data was not showing up after a license was deployed using the /licenses endpoint. Kong Gateway now triggers an event that allows the Vitals subsystem to be reinitialized during license preload.
• Fixed an issue where the forward proxy between data planes and the control plane didn’t support the telemetry port 8006.
• Reverted the removal of WebSocket protocol support for configuration sync. Backwards compatibility with 2.8.x.x data planes has been restored. #10067

Plugins

• Datadog (datadog),OpenTelemetry (opentelemetry), and StatsD (statsd)
  • Fixed an issue in these plugins’ batch queue processing, where metrics would be published multiple times. This caused a memory leak, where memory usage would grow without limit.
• Rate Limiting Advanced (rate-limiting-advanced)
  • Fixed an issue with the local strategy, which was not working correctly when window_size was set to fixed, and the cache would expire while the window was still valid.
• OAS Validation (oas-validation)
  • Added the OAS Validation plugin back into the bundled plugins list. The plugin is now available by default with no extra configuration necessary through kong.conf.
  • Fixed an issue where the plugin returned the wrong error message when failing to get the path schema spec.
  • Fixed a 500 error that occurred when the response body schema had no content field.
• mTLS Authentication (mtls-auth)
  • Fixed an issue where the plugin used the old route caches after routes were updated.

Deprecations

• Support for the /vitals/reports/:entity_type endpoint is deprecated. Use one of the following endpoints from the Vitals API instead:

  • For /vitals/reports/consumer, use /{workspace_name}/vitals/status_codes/by_consumer instead
  • For /vitals/reports/service, use /{workspace_name}/vitals/status_codes/by_service instead
  • For /vitals/reports/hostname, use /{workspace_name}/vitals/nodes instead

  See the Vitals documentation for more detail.

Known issues

• The ca-certificates dependency is missing from packages and images. This prevents SSL connections from using common root certificate authorities.

  Upgrade to 3.1.1.3 to resolve.

3.1.0.0

Release Date 2022/12/06

Features

Enterprise

• You can now specify the namespaces of HashiCorp Vaults for secrets management.

• Added support for HashiCorp Vault backends to retrieve a vault token from a Kubernetes service account. See the following configuration parameters:

  • keyring_vault_auth_method
  • keyring_vault_kube_role
  • keyring_vault_kube_api_token_file
• FIPS 140-2 packages:
  • Kong Gateway Enterprise now provides FIPS 140-2 compliant packages for Red Hat Enterprise 8 and Ubuntu 22.04.
  • Kong Gateway FIPS distributions now support TLS connections to the PostgreSQL database.

• You can now delete consumer group configurations without deleting the group or the consumers in it.

• Kong Manager:

  • You can now configure the base path for Kong Manager, for example: localhost:8445/manager. This allows you to proxy all traffic through Kong Gateway. For example, you can proxy both API and Kong Manager traffic from one port. In addition, using the new Kong Manager base path allows you to add plugins to control access to Kong Manager. For more information, see Enable Kong Manager.
  • You can now create consumer groups in Kong Manager. This allows you to define any number of rate limiting tiers and apply them to subsets of consumers instead of managing each consumer individually. For more information, see Create Consumer Groups in Kong Manager.
  • You can now add key-auth-enc credentials to a consumer.
  • OpenID Connect plugin: More authorization variables have been added to the Authorization tab.
  • The Kong Manager overview tab has been optimized for performance.
  • You can now configure vaults for managing secrets through Kong Manager. Use the new Vaults menu to set up and manage any vaults that Kong Gateway supports. See the Vault Backends references for descriptions of all the configuration options.
  • Added support for interfacing with dynamic plugin ordering.
  • Added the ability to view details about certificates.
  • Added tooltips to plugin UI with field descriptions.
  • Added support for persisting the page size of lists across pages and provided more options for page sizes.

Core

• Allow kong.conf SSL properties to be stored in vaults or environment variables. Allow such properties to be configured directly as content or base64 encoded content. #9253
• Added support for full entity transformations in schemas. #9431
• The schema map type field can now be marked as referenceable. #9611
• Added support for dynamically changing the log level. #9744
• Added support for the keys and key-sets entities. These are used for managing asymmetric keys in various formats (JWK, PEM). For more information, see Key management. #9737

Hybrid Mode

• Data plane node IDs will now persist across restarts. #9067
• Added HTTP CONNECT forward proxy support for hybrid mode connections. New configuration options cluster_use_proxy, proxy_server and proxy_server_ssl_verify are added. For more information, see CP/DP Communication through a Forward Proxy. #9758 #9773

Performance

• Increase the default value of lua_regex_cache_max_entries. A warning will be thrown when there are too many regex routes and router_flavor is traditional. #9624
• Add batch queue into the Datadog and StatsD plugins to reduce timer usage. #9521

OS support

• Kong Gateway now supports Amazon Linux 2022 with Enterprise packages.
• Kong Gateway now supports Ubuntu 22.04 with both open-source and Enterprise packages.

PDK

• Extend kong.client.tls.request_client_certificate to support setting the Distinguished Name (DN) list hints of the accepted CA certificates. #9768

Plugins

New plugins:

• AppDynamics (app-dynamics)
  • Integrate Kong Gateway with the AppDynamics APM Platform.
• JWE Decrypt (jwe-decrypt)
  • Allows you to decrypt an inbound token (JWE) in a request.
• OAS Validation (oas-validation)
  • Validate HTTP requests and responses based on an OpenAPI 3.0 or Swagger API Specification.
• SAML (saml)
  • Provides SAML v2.0 authentication and authorization between a service provider (Kong Gateway) and an identity provider (IdP).
• XML Threat Protection (xml-threat-protection)
  • This new plugin allows you to reduce the risk of XML attacks by checking the structure of XML payloads. This validates maximum complexity (depth of the tree), maximum size of elements and attributes.

Updates to existing plugins:

• ACME (acme)
  • Added support for Redis SSL, through configuration properties config.storage_config.redis.ssl, config.storage_config.redis.ssl_verify, and config.storage_config.redis.ssl_server_name. #9626
• AWS Lambda (aws-lambda)
  • Added requestContext field into awsgateway_compatible input data #9380
• Authentication plugins:
  • The anonymous field can now be configured as the username of the consumer. This field allows you to configure a string to use as an “anonymous” consumer if authentication fails.
• OpenTelemetry (opentelemetry)
  • Added referenceable attribute to the headers field that could be stored in vaults. #9611

• Forward Proxy (forward-proxy)

  • x_headers field added. This field indicates how the plugin handles the headers X-Real-IP, X-Forwarded-For, X-Forwarded-Proto, X-Forwarded-Host, and X-Forwarded-Port.

    The field can take one of the following options:

    • append: append information from this hop in the chain to those headers. This is the default setting.
    • transparent: leave the headers unchanged, as if the the Kong Gateway was not a proxy.
    • delete: remove all the headers, as if the Kong Gateway was the originating client.

    Note that all options respect the trusted IP setting, and will ignore headers from the last hop in the chain if they are not from clients with trusted IPs.

• Mocking (mocking)

  • Added the included_status_codes and random_status_code fields. These allow you to configure the HTTP status codes for the plugin.
  • The plugin now lets you auto-generate a random response based on the schema definition without defining examples.
  • You can now control behavior or obtain a specific response by sending behavioral headers: X-Kong-Mocking-Delay, X-Kong-Mocking-Example-Id, and X-Kong-Mocking-Status-Code.
  • This plugin now supports:
    • MIME types priority match
    • All HTTP codes
    • $ref
• mTLS Authentication (mtls-auth)
  • Added the config.send_ca_dn configuration parameter to support sending CA DNs in the CertificateRequest message during SSL handshakes.
  • Added the allow_partial_chain configuration parameter to allow certificate verification with only an intermediate certificate.
• OPA (OPA)
  • Added the include_uri_captures_in_opa_input field. When this field is set to true, the regex capture groups captured on the Kong Gateway route’s path field in the current request (if any) are included as input to OPA.
• Proxy Cache Advanced (proxy-cache-advanced)
  • Added support for integrating with Redis clusters through the config.redis.cluster_addresses configuration property.
• Rate Limiting (rate-limiting)
  • The HTTP status code and response body for rate-limited requests can now be customized. Thanks, @utix! #8930
• Rate Limiting Advanced (rate-limiting-advanced)
  • Added support for deleting customer groups using the API.
  • Added config.disable_penalty to control whether to count 429 or not in sliding window mode.
• Request Transformer Advanced (request-transformer-advanced)
  • Added support for navigating nested JSON objects and arrays when transforming a JSON payload.
  • The plugin now supports vault references.
• Request Validator (request-validator)
  • The plugin now supports the charset option for the config.allowed_content_types parameter.
• Response Rate Limiting (response-ratelimiting)
  • Added support for Redis SSL through configuration properties redis_ssl (can be set to true or false), ssl_verify, and ssl_server_name. Thanks, @dominikkukacka! #8595
• Route Transformer Advanced (route-transformer-advanced)
  • Added the config.escape_path configuration parameter, which lets you escape the transformed path.
• Session (session)
  • Added new config cookie_persistent, which allows the browser to persist cookies even if the browser is closed. This defaults to false which means cookies are not persisted across browser restarts. Thanks @tschaume for this contribution! #8187
• Vault Authentication (vault-auth)
  • Added support for KV Secrets Engine v2.
• Zipkin (zipkin)
  • Added the response_header_for_traceid field in Zipkin plugin. The plugin sets the corresponding header in the response if the field is specified with a string value. #9173
• WebSocket service/route support was added for logging plugins:
  • http-log
  • file-log
  • udp-log
  • tcp-log
  • loggly
  • syslog
  • kafka-log

Known limitations

• With Dynamic log levels, if you set log-level to alert you will still see info and error entries in the logs.

Fixes

Enterprise

• Fixed an issue where the RBAC token was not re-hashed after an update on the user_token field.
• Fixed an issue where admin_gui_auth_conf wouldn’t accept a JSON-formatted value, and was therefore unable to use vault references to secrets.
• Fixed an issue where Admin GUI logs were not stored in the correct log file.
• Fixed an issue where Kong Gateway was unable to start in free Enterprise mode while using vaults.
• Updated the response body for the TRACE method request.
• Targets with a weight of 0 are no longer included in health checks, and checking their status via the upstreams/<upstream>/health endpoint results in the status HEALTHCHECK_OFF. Previously, the upstreams/<upstream>/health endpoint was incorrectly reporting targets with weight=0 as HEALTHY, and the health check was reporting the same targets as UNDEFINED.
• Updated the Admin API response status code from 500 to 200 when the database is down.
• Fixed an issue when passing a license from the control plane to the data plane using the Admin API /licenses endpoint.
• In hybrid mode, fixed a license issue where entity validation would fail when the license entity was not processed first.
• Fixed a Websockets issue with redirects. Now, Kong Gateway redirects ws requests to wss for wss-only routes for parity with HTTP/HTTPS.
• Kong Manager:
  • Added logging for all Kong Manager access logs.
  • Fixed an issue where the New Workspace button was occasionally unusable.
  • Fixed the name display of plugin configurations in Kong Manager.
  • Fixed an issue where some items were missing from the suggestion list when there were many items present.
  • Removed the deprecated Vitals Reports feature from Kong Manager.
  • Fixed an issue where admins with permissions to interact with scoped entities, such as routes and services, couldn’t perform operations as expected.
  • Fixed an issue where admins with the /admins permission were forced to log out after signing in.
  • Fixed a performance issue where admins with a large number of workspace permissions caused Kong Manager to load slowly.

Core

• Fixed an issue where external plugins crashing with unhandled exceptions would cause high CPU utilization after the automatic restart. #9384
• Added use_srv_name options to upstream for balancer. #9430
• Fixed an issue in header_filter instrumentation where the span was not correctly created. #9434
• Fixed an issue in router building in traditional_compatible mode. When the field contained an empty table, the generated expression was invalid. #9451
• Fixed an issue in router rebuilding where when the paths field is invalid, the router’s mutex is not released properly. #9480
• Fixed an issue where kong docker-start would fail if KONG_PREFIX was set to a relative path. #9337
• Fixed an issue with error-handling and process cleanup in kong start. #9337
• Fixed issue with prefix path normalization. #9760
• Increased the maximum request argument number of the Admin API from 100 to 1000. The Admin API now returns a 400 error if request parameters reach the limitation instead of truncating any parameters over the limit. #9510
• Paging size parameter is now propagated to next page if specified in current request. #9503

Hybrid Mode

• Fixed a race condition that could cause configuration push events to be dropped when the first data plane connection was established with a control plane worker. #9616

CLI

• Fixed slow CLI performance due to pending timer jobs. #9536

PDK

• Added support for kong.request.get_uri_captures (kong.request.getUriCaptures) #9512
• Fixed parameter type of kong.service.request.set_raw_body (kong.service.request.setRawBody), return type of kong.service.response.get_raw_body(kong.service.request.getRawBody), and body parameter type of kong.response.exit to bytes. Note that the old version of the go PDK is incompatible after this change. #9526

Plugins

• Added the missing protocols field to the following plugin schemas:

  • Azure Functions (azure-functions)
  • gRPC Gateway (grpc-gateway)
  • gRPC Web (grpc-web)
  • Serverless pre-function (pre-function)
  • Prometheus (prometheus)
  • Proxy Caching (proxy-cache)
  • Request Transformer (request-transformer)
  • Session (session)
  • Zipkin (zipkin)

  #9525

• AWS Lambda (aws-lambda)

  • Fixed an issue that was causing inability to read environment variables in ECS environment. #9460
  • Specifying a null value for the isBase64Encoded field in lambda output now results in a more obvious error log entry with a 502 code. #9598
• Azure Functions (azure-functions)
  • Fixed an issue where calls made by this plugin would fail in the following situations:
    • The plugin was associated with a route that had no service.
    • The route’s associated service had a path value. #9177
• HTTP Log (http-log)
  • Fixed an issue where queue ID serialization did not include queue_size and flush_timeout. #9789
• Mocking (mocking)
  • Fixed an issue with accept headers not being split and not working with wildcards. The ;q= (q-factor weighting) of accept headers is now supported.
• OPA (opa)
  • Removed redundant deprecated code from the plugin.
• OpenTelemetry (opentelemetry)
  • Fixed an issue that the default propagation header was not configured to w3c correctly. #9457
  • Replaced the worker-level table cache with BatchQueue to avoid data race. #9504
  • Fixed an issue that the parent_id was not set on the span when propagating w3c traceparent. #9628
• Proxy Cache Advanced (proxy-cached-advanced)
  • The plugin now catches the error when Kong Gateway connects to Redis SSL port 6379 with config.ssl=false.
• Rate Limiting Advanced (rate-limiting-advanced)
  • The plugin now ensures that shared dict TTL is higher than config.sync_rate, otherwise Kong Gateway would lose all request counters in shared dict.
• Request Transformer (request-transformer)
  • Fixed a bug when header renaming would override the existing header and cause unpredictable results. #9442
• Request Termination (request-termination)
  • The plugin no longer allows setting status_code to null. #9400
• Response Transformer (response-transformer)
  • Fixed the bug that the plugin would break when receiving an unexpected body. #9463
• Zipkin (zipkin)
  • Fixed an issue where Zipkin plugin couldn’t parse OT baggage headers due to an invalid OT baggage pattern. #9280

Breaking changes

Hybrid mode

• The legacy hybrid configuration protocol has been removed in favor of the wRPC protocol introduced in 3.0.0.0. Rolling upgrades from 2.8.x.y to 3.1.0.0 are not supported. Operators must upgrade to 3.0.x.x before they can perform a rolling upgrade to 3.1.0.0. For more information, see Upgrade Kong Gateway 3.1.x. #9740

3.0.1.0

Release Date 2022/11/02

Features

Plugins

• Request Transformer Advanced (request-transformer-advanced)
  • Values stored in key:value pairs in this plugin’s configuration are now referenceable, which means they can be stored as secrets in a vault.

Fixes

Enterprise

• Kong Manager:
  • Removed the endpoint all_routes from configurable RBAC endpoint permissions. This endpoint was erroneously appearing in the endpoints list, and didn’t configure anything.
  • Fixed an issue that allowed unauthorized IDP users to log in to Kong Manager. These users had no access to any resources in Kong Manager, but were able to go beyond the login screen.
  • Fixed an issue where, in an environment with a valid Enterprise license, admins with no access to the default workspace would see a message prompting them to upgrade to Kong Enterprise.
  • Fixed pagination issues with Kong Manager tables.
  • Fixed broken Learn more links.
  • Fixed an issue with group to role mapping, where it didn’t support group names with spaces.
  • Fixed the Cross Site Scripting (XSS) security vulnerability in the Kong Manager UI.
  • Fixed an RBAC issue where permissions applied to specific endpoints (for example, an individual service or route) were not reflected in the Kong Manager UI.
  • Removed New Relic from Kong Manager. Previously, VUE_APP_NEW_RELIC_LICENSE_KEY and VUE_APP_SEGMENT_WRITE_KEY were being exposed in Kong Manager with invalid values.
  • Removed the action dropdown menu on service and route pages for read-only users.
  • Fixed the Edit Configuration button for Dev Portal applications.
  • Fixed an RBAC issue where the roles page listed deleted roles.
  • Fixed an issue where the orphaned roles would remain after deleting a workspace and cause the Teams > Admins page to break.
  • Added the missing Copy JSON button for plugin configuration.
  • Fixed an issue where the New Workspace button on the global workspace dashboard wasn’t clickable on the first page load.
  • Removed the ability to add multiple documents per service from the UI. Each service only supports one document, so the UI now reflects that.
  • The Upstream Timeout plugin now has an icon and is part of the Traffic Control category.
  • Fixed an error that would occur when attempting to delete ACL credentials from the consumer credentials list. This happened because the name of the plugin, acl, and its endpoint, /acls, don’t match.
  • Fixed a caching issue with Dev Portal, where enabling or disabling the Dev Portal for a workspace wouldn’t change the Kong Manager menu.
• Unpinned the version of alpine used in the kong/kong-gateway Docker image. Previously, the version was pinned to 3.10, which was creating outdated alpine builds.

Core

• Fixed an issue with how Kong initializes resty.events. The code was previously using ngx.config.prefix() to determine the listening socket path to provide to the resty.events module. This caused breakage when Nginx was started with a relative path prefix. This meant that you couldn’t start 3.0.x with the same default configuration as 2.8.x.

  Instead of using ngx.config.prefix(), Kong will now prefer the kong.configuration.prefix when available, as it is already normalized to an absolute path. If kong.configuration.prefix is not defined, the result of ngx.config.prefix() will be used after resolving it to an absolute path. #9337

• Fixed an issue with secret management references for HashiCorp Vault. By default, Kong passes secrets to the Nginx using environment variables when using kong start. Nginx was being started directly without calling kong start, so the secrets were not available at initialization. #9478

• Fixed the Amazon Linux RPM installation instructions.

3.0.0.0

Release Date 2022/09/09

Important: Kong Gateway 3.0.0.0 is a major release and contains breaking changes. Review the breaking changes and deprecations and the known limitations before attempting to upgrade.

Features

Enterprise

• Kong Gateway now supports dynamic plugin ordering. You can change a plugin’s static priority by specifing the order in which plugins run. This lets you run plugins such as rate-limiting before authentication plugins.

• Kong Gateway now offers a FIPS package. The package replaces the primary library, OpenSSL, with BoringSSL, which at its core uses the FIPS 140-2 compliant BoringCrypto for cryptographic operations.

  To enable FIPS mode, set fips to on. FIPS mode is only supported in Ubuntu 20.04.

  Note: The Kong Gateway FIPS package is not currently compatible with SSL connections to PostgreSQL.

• Kong Gateway now includes WebSocket validation functionality. Websockets are a type of persistent connection that works on top of HTTP.

  Previously, Kong Gateway 2.x supported limited WebSocket connections, where plugins only ran during the initial connection phase instead of for each frame. Now, Kong Gateway provides more control over WebSocket traffic by implementing plugins that target WebSocket frames.

  This release includes:

  • Service and route support for ws and wss protocols
  • Two new plugins: WebSocket Size Limit and WebSocket Validator
  • WebSocket plugin development capabilities (Beta feature)
    • PDK modules: kong.websocket.client and kong.websocket.upstream
    • New plugin handlers

  Learn how to develop WebSocket plugins with our plugin development guide.

• In this release, Kong Manager ships a with a refactored design and improved user experience.

  Notable changes:

  • Reworked workspace dashboards, both for specific workspaces and at the multi-workspace level.
  • License metrics now appear at the top of overview pages.
  • Restructured the layout and navigation to make workspace selection a secondary concern.
  • Grayed out portal buttons when you don’t have permissions.
  • Added license level to phone home metrics.
  • Added more tooltips.
• Secrets management is now generally available.
  • Added GCP integration support for the secrets manager. GCP is now available as a vault backend.
  • The /vaults-beta entity has been deprecated and replaced with the /vaults entity. #8871 #9217

• Kong Gateway now provides slim and UBI images. Slim images are docker containers built with a minimal set of installed packages to run Kong Gateway. From 3.0 onward, Kong Docker images will only contain software required to run the Gateway. This ensures that false positive vulnerabilities don’t get flagged during security scanning.

  If you want to retain or add other dependencies, you can build custom Kong Docker images.

• The base OS for our convenience docker tags (for example, latest, 3.0.0.0, 3.0) has switched from Alpine to Debian.

• Added key recovery for keyring encryption. This exposes a new endpoint for the Admin API, /keyring/recover, and requires keyring_recovery_public_key to be set in kong.conf.

• You can now encrypt declarative configuration files on data planes in DB-less and hybrid modes using AES-256-GCM or chacha20-poly1305 encryption algorithms.

  Set your desired encryption mode with the declarative_config_encryption_mode configuration parameter.

Core

• This release introduces a new router implementation: atc-router. This router is written in Rust, a powerful routing language that can handle complex routing requirements. The new router can be used in traditional-compatible mode, or use the new expression-based language.

  With the new router, we have:

  • Reduced router rebuild time when changing Kong’s configuration
  • Increased runtime performance when routing requests
  • Reduced P99 latency from 1.5s to 0.1s with 10,000 routes

  Learn more about the router:

  • Configure routes using expressions
  • Router Expressions Language reference
  • #8938
• Implemented delayed response in stream mode. #6878
• Added cache_key on target entity for uniqueness detection. #8179

• Introduced the tracing API, which is compatible with OpenTelemetry API specs, and adds built-in instrumentations.

  The tracing API is intended to be used with a external exporter plugin. Built-in instrumentation types and sampling rate are configurable through the opentelemetry_tracing and opentelemetry_tracing_sampling_rate options. #8724

• Added path, uri_capture, and query_arg options to upstream hash_on for load balancing. #8701

• Introduced Unix domain socket-based lua-resty-events to replace shared memory-based lua-resty-worker-events. #8890
• Introduced the table_name field for entities. This field lets you specify a table name. Previously, the name was deduced by the entity name attribute. #9182
• Added headers on active health checks for upstreams. #8255
• Target entities using hostnames were resolved when they were not needed. Now when a target is removed or updated, the DNS record associated with it is removed from the list of hostnames to be resolved. #8497 9265
• Improved error handling and debugging info in the DNS code. #8902
• Kong Gateway will now attempt to recover from an unclean shutdown by detecting and removing dangling Unix sockets in the prefix directory. #9254
• A new CLI command, kong migrations status, generates the migration status in a JSON file.
• Removed the warning for AAAA being experimental with dns_order.

Performance

• Kong Gateway does not register unnecessary event handlers on hybrid mode control plane nodes anymore. #8452.
• Use the new timer library to improve performance, except for the plugin server. #8912
• Increased the use of caching for DNS queries by activating additional_section by default. #8895
• pdk.request.get_header has been changed to a faster implementation. It doesn’t fetch all headers every time it’s called. #8716
• Conditional rebuilding of the router, plugins iterator, and balancer on data planes. #8519, #8671
• Made configuration loading code more cooperative by yielding. #8888
• Use the LuaJIT encoder instead of JSON to serialize values faster in LMDB. #8942
• Made inflating and JSON decoding non-concurrent, which avoids blocking and makes data plane reloads faster. #8959
• Stopped duplication of some events. #9082
• Improved performance of configuration hash calculation by using string.buffer and tablepool. #9073
• Reduced cache usage in DB-less mode by not using the Kong cache for routes and services in LMDB. #8972

Admin API

• Added a new /timers Admin API endpoint to get timer statistics and worker info. #8912 #8999
• The / endpoint now includes plugin priority. #8821

Hybrid Mode

• Added wRPC protocol support. Configuration synchronization now happens over wRPC. wRPC is an RPC protocol that encodes with ProtoBuf and transports with WebSocket. #8357
  • To keep compatibility with earlier versions, added support for the control plane to fall back to the previous protocol to support older data planes. #8834
  • Added support to negotiate services supported with wRPC protocol. We will support more services in the future. #8926
• Declarative configuration exports now happen inside a transaction in PostgreSQL. #8586

Plugins

• Starting with version 3.0, all bundled plugin versions are the same as the Kong Gateway version. #8772

  Plugin documentation now refers to the Kong Gateway version instead of the individual plugin version.

• New plugins:

  • OpenTelemetry (opentelemetry)

    Export tracing instrumentations to any OTLP/HTTP compatible backend. opentelemetry_tracing configuration must be enabled to collect the core tracing spans of Kong Gateway. #8826

  • TLS Handshake Modifier (tls-handshake-modifier)

    Make certificates available to other plugins acting on the same request.

  • TLS Metadata Headers (tls-metadata-headers)

    Proxy TLS client certificate metadata to upstream services via HTTP headers.

  • WebSocket Size Limit (websocket-size-limit)

    Allows operators to specify a maximum size for incoming WebSocket messages.

  • WebSocket Validator (websocket-validator)

    Validate individual WebSocket messages against a user-specified schema before proxying them.

• ACME (acme)

  • Added the allow_any_domain field. It defaults to false and if set to true, the gateway will ignore the domains field. #9047
• AWS Lambda (aws-lambda)
  • Added support for cross-account invocation through the aws_assume_role_arn and aws_role_session_name configuration parameters. #8900
  • The plugin now accepts string type statusCode as a valid return when working in proxy integration mode. #8765
  • The plugin now separates AWS credential cache by the IAM role ARN. #8907
• Collector (collector)
  • The deprecated Collector plugin has been removed.
• DeGraphQL (degraphql)
  • The GraphQL server path is now configurable with the graphql_server_path configuration parameter.
• Kafka Upstream (kafka-upstream) and Kafka Log (kafka-log)
  • Added support for the SCRAM-SHA-512 authentication mechanism.
• LDAP Authentication Advanced (ldap-auth-advanced)
  • This plugin now allows authorization based on group membership. The new configuration parameter, groups_required, is an array of string elements that indicates the groups that users must belong to for the request to be authorized.
  • The character . is now allowed in group attributes.
  • The character : is now allowed in the password field.
• mTLS Authentication (mtls-auth)
  • Introduced certificate revocation list (CRL) and OCSP server support with the following parameters: http_proxy_host, http_proxy_port, https_proxy_host, and https_proxy_port.

• OPA (opa)

  • New configuration parameter include_body_in_opa_input: When enabled, include the raw body as a string in the OPA input at input.request.http.body and the body size at input.request.http.body_size.

  • New configuration parameter include_parsed_json_body_in_opa_input: When enabled and content-type is application/json, the parsed JSON will be added to the OPA input at input.request.http.parsed_body.

• Prometheus (prometheus)

  • High cardinality metrics are now disabled by default.
  • Decreased performance penalty to proxy traffic when collecting metrics.

  • The following metric names were adjusted to add units to standardize where possible:

    • http_status to http_requests_total.

    • latency to kong_request_latency_ms (HTTP), kong_upstream_latency_ms, kong_kong_latency_ms, and session_duration_ms (stream).

      Kong latency and upstream latency can operate at orders of different magnitudes. Separate these buckets to reduce memory overhead.

    • kong_bandwidth to kong_bandwidth_bytes.

    • nginx_http_current_connections and nginx_stream_current_connections were merged into to nginx_hconnections_total (or nginx_current_connections?)

    • request_count and consumer_status were merged into http_requests_total.

      If the per_consumer config is set to false, the consumer label will be empty. If the per_consumer config is true, the consumer label will be filled.

  • Removed the following metric: http_consumer_status

  • New metrics:
    • session_duration_ms: monitoring stream connections.
    • node_info: Single gauge set to 1 that outputs the node’s ID and Kong Gateway version.
  • http_requests_total has a new label, source. It can be set to exit, error, or service.
  • All memory metrics have a new label: node_id.
  • Updated the Grafana dashboard that comes packaged with Kong
• StatsD (statsd)
  • Newly open-sourced plugin capabilities: All capabilities of the StatsD Advanced plugin are now bundled in the StatsD plugin. #9046
• Zipkin (zipkin)
  • Added support for including the HTTP path in the span name with the http_span_name configuration parameter. #8150
  • Added support for socket connect and send/read timeouts through the connect_timeout, send_timeout, and read_timeout configuration parameters. This can help mitigate ngx.timer saturation when upstream collectors are unavailable or slow. #8735

Configuration

• You can now configure openresty_path to allow developers and operators to specify the OpenResty installation to use when running Kong Gateway, instead of using the system-installed OpenResty. #8412
• Added ipv6only to listen options admin_listen, proxy_listen, and stream_listen. #9225
• Added so_keepalive to listen options admin_listen, proxy_listen, and stream_listen. #9225
• Add LMDB DB-less configuration persistence and removed the JSON-based configuration cache for faster startup time. #8670
• nginx_events_worker_connections=auto now has a lower bound of 1024. #9276
• nginx_main_worker_rlimit_nofile=auto now has a lower bound of 1024. #9276

PDK

• Added new PDK function: kong.request.get_start_time(). This function returns the request start time, in Unix epoch milliseconds. #8688
• The function kong.db.*.cache_key() now falls back to .id if nothing from cache_key is found. #8553

Known limitations

• Kong Manager does not currently support the following features:
  • Secrets management
  • Plugin ordering
  • Expression-based routing
• Blue-green migration from 2.8.x (and below) to 3.0.x is not supported.
  • This is a known issue planned to be fixed in the next 2.8 release. If this is a requirement for upgrading, Kong operators should upgrade to that version before beginning a upgrade to 3.0.0.0.
  • See Upgrade Kong Gateway for more details.

• OpenTracing: There is an issue with nginx-opentracing in this release, so it is not recommended to upgrade yet if you are an OpenTracing user. This will be rectified in an upcoming patch/minor release.

• The Kong Gateway FIPS package is not currently compatible with SSL connections to PostgreSQL.

Breaking changes and deprecations

Deployment

• Deprecated and stopped producing Amazon Linux 1 containers and packages. Amazon Linux 1 reached end-of-life on December 31, 2020. Kong/docs.konghq.com #3966
• Deprecated and stopped producing Debian 8 (Jessie) containers and packages. Debian 8 reached end-of-life in June 30, 2020. Kong/kong-build-tools #448

Core

• As of 3.0, Kong Gateway’s schema library’s process_auto_fields function will not make deep copies of data that is passed to it when the given context is select. This was done to avoid excessive deep copying of tables where we believe the data most of the time comes from a driver like pgmoon or lmdb.

  If a custom plugin relied on process_auto_fields not overriding the given table, it must make its own copy before passing it to the function now. #8796

• The deprecated shorthands field in Kong plugin or DAO schemas was removed in favor of the typed shorthand_fields. If your custom schemas still use shorthands, you need to update them to use shorthand_fields. #8815

• The support for legacy = true/false attribute was removed from Kong schemas and Kong field schemas. #8958
• The deprecated alias of Kong.serve_admin_api was removed. If your custom Nginx templates still use it, change it to Kong.admin_content. #8815
• The Kong singletons module kong.singletons was removed in favor of the PDK kong.*. #8874
• The data plane configuration cache was removed. Configuration persistence is now done automatically with LMDB. #8704
• ngx.ctx.balancer_address was removed in favor of ngx.ctx.balancer_data. #9043
• The normalization rules for route.path have changed. Kong Gateway now stores the unnormalized path, but the regex path always pattern-matches with the normalized URI. Previously, Kong Gateway replaced percent-encoding in the regex path pattern to ensure different forms of URI matches. That is no longer supported. Except for the reserved characters defined in rfc3986, write all other characters without percent-encoding. #9024
• Kong Gateway no longer uses a heuristic to guess whether a route.path is a regex pattern. From 3.0 onward, all regex paths must start with the "~" prefix, and all paths that don’t start with "~" will be considered plain text. The migration process should automatically convert the regex paths when upgrading from 2.x to 3.0. #9027

• Bumped the version number (_format_version) of declarative configuration to 3.0 for changes on route.path. Declarative configurations using older versions are upgraded to 3.0 during migrations.

  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

• Tags may now contain space characters. #9143

• Support for the nginx-opentracing module is deprecated as of 3.0 and will be removed from Kong in 4.0 (see the Known Limitations section for additional information).
• We removed regex look-around and backreferences support in the the atc-router. These are rarely used features and removing support for them improves the speed of our regex matching. If your current regexes use look-around or backreferences you will receive an error when attempting to start Kong, showing exactly what regex is incompatible. Users can either switch to the traditional router flavor or change the regex to remove look-around / backreferences.

Admin API

• The Admin API endpoint /vitals/reports has been removed.
• POST requests on /targets endpoints are no longer able to update existing entities. They are only able to create new ones. #8596, #8798. If you have scripts that use POST requests to modify /targets, change them to PUT requests to the appropriate endpoints before updating to Kong Gateway 3.0.
• Insert and update operations on duplicated targets return a 409 error. #8179, #8768
• The list of reported plugins available on the server now returns a table of metadata per plugin instead of a boolean true. #8810

PDK

• The kong.request.get_path() PDK function now performs path normalization on the string that is returned to the caller. The raw, non-normalized version of the request path can be fetched via kong.request.get_raw_path(). #8823
• pdk.response.set_header(), pdk.response.set_headers(), pdk.response.exit() now ignore and emit warnings for manually set Transfer-Encoding headers. #8698
• The PDK is no longer versioned. #8585
• The JavaScript PDK now returns Uint8Array for kong.request.getRawBody, kong.response.getRawBody, and kong.service.response.getRawBody. The Python PDK returns bytes for kong.request.get_raw_body, kong.response.get_raw_body, and kong.service.response.get_raw_body. Previously, these functions returned strings. #8623
• The go_pluginserver_exe and go_plugins_dir directives are no longer supported. #8552. If you are using Go plugin server, migrate your plugins to use the Go PDK before upgrading.

Plugins

• DAOs in plugins must be listed in an array, so that their loading order is explicit. Loading them in a hash-like table is no longer supported. #8988
• Plugins MUST now have a valid PRIORITY (integer) and VERSION (“x.y.z” format) field in their handler.lua file, otherwise the plugin will fail to load. #8836
• The old kong.plugins.log-serializers.basic library was removed in favor of the PDK function kong.log.serialize. Upgrade your plugins to use the PDK. #8815
• The support for deprecated legacy plugin schemas was removed. If your custom plugins still use the old (0.x era) schemas, you are now forced to upgrade them. #8815

• Updated the priority for some plugins.

  This is important for those who run custom plugins as it may affect the sequence in which your plugins are executed. This does not change the order of execution for plugins in a standard Kong Gateway installation.

  Old and new plugin priority values:

  • acme changed from 1007 to 1705
  • basic-auth changed from 1001 to 1100
  • canary changed from 13 to 20
  • degraphql changed from 1005 to 1500
  • graphql-proxy-cache-advanced changed from 100 to 99
  • hmac-auth changed from 1000 to 1030
  • jwt changed from 1005 to 1450
  • jwt-signer changed from 999 to 1020.
  • key-auth changed from 1003 to 1250
  • key-auth-advanced changed from 1003 to 1250
  • ldap-auth changed from 1002 to 1200
  • ldap-auth-advanced changed from 1002 to 1200
  • mtls-auth changed from 1006 to 1600
  • oauth2 changed from 1004 to 1400
  • openid-connect changed from 1000 to 1050
  • rate-limiting changed from 901 to 910
  • rate-limiting-advanced changed from 902 to 910
  • route-by-header changed from 2000 to 850
  • route-transformer-advanced changed from 800 to 780
  • pre-function changed from +inf to 1000000
  • vault-auth changed from 1003 to 1350

• Kong plugins no longer support CREDENTIAL_USERNAME (X-Credential-Username). Use the constant CREDENTIAL_IDENTIFIER (X-Credential-Identifier) when setting the upstream headers for a credential. #8815

• ACL (acl), Bot Detection (bot-detection), and IP Restriction (ip-restriction)

  • Removed the deprecated blacklist and whitelist configuration parameters. #8560
• ACME (acme)
  • The default value of the auth_method configuration parameter is now token.
• AWS Lambda (aws-lambda)
  • The AWS region is now required. You can set it through the plugin configuration with the aws_region field parameter, or with environment variables.
  • The plugin now allows host and aws_region fields to be set at the same time, and always applies the SigV4 signature. #8082
• HTTP Log (http-log)
  • The headers field now only takes a single string per header name, where it previously took an array of values. #6992
• JWT (jwt)
  • The authenticated JWT is no longer put into the nginx context (ngx.ctx.authenticated_jwt_token). Custom plugins which depend on that value being set under that name must be updated to use Kong’s shared context instead (kong.ctx.shared.authenticated_jwt_token) before upgrading to 3.0.

• Prometheus (prometheus)

  • High cardinality metrics are now disabled by default.
  • Decreased performance penalty to proxy traffic when collecting metrics.

  • The following metric names were adjusted to add units to standardize where possible:

    • http_status to http_requests_total.

    • latency to kong_request_latency_ms (HTTP), kong_upstream_latency_ms, kong_kong_latency_ms, and session_duration_ms (stream).

      Kong latency and upstream latency can operate at orders of different magnitudes. Separate these buckets to reduce memory overhead.

    • kong_bandwidth to kong_bandwidth_bytes.

    • nginx_http_current_connections and nginx_stream_current_connections were merged into to nginx_connections_total.

    • request_count and consumer_status were merged into http_requests_total.

      If the per_consumer config is set to false, the consumer label will be empty. If the per_consumer config is true, the consumer label will be filled.

  • Removed the following metric: http_consumer_status

  • New metrics:
    • session_duration_ms: monitoring stream connections.
    • node_info: Single gauge set to 1 that outputs the node’s ID and Kong Gateway version.
  • http_requests_total has a new label, source. It can be set to exit, error, or service.
  • All memory metrics have a new label: node_id.
  • Updated the Grafana dashboard that comes packaged with Kong #8712
  • The plugin doesn’t export status codes, latencies, bandwidth and upstream health check metrics by default. They can still be turned on manually by setting status_code_metrics, lantency_metrics, bandwidth_metrics and upstream_health_metrics respectively. #9028
• Serverless Functions (post-function or pre-function)
  • Removed the deprecated config.functions configuration parameter from the Serverless Functions plugins’ schemas. Use the config.access phase instead. #8559

• StatsD (statsd):

  • Any metric name that is related to a service now has a service. prefix: kong.service.<service_identifier>.request.count.
    • The metric kong.<service_identifier>.request.status.<status> has been renamed to kong.service.<service_identifier>.status.<status>.
    • The metric kong.<service_identifier>.user.<consumer_identifier>.request.status.<status> has been renamed to kong.service.<service_identifier>.user.<consumer_identifier>.status.<status>.
  • The metric *.status.<status>.total from metrics status_count and status_count_per_user has been removed.

  #9046

• Rate Limiting (rate-limiting), Rate Limiting Advanced (rate-limiting-advanced), and Response Rate Limiting (response-ratelimiting):

  • The default policy is now local for all deployment modes. #9344
• Deprecated: StatsD Advanced (statsd-advanced):
  • The StatsD Advanced plugin has been deprecated and will be removed in 4.0. All capabilities are now available in the StatsD plugin.
• Proxy Cache (proxy-cache), Proxy Cache Advanced (proxy-cache-advanced), and GraphQL Proxy Cache Advanced (graphql-proxy-cache-advanced)
  • These plugins don’t store response data in ngx.ctx.proxy_cache_hit anymore. Logging plugins that need the response data must now read it from kong.ctx.shared.proxy_cache_hit. #8607

Configuration

• The Kong constant CREDENTIAL_USERNAME with the value of X-Credential-Username has been removed. #8815
• The default value of lua_ssl_trusted_certificate has changed to system #8602 to automatically load the trusted CA list from the system CA store.
• It is no longer possible to use a .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 Kong Gateway involves executing kong config db_import config.lua, convert the config.lua file into a config.json or config.yml file before upgrading. #8898
• The data plane config cache mechanism and its related configuration options (data_plane_config_cache_mode and data_plane_config_cache_path) have been removed in favor of LMDB.

Migrations

• The migration helper library (mostly used for Cassandra migrations) is no longer supplied with Kong Gateway. #8781
• PostgreSQL migrations can now have an up_f part like Cassandra migrations, designating a function to call. The up_f part is invoked after the up part has been executed against the database for both PostgreSQL and Cassandra.

Fixes

Enterprise

• Fixed an issue with keyring encryption, where the control plane would crash if any errors occurred during the initialization of the keyring module.

• Fixed an issue where the keyring module was not decrypting keys after a soft reload.

• Fixed pagination issues:

  • Fixed a consumer pagination issue.
  • Fixed an issue that appeared when loading the second page while iterating over a foreign key field using the DAO. #9255

• Fixed service route update failures that occurred after restarting a control plane.

• Vitals:

  • Disabled phone_home for anonymous_reports on the data plane.
  • The Kong Gateway version information is now sent in the telemetry request query parameter.
• Kong Manager:
  • Fixed the workspace dashboard’s loading state. Previously, a dashboard with no request data and an existing service would still prompt users to add a service.
  • Fixed an issue where Kong Manager allowed selection of metrics not supported by the Datadog plugin.
  • Fixed the values accepted for upstream configuration in Kong Manager. Previously, fields that were supposed to accept decimals would only accept whole numbers.
  • Fixed an issue where you couldn’t save or update pre-function plugin configuration when the updated value contained a comma (,).
  • The service name field on the Service Contracts page now correctly shows the service display name. Previously, it showed the service ID.
  • Fixed an issue where, after updating the CA certificate, the page wouldn’t return to the certificate view.
  • Fixed an issue where the port was missing from the service URL on the service overview page.
  • Fixed an issue where switching between workspace dashboard pages would not update the Dev Portal URL.
  • Fixed issues with plugins:
    • The Exit Transformer plugin can now load Lua functions added through Kong Manager.
    • The CORS plugin now treats regexes properly for the config.origins field.
    • The Datadog plugin now accepts an array for the tags field. Previously, it was incorrectly expecting a string.
  • Fixed an HTTP 500 error that occurred when sorting routes by the Hosts column, then clicking Next on a paginated listing.
  • Fixed an issue that prevented developer role assignments from displaying in Kong Manager. When viewing a role under the Permissions tab in the Dev Portal section, the list of developers wouldn’t update when a new developer was added. Kong Manager was constructing the wrong URL when retrieving Dev Portal assignees.
  • Fixed an issue where admins couldn’t switch workspaces if they didn’t have an roles in the default workspace.
  • Fixed a display issue with Dev Portal settings in Kong Manager.
  • Improved the error that appeared when trying to view admin roles without permissions for the resource. Instead of displaying 404 workspace not found, the error now informs the user that they don’t have access to view roles.
• Fixed an issue where the data plane would reload and lose its license after an Nginx reload.

• Fixed issues in dependencies:

  • kong-gql: Fixed variable definitions to handle non-nullable/list-type variables correctly.
  • lua-resty-openssl-aux-module: Fixed an issue with getting SSL_CTX from a request.

Core

• The schema validator now correctly converts null from declarative configurations to nil. #8483
• Kong now reschedules router and plugin iterator timers only after finishing the previous execution, avoiding unnecessary concurrent executions. #8567
• External plugins now handle returned JSON with null member correctly. #8611
• Fixed an issue where the address of an environment variable could change but the code didn’t check that it was fixed after init. #8581
• Fixed an issue where the Go plugin server instance would not be updated after a restart. #8547
• Fixed an issue on trying to reschedule the DNS resolving timer when Kong was being reloaded. #8702
• The private stream API has been rewritten to allow for larger message payloads. #8641
• Fixed an issue that the client certificate sent to the upstream was not updated when using the PATCH method. #8934
• Fixed an issue where the control plane and wRPC module interaction would cause Kong to crash when calling export_deflated_reconfigure_payload without a pcall. #8668
• Moved all .proto files to /usr/local/kong/include and ordered by priority. #8914
• Fixed an issue that caused unexpected 404 errors when creating or updating configs with invalid options. #8831
• Fixed an issue that caused crashes when calling some PDK APIs. #8604
• Fixed an issue that caused crashes when go PDK calls returned arrays. #8891
• Plugin servers now shutdown gracefully when Kong exits. #8923
• CLI now prompts with [y/n] instead of [Y/n], as it does not take y as default. #9114
• Improved the error message that appears when Kong can’t connect to Cassandra on init. #8847
• Fixed an issue where the Vault subschema wasn’t loaded in the off strategy. #9174
• The schema now runs select transformations before process_auto_fields. #9049
• Fixed an issue where Kong Gateway would use too many timers to keep track of upstreams when worker_consistency = eventual. #8694, #8858
• Fixed an issue where it wasn’t possible to set target status using only a hostname for targets set only by their hostname. #8797
• Fixed an issue where cache entries of some entities were not being properly invalidated after a cascade delete. #9261
• Running kong start when Kong Gateway is already running no longer overwrites the existing .kong_env file #9254

Admin API

• The Admin API now supports HTTP/2 when requesting /status. #8690
• Fixed an issue where the Admin API didn’t display Allow and Access-Control-Allow-Methods headers with OPTIONS requests.

Plugins

• Plugins with colliding priorities have now deterministic sorting based on their name. #8957

• External plugins: Kong Gateway now handles logging better when a plugin instance loses the instances_id in an event handler. #8652

• ACME (acme)

  • The default value of the auth_method configuration parameter is now set to token. #8565
  • Added a cache for domains_matcher. #9048
• HTTP Log (http-log)
  • Log output is now restricted to the workspace the plugin is running in. Previously, the plugin could log requests from outside of its workspace.
• AWS Lambda (aws-lambda)
  • Removed the deprecated proxy_scheme field from the plugin’s schema. #8566
  • Changed the path from request_uri to upstream_uri to fix an issue where the URI could not follow a rule defined by the Request Transformer plugin. #9058 #9129
• Forward Proxy (forward-proxy)
  • Fixed a proxy authentication error caused by incorrect base64 encoding.
  • Use lowercase when overwriting the Nginx request host header.
  • The plugin now allows multi-value response headers.
• gRPC Gateway (grpc-gateway)
  • Fixed the handling of boolean fields from URI arguments. #9180
• HMAC Authentication (hmac-auth)
  • Removed deprecated signature format using ngx.var.uri. #8558
• LDAP Authentication (ldap-auth)
  • Refactored ASN.1 parser using OpenSSL API through FFI. #8663
• LDAP Authentication Advanced (ldap-auth-advanced)
  • Fixed an issue where Kong Manager LDAP authentication failed when base_dn was the domain root.
• Mocking (mocking)
  • Fixed an issue where 204 responses were not handled correctly and you would see the following error: "No examples exist in API specification for this resource".
  • 204 response specs now support empty content elements.
• OpenID Connect (openid-connect) openid-connect
  • Fixed an issue with kong_oauth2 consumer mapping.
• Rate Limiting (rate-limiting) and Response Rate Limiting (response-ratelimiting)
  • Fixed a PostgreSQL deadlock issue that occurred when the cluster policy was used with two or more metrics (for example, second and day.) #8968
• Rate Limiting Advanced (rate-limiting-advanced)
  • Fixed error handling when calling get_window and added more buffer on the window reserve.
  • Fixed error handling for plugin strategy configuration when in hybrid or DB-less mode and strategy is set to cluster.
• Serverless Functions (serverless-functions)
  • Fixed a problem that could cause a crash. #9269
• Syslog (syslog)
  • The conf.facility default value is now set to user. #8564
• Zipkin (zipkin)
  • Fixed the balancer spans’ duration to include the connection time from Nginx to the upstream. #8848
  • Corrected the calculation of the header filter start time. #9230
  • Made the plugin compatible with the latest Jaeger header spec, which makes parent_id optional. #8352

Clustering

• The cluster listener now uses the value of admin_error_log for its log file instead of proxy_error_log. #8583
• Fixed a typo in some business logic that checks the Kong role before setting a value in cache at startup. #9060
• Fixed an issue in hybrid mode where, if a service was set to enabled: false and that service had a route with an enabled plugin, any new data planes would receive empty configuration. #8816
• Localized config_version to avoid a race condition from the new yielding config loading code. #8188

PDK

• kong.response.get_source() now returns an error instead of an exit when plugin throws a runtime exception in the access phase. #8599

• kong.tools.uri.normalize() now escapes reserved and unreserved characters more accurately. #8140

• RFC3987 validation on route paths was removed, allowing operators to create a route with an invalid path URI like /something| which can not match any incoming request. This validation will be added back in a future release.

Dependencies

• Bumped openresty from 1.19.9.1 to 1.21.4.1 #8850
• Bumped pgmoon from 1.13.0 to 1.15.0 #8908 #8429
• Bumped openssl from 1.1.1n to 1.1.1q #9074 #8544 #8752 #8994
• Bumped resty.openssl from 0.8.8 to 0.8.10 #8592 #8753 #9023
• Bumped inspect from 3.1.2 to 3.1.3 #8589
• Bumped resty.acme from 0.7.2 to 0.8.1 #8680 #9165
• Bumped luarocks from 3.8.0 to 3.9.1 #8700 #9204
• Bumped luasec from 1.0.2 to 1.2.0 #8754 #8754
• Bumped resty.healthcheck from 1.5.0 to 1.6.1 #8755 #9018 #9150
• Bumped resty.cassandra from 1.5.1 to 1.5.2 #8845
• Bumped penlight from 1.12.0 to 1.13.1 #9206
• Bumped lua-resty-mlcache from 2.5.0 to 2.6.0 #9287
• Bumped lodash for Dev Portal from 4.17.11 to 4.17.21
• Bumped lodash for Kong Manager from 4.17.15 to 4.17.21

2.8.4.2

Release Date 2023/07/07

Fixes

• Fixed a bug where internal redirects, such as those produced by the error_page directive, could interfere with worker process handling the request when buffered proxying is being used.

Kong Manager

• Fixed an issue where the Zipkin plugin didn’t allow the addition of static_tags through the Kong Manager UI.
• Fixed an issue where some of the icons were not rendering correctly.

Plugins

• Fixed an issue with the Oauth 2.0 Introspection plugin where a request with JSON that is not a table failed.

• Fixed an issue where the slow startup of the Go plugin server caused a deadlock.

  Dependencies

• Bumped lodash for Dev Portal from 4.17.11 to 4.17.21

• Bumped lodash for Kong Manager from 4.17.15 to 4.17.21

  2.8.4.1

Release Date 2023/05/25

Breaking Changes

Plugins

• Request Validator (request-validator)
  • The plugin now allows requests carrying a content-type with a parameter to match its content-type without a parameter.

Features

• Redis Cluster: Added username and password authentication to Redis Cluster 6 and later versions.

Fixes

• Fixed an issue where the RBAC token was not re-hashed after an update on the user_token field.
• Fixed the Dynatrace implementation. Due to a build system issue, Kong Gateway 2.8.4 packages prior to 2.8.4.1 didn’t contain the debug symbols that Dynatrace requires.

Plugins

• Forward Proxy (forward-proxy)
  • Fixed an issue which occurred when receiving an HTTP 408 from the upstream through a forward proxy. Nginx exited the process with this code, which resulted in Nginx ending the request without any contents.
• Request Validator (request-validator)
  • The plugin now allows requests carrying a content-type with a parameter to match its content-type without a parameter.

Dependencies

• Bumped pgmoon from 2.2.0.1 to 2.3.2.0.

2.8.4.0

Release Date 2023/03/28

Features

Plugins

• AWS Lambda (aws-lambda)
  • Added the configuration parameter aws_imds_protocol_version, which lets you select the IMDS protocol version. This option defaults to v1 and can be set to v2 to enable IMDSv2. #9962

Fixes

Enterprise

• Fixed an issue where the OpenTracing module was not included in the Amazon Linux 2 package.
• Hybrid mode: Fixed an issue where enabling encryption on a data plane would cause the data plane to stop working after a restart.
• Fixed the systemd unit file, which was incorrectly named kong.service in 2.8.1.x and later versions. It has been renamed back to kong-enterprise-edition.service to align with previous versions.

Kong Manager

• Fix the character limit error [postgres] ERROR: value too long for type character(32) that occurred while enabling the Dev Portal. The character limit was shorter than the length of the autogenerated UUID.
• The /auth endpoint, used by Kong Manager for OIDC authentication, now correctly supports the HTTP POST method.
• Fixed an issue where users with newly registered Dev Portal accounts created through OIDC were unable to log into Dev Portal until the Kong Gateway container was restarted.

Core

• Fixed the Ubuntu ARM64 image, which was broken in 2.8.2.x and later versions.
• Router: Fixed an issue where the router used stale data when workers were respawned. #9396 #9485
• Update the batch queues module so that queues no longer grow without bounds if their consumers fail to process the entries. Instead, old batches are now dropped and an error is logged. #10247

Plugins

• Added the missing protocols field to the following plugin schemas:

  • Azure Functions (azure-functions)
  • gRPC Gateway (grpc-gateway)
  • gRPC Web (grpc-web)
  • Serverless pre-function (pre-function)
  • Prometheus (prometheus)
  • Proxy Caching (proxy-cache)
  • Request Transformer (request-transformer)
  • Session (session)
  • Zipkin (zipkin)

  #9525

• HTTP Log (http-log)

  • Fixed an issue in this plugin’s batch queue processing, where metrics would be published multiple times. This caused a memory leak, where memory usage would grow without limit. #10052 #10044
• mTLS Authentication (mtls-auth)
  • Fixed an issue where the plugin used the old route caches after routes were updated.
• Key Authentication - Encrypted (key-auth-enc)
  • Fixed an issue where using an API key that exists in multiple workspaces caused a 401 error. This occurred because of a caching issue.

2.8.2.4

Release Date 2023/01/23

Fixes

• Kong Gateway now statically links the BoringSSL PCRE library. This fixes an issue introduced in 2.8.2.3, where the BoringSSL library was dynamically linked, causing regex compilation to fail when routing requests with some versions of the library.

2.8.2.3

Release Date 2023/01/06

Fixes

Enterprise

Kong Manager:

• Fixed a role precedence issue with RBAC. RBAC rules involving deny (negative) rules now correctly take precedence over allow (non-negative) roles.
• Fixed workspace filtering pagination on the overview page.

Core

• Fixed a router issue where, in an environment with more than 50,000 routes, attempting to update a route caused a 500 error response.
• Fixed a timer leak that occurred whenever the generic messaging protocol connection broke in hybrid mode.
• Fixed a tlshandshake method error that occurred when SSL was configured on PostgreSQL, and the Kong Gateway had stream_listen configured with a stream proxy.

Plugins

• HTTP Log (http-log)
  • Fixed the could not update kong admin internal error caused by empty headers. This error occurred when using this plugin with the Kong Ingress Controller.
• JWT (jwt)
  • Fixed an issue where the JWT plugin could potentially forward an unverified token to the upstream.
• JWT Signer (jwt-signer)
  • Fixed the error attempt to call local 'err' (a string value).
• Mocking (mocking)
  • Fixed UUID pattern matching.
• Prometheus (prometheus)
  • Provided options to reduce the plugin’s impact on performance. Added new kong.conf options to switch high cardinality metrics on or off: prometheus_plugin_status_code_metrics, prometheus_plugin_latency_metrics, prometheus_plugin_bandwidth_metrics, and prometheus_plugin_upstream_health_metrics.
• Rate Limiting Advanced (rate-limiting-advanced)
  • Fixed a maintenance cycle lock leak in the kong_locks dictionary. Kong Gateway now clears old namespaces from the maintenance cycle schedule when a namespace is updated.
• Request Transformer (request-transformer)
  • Fixed an issue where empty arrays were being converted to empty objects. Empty arrays are now preserved.

Known limitations

• A required PCRE library is dynamically linked, where prior versions statically linked the library. Depending on the system PCRE version, this may cause regex compilation to fail when routing requests. Starting in 2.8.2.4 and later, Kong Gateway will return to statically linking the PCRE library.

2.8.2.2

Release Date 2022/12/01

Fixes

Core

Timer issue fixes:

• Added batch queues for the Datadog and StatsD plugins to reduce timer usage, fixing a lua_max_running_timers are not enough timer error.

  Whenever a request was processed, a new running timer was instantly created during the log phase. This was causing a shortage of timers under heavy traffic and led to unpredictable consequences, where internal timers were killed randomly and couldn’t recover automatically. This would then trigger a lua_max_running_timers are not enough timer error and cause data planes to crash.

  #9521

• Fixed a timer leak that occurred whenever the generic messaging protocol connection would break in hybrid mode.

2.8.2.1

Release Date 2022/11/21

Fixes

Enterprise

• Kong Manager:
  • Fixed an issue where admins needed the specific rbac/role permission to edit RBAC roles. Now, admins can edit RBAC roles with the /admins permission.
  • Fixed an issue where the client certificate ID didn’t display properly in the upstream update form.
  • Fixed an issue in the service documents UI which allowed users to upload multiple documents. Since each service only supports one document, the documents would not display correctly. Uploading a new document now overrides the previous document.
  • Fixed an issue where the New Workspace button on the global workspace dashboard wasn’t clickable on the first page load.
  • Fixed an RBAC issue where the roles page listed deleted roles.
  • Removed New Relic from Kong Manager. Previously, VUE_APP_NEW_RELIC_LICENSE_KEY and VUE_APP_SEGMENT_WRITE_KEY were being exposed in Kong Manager with invalid values.
  • Fixed an RBAC issue where permissions applied to specific endpoints (for example, an individual service or route) were not reflected in the Kong Manager UI.
  • Fixed an issue with group to role mapping, where it didn’t support group names with spaces.
  • Fixed an issue with individual workspace dashboards, where right-clicking on View All and choosing “Open Link in New Tab” or “Copy Link” for services, routes, and plugins redirected to the default workspace and caused an HTTP 404 error.
• Dev Portal: Fixed an issue where Dev Portal response examples weren’t rendered when media type was vendor-specific.

Core

• Targets with a weight of 0 are no longer included in health checks, and checking their status via the upstreams/<upstream>/health endpoint results in the status HEALTHCHECK_OFF. Previously, the upstreams/<upstream>/health endpoint was incorrectly reporting targets with weight=0 as HEALTHY, and the health check was reporting the same targets as UNDEFINED.

• Fixed the default logrotate configuration, which lacked permissions to access logs.

Plugins

• Kafka Upstream (kafka-upstream)
  • Fixed the Bad Gateway error that would occur when using the Kafka Upstream plugin with the configuration producer_async=false.
• Response Transformer (response-transformer)
  • Fixed an issue where the plugin couldn’t process string responses.
• mTLS Authentication (mtls-auth)
  • Fixed an issue where the plugin was causing requests to silently fail on Kong Gateway data planes.
• Request Transformer (request-transformer)
  • Fixed an issue where empty arrays were being converted to empty objects. Empty arrays are now preserved.
• Azure Functions (azure-functions)
  • Fixed an issue where calls made by this plugin would fail in the following situations:
    • The plugin was associated with a route that had no service.
    • The route’s associated service had a path value.
• LDAP Auth Advanced (ldap-auth-advanced)
  • Fixed an issue where operational attributes referenced by group_member_attribute weren’t returned in search query results.

2.8.2.0

Release Date 2022/10/12

Fixes

Enterprise

• Kong Manager:
  • Fixed an issue where workspaces with zero roles were not correctly sorted by the number of roles.
  • Fixed the Cross Site Scripting (XSS) security vulnerability in the Kong Manager UI.
  • Fixed an issue where registering an admin without admin_gui_auth set resulted in a 500 error.
  • Fixed an issue that allowed unauthorized IDP users to log in to Kong Manager. These users had no access to any resources in Kong Manager, but were able to go beyond the login screen.
• Fixed OpenSSL vulnerabilities CVE-2022-2097 and CVE-2022-2068.
• Hybrid mode: Fixed an issue with consumer groups, where the control plane wasn’t sending the correct number of consumer entries to data planes.
• Hybrid mode: Fixed an issue where sending a PATCH request to update a route after restarting a control plane caused a 500 error response.

Plugins

• AWS Lambda (aws-lambda)
  • Fixed an issue where the plugin couldn’t read environment variables in the ECS environment, causing permission errors.
• Forward Proxy (forward-proxy)
  • If the https_proxy configuration parameter is not set, it now defaults to http_proxy to avoid DNS errors.
• GraphQL Proxy Cache Advanced (graphql-proxy-cache-advanced) and Proxy Cache Advanced (proxy-cache-advanced)
  • Fixed the error function cannot be called in access phase (only in: log), which was preventing the plugin from working consistently.
• GraphQL Rate Limiting Advanced (graphql-rate-limiting-advanced)
  • The plugin now returns a 500 error when using the cluster strategy in hybrid or DB-less modes instead of crashing.
• LDAP Authentication Advanced (ldap-auth-advanced)
  • The characters . and : are now allowed in group attributes.
• OpenID Connect (openid-connect)
  • Fixed issues with OIDC role mapping where admins couldn’t be added to more than one workspace, and permissions were not being updated.
• Request Transformer Advanced (request-transformer-advanced)
  • Fixed an issue where empty arrays were being converted to empty objects. Empty arrays are now preserved.
• Route Transformer Advanced (route-transformer-advanced)
  • Fixed an issue where URIs that included %20 or a whitespace would return a 400 Bad Request.

2.8.1.4

Release Date 2022/08/23

• Fixed vulnerabilities CVE-2022-37434 and CVE-2022-24975.

• When using secrets management in free mode, only the environment variable backend is available. AWS, GCP, and HashiCorp vault backends require an Enterprise license.

• Fixed an issue in Kong Manager where entity detail pages were empty and didn’t list existing entities. The following entities were affected:

  • Route lists on service pages
  • Upstreams
  • Certificates
  • SNIs
  • RBAC roles
• Fixed an issue where the browser hung when creating an upstream with the existing host and port.

Plugins

• OpenID Connect (openid-connect)
  • Fixed a caching issue in hybrid mode, where the data plane node would try to retrieve a new JWK from the IdP every time. The data plane node now looks for a cached JWK first.
• Proxy Caching Advanced (proxy-cache-advanced)
  • Fixed an issue that prevented users from removing the cluster addresses on an existing configuration.

Dependencies

• Bump lua-resty-aws version to 0.5.4 to reduce memory usage when AWS vault is enabled. #23
• Bump lua-resty-gcp version to 0.0.5 to reduce memory usage when GCP vault is enabled. #7

2.8.1.3

Release Date 2022/08/05

Features

Enterprise

• Added GCP integration support for the secrets manager. GCP is now available as a vault backend.

Plugins

• AWS Lambda (aws-lambda)
  • Added support for cross-account lambda function invocation based on AWS roles.

Fixes

Enterprise

• Fixed an issue with excessive log file disk utilization on control planes.
• Fixed an issue with keyring encryption, where keyring was not decrypting keys after a soft reload.
• The router now detects static route collisions inside the current workspace, as well as with other workspaces.
• When using a custom plugin in a hybrid mode deployment, the control plane now detects compatibility issues and stops sending the plugin configuration to data planes that can’t use it. The control plane continues sending the custom plugin configuration to compatible data planes.
• Optimized the Kong PDK function kong.response.get_source().

Kong Manager

• Fixed an issue with admin creation. Previously, when an admin was created with no roles, the admin would have access to the first workspace listed alphabetically.
• Fixed several issues with SNI listing. Previously, the SNI list was empty after sorting by the SSL certificate ID field. In 2.8.1.1, the SSL certificate ID field in the SNI list was empty.

Plugins

• Mocking (mocking)
  • Fixed an issue where the plugin didn’t accept empty values in examples.
• ACME (acme)
  • The domains plugin parameter can now be left empty. When domains is empty, all TLDs are allowed. Previously, the parameter was labelled as optional, but leaving it empty meant that the plugin retrieved no certificates at all.
• Response Transformer Advanced (response-transformer-advanced)
  • Fixed an issue with nested array parsing.
• Rate Limiting Advanced (rate-limiting-advanced)
  • Fixed an issue with cluster strategy timestamp precision in Cassandra.

2.8.1.2

Release Date 2022/07/15

Fixes

Enterprise

• Fixed an issue in hybrid mode where, if a service was set to enabled: false and that service had a route with an enabled plugin, any new data planes would receive empty configuration.
• Fixed a timer leak that occurred when worker_consistency was set to eventual in kong.conf. This issue caused timers to be exhausted and failed to start any other timers used by Kong Gateway, resulting in a too many pending timers error.
• Fixed memory leaks coming from lua-resty-lock.
• Fixed global plugins can operate out of the workspace scope

Kong Manager and Dev Portal

• Fixed an issue where Kong Manager did not display all Dev Portal developers in the organization.
• Fixed an issue that prevented developer role assignments from displaying in Kong Manager. When viewing a role under the Permissions tab in the Dev Portal section, the list of developers wouldn’t update when a new developer was added. Kong Manager was constructing the wrong URL when retrieving Dev Portal assignees.
• Fixed empty string handling in Kong Manager. Previously, Kong Manager was handling empty strings as "" instead of a null value.
• Improved Kong Manager styling by fixing an issue where content didn’t fit on object detail pages.
• Fixed an issue that sometimes prevented clicking Kong Manager links and buttons in Safari.
• Fixed an issue where users were being navigated to the object detail page after clicking on the “Copy ID” button from the object list.
• Fixed an issue where the number of requests and error rate were not correctly displaying when Vitals was disabled.

Plugins

• Rate Limiting (rate-limiting) and Response Rate Limiting (response-ratelimiting)
  • Fixed a PostgreSQL deadlock issue that occurred when the cluster policy was used with two or more metrics (for example, second and day.)
• HTTP Log (http-log)
  • Log output is now restricted to the workspace the plugin is running in. Previously, the plugin could log requests from outside of its workspace.
• Mocking (mocking)
  • Fixed an issue where 204 responses were not handled correctly and you would see the following error: "No examples exist in API specification for this resource".
  • 204 response specs now support empty content elements.

Deprecated

• Amazon Linux 1: Support for running Kong Gateway on Amazon Linux 1 is now deprecated, as the Amazon Linux (1) AMI has ended standard support as of December 31, 2020. Starting with Kong Gateway 3.0.0.0, Kong is not building new Amazon Linux 1 images or packages, and Kong will not test package installation on Amazon Linux 1.

  If you need to install Kong Gateway on Amazon Linux 1, see the documentation for previous versions.

• Debian 8: Support for running Kong Gateway on Debian 8 (“Jessie”) is now deprecated, as Debian 8 (“Jessie”) has reached End of Life (EOL). Starting with Kong Gateway 3.0.0.0, Kong is not building new Debian 8 (“Jessie”) images or packages, and Kong will not test package installation on Debian 8 (“Jessie”).

  If you need to install Kong Gateway on Debian 8 (“Jessie”), see the documentation for previous versions.

• Ubuntu 16.04: Support for running Kong Gateway on Ubuntu 16.04 (“Xenial”) is now deprecated, as Standard Support for Ubuntu 16.04 has ended as of April, 2021. Starting with Kong Gateway 3.0.0.0, Kong is not building new Ubuntu 16.04 images or packages, and Kong will not test package installation on Ubuntu 16.04.

  If you need to install Kong Gateway on Ubuntu 16.04, see the documentation for previous versions.

2.8.1.1

Release Date 2022/05/27

Features

Enterprise

• You can now enable application status and application request emails for the Developer Portal using the following configuration parameters:
  • portal_application_status_email: Enable to send application request status update emails to developers.
  • portal_application_request_email: Enable to send service access request emails to users specified in smtp_admin_emails.
  • portal_smtp_admin_emails: Specify the email addresses to send portal admin emails to, overriding values set in smtp_admin_emails.
• Added the ability to use email.developer_meta fields in portal email templates. For example, {{email.developer_meta.preferred_name}}.

Plugins

• AWS Lambda (aws-lambda)
  • When working in proxy integration mode, the statusCode field now accepts string datatypes.
• mTLS Authentication (mtls-auth)
  • Introduced certificate revocation list (CRL) and OCSP server support with the following parameters: http_proxy_host, http_proxy_port, https_proxy_host, and https_proxy_port.
• Kafka Upstream (kafka-upstream) and Kafka Log (kafka-log)
  • Added support for the SCRAM-SHA-512 authentication mechanism.

Fixes

Enterprise

• Improved Kong Admin API and Kong Manager performance for organizations with many entities.

• Fixed an issue with keyring encryption, where the control plane would crash if any errors occurred during the initialization of the keyring module.

• Fixed an issue where Kong Manager did not display all RBAC users and Consumers in the organization.

• Fixed an issue where some areas in a row of a list were not clickable.

Plugins

• Rate Limiting Advanced (rate-limiting-advanced)
  • Fixed rate limiting advanced errors that appeared when the Rate Limiting Advanced plugin was not in use.
  • Fixed an error where rate limiting counters were not updating response headers due to incorrect key expiration tracking. Redis key expiration is now tracked properly in lua_shared_dict kong_rate_limiting_counters.
• Forward Proxy (forward-proxy)
  • Fixed an invalid header value error for HTTPS requests. The plugin now accepts multi-value response headers.
  • Fixed an error where basic authentication headers containing the = character weren’t forwarded.
  • Fixed request errors that occurred when a scheme had no proxy set. The https proxy now falls back to the http proxy if not specified, and the http proxy falls back to https.
• GraphQL Rate Limiting Advanced (graphql-rate-limiting-advanced)
  • Fixed deserialize_parse_tree logic when building GraphQL AST with non-nullable or list types.

2.8.1.0

Release Date 2022/04/07

Fixes

Enterprise

• Fixed an issue with RBAC where endpoint=/kong workspace=* would not let the /kong endpoint be accessed from all workspaces
• Fixed an issue with RBAC where admins without a top level endpoint=* permission could not add any RBAC rules, even if they had endpoint=/rbac permissions. These admins can now add RBAC rules for their current workspace only.
• Kong Manager
  • Serverless functions can now be saved when there is a comma in the provided value
  • Custom plugins now show an Edit button when viewing the plugin configuration
  • Editing Dev Portal permissions no longer returns a 404 error
  • Fix an issue where admins with access to only non-default workspaces could not see any workspaces
  • Show the workspace name when an admin only has access to non-default workspaces
  • Add support for table filtering and sorting when using Cassandra
  • Support the # character in RBAC tokens on the RBAC edit page
  • Performing an action on an upstream target no longer leads to a 404 error
• Developer Portal
  • Information about the current session is now bound to an nginx worker thread. This prevents data leaks when a worker is handling multiple requests at the same time
• Keys are no longer rotated unexpectedly when a node restarts
• Add cache when performing RBAC token verification
• The log message “plugins iterator was changed while rebuilding it” was incorrectly logged as an error. This release converts it to the info log level.
• Fixed a 500 error when rate limiting counters are full with the Rate Limiting Advanced plugin
• Improved the performance of the router, plugins iterator and balancer by adding conditional rebuilding

Plugins

• HTTP Log (http-log)
  • Include provided query string parameters when sending logs to the http_endpoint
• Forward Proxy (forward-proxy)
  • Use lowercase when overwriting the host header
• StatsD Advanced (statsd-advanced)
  • Added support for setting workspace_identifier to workspace_name
• Rate Limiting Advanced (rate-limiting-advanced)
  • Skip namespace creation if the plugin is not enabled. This prevents the error “[rate-limiting-advanced] no shared dictionary was specified” being logged.
• LDAP Auth Advanced (ldap-auth-advanced)
  • Support passwords that contain a : character
• OpenID Connect (openid-connect)
  • Provide valid upstream headers e.g. X-Consumer-Id, X-Consumer-Username
• JWT Signer (jwt-signer)
  • Implement the enable_hs_signatures option to enable JWTs signed with HMAC algorithms

Dependencies

• Bumped openssl from 1.1.1k to 1.1.1n to resolve CVE-2022-0778 #8635
• Bumped openresty from 1.19.3.2 to 1.19.9.1 #7727

2.8.0.0

Release Date 2022/03/02

Features

Enterprise

• Improved tables in Kong Manager: (for PostgreSQL-backed instances only)
  • Click on a table row to access the entry instead of using the old View icon.
  • Search and filter tables through the Filters dropdown, which is located above the table.
  • Sort any table by clicking on a column title.
  • Tables now have pagination.
• Kong Manager with OIDC:
  • Added the configuration option admin_auto_create_rbac_token_disabled to enable or disable RBAC tokens when automatically creating admins with OpenID Connect.
• If a license is present,license_key is now included in the api signal for anonymous_reports.

Dev Portal

• The new /developers/export endpoint lets you export the list of developers and their statuses into CSV format.

Core

• Beta feature: Kong Gateway 2.8.0.0 introduces secrets management and vault support. You can now store confidential values such as usernames and passwords as secrets in secure vaults. Kong Gateway can then reference these secrets, making your environment more secure.

  The beta includes get support for the following vault implementations:

  • AWS Secrets Manager
  • HashiCorp Vault
  • Environment variable

  As part of this support, some plugins have certain fields marked as referenceable. See the plugin section of the Kong Gateway 2.8 changelog for details.

  Test out secrets management using the getting started guide, and check out the documentation for the Kong Admin API /vaults-beta entity.

  This feature is in beta. It has limited support and implementation details may change. This means it is intended for testing in staging environments only, and should not be deployed in production environments.

• You can customize the transparent dynamic TLS SNI name.

  Thanks, @Murphy-hub! #8196

• Routes now support matching headers with regular expressions.

  Thanks, @vanhtuan0409! #6079

• You can now configure cluster_max_payload for hybrid mode deployments. This configuration option sets the maximum payload size allowed to be sent across from the control plane to the data plane. If your environment has large configurations that generate payload too big errors and don’t get applied to the data planes, use this setting to adjust the limit.

  Thanks, @andrewgkew! #8337

Performance

• Improved the calculation of declarative configuration hash for big configurations. The new method is faster and uses less memory. #8204

• Multiple improvements in the Router, including:

  • The router builds twice as fast
  • Failures are cached and discarded faster (negative caching)
  • Routes with header matching are cached

  These changes should be particularly noticeable when rebuilding in DB-less environments. #8087 #8010

Admin API

• The current declarative configuration hash is now returned by the status endpoint when Kong node is running in DB-less or data plane mode. #8214 #8425

Plugins

• Canary (canary)
  • Added the ability to configure canary_by_header_name. This parameter accepts a header name that, when present on a request, overrides the configured canary functionality.
    • If the configured header is present with the value always, the request will always go to the canary upstream.
    • If the header is present with the value never, the request will never go to the canary upstream.
• Prometheus (prometheus)
  • Added three new metrics:
    • kong_db_entities_total (gauge): total number of entities in the database.
    • kong_db_entity_count_errors (counter): measures the number of errors encountered during the measurement of kong_db_entities_total.
    • kong_nginx_timers (gauge): total number of Nginx timers, in Running or Pending state. Tracks ngx.timer.running_count() and ngx.timer.pending_count(). #8387

• OpenID Connect (openid-connect)

  • Added Redis ACL support (Redis v6.0.0+) for storing and retrieving a session. Use the session_redis_username and session_redis_password configuration parameters to configure it.

    These parameters replace the session_redis_auth field, which is now deprecated and planned to be removed in 3.x.x.

  • Added support for distributed claims. Set the resolve_distributed_claims configuration parameter to true to tell OIDC to explicitly resolve distributed claims.

    Distributed claims are represented by the _claim_names and _claim_sources members of the JSON object containing the claims.

  • Beta feature: The client_id, client_secret, session_secret, session_redis_username, and session_redis_password configuration fields are now marked as referenceable, which means they can be securely stored as secrets in a vault. References must follow a specific format.

• Forward Proxy Advanced (forward-proxy)

  • Added http_proxy_host, http_proxy_port, https_proxy_host, and https_proxy_port configuration parameters for mTLS support.

    These parameters replace the proxy_port and proxy_host fields, which are now deprecated and planned to be removed in 3.x.x.

  • The auth_password and auth_username configuration fields are now marked as referenceable, which means they can be securely stored as secrets in a vault. References must follow a specific format.

• Kafka Upstream (kafka-upstream) and Kafka Log (kafka-log)

  • Added the ability to identify a Kafka cluster using the cluster_name configuration parameter. By default, this field generates a random string. You can also set your own custom cluster identifier.

  • Beta feature: The authentication.user and authentication.password configuration fields are now marked as referenceable, which means they can be securely stored as secrets in a vault. References must follow a specific format.

• LDAP Authentication Advanced (ldap-auth-advanced)

  • Beta feature: The ldap_password and bind_dn configuration fields are now marked as referenceable, which means they can be securely stored as secrets in a vault. References must follow a specific format.

• Vault Authentication (vault-auth)

  • Beta feature: The vaults.vault_token form field is now marked as referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

• GraphQL Rate Limiting Advanced (graphql-rate-limiting-advanced)

  • Added Redis ACL support (Redis v6.0.0+ and Redis Sentinel v6.2.0+).

  • Added the redis.username and redis.sentinel_username configuration parameters.

  • Beta feature: The redis.username, redis.password, redis.sentinel_username, and redis.sentinel_password configuration fields are now marked as referenceable, which means they can be securely stored as secrets in a vault. References must follow a specific format.

• Rate Limiting (rate-limiting)

• Rate Limiting Advanced (rate-limiting-advanced)

  • Added Redis ACL support (Redis v6.0.0+ and Redis Sentinel v6.2.0+).

  • Added the redis.username and redis.sentinel_username configuration parameters.

  • Beta feature: The redis.username, redis.password, redis.sentinel_username, and redis.sentinel_password configuration fields are now marked as referenceable, which means they can be securely stored as secrets in a vault. References must follow a specific format.

• Response Rate Limiting (response-ratelimiting)

  • Added Redis ACL support (Redis v6.0.0+ and Redis Sentinel v6.2.0+).

  • Added the redis_username configuration parameter.

    Thanks, @27ascii for the original contribution! #8213

• Response Transformer Advanced (response-transformer-advanced)

  • Use response buffering from the PDK.

• Proxy Cache Advanced (proxy-cache-advanced)

  • Added Redis ACL support (Redis v6.0.0+ and Redis Sentinel v6.2.0+).

  • Added the redis.sentinel_username and redis.sentinel_password configuration parameters.

  • Beta feature: The redis.password, redis.sentinel_username, and redis.sentinel_password configuration fields are now marked as referenceable, which means they can be securely stored as secrets in a vault. References must follow a specific format.

• jq (jq)

  • Use response buffering from the PDK.

• ACME (acme)

  • Added the rsa_key_size configuration parameter.

    Thanks, lodrantl! #8114

Fixes

Enterprise

• Fixed a timer leak that caused the timers to be exhausted and failed to start any other timers used by Kong, showing the error too many pending timers.

• Fixed an issue where, if data_plane_config_cache_mode was set to off, the data plane received no updates from the control plane.

• Fixed attempt to index local 'workspace' error, which occurred when accessing Routes or Services using TLS.

• Fixed an issue where cluster_telemetry_server_name was not automatically generated and registered if it was not explicitly set.

• Fixed the cluster_allowed_common_names setting. When using PKI for certificate verification in hybrid mode, you can now configure a list of Common Names allowed to connect to a control plane with the option. If not set, only data planes with the same parent domain as the control plane cert are allowed.

Kong Manager

• Fixed an issue where OIDC authentication into Kong Manager failed when used with Azure AD.

• Fixed a performance issue with the Teams page in Kong Manager.

• Fixed an issue with checkboxes in Kong Manager, where the checkbox for the OAuth2 plugin’s hash_secret value was labelled as Required and users were not able to uncheck it.

• Fixed an issue where Kong Manager was not updating plugin configuration when attempting to clear the service.id from a plugin.

• Fixes an issue with Route creation in Kong Manager, where a new route would default to http as the supported protocol. Now, creating a Route picks up the correct default value, which is http,https.

• Kong Manager now accurately lists udp as a protocol option for Route and Service objects on their configuration pages.

• Fixed an issue with Kong Manager OIDC authentication, which caused the error “attempt to call method 'select_by_username_ignore_case' (a nil value)” and prevented login with OIDC.

• Fixed a latency issue with OAuth2 token creation. These tokens are no longer tracked by the workspace entity counter, as the count is not needed by the Kong Manager UI.

• Fixed an issue where the plugin list table couldn’t be sorted by the Applied To column.

Dev Portal

• When the SMTP configuration was broken or unresponsive, the API would respond with an error message that was a JavaScript Object ([Object object]) instead of a string. This happened when a user was registering on any given portal with broken SMTP. Now, if there is an error, the API responds with the string Error sending email.

• The /document_objects and /services/:id/document_objects endpoints no longer accept multiple documents per service. This was an issue, as each service can only have one document. Instead, posting a document to one of these endpoints now overrides the previous document.

Core

• When the Router encounters an SNI FQDN with a trailing dot (.), the dot will be ignored, since according to RFC-3546 the dot is not part of the hostname. #8269

• Fixed a bug in the Router that would not prioritize the routes with both a wildcard and a port (route.*:80) over wildcard-only routes (route.*), which have less specificity. #8233

• The internal DNS client isn’t confused by the single-dot (.) domain, which can appear in /etc/resolv.conf in special cases like search . #8307

• The Cassandra connector now records migration consistency level.

  Thanks, @mpenick! #8226

Balancer

• Targets now keep their health status when upstreams are updated. #8394

• One debug message which was erroneously using the error log level has been downgraded to the appropriate debug log level. #8410

Clustering

• Replaced a cryptic error message with a more useful one when there is a failure on SSL when connecting with the control plane. #8260

Admin API

• Fixed an incorrect next field that appeared when paginating Upstreams. #8249

PDK

• Phase names are now correctly selected when performing phase checks. #8208
• Fixed a bug in the go-PDK where, if kong.request.getrawbody was big enough to be buffered into a temporary file, it would return an an empty string. #8390

Plugins

• External Plugins:

  • Fixed incorrect handling of the Headers Protobuf Structure and representation of null values, which provoked an error on init with the go-pdk. #8267

  • Unwrap ConsumerSpec and AuthenticateArgs.

    Thanks, @raptium! #8280

  • Fixed a problem in the stream subsystem, where it would attempt to load HTTP headers. #8414

• CORS (cors)

  • The CORS plugin does not send the Vary: Origin header anymore when the header Access-Control-Allow-Origin is set to *.

    Thanks, @jkla-dr! #8401

• AWS Lambda (aws-lambda)

  • Fixed incorrect behavior when configured to use an HTTP proxy and deprecated the proxy_scheme config attribute for removal in 3.0. #8406
• OAuth2 (oauth2)
  • The plugin clears the X-Authenticated-UserId and X-Authenticated-Scope headers when it is configured in logical OR and is used in conjunction with another authentication plugin. #8422
• Datadog (datadog)
  • The plugin schema now lists the default values for configuration options in a single place instead of in two separate places. #8315
• Rate Limiting (rate-limiting)
  • Fixed a 500 error associated with performing arithmetic functions on a nil value by adding a nil value check after performing ngx.shared.dict operations.

• Rate Limiting Advanced (rate-limiting-advanced)

  • Fixed a 500 error that occurred when consumer groups were enforced but no proper configurations were provided. Now, if no specific consumer group configuration exists, the consumer group defaults to the original plugin configuration.

  • Fixed a timer leak that caused the timers to be exhausted and failed to start any other timers used by Kong, showing the error too many pending timers.

    Before, the plugin used one timer for each namespace maintenance process, increasing timer usage on instances with a large number of rate limiting namespaces. Now, it uses a single timer for all namespace maintenance.

  • Fixed an issue where the local strategy was not working with DB-less and hybrid deployments. We now allow sync_rate = null and sync_rate = -1 when a local strategy is defined.

• Exit Transformer (exit-transformer)

  • Fixed an issue where the Exit Transformer plugin would break the plugin iterator, causing later plugins not to run.

• mTLS Authentication (mtls-auth)

  • Fixed attempt to index local 'workspace' error, which occurred when accessing Routes or Services using TLS.

• OAuth2 Introspection (oauth2-introspection)

  • Fixed issues with TLS connections when the IDP is behind a reverse proxy.

• Proxy Cache Advanced (proxy-cache-advanced)

  • Fixed a X-Cache-Status:Miss error that occurred when caching large files.

• Proxy Cache Advanced (proxy-cache-advanced)

  • Fixed a X-Cache-Status:Miss error that occurred when caching large files.

• Response Transformer Advanced (response-transformer-advanced)

  • In the body_filter phase, the plugin now sets the body to an empty string instead of nil.

• jq (jq)

  • If plugin has no output, it will now return the raw body instead of attempting to restore the original response body.

• OpenID Connect (openid-connect)

  • Fixed negative caching, which was loading wrong a configuration value.

• JWT Signer (jwt-signer)

  • Fixed an issue where the enable_hs_signatures configuration parameter did not work. The plugin now defines expiry earlier to avoid arithmetic on a nil value.

Dependencies

• Bumped OpenSSL from 1.1.1l to 1.1.1m #8191
• Bumped resty.session from 3.8 to 3.10 #8294
• Bumped lua-resty-openssl to 0.8.5 #8368
• Bumped lodash for Dev Portal from 4.17.11 to 4.17.21
• Bumped lodash for Kong Manager from 4.17.15 to 4.17.21

Deprecated

• The external go-pluginserver project is considered deprecated in favor of the embedded server approach.

• Starting with Kong Gateway 2.8.0.0, Kong is not building new open-source CentOS images. Support for running open-source Kong Gateway on CentOS on is now deprecated, as CentOS has reached End of Life (OEL).

  Running Kong Gateway Enterprise on CentOS is currently supported, but CentOS is planned to be fully deprecated in Kong Gateway 3.x.x.

• OpenID Connect plugin: The session_redis_auth field is now deprecated and planned to be removed in 3.x.x. Use session_redis_username and session_redis_password instead.

• Forward Proxy Advanced plugin: The proxy_port and proxy_host fields are now deprecated and planned to be removed in 3.x.x. Use http_proxy_host and http_proxy_port, or https_proxy_host and https_proxy_port instead.

• AWS Lambda plugin: The proxy_scheme field is now deprecated and planned to be removed in 3.x.x.

2.7.2.0

Release Date 2022/04/07

Fixes

Enterprise

• Fixed an issue with RBAC where endpoint=/kong workspace=* would not let the /kong endpoint be accessed from all workspaces
• Fixed an issue with RBAC where admins without a top level endpoint=* permission could not add any RBAC rules, even if they had endpoint=/rbac permissions. These admins can now add RBAC rules for their current workspace only.
• Kong Manager
  • Enable the search_user_info option when using OpenID Connect (OIDC)
  • Fix broken docs links on the Upstream page
  • Serverless functions can now be saved when there is a comma in the provided value
  • Custom plugins now show an Edit button when viewing the plugin configuration
• Keys are no longer rotated unexpectedly when a node restarts
• Add cache when performing RBAC token verification
• The log message “plugins iterator was changed while rebuilding it” was incorrectly logged as an error. This release converts it to the info log level.
• Fixed a 500 error when rate limiting counters are full with the Rate Limiting Advanced plugin

Plugins

• HTTP Log (http-log)
  • Include provided query string parameters when sending logs to the http_endpoint
• Forward Proxy (forward-proxy)
  • Fix timeout issues with HTTPs requests by setting https_proxy_host to the same value as http_proxy_host
  • Use lowercase when overwriting the host header
  • Add support for basic authentication when using a secured proxy with HTTPS requests
• StatsD Advanced (statsd-advanced)
  • Added support for setting workspace_identifier to workspace_name
• Rate Limiting Advanced (rate-limiting-advanced)
  • Skip namespace creation if the plugin is not enabled. This prevents the error “[rate-limiting-advanced] no shared dictionary was specified” being logged.
• Proxy Cache Advanced (proxy-cache-advanced)
  • Large files would not be cached due to memory usage, leading to a X-Cache-Status:Miss response. This has now been resolved
• GraphQL Proxy Cache Advanced (graphql-proxy-cache-advanced)
  • Large files would not be cached due to memory usage, leading to a X-Cache-Status:Miss response. This has now been resolved
• LDAP Auth Advanced (ldap-auth-advanced)
  • Support passwords that contain a : character

Dependencies

• Bumped openssl from 1.1.1k to 1.1.1n to resolve CVE-2022-0778 #8635
• Bumped openresty from 1.19.3.2 to 1.19.9.1 #7727

2.7.1.2

Release Date 2022/02/17

Fixes

Enterprise

• Fixed an issue with Kong Manager OIDC authentication, which caused the error “attempt to call method 'select_by_username_ignore_case' (a nil value)” and prevented login with OIDC.
• Fixed an issue where common names added to cluster_allowed_common_names did not work.

2.7.1.1

Release Date 2022/02/04

Fixes

Enterprise

• Fixed a performance issue with Kong Manager, which occurred when admins had access to multiple workspaces.
• Fixed the attempt to index local 'workspace' error, which occurred when accessing Routes or Services using TLS.

2.7.1.0

Release Date: 2022/01/27

Features

Enterprise

• You can now configure cluster_max_payload for hybrid mode deployments. This configuration option sets the maximum payload size allowed to be sent across from the control plane to the data plane. If your environment has large configurations that generate payload too big errors and don’t get applied to the data planes, use this setting to adjust the limit.
• When using PKI for certificate verification in hybrid mode, you can now configure a list of Common Names allowed to connect to a control plane with the cluster_allowed_common_names option. If not set, only data planes with the same parent domain as the control plane cert are allowed.

Fixes

Enterprise

• Fixed an issue where OIDC authentication into Kong Manager failed when used with Azure AD.
• Fixed a timer leak that caused the timers to be exhausted and failed to start any other timers used by Kong, showing the error too many pending timers.
• Fix an issue where, if data_plane_config_cache_mode was set to off, the data plane received no updates from the control plane.

Core

• Reschedule resolve timer only when the previous one has finished. #8344
• Plugins, and any entities implemented with subchemas, now can use the transformations and shorthand_fields properties, which were previously only available for non-subschema entities. #8146

Plugins

• Rate Limiting (rate-limiting)

  • Fixed a 500 error associated with performing arithmetic functions on a nil value by adding a nil value check after performing ngx.shared.dict operations.

  • Fixed a timer leak that caused the timers to be exhausted and failed to start any other timers used by Kong, showing the error too many pending timers.

    Before, the plugin used one timer for each namespace maintenance process, increasing timer usage on instances with a large number of rate limiting namespaces. Now, it uses a single timer for all namespace maintenance.

• Rate Limiting Advanced (rate-limiting-advanced)

  • Fixed a 500 error that occurred when consumer groups were enforced but no proper configurations were provided. Now, if no specific consumer group configuration exists, the consumer group defaults to the original plugin configuration.
• Exit Transformer (exit-transformer)
  • Fix an issue where the Exit Transformer plugin would break the plugin iterator, causing later plugins not to run.

2.7.0.0

Release Date: 2021/12/16

Features

Enterprise

• Kong Gateway now supports installations on Debian 10 and 11.

• This release introduces consumer groups, a new entity that lets you manage custom rate limiting configuration for any defined subsets of consumers. To use consumer groups for rate limiting, configure the Rate Limiting Advanced plugin with the enforce_consumer_groups and consumer_groups parameters, and use the /consumer_groups endpoint to manage the groups.

  This is useful for managing consumers with same rate limiting settings, as you can create a consumer group and one Rate Limiting Advanced plugin instance for the group to reduce proxy delay.

  • Consumer groups reference

  • Consumer groups examples

    This feature is currently not supported with declarative configuration.

• The data plane configuration cache can now be encrypted or turned off entirely. Two new configuration options have been added:

  • data_plane_config_cache_mode: The cache can be unencrypted, encrypted, or off.
  • data_plane_config_cache_path: Use this setting to specify a custom path for the cache.
• The /license/report API endpoint now provides monthly throughput usage reports.

Dev Portal

• The Dev Portal API now supports sort_by={attribute} and sort_desc query parameters for sorted list results.

• Improvements to Dev Portal authentication with OpenID Connect (OIDC): If OIDC auth is enabled, the first time a user attempts to access the Dev Portal using their IDP credentials, they are directed to a pre-filled registration form. Submit the form to create a Dev Portal account, linking the account to your IDP.

  After linking, you can use your IDP credentials to directly access this Dev Portal account.

• Added TLSv1.3 support for the Dev Portal API and GUI.

Kong Manager

• When using OpenID Connect to secure Kong Manager, you no longer need to create admins manually in Kong Manager and map their roles to your identity provider. Instead, admins are created on first login and their roles are assigned based on their group membership in your IdP. This feature also partly resolves a problem with creating admins for both Kong Manager and Dev Portal.

  Important: This feature introduces a breaking change. The admin_claim parameter replaces the consumer_claim parameter required by previous versions. You must update your OIDC config file to keep OIDC authentication working for Kong Manager. For more information, see OIDC Authenticated Group Mapping.

• Kong Manager now provides a simplified, organized form for configuring the OpenID Connect plugin. Users can now easily identify a common set of required parameters to configure the plugin, and add custom configurations as needed.

Core

• Service entities now have a required enabled field which defaults to true. When set to false, routes attached to the service are not added to the proxy router. #8113

  In hybrid mode:

  • If enabled is set to false for a service, the service and its attached routes and plugins are not exported to data planes.
  • If enabled is set to false for a plugin, plugins are now also not exported to data planes, regardless of the service setting.
• DAOs in plugins must be listed in an array, so that their loading order is explicit. Loading them in a hash-like table is now deprecated. #7942
• Added the ability to route TLS traffic based on SNIs without terminating the connection. #6757

Performance

In this release, we continued our work on better performance:

• Improved the plugin iterator performance and JITability #7912 #7979
• Simplified the Kong core context read and writes for better performance #7919
• Reduced proxy long tail latency while reloading DB-less config #8133

PDK

• Added two new functions for the body_filter phase: kong.response.get_raw_body and kong.response.set_raw_body. #7887

Plugins

• OpenID Connect (openid-connect)
  • Added support for JWT algorithm RS384.
  • The plugin now allows Redis Cluster nodes to be specified by hostname through the session_redis_cluster_nodes field, which is helpful if the cluster IPs are not static.
• Rate Limiting Advanced (rate-limiting-advanced)
  • Added the enforce_consumer_groups and consumer_groups parameters, which introduce support for consumer groups. With consumer groups, you can manage custom rate limiting configuration for any defined subsets of consumers.
• Forward Proxy (forward-proxy)
  • Added two proxy authentication parameters, auth_username and auth_password.
• Mocking (mocking)
  • Added the random_examples parameter. Use this setting to randomly select one example from a set of mocked responses.

• IP-Restriction (ip-restriction)

  • Response status and message can now be customized through configurations status and message. #7728

    Thanks timmkelley for the patch!

• Datadog (datadog)

  • Added support for the distribution metric type. #6231

    Thanks onematchfox for the patch!

  • Allow service, consumer, and status tags to be customized through new plugin configurations service_tag, consumer_tag, and status_tag. #6230

    Thanks onematchfox for the patch!

• gRPC Gateway (grpc-gateway) and gRPC Web (grpc-web)

  • Both plugins now share the Timestamp transcoding and included .proto files features. [#7950(https://github.com/Kong/kong/pull/7950)
• gRPC Gateway (grpc-gateway)
  • This plugin now processes services and methods defined in imported .proto files. #8107

• Rate-Limiting (rate-limiting) Added support for Redis SSL through configuration properties redis_ssl (can be set to true or false), redis_ssl_verify, and redis_server_name. #6737

  Thanks gabeio for the patch!

Plugin encryption

• Several fields have been marked as encrypted on plugins. If keyring encryption is enabled, these fields will be encrypted:

  • ACME: account_email, eab_kid, and eab_hmac_kid
  • AWS Lambda: aws_key and aws_secret
  • Azure Functions: apikey and clientid
  • Basic Auth: basicauth_credentials.password
  • HTTP Log: http_endpoint
  • LDAP Auth Advanced: ldap_password
  • Loggly: key
  • OAuth2: config.provision_key parameter value and the oauth2_credentials.provision_key field
  • OpenID Connect: client_id, client_secret, session_auth, and session_redis_auth
  • Session: secret
  • Vault: vaults.vault_token and vault_credentials.secret_token

  Note: There is a known issue with encrypting deeply nested fields in certain plugins. For plugins with fields that are marked as encrypted but currently not working, see the Known Issues section.

Fixes

Enterprise

• Fixed an issue with Vitals report generation. If running Vitals with InfluxDB and attempting to generate a report containing any status codes outside of 2XX, 4XX, or 5XX, report generation would fail. With this fix, proxied traffic outside of the expected codes will not cause errors, and instead appear as count totals in Vitals reports.

• Fixed a latency issue in hybrid mode. Previously, applying a large number of configuration changes to a data plane simultaneously caused high latency in all upstream requests.

• Users can now successfully delete admins with the super-admin role from any workspace, as long as they have the correct permissions, and the associated Consumer entity will be deleted as well. This frees up the username for a new user. Previously, deleting an admin with a super-admin role from a different workspace than where it was originally created did not delete the associated Consumer entity, and the username would remain locked. For example, if the admin was created in workspace dev and deleted from workspace QA, this issue would occur.

• Phone home metrics are now sent over TLS, meaning that any analytics data on Kong Gateway usage now travels through an encrypted connection.

Dev Portal

• Dev Portal OpenID Connect authentication now properly redirects users based on the values of login_redirect_uri and forbidden_redirect_uri set in portal_auth. If these values are not set in portal_auth, redirect values are taken from the Portal templates file, portal.conf.yaml.

• When using OpenID Connect as the Dev Portal authentication method, updates to Developers now correctly propagate to their associated Consumers.

• Fixed links in Dev Portal footer.

• Improved accessibility of the Dev Portal, fixing various issues related to labels, names, headings, and color contrast:

  • Keyboard-accessible response examples and “Try it out” sections
  • Form inputs now have labels
  • Selectable elements now all have accessible names
  • Unique IDs for active elements
  • Heading levels only increase by one, and are in the correct order
  • Improved contrast of buttons

• Fixed info tooltip crash and rendering issue when viewing the Dev Portal app registration service list.

• Fixed the Dev Portal Application Services list to allow pagination.

• Fixed a table border styling issue in Dev Portal.

Kong Manager

• Fixed an issue with icon alignment in Kong Manager, where the Delete (garbage can) icon overlapped with the View link and caused users to accidentally click Delete.

Core

• Fixed an issue where the pluginsocket.proto file was missing for Go plugins.
• Balancer caches are now reset on configuration reload. #7924
• Configuration reload no longer causes a new DNS-resolving timer to be started. #7943
• Fixed problem when bootstrapping multi-node Cassandra clusters, where migrations could attempt insertions before a schema agreement occurred. #7667
• Fixed an intermittent botting error which happened when a custom plugin had interdependent entity schemas on its custom DAO and they were loaded in an incorrect order. #7911
• Fixed an issue where encrypted=true would apply to the main plugin object, instead of each plugin subschema.

PDK

• kong.log.inspect log level is now debug instead of warn. It also renders textboxes more cleanly now. #7815

Plugins

• LDAP Authentication (ldap-auth)

  • Fixed issue where the basic authentication header was not parsed correctly when the password contained a colon (:). #7977

    Thanks beldahanit for reporting the issue!

• Prometheus (prometheus)

  • Hid Upstream Target health metrics on the control plane, as the control plane doesn’t initialize the balancer and doesn’t have any real metrics to show. #7992
• Request Validator (request-validator)
  • Reverted the change in parsing multiple values, as arrays in version 1.1.3 headers and query-args as primitive are now validated individually when duplicates are provided, instead of merging them as an array.
  • Whitespace around CSV values is now dropped since it is not significant according to the RFC (whitespace is optional).
  • Bumped openapi3-deserialiser to 2.0.0 to enable the changes.
• Forward Proxy (forward-proxy)
  • This plugin no longer uses deprecated features of the lua-resty-http dependency, which previously added deprecation warnings to the DEBUG log.
  • This plugin no longer sets a Host header if the upstream_host is an empty string.
• OAuth2 Introspection (oauth2-introspection)
  • This plugin no longer uses deprecated features of the lua-resty-http dependency, which previously added deprecation warnings to the DEBUG log.
• GraphQL Rate Limiting Advanced (graphql-rate-limiting-advanced)
  • Fixed plugin initialization code causing HTTP 500 status codes after enabling the plugin.
• mTLS Auth (mtls-auth)
  • Fixed an issue where CRL cache was not properly invalidated, causing all certificates to appear invalid.
• Proxy Cache Advanced (proxy-cache-advanced)
  • Fixed the function cannot be called in access phase error, which occurred when the plugin was called in the log phase.
• Rate Limiting Advanced (rate-limiting-advanced)
  • Fixed the schema entity check for config.limit and config.window_size count when the number of configured window sizes and limits parameters are not equal.

Dependencies

• Bumped go-pdk used in tests from v0.6.0 to v0.7.1 #7964
• Bumped grpcurl from 1.8.2 to 1.8.5 #7959
• Bumped lua-pack from 1.0.5 to 2.0.0 #8004
• Dependency on luaossl is removed.
• lua-resty-openapi3-deserializer (library dependency)
  • Reverted the header fix in 1.1.0. For primitive types, the values are returned as plain strings, not as an array. Duplicate values must now be offered individually for deserialization.
  • Stripped whitespace from headers since it is not significant according to the RFC.

Deprecated

• Kong Immunity is deprecated, removed, and not available in Kong Gateway. To access old Kong Immunity documentation, see the doc archive.

• Cassandra as a backend database for Kong Gateway is deprecated with this release and will be removed in a future version.

  The target for Cassandra removal is the Kong Gateway 3.4 release. Starting with the Kong Gateway 3.0 release, some new features might not be supported with Cassandra. Our intent is to provide our users with ample time and alternatives for satisfying the use cases that they have been able to address with Cassandra.

• The old BasePlugin module is deprecated and will be removed in a future version of Kong. See porting tips in the documentation.

• Hash syntax for plugin DAOs is deprecated. Plugin DAOs should be arrays instead of hashes.

Known issues

• There’s a bug in Kong Gateway which prevents keyring encryption from working on deeply nested fields in plugins, so the encrypted=true setting does not have any effect on the following plugins and fields:
  • JWT Signer: the fields d, p, q, dp, dq, qi, and k inside jwt_signer_jwks.previous[...]. and jwt_signer_jwks.keys[...]
  • Kafka Log: config.authentication.user and config.authentication.password
  • Kafka Upstream: config.authentication.user and config.authentication.password
  • OpenID Connect: the fields d, p, q, dp, dq, qi, oth, r, t, and k inside openid_connect_jwks.previous[...]. and openid_connect_jwks.keys[...]

• Consumer groups are not supported in declarative configuration with decK. If you have consumer groups in your configuration, decK will ignore them.

• If you are using SSL certificates with custom plugins, you may need to set certificate phase in ngc.ctx.

2.6.1.0

Release Date 2022/04/07

Fixes

Enterprise

• Fixed an issue with RBAC where endpoint=/kong workspace=* would not let the /kong endpoint be accessed from all workspaces
• Fixed an issue with RBAC where admins without a top level endpoint=* permission could not add any RBAC rules, even if they had endpoint=/rbac permissions. These admins can now add RBAC rules for their current workspace only.

Plugins

• HTTP Log (http-log)
  • Include provided query string parameters when sending logs to the http_endpoint

Dependencies

• Bumped openssl from 1.1.1k to 1.1.1n to resolve CVE-2022-0778 #8635
• Bumped luarocks from 3.7.1 to 3.8.0 #8630
• Bumped openresty from 1.19.3.2 to 1.19.9.1 #7727

2.6.0.4

Release Date 2022/02/10

Fixes

Enterprise

• Fixed an issue with Kong Manager OIDC authentication, which caused the error “attempt to call method 'select_by_username_ignore_case' (a nil value)” and prevented login with OIDC.

2.6.0.3

Release Date: 2022/01/27

Features

Enterprise

• You can now configure cluster_max_payload for hybrid mode deployments. This configuration option sets the maximum payload size allowed to be sent across from the control plane to the data plane. If your environment has large configurations that generate payload too big errors and don’t get applied to the data planes, use this setting to adjust the limit.

Fixes

Enterprise

• Phone home metrics are now sent over TLS, meaning that any analytics data on Kong Gateway usage now travels through an encrypted connection.
• Fixed an issue where OIDC authentication into Kong Manager failed when used with Azure AD.
• Fixed a timer leak that caused the timers to be exhausted and failed to start any other timers used by Kong, showing the error too many pending timers.
• Fixed an issue with icon alignment in Kong Manager, where the Delete (garbage can) icon overlapped with the View link and caused users to accidentally click Delete.

Dev Portal

• Fixed the Dev Portal Application Services list to allow pagination.
• Fixed a table border styling issue.
• Fixed issues with modal accessibility.

Plugins

• Rate Limiting (rate-limiting) and Rate Limiting Advanced (rate-limiting-advanced)

  • Fixed a timer leak that caused the timers to be exhausted and failed to start any other timers used by Kong, showing the error too many pending timers.

    Before, the plugin used one timer for each namespace maintenance process, increasing timer usage on instances with a large number of rate limiting namespaces. Now, it uses a single timer for all namespace maintenance.

2.6.0.2

Release Date: 2021/12/03

Fixes

Dev Portal

• Fixed links in Dev Portal footer.

• Improved accessibility of the Dev Portal, fixing various issues related to labels, names, headings, and color contrast:

  • Keyboard-accessible response examples and “Try it out” sections
  • Form inputs now have labels
  • Selectable elements now all have accessible names
  • Unique IDs for active elements
  • Heading levels only increase by one, and are in the correct order
  • Improved contrast of buttons

• Fixed the Dev Portal API /applications endpoint to only accept allowed fields in a PATCH request.

• Fixed info tooltip crash and rendering issue when viewing the Dev Portal app registration service list.

Plugins

• OpenID Connect (openid-connect)
  • The plugin now allows Redis Cluster nodes to be specified by hostname through the session_redis_cluster_nodes field, which is helpful if the cluster IPs are not static.

2.6.0.1

Release Date: 2021/11/18

Fixes

Enterprise

• Fixed an issue with Vitals report generation. If running Vitals with InfluxDB and attempting to generate a report containing any status codes outside of 2XX, 4XX, or 5XX, report generation would fail. With this fix, proxied traffic outside of the expected codes will not cause errors, and instead appear as count totals in Vitals reports.

• Fixed a latency issue in hybrid mode. Previously, applying a large number of configuration changes to a Data Plane simultaneously caused high latency in all upstream requests.

• Fixed accessibility issues related to non-unique IDs in the Dev Portal.

• When using OpenID Connect as the Dev Portal authentication method, updates to Developers now correctly propagate to their associated Consumers.

• Users can now successfully delete admins with the super-admin role from any workspace, as long as they have the correct permissions, and the associated Consumer entity will be deleted as well. This frees up the username for a new user. Previously, deleting an admin with a super-admin role from a different workspace than where it was originally created did not delete the associated Consumer entity, and the username would remain locked. For example, if the admin was created in workspace dev and deleted from workspace QA, this issue would occur.

Dependencies

• Bumped kong-redis-cluster from 1.1-0 to 1.2.0.
  • With this update, if the entire cluster is restarted and starts up using new IP addresses, the cluster client can recover automatically.

2.6.0.0

Release date: 2021/10/14

Features

Enterprise

Core

This release includes the addition of a new schema entity validator: mutually_exclusive. Before, the only_one_of validator required at least one of the fields included be configured. This new entity validator allows only one or neither of the fields be configured. #7765

Configuration

• Enable IPV6 on dns_order as unsupported experimental feature. #7819.
• The template renderer can now use os.getenv. #6872.

Hybrid Mode

• Data plane is able to eliminate some unknown fields when Control Plane is using a more modern version. #7827.

Admin API

• Added support for the HTTP HEAD method for all Admin API endpoints. #7796
• Added better support for OPTIONS requests. Previously, the Admin API replied the same on all OPTIONS requests, where as now OPTIONS request will only reply to routes that our Admin API has. Non-existing routes will have a 404 returned. Additionally, the Allow header was added to responses. Both Allow and Access-Control-Allow-Methods now contain only the methods that the specific API supports. #7830

Plugins

• New plugin: jq (jq) The jq plugin enables arbitrary jq transformations on JSON objects included in API requests or responses.
• Kafka Log (kafka-log) The Kafka Log plugin now supports TLS, mTLS, and SASL auth. SASL auth includes support for PLAIN, SCRAM-SHA-256, and delegation tokens.
• Kafka Upstream (kafka-upstream) The Kafka Upstream plugin now supports TLS, mTLS, and SASL auth. SASL auth includes support for PLAIN, SCRAM-SHA-256, and delegation tokens.
• Rate Limiting Advanced (rate-limiting-advanced)
  • The Rate Limiting Advanced plugin now has a new identifier type, path, which allows rate limiting by matching request paths.
  • The plugin now has a local strategy in the schema. The local strategy automatically sets config.sync_rate to -1.
  • The highest sync-rate configurable was a 1 second interval. This sync-rate has been increased by reducing the minimum allowed interval from 1 to 0.020 second (20ms).
• OPA (opa) The OPA plugin now has a request path parameter, which makes setting policies on a path easier for administrators.
• Canary (canary) The Canary plugin now has the option to hash on the header (falls back on IP, and then random).
• OpenID Connect (openid-connect) Upgrade to v2.1.0 to maintain version compatibility with older data planes.
  • Features from v2.0.x include the following:
    • The OpenID Connect plugin can now handle JWT responses from a userinfo endpoint.
    • The plugin now supports JWE Introspection.
  • Feature from to v2.1.x includes the following:
    • The plugin now has a new param, by_username_ignore_case, which allows consumer_by username values to be matched case-insensitive with Identity Provider claims.
• Request Transformer Advanced (request-transformer-advanced)
  • This release includes a fix for the URL encode transformed path. The plugin now uses PDK functions to set upstream URI by replacing ngx.var.upstream_uri so the urlencode is taken care of.
• AWS-Lambda (aws-lambda) The plugin will now try to detect the AWS region by using AWS_REGION and AWS_DEFAULT_REGION environment variables (when not specified with the plugin configuration). This allows users to specify a ‘region’ on a per Kong node basis, adding the ability to invoke the Lambda function in the same region where Kong is located. #7765
• Datadog (datadog) The Datadog plugin now allows host and port config options be configured from environment variables, KONG_DATADOG_AGENT_HOST and KONG_DATADOG_AGENT_PORT. This update enables users to set different destinations on a per Kong node basis, which makes multi-DC setups easier and in Kubernetes helps with the ability to run the Datadog agents as a daemon-set. #7463
• Prometheus (prometheus) The Prometheus plugin now includes a new metric, data_plane_cluster_cert_expiry_timestamp, to expose the Data Plane’s cluster_cert expiry timestamp for improved monitoring in Hybrid Mode. #7800.
• GRPC-Gateway (grpc-gateway)
  • Fields of type .google.protobuf.Timestamp on the gRPC side are now transcoded to and from ISO8601 strings in the REST side. #7538
  • URI arguments like ..?foo.bar=x&foo.baz=y are interpreted as structured fields, equivalent to {"foo": {"bar": "x", "baz": "y"}}. #7564
• Request Termination (request-termination)
  • The Request Termination plugin now includes a new trigger config option, which makes the plugin only activate for any requests with a header or query parameter named like the trigger. This config option can be a great debugging aid, without impacting actual traffic being processed. #6744.
  • The request-echo config option was added. If set, the plugin responds with a copy of the incoming request. This config option eases troubleshooting when Kong Gateway is behind one or more other proxies or LB’s, especially when combined with the new trigger option. #6744.

Dependencies

• Bumped openresty from 1.19.3.2 to 1.19.9.1 #7430
• Bumped openssl from 1.1.1k to 1.1.1l 7767
• Bumped lua-resty-http from 0.15 to 0.16.1 #7797
• Bumped Penlight to 1.11.0 #7736
• Bumped lua-resty-http from 0.15 to 0.16.1 #7797
• Bumped lua-protobuf from 0.3.2 to 0.3.3 #7656
• Bumped lua-resty-openssl from 0.7.3 to 0.7.4 #7657
• Bumped lua-resty-acme from 0.6 to 0.7.1 #7658
• Bumped grpcurl from 1.8.1 to 1.8.2 #7659
• Bumped luasec from 1.0.1 to 1.0.2 #7750
• Bumped lua-resty-ipmatcher to 0.6.1 #7703

Fixes