/CHANGELOG-OLD.md

Table of Contents

Looking for recent releases? Please see CHANGELOG.md instead.

• 2.8.5
• 2.8.4
• 2.8.3
• 2.8.2
• 2.8.1
• 2.8.0
• 2.7.1
• 2.7.0
• 2.6.0
• 2.5.1
• 2.5.0
• 2.4.1
• 2.4.0
• 2.3.3
• 2.3.2
• 2.3.1
• 2.3.0
• 2.2.2
• 2.2.1
• 2.2.0
• 2.1.4
• 2.1.3
• 2.1.2
• 2.1.1
• 2.1.0
• 2.0.5
• 2.0.4
• 2.0.3
• 2.0.2
• 2.0.1
• 2.0.0
• 1.5.1
• 1.5.0
• 1.4.3
• 1.4.2
• 1.4.1
• 1.4.0
• 1.3.0
• 1.2.2
• 1.2.1
• 1.2.0
• 1.1.2
• 1.1.1
• 1.1.0
• 1.0.3
• 1.0.2
• 1.0.1
• 1.0.0
• 0.15.0
• 0.14.1
• 0.14.0
• 0.13.1
• 0.13.0
• 0.12.3
• 0.12.2
• 0.12.1
• 0.12.0
• 0.11.2
• 0.11.1
• 0.10.4
• 0.11.0
• 0.10.3
• 0.10.2
• 0.10.1
• 0.10.0
• 0.9.9 and prior

[2.8.5]

Kong

Performance

Performance

• Fixed an inefficiency issue in the Luajit hashing algorithm #13269

Fixes

Default

• Added zlib1g-dev dependency to Ubuntu packages. #13269

[2.8.4]

Fixes

• Fixed a bug where internal redirects (i.e. those produced by the error_page directive) could interfere with worker process handling the request when buffered proxying is being used.

[2.8.3]

Fixes

Plugins

• HTTP Log: fix internal error during validating the schema if http_endpoint contains userinfo but headers is empty #9574
• 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

CLI

• Fixed a packaging problem affecting a subset of releases where the kong version command was incorrect

[2.8.2]

Dependencies

• Bumped OpenSSL from 1.1.1n to 1.1.1o #8635

2.8.1

Dependencies

• Bumped lua-resty-healthcheck from 1.5.0 to 1.5.1 #8584
• Bumped OpenSSL from 1.1.1l to 1.1.1n #8635

Fixes

Core

• Only reschedule router and plugin iterator timers after finishing previous execution, avoiding unnecessary concurrent executions. #8634
• Implements conditional rebuilding of router, plugins iterator and balancer on data planes. This means that DPs will not rebuild router if there were no changes in routes or services. Similarly, the plugins iterator will not be rebuilt if there were no changes to plugins, and, finally, the balancer will not be reinitialized if there are no changes to upstreams or targets. #8639

2.8.0

Deprecations

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

Dependencies

• OpenSSL bumped to 1.1.1m #8191
• Bumped resty.session from 3.8 to 3.10 #8294
• Bumped lua-resty-openssl to 0.8.5 #8368

Additions

Core

• Customizable transparent dynamic TLS SNI name. Thanks, @zhangshuaiNB! #8196
• Routes now support matching headers with regular expressions Thanks, @vanhtuan0409! #6079

Beta

• Secrets Management and Vault support as been introduced as a Beta feature. This means it is intended for testing in staging environments. It not intended for use in Production environments. You can read more about Secrets Management in our docs page. #8403

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. Amongst others:
  • The router builds twice as fast compared to prior Kong versions
  • Failures are cached and discarded faster (negative caching)
  • Routes with header matching are cached These changes should be particularly noticeable when rebuilding on db-less environments #8087 #8010
• Prometheus plugin export performance is improved, it now has less impact to proxy side traffic when being scrapped. #9028

Plugins

• Response-ratelimiting: Redis ACL support, and genenarized Redis connection support for usernames. Thanks, @27ascii for the original contribution! #8213
• ACME: Add rsa_key_size config option Thanks, lodrantl! #8114
• Prometheus: Added gauges to track ngx.timer.running_count() and ngx.timer.pending_count() #8387

Clustering

• CLUSTERING_MAX_PAYLOAD is now configurable in kong.conf Thanks, @andrewgkew! #8337

Admin API

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

Fixes

Core

• When the Router encounters an SNI FQDN with a trailing dot (.), the dot will be ignored, since according to RFC-3546 said 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
• Cassandra connector now records migration consistency level. Thanks, @mpenick! #8226

Balancer

• Targets 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 appropiate debug log level. #8410

Clustering

• Replaced cryptic error message with more useful one when there is a failure on SSL when connecting with CP: #8260

Admin API

• Fix incorrect next field in when paginating Upstreams #8249

PDK

• Phase names are 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
• External Plugins: Unwrap ConsumerSpec and AuthenticateArgs. Thanks, @raptium! #8280
• External Plugins: Fixed a problem in the stream subsystem would attempt to load HTTP headers. #8414
• CORS: The CORS plugin does not send the Vary: Origin header any more when the header Access-Control-Allow-Origin is set to *. Thanks, @jkla-dr! #8401
• 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: The plugin clears the X-Authenticated-UserId and X-Authenticated-Scope headers when it configured in logical OR and is used in conjunction with another authentication plugin. #8422
• Datadog: The plugin schema now lists the default values for configuration options in a single place instead of in two separate places. #8315

2.7.1

Fixes

• 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

2.7.0

Dependencies

• Bumped kong-plugin-session from 0.7.1 to 0.7.2 #7910
• Bumped resty.openssl from 0.7.4 to 0.7.5 #7909
• Bumped go-pdk used in tests from v0.6.0 to v0.7.1 #7964
• Cassandra support is deprecated with 2.7 and will be fully removed with 4.0.

Additions

Configuration

• Deprecated the worker_consistency directive, and changed its default to eventual. Future versions of Kong will remove the option and act with eventual consistency only.

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

Core

• 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
• Postgres credentials pg_user and pg_password, and pg_ro_user and pg_ro_password now support automatic secret rotation when used together with Kong Secrets Management vault references. #8967

PDK

• New functions: kong.response.get_raw_body and kong.response.set_raw_body #7887

Plugins

• IP-Restriction: response status and message can now be customized through configurations status and message. #7728 Thanks timmkelley for the patch!
• Datadog: add support for the distribution metric type. #6231 Thanks onematchfox for the patch!
• Datadog: allow service, consumer, and status tags to be customized through plugin configurations service_tag, consumer_tag, and status_tag. #6230 Thanks onematchfox for the patch!
• gRPC Gateway and gRPC Web: Now share most of the ProtoBuf definitions. Both plugins now share the Timestamp transcoding and included .proto files features. #7950
• gRPC Gateway: processes services and methods defined in imported .proto files. #8107
• Rate-Limiting: add support for Redis SSL, through configuration properties redis_ssl (can be set to true or false), ssl_verify, and ssl_server_name. #6737 Thanks gabeio for the patch!
• LDAP: basic authentication header was not parsed correctly when the password contained colon (:). #7977 Thanks beldahanit for reporting the issue!
• Old BasePlugin is deprecated and will be removed in a future version of Kong. Porting tips in the documentation
• The deprecated BasePlugin has been removed. #7961

Configuration

• Removed the following config options, which had been deprecated in previous versions, in favor of other config names. If you have any of these options in your config you will have to rename them: (removed option -> current option).
  • upstream_keepalive -> nginx_upstream_keepalive + nginx_http_upstream_keepalive
  • nginx_http_upstream_keepalive -> nginx_upstream_keepalive
  • nginx_http_upstream_keepalive_requests -> nginx_upstream_keepalive_requests
  • nginx_http_upstream_keepalive_timeout -> nginx_upstream_keepalive_timeout
  • nginx_http_upstream_directives -> nginx_upstream_directives
  • nginx_http_status_directives -> nginx_status_directives
  • nginx_upstream_keepalive -> upstream_keepalive_pool_size
  • nginx_upstream_keepalive_requests -> upstream_keepalive_max_requests
  • nginx_upstream_keepalive_timeout -> upstream_keepalive_idle_timeout
  • client_max_body_size -> nginx_http_client_max_body_size
  • client_body_buffer_size -> nginx_http_client_max_buffer_size
  • cassandra_consistency -> cassandra_write_consistency / cassandra_read_consistency
  • router_update_frequency -> worker_state_update_frequency
• Removed the nginx_optimizations config option. If you have it in your configuration, please remove it before updating to 3.0.

Fixes

Core

• 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 schema agreement occurred. #7667
• Fixed intermittent botting error which happened when a custom plugin had inter-dependent entity schemas on its custom DAO and they were loaded in an incorrect order #7911
• Fixed problem when the consistent hash header is not found, the balancer tries to hash a nil value. #8141
• Fixed DNS client fails to resolve unexpectedly in ssl_cert and ssl_session_fetch phases. #8161

PDK

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

Plugins

• Prometheus: Control Plane does not show Upstream Target health metrics #7992

Dependencies

• Bumped lua-pack from 1.0.5 to 2.0.0 #8004

Back to TOC

2.6.0

Release date: 2021/10/04

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 Thanks EpicEric for the patch!

All Kong Gateway OSS plugins will be moved from individual repositories and centralized into the main Kong Gateway (OSS) repository. We are making a gradual transition. On this release:

• Moved AWS-Lambda inside the Kong repo #7464.
• Moved ACME inside the Kong repo #7464.
• Moved Prometheus inside the Kong repo #7666.
• Moved Session inside the Kong repo #7738.
• Moved GRPC-web inside the Kong repo #7782.
• Moved Serverless functions inside the Kong repo #7792.

Additions

Core

• New schema entity validator: mutually_exclusive. It accepts a list of fields. If more than 1 of those fields is set simultaneously, the entity is considered invalid. #7765

Performance

On this release we've done some special efforts with regards to performance.

There's a new performance workflow which periodically checks new code additions against some typical scenarios #7030 #7547

In addition to that, the following changes were specifically included to improve performance:

• Reduced unnecessary reads of ngx.var #7840
• Loaded more indexed variables #7849
• Optimized table creation in Balancer #7852
• Reduce calls to ngx.update_time #7853
• Use read-only replica for PostgreSQL meta-schema reading #7454
• URL escaping detects cases when it's not needed and early-exits #7742
• Accelerated variable loading via indexes #7818
• Removed unnecessary call to get_phase in balancer #7854

Configuration

• Enable IPV6 on dns_order as unsupported experimental feature. Please give it a try and report back any issues #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. It also adds Allow header to responses, both Allow and Access-Control-Allow-Methods now contain only the methods that the specific API supports. #7830

Plugins

• 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 to specify a 'region' on a per Kong node basis, hence adding the ability to invoke the Lamda in the same region where Kong is located. #7765
• Datadog: host and port config options can be configured from environment variables KONG_DATADOG_AGENT_HOST and KONG_DATADOG_AGENT_PORT. This allows to set different destinations on a per Kong node basis, which makes multi-DC setups easier and in Kubernetes allows to run the datadog agents as a daemon-set. #7463 Thanks rallyben for the patch!
• Prometheus: A new metric data_plane_cluster_cert_expiry_timestamp is added to expose the Data Plane's cluster_cert expiry timestamp for improved monitoring in Hybrid Mode. #7800.

Request Termination:

• New trigger config option, which makes the plugin only activate for any requests with a header or query parameter named like the trigger. This 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 eases troubleshooting when Kong is behind one or more other proxies or LB's, especially when combined with the new 'trigger' option. #6744.

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 Thanks git-torrent for the patch!

Fixes

Core

• Balancer retries now correctly set the :authority pseudo-header on balancer retries #7725.
• Healthchecks are now stopped while the Balancer is being recreated #7549.
• Fixed an issue in which a malformed Accept header could cause unexpected HTTP 500 #7757.
• Kong no longer removes Proxy-Authentication request header and Proxy-Authenticate response header #7724.
• Fixed an issue where Kong would not sort correctly Routes with both regex and prefix paths #7695 Thanks jiachinzhao for the patch!

Hybrid Mode

• Ensure data plane config thread is terminated gracefully, preventing a semi-deadlocked state #7568 Thanks flrgh for the patch!
• Older data planes using aws-lambda, grpc-web or request-termination plugins can now talk with newer control planes by ignoring new plugin fields. #7881

CLI

• kong config parse no longer crashes when there's a Go plugin server enabled #7589.

Configuration

• Declarative Configuration parser now prints more correct errors when pointing unknown foreign references #7756.
• YAML anchors in Declarative Configuration are properly processed #7748.

Admin API

• GET /upstreams/:upstreams/targets/:target no longer returns 404 when target weight is 0 #7758.

PDK

• kong.response.exit now uses customized "Content-Length" header when found #7828.

Plugins

• ACME: Dots in wildcard domains are escaped #7839.
• Prometheus: Upstream's health info now includes previously missing subsystem field #7802.
• Proxy-Cache: Fixed an issue where the plugin would sometimes fetch data from the cache but not return it #7775 Thanks agile6v for the patch!

Back to TOC

2.5.1

Release date: 2021/09/07

This is the first patch release in the 2.5 series. Being a patch release, it strictly contains bugfixes. There are no new features or breaking changes.

Dependencies

• Bumped grpcurl from 1.8.1 to 1.8.2 #7659
• Bumped lua-resty-openssl from 0.7.3 to 0.7.4 #7657
• Bumped penlight from 1.10.0 to 1.11.0 #7736
• Bumped luasec from 1.0.1 to 1.0.2 #7750
• Bumped OpenSSL from 1.1.1k to 1.1.1l #7767

Fixes

Core

• You can now successfully delete workspaces after deleting all entities associated with that workspace. Previously, Kong Gateway was not correctly cleaning up parent-child relationships. For example, creating an Admin also creates a Consumer and RBAC user. When deleting the Admin, the Consumer and RBAC user are also deleted, but accessing the /workspaces/workspace_name/meta endpoint would show counts for Consumers and RBAC users, which prevented the workspace from being deleted. Now deleting entities correctly updates the counts, allowing an empty workspace to be deleted. #7560
• When an upstream event is received from the DAO, handler.lua now gets the workspace ID from the request and adds it to the upstream entity that will be used in the worker and cluster events. Before this change, when posting balancer CRUD events, the workspace ID was lost and the balancer used the default workspace ID as a fallback. #7778

CLI

• Fixes regression that included an issue where Go plugins prevented CLI commands like kong config parse or kong config db_import from working as expected. #7589

CI / Process

• Improves tests reliability. (#7578 #7704)
• Adds Github Issues template forms. #7774
• Moves "Feature Request" link from Github Issues to Discussions. #7777

Admin API

• Kong Gateway now validates workspace names, preventing the use of reserved names on workspaces. #7380

Back to TOC

2.5.0

Release date: 2021-07-13

This is the final release of Kong 2.5.0, with no breaking changes with respect to the 2.x series.

This release includes Control Plane resiliency to database outages and the new declarative_config_string config option, among other features and fixes.

Distribution

• ⚠️ Since 2.4.1, Kong packages are no longer distributed through Bintray. Please visit the installation docs for more details.

Dependencies

• Bumped openresty from 1.19.3.1 to 1.19.3.2 #7430
• Bumped luasec from 1.0 to 1.0.1 #7126
• Bumped luarocks from 3.5.0 to 3.7.0 #7043
• Bumped grpcurl from 1.8.0 to 1.8.1 #7128
• Bumped penlight from 1.9.2 to 1.10.0 #7127
• Bumped lua-resty-dns-client from 6.0.0 to 6.0.2 #7539
• Bumped kong-plugin-prometheus from 1.2 to 1.3 #7415
• Bumped kong-plugin-zipkin from 1.3 to 1.4 #7455
• Bumped lua-resty-openssl from 0.7.2 to 0.7.3 #7509
• Bumped lua-resty-healthcheck from 1.4.1 to 1.4.2 #7511
• Bumped hmac-auth from 2.3.0 to 2.4.0 #7522
• Pinned lua-protobuf to 0.3.2 (previously unpinned) #7079

All Kong Gateway OSS plugins will be moved from individual repositories and centralized into the main Kong Gateway (OSS) repository. We are making a gradual transition, starting with the grpc-gateway plugin first:

• Moved grpc-gateway inside the Kong repo. #7466

Additions

Core

• Control Planes can now send updates to new data planes even if the control planes lose connection to the database. #6938
• Kong now automatically adds cluster_cert(cluster_mtls=shared) or cluster_ca_cert(cluster_mtls=pki) into lua_ssl_trusted_certificate when operating in Hybrid mode. Before, Hybrid mode users needed to configure lua_ssl_trusted_certificate manually as a requirement for Lua to verify the Control Plane’s certificate. See Starting Data Plane Nodes in the Hybrid Mode guide for more information. #7044
• New declarative_config_string option allows loading a declarative config directly from a string. See the Loading The Declarative Configuration File section of the DB-less and Declarative Configuration guide for more information. #7379

PDK

• The Kong PDK now accepts tables in the response body for Stream subsystems, just as it does for the HTTP subsystem. Before developers had to check the subsystem if they wrote code that used the exit() function before calling it, because passing the wrong argument type would break the request response. #7082

Plugins

• hmac-auth: The HMAC Authentication plugin now includes support for the @request-target field in the signature string. Before, the plugin used the request-line parameter, which contains the HTTP request method, request URI, and the HTTP version number. The inclusion of the HTTP version number in the signature caused requests to the same target but using different request methods(such as HTTP/2) to have different signatures. The newly added request-target field only includes the lowercase request method and request URI when calculating the hash, avoiding those issues. See the HMAC Authentication documentation for more information. #7037
• syslog: The Syslog plugin now includes facility configuration options, which are a way for the plugin to group error messages from different sources. See the description for the facility parameter in the Parameters section of the Syslog documentation for more information. #6081. Thanks, jideel!
• Prometheus: The Prometheus plugin now exposes connected data planes' status on the control plane. New metrics include the following: data_plane_last_seen, data_plane_config_hash and data_plane_version_compatible. These metrics can be useful for troubleshooting when data planes have inconsistent configurations across the cluster. See the Available metrics section of the Prometheus plugin documentation for more information. 98
• Zipkin: The Zipkin plugin now includes the following tags: kong.route,kong.service_name and kong.route_name. See the Spans section of the Zipkin plugin documentation for more information. 115

Hybrid Mode

• Kong now exposes an upstream health checks endpoint (using the status API) on the data plane for better observability. #7429
• Control Planes are now more lenient when checking Data Planes' compatibility in Hybrid mode. See the Version compatibility section of the Hybrid Mode guide for more information. #7488
• This release starts the groundwork for Hybrid Mode 2.0 Protocol. This code isn't active by default in Kong 2.5, but it allows future development. #7462

Fixes

Core

• When using DB-less mode, select_by_cache_key now finds entities by using the provided field directly in select_by_key and does not complete unnecessary cache reads. #7146
• Kong can now finish initialization even if a plugin’s init_worker handler fails, improving stability. #7099
• TLS keepalive requests no longer share their context. Before when two calls were made to the same "server+hostname" but different routes and using a keepalive connection, plugins that were active in the first call were also sometimes (incorrectly) active in the second call. The wrong plugin was active because Kong was passing context in the SSL phase to the plugin iterator, creating connection-wide structures in that context, which was then shared between different keepalive requests. With this fix, Kong does not pass context to plugin iterators with the certificate phase, avoiding plugin mixups.#7102
• The HTTP status 405 is now handled by Kong's error handler. Before accessing Kong using the TRACE method returned a standard NGINX error page because the 405 wasn’t included in the error page settings of the NGINX configuration. #6933. Thanks, yamaken1343!
• Custom ngx.sleep implementation in init_worker phase now invokes update_time in order to prevent time-based deadlocks #7532
• Proxy-Authorization header is removed when it is part of the original request or when a plugin sets it to the same value as the original request #7533
• HEAD requests don't provoke an error when a Plugin implements the response phase #7535

Hybrid Mode

• Control planes no longer perform health checks on CRUD upstreams’ and targets’ events. #7085
• To prevent unnecessary cache flips on data planes, Kong now checks dao:crud events more strictly and has a new cluster event, clustering:push_config for configuration pushes. These updates allow Kong to filter invalidation events that do not actually require a database change. Furthermore, the clustering module does not subscribe to the generic invalidations event, which has a more broad scope than database entity invalidations. #7112
• Data Planes ignore null fields coming from Control Planes when doing schema validation. #7458
• Kong now includes the source in error logs produced by Control Planes. #7494
• Data Plane config hash calculation and checking is more consistent now: it is impervious to changes in table iterations, hashes are calculated in both CP and DP, and DPs send pings more immediately and with the new hash now #7483

Balancer

• All targets are returned by the Admin API now, including targets with a weight=0, or disabled targets. Before disabled targets were not included in the output when users attempted to list all targets. Then when users attempted to add the targets again, they received an error message telling them the targets already existed. #7094
• Upserting existing targets no longer fails. Before, because of updates made to target configurations since Kong v2.2.0, upserting older configurations would fail. This fix allows older configurations to be imported. #7052
• The last balancer attempt is now correctly logged. Before balancer tries were saved when retrying, which meant the last retry state was not saved since there were no more retries. This update saves the failure state so it can be correctly logged. #6972
• Kong now ensures that the correct upstream event is removed from the queue when updating the balancer state. #7103

CLI

• The prefix argument in the kong stop command now takes precedence over environment variables, as it does in the kong start command. #7080

Configuration

• Declarative configurations now correctly parse custom plugin entities schemas with attributes called "plugins". Before when using declarative configurations, users with custom plugins that included a "plugins" field would encounter startup exceptions. With this fix, the declarative configuration can now distinguish between plugins schema and custom plugins fields. #7412
• The stream access log configuration options are now properly separated from the HTTP access log. Before when users used Kong with TCP, they couldn’t use a custom log format. With this fix, proxy_stream_access_log and proxy_stream_error_log have been added to differentiate stream access log from the HTTP subsystem. See proxy_stream_access_log and proxy_stream_error in the Configuration Property Reference for more information. #7046

Migrations

• Kong no longer assumes that /?/init.lua is in the Lua path when doing migrations. Before, when users created a custom plugin in a non-standard location and set lua_package_path = /usr/local/custom/?.lua, migrations failed. Migrations failed because the Kong core file is init.lua and it is required as part of kong.plugins.<name>.migrations. With this fix, migrations no longer expect init.lua to be a part of the path. #6993
• Kong no longer emits errors when doing ALTER COLUMN operations in Apache Cassandra 4.0. #7490

PDK

• With this update, kong.response.get_XXX() functions now work in the log phase on external plugins. Before kong.response.get_XXX() functions required data from the response object, which was not accessible in the post-log timer used to call log handlers in external plugins. Now these functions work by accessing the required data from the set saved at the start of the log phase. See kong.response in the Plugin Development Kit for more information. #7048
• External plugins handle certain error conditions better while the Kong balancer is being refreshed. Before when an instance_id of an external plugin changed, and the plugin instance attempted to reset and retry, it was failing because of a typo in the comparison. #7153. Thanks, ealogar!
• With this release, kong.log's phase checker now accounts for the existence of the new response pseudo-phase. Before users may have erroneously received a safe runtime error for using a function out-of-place in the PDK. #7109
• Kong no longer sandboxes the string.rep function. Before string.rep was sandboxed to disallow a single operation from allocating too much memory. However, a single operation allocating too much memory is no longer an issue because in LuaJIT there are no debug hooks and it is trivial to implement a loop to allocate memory on every single iteration. Additionally, since the string table is global and obtainable by any sandboxed string, its sandboxing provoked issues on global state. #7167
• The kong.pdk.node function can now correctly iterates over all the shared dict metrics. Before this fix, users using the kong.pdk.node function could not see all shared dict metrics under the Stream subsystem. #7078

Plugins

• All custom plugins that are using the deprecated BasePlugin class have to remove this inheritance.
• LDAP-auth: The LDAP Authentication schema now includes a default value for the config.ldap_port parameter that matches the documentation. Before the plugin documentation Parameters section included a reference to a default value for the LDAP port; however, the default value was not included in the plugin schema. #7438
• Prometheus: The Prometheus plugin exporter now attaches subsystem labels to memory stats. Before, the HTTP and Stream subsystems were not distinguished, so their metrics were interpreted as duplicate entries by Prometheus. https://github.com/Kong/kong-plugin-prometheus/pull/118
• External Plugins: the return code 127 (command not found) is detected and appropriate error is returned #7523

2.4.1

Released 2021/05/11

This is a patch release in the 2.4 series. Being a patch release, it strictly contains bugfixes. There are no new features or breaking changes.

Distribution

• ⚠️ Starting with this release, Kong packages are no longer distributed through Bintray. Please download from download.konghq.com.

Dependencies

• Bump luasec from 1.0.0 to 1.0.1 #7126
• Bump prometheus plugin from 1.2.0 to 1.2.1 #7061

Fixes

Core

• Ensure healthchecks and balancers are not created on control plane nodes. #7085
• Optimize URL normalization code. #7100
• Fix issue where control plane nodes would needlessly invalidate and send new configuration to data plane nodes. #7112
• Ensure HTTP code 405 is handled by Kong's error page. #6933
• Ensure errors in plugins init_worker do not break Kong's worker initialization. #7099
• Fix issue where two subsequent TLS keepalive requests would lead to incorrect plugin execution. #7102
• Ensure Targets upsert operation behaves similarly to other entities' upsert method. #7052
• Ensure failed balancer retry is saved and accounted for in log data. #6972

CLI

• Ensure kong start and kong stop prioritize CLI flag --prefix over environment variable KONG_PREFIX. #7080

Configuration

• Ensure Stream subsystem allows for configuration of access logs format. #7046

Admin API

• Ensure targets with weight 0 are displayed in the Admin API. #7094

PDK

• Ensure new response phase is accounted for in phase checkers. #7109

Plugins

• Ensure plugins written in languages other than Lua can use kong.response.get_* methods - e.g., kong.response.get_status. #7048
• hmac-auth: enable JIT compilation of authorization header regex. #7037

Back to TOC

2.4.0

Released 2021/04/06

This is the final release of Kong 2.4.0, with no breaking changes with respect to the 2.x series. This release includes JavaScript PDK, improved CP/DP updates and UTF-8 Tags, amongst other improvements and fixes.

Dependencies

• ⚠️ For Kong 2.4, the required OpenResty version has been bumped to 1.19.3.1, and the set of patches included has changed, including the latest release of lua-kong-nginx-module. If you are installing Kong from one of our distribution packages, you are not affected by this change.

Note: if you are not using one of our distribution packages and compiling OpenResty from source, you must still apply Kong's OpenResty patches (and, as highlighted above, compile OpenResty with the new lua-kong-nginx-module). Our kong-build-tools repository will allow you to do both easily.

• Bump luarocks from 3.4.0 to 3.5.0. #6699
• Bump luasec from 0.9 to 1.0. #6814
• Bump lua-resty-dns-client from 5.2.1 to 6.0.0. #6999
• Bump kong-lapis from 1.8.1.2 to 1.8.3.1. #6925
• Bump pgmoon from 1.11.0 to 1.12.0. #6741
• Bump lua-resty-openssl from 0.6.9 to 0.7.2. #6967
• Bump kong-plugin-zipkin from 1.2 to 1.3. #6936
• Bump kong-prometheus-plugin from 1.0 to 1.2. #6958
• Bump lua-cassandra from 1.5.0 to 1.5.1 #6857
• Bump luasyslog from 1.0.0 to 2.0.1 #6957

Additions

Core

• Relaxed version check between Control Planes and Data Planes, allowing Data Planes that are missing minor updates to still connect to the Control Plane. Also, now Data Plane is allowed to have a superset of Control Plane plugins. 6932
• Allowed UTF-8 in Tags 6784
• Added support for Online Certificate Status Protocol responder found in cluster. 6887

PDK

• JavaScript Plugin Development Kit (PDK) is released alongside with Kong 2.4. It allows users to write Kong plugins in JavaScript and TypeScript.
• Beta release of Protobuf plugin communication protocol, which can be used in place of MessagePack to communicate with non-Lua plugins. 6941
• Enabled ssl_certificate phase on plugins with stream module. 6873

Plugins

• Zipkin: support for Jaeger style uber-trace-id headers. 101 Thanks nvx for the patch!
• Zipkin: support for OT headers. 103 Thanks ishg for the patch!
• Zipkin: allow insertion of custom tags on the Zipkin request trace. 102
• Zipkin: creation of baggage items on child spans is now possible. 98 Thanks Asafb26 for the patch!
• JWT: Add ES384 support 6854 Thanks pariviere for the patch!
• Several plugins: capability to set new log fields, or unset existing fields, by executing custom Lua code in the Log phase. 6944

Fixes

Core

• Changed default values and validation rules for plugins that were not well-adjusted for dbless or hybrid modes. 6885
• Kong 2.4 ensures that all the Core entities are loaded before loading any plugins. This fixes an error in which Plugins to could not link to or modify Core entities because they would not be loaded yet 6880
• If needed, Host header is now updated between balancer retries, using the value configured in the correct upstream entity. 6796
• Schema validations now log more descriptive error messages when types are invalid. 6593 Thanks WALL-E for the patch!
• Kong now ignores tags in Cassandra when filtering by multiple entities, which is the expected behavior and the one already existent when using Postgres databases. 6931
• Upgrade header is not cleared anymore when response Connection header contains Upgrade. 6929
• Accept fully-qualified domain names ending in dots. 6864
• Kong does not try to warmup upstream names when warming up DNS entries. 6891
• Migrations order is now guaranteed to be always the same. 6901
• Buffered responses are disabled on connection upgrades. 6902
• Make entity relationship traverse-order-independent. 6743
• The host header is updated between balancer retries. 6796
• The router prioritizes the route with most matching headers when matching headers. 6638
• Fixed an edge case on multipart/form-data boundary check. 6638
• Paths are now properly normalized inside Route objects. 6976
• Do not cache empty upstream name dictionary. 7002
• Do not assume upstreams do not exist after init phase. 7010
• Do not overwrite configuration files when running migrations. 7017

PDK

• Now Kong does not leave plugin servers alive after exiting and does not try to start them in the unsupported stream subsystem. 6849
• Go does not cache kong.log methods 6701
• The response phase is included on the list of public phases 6638
• Config file style and options case are now consistent all around. 6981
• Added right protobuf MacOS path to enable external plugins in Homebrew installations. 6980
• Auto-escape upstream path to avoid proxying errors. 6978
• Ports are now declared as Int. 6994

Plugins

• oauth2: better handling more cases of client invalid token generation. 6594 Thanks jeremyjpj0916 for the patch!
• Zipkin: the w3c parsing function was returning a non-used extra value, and it now early-exits. 100 Thanks nvx for the patch!
• Zipkin: fixed a bug in which span timestamping could sometimes raise an error. 105 Thanks Asafb26 for the patch!

Back to TOC

2.3.3

Released 2021/03/05

This is a patch release in the 2.3 series. Being a patch release, it strictly contains bugfixes. The are no new features or breaking changes.

Dependencies

• Bump OpenSSL from 1.1.1i to 1.1.1j. 6859

Fixes

Core

• Ensure control plane nodes do not execute healthchecks. 6805
• Ensure only one worker executes active healthchecks. 6844
• Declarative config can be now loaded as an inline yaml file by kong config (previously it was possible only as a yaml string inside json). JSON declarative config is now parsed with the cjson library, instead of with libyaml. 6852
• When using eventual worker consistency now every Nginx worker deals with its upstreams changes, avoiding unnecessary synchronization among workers. 6833

Admin API

• Remove prng_seed from the Admin API and add PIDs instead. 6842

PDK

• Ensure kong.log.serialize properly calculates reported latencies. 6869

Plugins

• HMAC-Auth: fix issue where the plugin would check if both a username and signature were specified, rather than either. 6826

Back to TOC

2.3.2

Released 2021/02/09

This is a patch release in the 2.3 series. Being a patch release, it strictly contains bugfixes. The are no new features or breaking changes.

Fixes

Core

• Fix an issue where certain incoming URI may make it possible to bypass security rules applied on Route objects. This fix make such attacks more difficult by always normalizing the incoming request's URI before matching against the Router. #6821
• Properly validate Lua input in sandbox module. #6765
• Mark boolean fields with default values as required. #6785

CLI

• kong migrations now accepts a -p/--prefix flag. #6819

Plugins

• JWT: disallow plugin on consumers. #6777
• rate-limiting: improve counters accuracy. #6802

Back to TOC

2.3.1

Released 2021/01/26

This is a patch release in the 2.3 series. Being a patch release, it strictly contains bugfixes. The are no new features or breaking changes.

Fixes

Core

• lua-resty-dns-client was bumped to 5.2.1, which fixes an issue that could lead to a busy loop when renewing addresses. #6760
• Fixed an issue that made Kong return HTTP 500 Internal Server Error instead of HTTP 502 Bad Gateway on upstream connection errors when using buffered proxying. #6735

Back to TOC

2.3.0

Released 2021/01/08

This is a new release of Kong, with no breaking changes with respect to the 2.x series, with Control Plane/Data Plane version checks, UTF-8 names for Routes and Services, and a Plugin Servers.

Distributions

• ⚠️ Support for Centos 6 has been removed, as said distro entered EOL on Nov 30. #6641

Dependencies

• Bump kong-plugin-serverless-functions from 1.0 to 2.1. #6715
• Bump lua-resty-dns-client from 5.1.0 to 5.2.0. #6711
• Bump lua-resty-healthcheck from 1.3.0 to 1.4.0. #6711
• Bump OpenSSL from 1.1.1h to 1.1.1i. #6639
• Bump kong-plugin-zipkin from 1.1 to 1.2. #6576
• Bump kong-plugin-request-transformer from 1.2 to 1.3. #6542

Additions

Core

• Introduce version checks between Control Plane and Data Plane nodes in Hybrid Mode. Sync will be stopped if the major/minor version differ or if installed plugin versions differ between Control Plane and Data Plane nodes. #6612
• Kong entities with a name field now support utf-8 characters. #6557
• The certificates entity now has cert_alt and key_alt fields, used to specify an alternative certificate and key pair. #6536
• The go-pluginserver stderr and stdout are now written into Kong's logs. #6503
• Introduce support for multiple pluginservers. This feature is backwards-compatible with the existing single Go pluginserver. #6600

PDK

• Introduce a kong.node.get_hostname method that returns current's node host name. #6613
• Introduce a kong.cluster.get_id method that returns a unique ID for the current Kong cluster. If Kong is running in DB-less mode without a cluster ID explicitly defined, then this method returns nil. For Hybrid mode, all Control Planes and Data Planes belonging to the same cluster returns the same cluster ID. For traditional database based deployments, all Kong nodes pointing to the same database will also return the same cluster ID. #6576
• Introduce a kong.log.set_serialize_value, which allows for customizing the output of kong.log.serialize. #6646

Plugins

• http-log: the plugin now has a headers configuration, so that custom headers can be specified for the log request. #6449
• key-auth: the plugin now has two additional boolean configurations:
  • key_in_header: if false, the plugin will ignore keys passed as headers.
  • key_in_query: if false, the plugin will ignore keys passed as query arguments. Both default to true. #6590
• request-size-limiting: add new configuration require_content_length, which causes the plugin to ensure a valid Content-Length header exists before reading the request body. #6660
• serverless-functions: introduce a sandboxing capability, and it has been enabled by default, where only Kong PDK, OpenResty ngx APIs, and Lua standard libraries are allowed. #32

Configuration

• client_max_body_size and client_body_buffer_size, that previously hardcoded to 10m, are now configurable through nginx_admin_client_max_body_size and nginx_admin_client_body_buffer_size. #6597
• Kong-generated SSL privates keys now have 600 file system permission. #6509
• Properties ssl_cert, ssl_cert_key, admin_ssl_cert, admin_ssl_cert_key, status_ssl_cert, and status_ssl_cert_key is now an array: previously, only an RSA certificate was generated by default; with this change, an ECDSA is also generated. On intermediate and modern cipher suites, the ECDSA certificate is set as the default fallback certificate; on old cipher suite, the RSA certificate remains as the default. On custom certificates, the first certificate specified in the array is used. #6509
• Kong now runs as a kong user if it exists; it said user does not exist in the system, the nobody user is used, as before. #6421

Fixes

Core

• Fix issue where a Go plugin would fail to read kong.ctx.shared values set by Lua plugins. #6490
• Properly trigger dao:delete_by:post hook. #6567
• Fix issue where a route that supports both http and https (and has a hosts and snis match criteria) would fail to proxy http requests, as it does not contain an SNI. #6517
• Fix issue where a nil request context would lead to errors attempt to index local 'ctx' being shown in the logs
• Reduced the number of needed timers to active health check upstreams and to resolve hosts.
• Schemas for full-schema validations are correctly cached now, avoiding memory leaks when reloading declarative configurations. #6713
• The schema for the upstream entities now limits the highest configurable number of successes and failures to 255, respecting the limits imposed by lua-resty-healthcheck. #6705
• Certificates for database connections now are loaded in the right order avoiding failures to connect to Postgres databases. #6650

CLI

• Fix issue where kong reload -c <config> would fail. #6664
• Fix issue where the Kong configuration cache would get corrupted. #6664

PDK

• Ensure the log serializer encodes the tries field as an array when empty, rather than an object. #6632

Plugins

• request-transformer plugin does not allow null in config anymore as they can lead to runtime errors. #6710

Back to TOC

2.2.2

Released 2021/03/01

This is a patch release in the 2.2 series. Being a patch release, it strictly contains bugfixes. The are no new features or breaking changes.

Fixes

Plugins

• serverless-functions: introduce a sandboxing capability, enabled by default, where only Kong PDK, OpenResty ngx APIs, and some Lua standard libraries are allowed. Read the documentation here. #32

Back to TOC

2.2.1

Released 2020/12/01

This is a patch release in the 2.2 series. Being a patch release, it strictly contains bugfixes. The are no new features or breaking changes.

Fixes

Distribution

Core

• Fix issue where Kong would fail to start a Go plugin instance with a starting instance: nil error. #6507
• Fix issue where a route that supports both http and https (and has a hosts and snis match criteria) would fail to proxy http requests, as it does not contain an SNI. #6517
• Fix issue where a Go plugin would fail to read kong.ctx.shared values set by Lua plugins. #6426
• Fix issue where gRPC requests would fail to set the :authority pseudo-header in upstream requests. #6603

CLI

• Fix issue where kong config db_import and kong config db_export commands would fail if Go plugins were enabled. #6596 Thanks daniel-shuy for the patch!

Back to TOC

2.2.0

Released 2020/10/23

This is a new major release of Kong, including new features such as UDP support, Configurable Request and Response Buffering, Dynamically Loading of OS Certificates, and much more.

Distributions

• Added support for running Kong as the non-root user kong on distributed systems.

Dependencies

• ⚠️ For Kong 2.2, the required OpenResty version has been bumped to 1.17.8.2, and the the set of patches included has changed, including the latest release of lua-kong-nginx-module. If you are installing Kong from one of our distribution packages, you are not affected by this change.
• Bump OpenSSL version from 1.1.1g to 1.1.1h. #6382

Note: if you are not using one of our distribution packages and compiling OpenResty from source, you must still apply Kong's OpenResty patches (and, as highlighted above, compile OpenResty with the new lua-kong-nginx-module). Our kong-build-tools repository will allow you to do both easily.

• ⚠️ Cassandra 2.x support is now deprecated. If you are still using Cassandra 2.x with Kong, we recommend you to upgrade, since this series of Cassandra is about to be EOL with the upcoming release of Cassandra 4.0.

Additions

Core

• 🎆 UDP support: Kong now features support for UDP proxying in its stream subsystem. The "udp" protocol is now accepted in the protocols attribute of Routes and the protocol attribute of Services. Load balancing and logging plugins support UDP as well. #6215
• Configurable Request and Response Buffering: The buffering of requests or responses can now be enabled or disabled on a per-route basis, through setting attributes Route.request_buffering or Route.response_buffering to true or false. Default behavior remains the same: buffering is enabled by default for requests and responses. #6057
• Option to Automatically Load OS Certificates: The configuration attribute lua_ssl_trusted_certificate was extended to accept a comma-separated list of certificate paths, as well as a special system value, which expands to the "system default" certificates file installed by the operating system. This follows a very simple heuristic to try to use the most common certificate file in most popular distros. #6342
• Consistent-Hashing load balancing algorithm does not require to use the entire target history to build the same proxying destinations table on all Kong nodes anymore. Now deleted targets are actually removed from the database and the targets entities can be manipulated by the Admin API as any other entity. #6336
• Add X-Forwarded-Path header: if a trusted source provides a X-Forwarded-Path header, it is proxied as-is. Otherwise, Kong will set the content of said header to the request's path. #6251
• Hybrid mode synchronization performance improvements: Kong now uses a new internal synchronization method to push changes from the Control Plane to the Data Plane, drastically reducing the amount of communication between nodes during bulk updates. #6293
• The Upstream.client_certificate attribute can now be used from proxying: This allows client_certificate setting used for mTLS handshaking with the Upstream server to be shared easily among different Services. However, Service.client_certificate will take precedence over Upstream.client_certificate if both are set simultaneously. In previous releases, Upstream.client_certificate was only used for mTLS in active health checks. #6348
• New shorthand_fields top-level attribute in schema definitions, which deprecates shorthands and includes type definitions in addition to the shorthand callback. #6364
• Hybrid Mode: the table of Data Plane nodes at the Control Plane is now cleaned up automatically, according to a delay value configurable via the cluster_data_plane_purge_delay attribute, set to 14 days by default. #6376
• Hybrid Mode: Data Plane nodes now apply only the last config when receiving several updates in sequence, improving the performance when large configs are in use. #6299

Admin API

• Hybrid Mode: new endpoint /clustering/data-planes which returns complete information about all Data Plane nodes that are connected to the Control Plane cluster, regardless of the Control Plane node to which they connected. #6308
  • ⚠️ The /clustering/status endpoint is now deprecated, since it returns only information about Data Plane nodes directly connected to the Control Plane node to which the Admin API request was made, and is superseded by /clustering/data-planes.
• Admin API responses now honor the headers configuration setting for including or removing the Server header. #6371

PDK

• New function kong.request.get_forwarded_prefix: returns the prefix path component of the request's URL that Kong stripped before proxying to upstream, respecting the value of X-Forwarded-Prefix when it comes from a trusted source. #6251
• kong.response.exit now honors the headers configuration setting for including or removing the Server header. #6371
• kong.log.serialize function now can be called using the stream subsystem, allowing various logging plugins to work under TCP and TLS proxy modes. #6036
• Requests with multipart/form-data MIME type now can use the same part name multiple times. #6054

Plugins

• New Response Phase: both Go and Lua pluggins now support a new plugin phase called response in Lua plugins and Response in Go. Using it automatically enables response buffering, which allows you to manipulate both the response headers and the response body in the same phase. This enables support for response handling in Go, where header and body filter phases are not available, allowing you to use PDK functions such as kong.Response.GetBody(), and provides an equivalent simplified feature for handling buffered responses from Lua plugins as well. #5991
• aws-lambda: bump to version 3.5.0: #6379
  • support for 'isBase64Encoded' flag in Lambda function responses
• grpc-web: introduce configuration pass_stripped_path, which, if set to true, causes the plugin to pass the stripped request path (see the strip_path Route attribute) to the upstream gRPC service.
• rate-limiting: Support for rate limiting by path, by setting the limit_by = "path" configuration attribute. Thanks KongGuide for the patch! #6286
• correlation-id: the plugin now generates a correlation-id value by default if the correlation id header arrives but is empty. #6358

2.1.4

Released 2020/09/18

This is a patch release in the 2.0 series. Being a patch release, it strictly contains bugfixes. The are no new features or breaking changes.

Fixes

Core

• Improve graceful exit of Control Plane and Data Plane nodes in Hybrid Mode. #6306

Plugins

• datadog, loggly, statsd: fixes for supporting logging TCP/UDP services. #6344
• Logging plugins: request and response sizes are now reported by the log serializer as number attributes instead of string. #6356
• prometheus: Remove unnecessary WARN log that was seen in the Kong 2.1 series. #6258
• key-auth: no longer trigger HTTP 400 error when the body cannot be decoded. #6357
• aws-lambda: respect skip_large_bodies config setting even when not using AWS API Gateway compatibility. #6379

Back to TOC

• Fix issue where kong reload would occasionally leave stale workers locked at 100% CPU. #6300
• Hybrid Mode: more informative error message when the Control Plane cannot be reached. #6267

CLI

• kong hybrid gen_cert now reports "permission denied" errors correctly when it fails to write the certificate files. #6368

Plugins

• acl: bumped to 3.0.1
  • Fix regression in a scenario where an ACL plugin with a deny clause was configured for a group that does not exist would cause a HTTP 401 when an authenticated plugin would match the anonymous consumer. The behavior is now restored to that seen in Kong 1.x and 2.0. #6354
• request-transformer: bumped to 1.2.7
  • Fix the construction of the error message when a template throws a Lua error. #26

2.1.3

Released 2020/08/19

This is a patch release in the 2.0 series. Being a patch release, it strictly contains bugfixes. The are no new features or breaking changes.

Fixes

Core

• Fix behavior of X-Forwarded-Prefix header with stripped path prefixes: the stripped portion of path is now added in X-Forwarded-Prefix, except if it is / or if it is received from a trusted client. #6222

Migrations

• Avoid creating unnecessary an index for Postgres. #6250

Admin API

• DB-less: fix concurrency issues with /config endpoint. It now waits for the configuration to update across workers before returning, and returns HTTP 429 on attempts to perform concurrent updates and HTTP 504 in case of update timeouts. #6121

Plugins

• request-transformer: bump from v1.2.5 to v1.2.6
  • Fix an issue where query parameters would get incorrectly URL-encoded. #24
• acl: Fix migration of ACLs table for the Kong 2.1 series. #6250

2.1.2

Released 2020/08/13

✅ Update (2020/08/13): This release fixed a balancer bug that may cause incorrect request payloads to be sent to unrelated upstreams during balancer retries, potentially causing responses for other requests to be returned. Therefore it is highly recommended that Kong users running versions 2.1.0 and 2.1.1 to upgrade to this version as soon as possible, or apply mitigation from the 2.1.0 section below.

Fixes

Core

• Fix a bug that balancer retries causes incorrect requests to be sent to subsequent upstream connections of unrelated requests. #6224
• Fix an issue where plugins iterator was being built before setting the default workspace id, therefore indexing the plugins under the wrong workspace. #6206

Migrations

• Improve reentrancy of Cassandra migrations. #6206

PDK

• Make sure the kong.response.error PDK function respects gRPC related content types. #6214

2.1.1

Released 2020/08/05

🔴 Post-release note (as of 2020/08/13): A faulty behavior has been observed with this change. When Kong proxies using the balancer and a request to one of the upstream Target fails, Kong might send the same request to another healthy Target in a different request later, causing response for the failed request to be returned.

This bug could be mitigated temporarily by disabling upstream keepalive pools. It can be achieved by either:

1. In kong.conf, set upstream_keepalive_pool_size=0, or
2. Setting the environment KONG_UPSTREAM_KEEPALIVE_POOL_SIZE=0 when starting Kong with the CLI.

Then restart/reload the Kong instance.

Thanks Nham Le (@nhamlh) for reporting it in #6212.

✅ Update (2020/08/13): A fix to this regression has been released as part of 2.1.2. See the section of the Changelog related to this release for more details.

Dependencies

• Bump lua-multipart to 0.5.9. #6148

Fixes

Core

• No longer reject valid characters (as specified in the RFC 3986) in the path attribute of the Service entity. #6183

Migrations

• Fix issue in Cassandra migrations where empty values in some entities would be incorrectly migrated. #6171

Admin API

• Fix issue where consumed worker memory as reported by the kong.node.get_memory_stats() PDK method would be incorrectly reported in kilobytes, rather than bytes, leading to inaccurate values in the /status Admin API endpoint (and other users of said PDK method). #6170

Plugins

• rate-limiting: fix issue where rate-limiting by Service would result in a global limit, rather than per Service. #6157
• rate-limiting: fix issue where a TTL would not be set to some Redis keys. #6150

Back to TOC

2.1.0

Released 2020/07/16

🔴 Post-release note (as of 2020/08/13): A faulty behavior has been observed with this change. When Kong proxies using the balancer and a request to one of the upstream Target fails, Kong might send the same request to another healthy Target in a different request later, causing response for the failed request to be returned.

This bug could be mitigated temporarily by disabling upstream keepalive pools. It can be achieved by either:

1. In kong.conf, set upstream_keepalive_pool_size=0, or
2. Setting the environment KONG_UPSTREAM_KEEPALIVE_POOL_SIZE=0 when starting Kong with the CLI.

Then restart/reload the Kong instance.

Thanks Nham Le (@nhamlh) for reporting it in #6212.

✅ Update (2020/08/13): A fix to this regression has been released as part of 2.1.2. See the section of the Changelog related to this release for more details.

Distributions

• 🎁 Introduce package for Ubuntu 20.04. #6006
• Add ca-certificates to the Alpine Docker image. #373
• ⚠️ The go-pluginserver no longer ships with Kong packages; users are encouraged to build it along with their Go plugins. For more info, check out the Go Guide.

Dependencies

• ⚠️ In order to use all Kong features, including the new dynamic upstream keepalive behavior, the required OpenResty version is 1.15.8.3. If you are installing Kong from one of our distribution packages, this version and all required patches and modules are included. If you are building from source, you must apply Kong's OpenResty patches as well as include lua-kong-nginx-module. Our kong-build-tools repository allows you to do both easily.
• Bump OpenSSL version from 1.1.1f to 1.1.1g. #5820
• Bump lua-resty-dns-client from 4.1.3 to 5.0.1. #5499
• Bump lyaml from 0.2.4 to 0.2.5. #5984
• Bump lua-resty-openssl from 0.6.0 to 0.6.2. #5941

Changes

Core

• Increase maximum allowed payload size in hybrid mode. #5654
• Targets now support a weight range of 0-65535. #5871

Configuration

• ⚠️ The configuration properties router_consistency and router_update_frequency have been renamed to worker_consistency and worker_state_update_frequency, respectively. The new properties allow for configuring the consistency settings of additional internal structures, see below for details. #5325
• ⚠️ The nginx_upstream_keepalive_* configuration properties have been renamed to upstream_keepalive_*. This is due to the introduction of dynamic upstream keepalive pools, see below for details. #5771
• ⚠️ The default value of worker_state_update_frequency (previously router_update_frequency) was changed from 1 to 5. #5325

Plugins

• ⚠️ Change authentication plugins to standardize on allow and deny as terms for access control. Previous nomenclature is deprecated and support will be removed in Kong 3.0.
  • ACL: use allow and deny instead of whitelist and blacklist
  • bot-detection: use allow and deny instead of whitelist and blacklist
  • ip-restriction: use allow and deny instead of whitelist and blacklist #6014

Additions

Core

• 🎆 Asynchronous upstream updates: Kong's load balancer is now able to update its internal structures asynchronously instead of onto the request/stream path.

  This change required the introduction of new configuration properties and the deprecation of older ones:

  • New properties:
    • worker_consistency
    • worker_state_update_frequency
  • Deprecated properties:
    • router_consistency
    • router_update_frequency

  The new worker_consistency property is similar to router_consistency and accepts either of strict (default, synchronous) or eventual (asynchronous). Unlike its deprecated counterpart, this new property aims at configuring the consistency of all internal structures of Kong, and not only the router. #5325

• 🎆 Read-Only Postgres: Kong users are now able to configure a read-only Postgres replica. When configured, Kong will attempt to fulfill read operations through the read-only replica instead of the main Postgres connection. #5584

• Introducing dynamic upstream keepalive pools. This change prevents virtual host confusion when Kong proxies traffic to virtual services (hosted on the same IP/port) over TLS. Keepalive pools are now created by the upstream IP/upstream port/SNI/client certificate tuple instead of IP/port only. Users running Kong in front of virtual services should consider adjusting their keepalive settings appropriately.

  This change required the introduction of new configuration properties and the deprecation of older ones:

  • New properties:
    • upstream_keepalive_pool_size
    • upstream_keepalive_max_requests
    • upstream_keepalive_idle_timeout
  • Deprecated properties:
    • nginx_upstream_keepalive
    • nginx_upstream_keepalive_requests
    • nginx_upstream_keepalive_timeout

  Additionally, this change allows for specifying an indefinite amount of max requests and idle timeout threshold for upstream keepalive connections, a capability that was previously removed by Nginx 1.15.3. #5771

• The default certificate for the proxy can now be configured via Admin API using the /certificates endpoint. A special * SNI has been introduced which stands for the default certificate. #5404

• Add support for PKI in Hybrid Mode mTLS. #5396

• Add X-Forwarded-Prefix to set of headers forwarded to upstream requests. #5620

• Introduce a _transform option to declarative configuration, which allows importing basicauth credentials with and without hashed passwords. This change is only supported in declarative configuration format version 2.1. #5835

• Add capability to define different consistency levels for read and write operations in Cassandra. New configuration properties cassandra_write_consistency and cassandra_read_consistency were introduced and the existing cassandra_consistency property was deprecated. Thanks Abhishekvrshny for the patch! #5812

• Introduce certificate expiry and CA constraint checks to Hybrid Mode certificates (cluster_cert and cluster_ca_cert). #6000

• Introduce new attributes to the Services entity, allowing for customizations in TLS verification parameters: #5976

  • tls_verify: whether TLS verification is enabled while handshaking with the upstream Service
  • tls_verify_depth: the maximum depth of verification when validating upstream Service's TLS certificate
  • ca_certificates: the CA trust store to use when validating upstream Service's TLS certificate

• Introduce new attribute client_certificate in Upstreams entry, used for supporting mTLS in active health checks. #5838

CLI

• Migrations: add a new --force flag to kong migrations bootstrap. #5635

Configuration

• Introduce configuration property db_cache_neg_ttl, allowing the configuration of negative TTL for DB entities. Thanks ealogar for the patch! #5397

PDK

• Support kong.response.exit in Stream (L4) proxy mode. #5524
• Introduce kong.request.get_forwarded_path method, which returns the path component of the request's URL, but also considers X-Forwarded-Prefix if it comes from a trusted source. #5620
• Introduce kong.response.error method, that allows PDK users to exit with an error while honoring the Accept header or manually forcing a content-type. #5562
• Introduce kong.client.tls module, which provides the following methods for interacting with downstream mTLS:
  • kong.client.tls.request_client_certificate(): request client to present its client-side certificate to initiate mutual TLS authentication between server and client.
  • kong.client.tls.disable_session_reuse(): prevent the TLS session for the current connection from being reused by disabling session ticket and session ID for the current TLS connection.
  • kong.client.tls.get_full_client_certificate_chain(): return the PEM encoded downstream client certificate chain with the client certificate at the top and intermediate certificates (if any) at the bottom. #5890
• Introduce kong.log.serialize method. #5995
• Introduce new methods to the kong.service PDK module:
  • kong.service.set_tls_verify(): set whether TLS verification is enabled while handshaking with the upstream Service
  • kong.service.set_tls_verify_depth(): set the maximum depth of verification when validating upstream Service's TLS certificate
  • kong.service.set_tls_verify_store(): set the CA trust store to use when validating upstream Service's TLS certificate

Plugins

• 🎆 New Plugin: introduce the grpc-web plugin, allowing clients to consume gRPC services via the gRPC-Web protocol. #5607
• 🎆 New Plugin: introduce the grpc-gateway plugin, allowing access to upstream gRPC services through a plain HTTP request. #5939
• Go: add getter and setter methods for kong.ctx.shared. #5496
• Add X-Credential-Identifier header to the following authentication plugins:
  • basic-auth
  • key-auth
  • ldap-auth
  • oauth2 #5516
• Rate-Limiting: auto-cleanup expired rate-limiting metrics in Postgres. #5498
• OAuth2: add ability to persist refresh tokens throughout their life cycle. Thanks amberheilman for the patch! #5264
• IP-Restriction: add support for IPv6. #5640
• OAuth2: add support for PKCE. Thanks amberheilman for the patch! #5268
• OAuth2: allow optional hashing of client secrets. #5610
• aws-lambda: bump from v3.1.0 to v3.4.0
  • Add host configuration to allow for custom Lambda endpoints. #35
• zipkin: bump from 0.2 to 1.1.0
  • Add support for B3 single header #66
  • Add traceid_byte_count config option #74
  • Add support for W3C header #75
  • Add new option header_type #75
• serverless-functions: bump from 0.3.1 to 1.0.0
  • Add ability to run functions in each request processing phase. #21
• prometheus: bump from 0.7.1 to 0.9.0
  • Performance: significant improvements in throughput and CPU usage. #79
  • Expose healthiness of upstreams targets. Thanks carnei-ro for the patch! #88
• rate-limiting: allow rate-limiting by custom header. Thanks carnei-ro for the patch! #5969
• session: bumped from 2.3.0 to 2.4.0. #5868

Fixes

Core

• Fix memory leak when loading a declarative configuration that fails schema validation. #5759
• Fix migration issue where the index for the ca_certificates table would fail to be created. #5764
• Fix issue where DNS resolution would fail in DB-less mode. #5831

Admin API

• Disallow PATCH on /upstreams/:upstreams/targets/:targets

Plugins

• Go: fix issue where instances of the same Go plugin applied to different Routes would get mixed up. #5597
• Strip Authorization value from logged headers. Values are now shown as REDACTED. #5628.
• ACL: respond with HTTP 401 rather than 403 if credentials are not provided. #5452
• ldap-auth: set credential ID upon authentication, allowing subsequent plugins (e.g., rate-limiting) to act on said value. #5497
• ldap-auth: hash the cache key generated by the plugin. #5497
• zipkin: bump from 0.2 to 1.1.0
  • Stopped tagging non-erroneous spans with error=false. #63
  • Changed the structure of localEndpoint and remoteEndpoint. #63
  • Store annotation times in microseconds. #71
  • Prevent an error triggered when timing-related kong variables were not present. #71
• aws-lambda: AWS regions are no longer validated against a hardcoded list; if an invalid region name is provided, a proxy Internal Server Error is raised, and a DNS resolution error message is logged. #33

Back to TOC

2.0.5

Released 2020/06/30

Dependencies

• Bump OpenSSL version from 1.1.1f to 1.1.1g. #5820
• Bump go-pluginserver from version from 0.2.0 to 0.3.2, leveraging go-pdk 0.3.1. See the go-pdk changelog.

Fixes

Core

• Fix a race condition leading to random config fetching failure in DB-less mode. #5833
• Fix issue where a respawned worker would not use the existing configuration in DB-less mode. #5850
• Fix issue where declarative configuration would fail with the error: Cannot serialise table: excessively sparse array. #5768
• Targets now support a weight range of 0-65535. #5871
• Make kong.ctx.plugin light-thread safe Thanks tdelaune for the assistance! #5873
• Go: fix issue with Go plugins where the plugin instance would be intermittently killed. Thanks primableatom for the patch! #5903
• Auto-convert config.anonymous from empty string to the ngx.null value. #5906
• Fix issue where DB-less wouldn't correctly validate input with missing IDs, names, or cache key. #5929
• Fix issue where a request to the upstream health endpoint would fail with HTTP 500 Internal Server Error. #5943
• Fix issue where providing a declarative configuration file containing fields with explicit null values would result in an error. #5999
• Fix issue where the balancer wouldn't be built for all workers. #5931
• Fix issue where a declarative configuration file with primary keys specified as numbers would result in an error. #6005

CLI

Configuration

• Fix issue where the Postgres password from the Kong configuration file would be truncated if it contained a # character. #5822

Admin API

• Fix issue where a PUT request on /upstreams/:upstreams/targets/:targets would result in HTTP 500 Internal Server Error. #6012

PDK

• Stop request processing flow if body encoding fails. #5829
• Ensure kong.service.set_target() includes the port number if a non-default port is used. #5996

Plugins

• Go: fix issue where the go-pluginserver would not reload Go plugins' configurations. Thanks wopol for the patch! #5866
• basic-auth: avoid fetching credentials when password is not given. Thanks Abhishekvrshny for the patch! #5880
• cors: avoid overwriting upstream response Vary header; new values are now added as additional Vary headers. Thanks aldor007 for the patch! #5794

Back to TOC

2.0.4

Released 2020/04/22

Fixes

Core

• Disable JIT mlcache:get_bulk() on ARM64 #5797
• Don't incrementing log counters on unexpected errors #5783
• Invalidate target history at cleanup so balancers stay synced #5775
• Set a log prefix with the upstream name #5773
• Fix memory leaks when loading a declarative config that fails schema validation #5766
• Fix some balancer and cluster_events issues #5804

Configuration

• Send declarative config updates to stream subsystem via Unix domain #5786
• Now when using declarative configurations the cache is purged on reload, cleaning any references to removed entries #5769

Back to TOC

2.0.3

Released 2020/04/06

This is a patch release in the 2.0 series. Being a patch release, it strictly contains performance improvements and bugfixes. The are no new features or breaking changes.

Fixes

Core

• Setting the target weight to 0 does not automatically remove the upstream. #5710.
• The plugins iterator is now always fully built, even if the initialization of any of them fails. #5692.
• Fixed the load of dns_not_found_ttl and dns_error_ttl configuration options. #5684.
• Consumers and tags are properly warmed-up from the plugins' perspective, i.e. they are loaded to the cache space that plugins access. #5669.
• Customized error messages don't affect subsequent default error responses now. #5673.

CLI

• Fixed the lua_package_path option precedence over LUA_PATH environment variable. #5729.
• Support to Nginx binary upgrade by correctly handling the USR2 signal. #5657.

Configuration

• Fixed the logrotate configuration file with the right line terminators. #243. Thanks, WALL-E

Admin API

• Fixed the sni is duplicated error when sending multiple SNIs as body arguments and an SNI on URL that matched one from the body. #5660.

Back to TOC

2.0.2

Released 2020/02/27

This is a patch release in the 2.0 series. Being a patch release, it strictly contains performance improvements and bugfixes. The are no new features or breaking changes.

Fixes

Core

• Fix issue related to race condition in Cassandra select each method #5564. Thanks, vasuharish!
• Fix issue related to running control plane under multiple Nginx workers #5612.
• Don't change route paths when marshaling #5587.
• Fix propagation of posted health across workers #5539.
• Use proper units for timeouts with cassandra #5571.
• Fix broken SNI based routing in L4 proxy mode #5533.

Plugins

• Enable the ACME plugin by default #5555.
• Accept consumer username in anonymous field #5552.

Back to TOC

2.0.1

Released 2020/02/04

This is a patch release in the 2.0 series. Being a patch release, it strictly contains performance improvements and bugfixes. The are no new features or breaking changes.

Fixes

Core

• Migrations include the configured Lua path now #5509.
• Hop-by-hop headers to not clear upgrade header on upgrade #5495.
• Balancers now properly check if a response is produced by an upstream #5493. Thanks, onematchfox!
• Kong correctly logs an error message when the Lua VM cannot allocate memory #5479 Thanks, pamiel!
• Schema validations work again in DB-less mode #5464.

Plugins

• oauth2: handle Authorization headers with missing access_token correctly. #5514. Thanks, jeremyjpj0916!
• oauth2: hash oauth2_tokens cache key via the DAO #5507

Back to TOC

2.0.0

Released 2020/01/20

This is a new major release of Kong, including new features such as Hybrid mode, Go language support for plugins and buffered proxying, and much more.

Kong 2.0.0 removes the deprecated service mesh functionality, which was been retired in favor of Kuma, as Kong continues to focus on its core gateway capabilities.

Please note that Kong 2.0.0 also removes support for migrating from versions below 1.0.0. If you are running Kong 0.x versions below 0.14.1, you need to migrate to 0.14.1 first, and once you are running 0.14.1, you can migrate to Kong 1.5.0, which includes special provisions for migrating from Kong 0.x, such as the kong migrations migrate-apis command, and then finally to Kong 2.0.0.

Dependencies

• ⚠️ The required OpenResty version is 1.15.8.2, and the the set of patches included has changed, including the latest release of lua-kong-nginx-module. If you are installing Kong from one of our distribution packages, you are not affected by this change.

Note: if you are not using one of our distribution packages and compiling OpenResty from source, you must still apply Kong's OpenResty patches (and, as highlighted above, compile OpenResty with the new lua-kong-nginx-module). Our kong-build-tools repository will allow you to do both easily.

Packaging

• RPM packages are now signed with our own GPG keys. You can download our public key at https://bintray.com/user/downloadSubjectPublicKey?username=kong
• Kong now ships with a systemd unit file

Additions

Core

• 🎆 Hybrid mode for management of control-plane and data-plane nodes. This allows running control-plane nodes using a database and have them deliver configuration updates to DB-less data-plane nodes. #5294
• 🎆 Buffered proxying - plugins can now request buffered reading of the service response (as opposed to the streaming default), allowing them to modify headers based on the contents of the body #5234
• The transformations in DAO schemas now also support on_read, allowing for two-way (read/write) data transformations between Admin API input/output and database storage. #5100
• Added threshold attribute for health checks #5206
• Caches for core entities and plugin-controlled entities (such as credentials, etc.) are now separated, protecting the core entities from cache eviction caused by plugin behavior. #5114
• Cipher suite was updated to the Mozilla v5 release. #5342
• Better support for using already existing Cassandra keyspaces when migrating #5361
• Better log messages when plugin modules fail to load #5357
• stream_listen now supports the backlog option. #5346
• The internal cache was split into two independent segments, kong.core_cache and kong.cache. The core_cache region is used by the Kong core to store configuration data that doesn't change often. The other region is used to store plugin runtime data that is dependent on traffic pattern and user behavior. This change should decrease the cache contention between Kong core and plugins and result in better performance overall.
  • ⚠️ Note that both structures rely on the already existent mem_cache_size configuration option to set their size, so when upgrading from a previous Kong version, the cache memory consumption might double if this value is not adjusted #5114

CLI

• kong config init now accepts a filename argument #4451

Configuration

• 🎆 Extended support for Nginx directive injections via Kong configurations, reducing the needs for custom Nginx templates. New injection contexts were added: nginx_main_, nginx_events and nginx_supstream_ (upstream in stream mode). #5390
• Enable reuseport option in the listen directive by default and allow specifying both reuseport and backlog=N in the listener flags. #5332
• Check existence of lua_ssl_trusted_certificate at startup #5345

Admin API

• Added /upstreams/<id>/health?balancer_health=1 attribute for detailed information about balancer health based on health threshold configuration #5206

PDK

• New functions kong.service.request.enable_buffering, kong.service.response.get_raw_body and kong.service.response.get_body for use with buffered proxying #5315

Plugins

• 🎆 Go plugin support - plugins can now be written in Go as well as Lua, through the use of an out-of-process Go plugin server. #5326
• The lifecycle of the Plugin Server daemon for Go language support is managed by Kong itself. #5366
• 🎆 New plugin: ACME - Let's Encrypt and ACMEv2 integration with Kong #5333
• 🎆 aws-lambda: bumped version to 3.0.1, with a number of new features! #5083
• 🎆 prometheus: bumped to version 0.7.0 including major performance improvements #5295
• zipkin: bumped to version 0.2.1 #5239
• session: bumped to version 2.2.0, adding authenticated_groups support #5108
• rate-limiting: added experimental support for standardized headers based on the ongoing RFC draft #5335
• rate-limiting: added Retry-After header on HTTP 429 responses #5329
• datadog: report metrics with tags -- Thanks mvanholsteijn for the patch! #5154
• request-size-limiting: added size_unit configuration option. #5214
• request-termination: add extra check for conf.message before sending response back with body object included. #5202
• jwt: add X-Credential-Identifier header in response -- Thanks davinwang for the patch! #4993

Fixes

Core

• Correct detection of update upon deleting Targets -- Thanks pyrl247 for the patch!
• Fix declarative config loading of entities with abstract records #5343
• Fix sort priority when matching routes by longest prefix #5430
• Detect changes in Routes that happen halfway through a router update #5431

Admin API

• Corrected the behavior when overwriting a Service configuration using the url shorthand #5315

Core

• ⚠️ Removed Service Mesh support - That has been deprecated in Kong 1.4 and made off-by-default already, and the code is now gone in 2.0. For Service Mesh, we now have Kuma, which is something designed for Mesh patterns from day one, so we feel at peace with removing Kong's native Service Mesh functionality and focus on its core capabilities as a gateway.

Configuration

• Routes using tls are now supported in stream mode by adding an entry in stream_listen with the ssl keyword enabled. #5346
• As part of service mesh removal, serviceless proxying was removed. You can still set service = null when creating a route for use with serverless plugins such as aws-lambda, or request-termination. #5353
• Removed the origins property which was used for service mesh. #5351
• Removed the transparent property which was used for service mesh. #5350
• Removed the nginx_optimizations property; the equivalent settings can be performed via Nginx directive injections. #5390
• The Nginx directive injection prefixes nginx_http_upstream_ and nginx_http_status_ were renamed to nginx_upstream_ and nginx_status_ respectively. #5390

Plugins

• Removed the Sidecar Injector plugin which was used for service mesh. #5199

Back to TOC

1.5.1

Released 2020/02/19

This is a patch release over 1.5.0, fixing a minor issue in the kong migrations migrate-apis command, which assumed execution in a certain order in the migration process. This now allows the command to be executed prior to running the migrations from 0.x to 1.5.1.

Fixes

CLI

• Do not assume new fields are already available when running kong migrations migrate-apis #5572

Back to TOC

1.5.0

Released 2020/01/20

Kong 1.5.0 is the last release in the Kong 1.x series, and it was designed to help Kong 0.x users upgrade out of that series and into more current releases. Kong 1.5.0 includes two features designed to ease the transition process: the new kong migrations migrate-apis commands, to help users migrate away from old apis entities which were deprecated in Kong 0.13.0 and removed in Kong 1.0.0, and a compatibility flag to provide better router compatibility across Kong versions.

Additions

Core

• New path_handling attribute in Routes entities, which selects the behavior the router will have when combining the Service Path, the Route Path, and the Request path into a single path sent to the upstream. This attribute accepts two values, v0 or v1, making the router behave as in Kong 0.x or Kong 1.x, respectively. #5360

CLI

• New command kong migrations migrate-apis, which converts any existing apis from an old Kong 0.x installation and generates Route, Service and Plugin entities with equivalent configurations. The converted routes are set to use path_handling = v0, to ensure compatibility. #5176

Fixes

Core

• Fixed the routing prioritization that could lead to a match in a lower priority path. #5443
• Changes in router or plugins entities while the rebuild is in progress now are treated in the next rebuild, avoiding to build invalid iterators. #5431
• Fixed invalid incorrect calculation of certificate validity period. #5449 -- Thanks Bevisy for the patch!

Back to TOC

1.4.3

Released 2020/01/09

⚠️ This release includes a security fix to address potentially sensitive information being written to the error log file. This affects certain uses of the Admin API for DB-less mode, described below.

This is a patch release in the 1.4 series, and as such, strictly contains bugfixes. There are no new features nor breaking changes.

Fixes

Core

• Fix the detection of the need for balancer updates when deleting targets #5352 -- Thanks zeeshen for the patch!
• Fix behavior of longest-path criteria when matching routes #5383
• Fix incorrect use of cache when using header-based routing #5267 -- Thanks marlonfan for the patch!

Admin API

• Do not make a debugging dump of the declarative config input into error.log when posting it with /config and using _format_version as a top-level parameter (instead of embedded in the config parameter). #5411
• Fix incorrect behavior of PUT for /certificates #5321

Plugins

• acl: fixed an issue where getting ACLs by group failed when multiple consumers share the same group #5322

Back to TOC

1.4.2

Released 2019/12/10

This is another patch release in the 1.4 series, and as such, strictly contains bugfixes. There are no new features nor breaking changes.

Fixes

Core

• Fixes some corner cases in the balancer behavior #5318

Plugins

• http-log: disable queueing when using the default settings, to avoid memory consumption issues #5323
• prometheus: restore compatibility with version 0.6.0 #5303

Back to TOC

1.4.1

Released 2019/12/03

This is a patch release in the 1.4 series, and as such, strictly contains bugfixes. There are no new features nor breaking changes.

Fixes

Core

• Fixed a memory leak in the balancer #5229 -- Thanks zeeshen for the patch!
• Removed arbitrary limit on worker connections. #5148
• Fixed preserve_host behavior for gRPC routes #5225
• Fix migrations for ttl for OAuth2 tokens #5253
• Improve handling of errors when creating balancers #5284

CLI

• Fixed an issue with kong config db_export when reading entities that are ttl-enabled and whose ttl value is null. #5185

Admin API

• Various fixes for Admin API behavior #5174, #5178, #5191, #5186

Plugins

• http-log: do not impose a retry delay on successful sends #5282

Back to TOC

1.4.0

Released on 2019/10/22

Installation

• ⚠️ All Bintray assets have been renamed from .all. / .noarch. to be architecture specific namely .arm64. and .amd64.

Additions

Core

• 🎆 New configuration option cassandra_refresh_frequency to set the frequency that Kong will check for Cassandra cluster topology changes, avoiding restarts when Cassandra nodes are added or removed. #5071
• New transformations property in DAO schemas, which allows adding functions that run when database rows are inserted or updated. #5047
• The new attribute hostname has been added to upstreams entities. This attribute is used as the Host header when proxying requests through Kong to servers that are listening on server names that are different from the names to which they resolve. #4959
• New status interface has been introduced. It exposes insensitive health, metrics and error read-only information from Kong, which can be consumed by other services in the infrastructure to monitor Kong's health. This removes the requirement of the long-used workaround to monitor Kong's health by injecting a custom server block. #4977
• New Admin API response header X-Kong-Admin-Latency, reporting the time taken by Kong to process an Admin API request. #4966

Configuration

• ⚠️ New configuration option service_mesh which enables or disables the Service Mesh functionality. The Service Mesh is being deprecated and will not be available in the next releases of Kong. #5124
• New configuration option router_update_frequency that allows setting the frequency that router and plugins will be checked for changes. This new option avoids performance degradation when Kong routes or plugins are frequently changed. #4897

Plugins

• rate-limiting: in addition to consumer, credential, and IP levels, now rate-limiting plugin has service-level support. Thanks wuguangkuo for the patch! #5031
• Now rate-limiting local policy counters expire using the shared dictionary's TTL, avoiding to keep unnecessary counters in memory. Thanks cb372 for the patch! #5029
• Authentication plugins have support for tags now. #4945
• response-transformer plugin now supports renaming response headers. Thanks aalmazanarbs for the patch! #5040

Fixes

Core

• ⚠️ Service Mesh is known to cause HTTPS requests to upstream to ignore proxy_ssl* directives, so it is being discontinued in the next major release of Kong. In this release it is disabled by default, avoiding this issue, and it can be enabled as aforementioned in the configuration section. #5124
• Fixed an issue on reporting the proper request method and URL arguments on NGINX-produced errors in logging plugins. #5073
• Fixed an issue where targets were not properly updated in all Kong workers when they were removed. #5041
• Deadlocks cases in database access functions when using Postgres and cleaning up cluster_events in high-changing scenarios were fixed. #5118
• Fixed issues with tag-filtered GETs on Cassandra-backed nodes. #5105

Configuration

• Fixed Lua parsing and error handling in declarative configurations. #5019
• Automatically escape any unescaped # characters in parsed KONG_* environment variables. #5062

Plugins

• file-log: creates log file with proper permissions when Kong uses declarative config. #5028
• basic-auth: fixed credentials parsing when using DB-less configurations. #5080
• jwt: plugin handles empty claims and return the correct error message. #5123 Thanks to @jeremyjpj0916 for the patch!
• serverless-functions: Lua code in declarative configurations is validated and loaded correctly. #24
• request-transformer: fixed bug on removing and then adding request headers with the same name. #9

Back to TOC

1.3.0

Released on 2019/08/21

Kong 1.3 is the first version to officially support gRPC proxying!

Following our vision for Kong to proxy modern Web services protocols, we are excited for this newest addition to the family of protocols already supported by Kong (HTTP(s), WebSockets, and TCP). As we have recently stated in our latest Community Call, more protocols are to be expected in the future.

Additionally, this release includes several highly-requested features such as support for upstream mutual TLS, header-based routing (not only Host), database export, and configurable upstream keepalive timeouts.

Changes

Dependencies

• ⚠️ The required OpenResty version has been bumped to 1.15.8.1. If you are installing Kong from one of our distribution packages, you are not affected by this change. See #4382. With this new version comes a number of improvements:
  1. The new ngx_http_grpc_module.
  2. Configurable of upstream keepalive connections by timeout or number of requests.
  3. Support for ARM64 architectures.
  4. LuaJIT GC64 mode for x86_64 architectures, raising the LuaJIT GC-managed memory limit from 2GB to 128TB and producing more predictable GC performance.
• ⚠️ From this version on, the new lua-kong-nginx-module Nginx module is required to be built into OpenResty for Kong to function properly. This new module allows Kong to support new features such as mutual TLS authentication. If you are installing Kong from one of our distribution packages, you are not affected by this change. openresty-build-tools#26

Note: if you are not using one of our distribution packages and compiling OpenResty from source, you must still apply Kong's OpenResty patches (and, as highlighted above, compile OpenResty with the new lua-kong-nginx-module). Our new openresty-build-tools repository will allow you to do both easily.

Core

• ⚠️ Bugfixes in the router may, in some edge-cases, result in different Routes being matched. It was reported to us that the router behaved incorrectly in some cases when configuring wildcard Hosts and regex paths (e.g. #3094). It may be so that you are subject to these bugs without realizing it. Please ensure that wildcard Hosts and regex paths Routes you have configured are matching as expected before upgrading. See 9ca4dc0, 2683b86, and 6a03e1b for details.
• Upstream connections are now only kept-alive for 100 requests or 60 seconds (idle) by default. Previously, upstream connections were not actively closed by Kong. This is a (non-breaking) change in behavior, inherited from Nginx 1.15, and configurable via new configuration properties (see below).

Configuration

• ⚠️ The upstream_keepalive configuration property is deprecated, and replaced by the new nginx_http_upstream_keepalive property. Its behavior is almost identical, but the notable difference is that the latter leverages the injected Nginx directives feature added in Kong 0.14.0. In future releases, we will gradually increase support for injected Nginx directives. We have high hopes that this will remove the occasional need for custom Nginx configuration templates. #4382

Additions

Core

• 🎆 Native gRPC proxying. Two new protocol types; grpc and grpcs correspond to gRPC over h2c and gRPC over h2. They can be specified on a Route or a Service's protocol attribute (e.g. protocol = grpcs). When an incoming HTTP/2 request matches a Route with a grpc(s) protocol, the request will be handled by the ngx_http_grpc_module, and proxied to the upstream Service according to the gRPC protocol specifications. ⚠️ Note that not all Kong plugins are compatible with gRPC requests yet. #4801
• 🎆 Mutual TLS handshake with upstream services. The Service entity now has a new client_certificate attribute, which is a foreign key to a Certificate entity. If specified, Kong will use the Certificate as a client TLS cert during the upstream TLS handshake. #4800
• 🎆 Route by any request header. The router now has the ability to match Routes by any request header (not only Host). The Route entity now has a new headers attribute, which is a map of headers names and values. E.g. { "X-Forwarded-Host": ["example.org"], "Version": ["2", "3"] }. #4758
• 🎆 Least-connection load-balancing. A new algorithm attribute has been added to the Upstream entity. It can be set to "round-robin" (default), "consistent-hashing", or "least-connections". #4528
• A new core entity, "CA Certificates" has been introduced and can be accessed via the new /ca_certificates Admin API endpoint. CA Certificates entities will be used as CA trust store by Kong. Certificates stored by this entity need not include their private key. #4798
• Healthchecks now use the combination of IP + Port + Hostname when storing upstream health information. Previously, only IP + Port were used. This means that different virtual hosts served behind the same IP/port will be treated differently with regards to their health status. New endpoints were added to the Admin API to manually set a Target's health status. #4792

Configuration

• 🎆 A new section in the kong.conf file describes injected Nginx directives (added to Kong 0.14.0) and specifies a few default ones. In future releases, we will gradually increase support for injected Nginx directives. We have high hopes that this will remove the occasional need for custom Nginx configuration templates. #4382
• 🎆 New configuration properties allow for controlling the behavior of upstream keepalive connections. nginx_http_upstream_keepalive_requests and nginx_http_upstream_keepalive_timeout respectively control the maximum number of proxied requests and idle timeout of an upstream connection. #4382
• New flags have been added to the *_listen properties: deferred, bind, and reuseport. #4692

CLI

• 🎆 Database export via the new kong config db_export CLI command. This command will export the configuration present in the database Kong is connected to (Postgres or Cassandra) as a YAML file following Kong's declarative configuration syntax. This file can thus be imported later on in a DB-less Kong node or in another database via kong config db_import. #4809

Admin API

• Many endpoints now support more levels of nesting for ease of access. For example: /services/:services/routes/:routes is now a valid API endpoint. #4713
• The API now accepts form-urlencoded payloads with deeply nested data structures. Previously, it was only possible to send such data structures via JSON payloads. #4768

Plugins

• 🎆 New bundled plugin: the session plugin is now bundled in Kong. It can be used to manage browser sessions for APIs proxied and authenticated by Kong. #4685
• ldap-auth: A new config.ldaps property allows configuring the plugin to connect to the LDAP server via TLS. It provides LDAPS support instead of only relying on STARTTLS. #4743
• jwt-auth: The new header_names property accepts an array of header names the JWT plugin should inspect when authenticating a request. It defaults to ["Authorization"]. #4757
• azure-functions: Bumped to 0.4 for minor fixes and performance improvements.
• kubernetes-sidecar-injector: The plugin is now more resilient to Kubernetes schema changes.
• serverless-functions:
  • Bumped to 0.3 for minor performance improvements.
  • Functions can now have upvalues.
• prometheus: Bumped to 0.4.1 for minor performance improvements.
• cors: add OPTIONS, TRACE and CONNECT to default allowed methods #4899 Thanks to @eshepelyuk for the patch!

PDK

• New function kong.service.set_tls_cert_key(). This functions sets the client TLS certificate used while handshaking with the upstream service. #4797

Fixes

Core

• Fix WebSocket protocol upgrades in some cases due to case-sensitive comparisons of the Upgrade header. #4780
• Router: Fixed a bug causing invalid matches when configuring two or more Routes with a plain hosts attribute shadowing another Route's wildcard hosts attribute. Details of the issue can be seen in 01b1cb8. #4775
• Router: Ensure regex paths always have priority over plain paths. Details of the issue can be seen in 2683b86. #4775
• Cleanup of expired rows in PostgreSQL is now much more efficient thanks to a new query plan. #4716
• Improved various query plans against Cassandra instances by increasing the default page size. #4770

Plugins

• cors: ensure non-preflight OPTIONS requests can be proxied. #4899 Thanks to @eshepelyuk for the patch!
• Consumer references in various plugin entities are now properly marked as required, avoiding credentials that map to no Consumer. #4879
• hmac-auth: Correct the encoding of HTTP/1.0 requests. #4839
• oauth2: empty client_id wasn't checked, causing a server error. #4884
• response-transformer: preserve empty arrays correctly. #4901

CLI

• Fixed an issue when running kong restart and Kong was not running, causing stdout/stderr logging to turn off. #4772

Admin API

• Ensure PUT works correctly when applied to plugin configurations. #4882

PDK

• Prevent PDK calls from failing in custom content blocks. This fixes a misbehavior affecting the Prometheus plugin. #4904
• Ensure kong.response.add_header works in the rewrite phase. #4888

Back to TOC

1.2.2

Released on 2019/08/14

⚠️ This release includes patches to the NGINX core (1.13.6) fixing vulnerabilities in the HTTP/2 module (CVE-2019-9511 CVE-2019-9513 CVE-2019-9516).

This is a patch release in the 1.2 series, and as such, strictly contains bugfixes. There are no new features nor breaking changes.

Fixes

Core

• Case sensitivity fix when clearing the Upgrade header. #4779

Performance

Core

• Speed up cascade deletes in Cassandra. #4770

1.2.1

Released on 2019/06/26

This is a patch release in the 1.2 series, and as such, strictly contains bugfixes. There are no new features nor breaking changes.

Fixes

Core

• Fix an issue preventing WebSocket connections from being established by clients. This issue was introduced in Kong 1.1.2, and would incorrectly clear the Upgrade response header. #4719
• Fix a memory usage growth issue in the /config endpoint when configuring Upstream entities. This issue was mostly observed by users of the Kong Ingress Controller. #4733
• Cassandra: ensure serial consistency is LOCAL_SERIAL when a datacenter-aware load balancing policy is in use. This fixes unavailability exceptions sometimes experienced when connecting to a multi-datacenter cluster with cross-datacenter connectivity issues. #4734
• Schemas: fix an issue in the schema validator that would not allow specifying false in some schema rules, such a { type = "boolean", eq = false }. #4708 #4727
• Fix an underlying issue with regards to database entities cache keys generation. #4717

Configuration

• Ensure the cassandra_local_datacenter configuration property is specified when a datacenter-aware Cassandra load balancing policy is in use. #4734

Plugins

• request-transformer: fix an issue that would prevent adding a body to requests without one. Kong/kong-plugin-request-transformer#4
• kubernetes-sidecar-injector: fix an issue causing mutating webhook calls to fail. Kong/kubernetes-sidecar-injector#9

Back to TOC

1.2.0

Released on: 2019/06/07

This release brings improvements to reduce long latency tails, consolidates declarative configuration support, and comes with newly open sourced plugins previously only available to Enterprise customers. It also ships with new features improving observability and usability.

This release includes database migrations. Please take a few minutes to read the 1.2 Upgrade Path for more details regarding changes and migrations before planning to upgrade your Kong cluster.

Installation

• ⚠️ All Bintray repositories have been renamed from kong-community-edition-* to kong-*.
• ⚠️ All Kong packages have been renamed from kong-community-edition to kong.

For more details about the updated installation, please visit the official docs: https://konghq.com/install.

Additions

Core

• 🎆 Support for wildcard SNI matching: the ssl_certificate_by_lua phase and the stream preread phase) is now able to match a client hello SNI against any registered wildcard SNI. This is particularly helpful for deployments serving a certificate for multiple subdomains. #4457
• 🎆 HTTPS Routes can now be matched by SNI: the snis Route attribute (previously only available for tls Routes) can now be set for https Routes and is evaluated by the HTTP router. #4633
• 🎆 Native support for HTTPS redirects: Routes have a new https_redirect_status_code attribute specifying the status code to send back to the client if a plain text request was sent to an https Route. #4424
• The loading of declarative configuration is now done atomically, and with a safety check to verify that the new configuration fits in memory. #4579
• Schema fields can now be marked as immutable. #4381
• Support for loading custom DAO strategies from plugins. #4518
• Support for IPv6 to tcp and tls Routes. #4333

Configuration

• 🎆 Asynchronous router updates: a new configuration property router_consistency accepts two possible values: strict and eventual. The former is the default setting and makes router rebuilds highly consistent between Nginx workers. It can result in long tail latency if frequent Routes and Services updates are expected. The latter helps preventing long tail latency issues by instructing Kong to rebuild the router asynchronously (with eventual consistency between Nginx workers). #4639
• 🎆 Database cache warmup: Kong can now preload entities during its initialization. A new configuration property (db_cache_warmup_entities) was introduced, allowing users to specify which entities should be preloaded. DB cache warmup allows for ahead-of-time DNS resolution for Services with a hostname. This feature reduces first requests latency, improving the overall P99 latency tail. #4565
• Improved PostgreSQL connection management: two new configuration properties have been added: pg_max_concurrent_queries sets the maximum number of concurrent queries to the database, and pg_semaphore_timeout allows for tuning the timeout when acquiring access to a database connection. The default behavior remains the same, with no concurrency limitation. #4551

Admin API

• 🎆 Add declarative configuration hash checking avoiding reloading if the configuration has not changed. The /config endpoint now accepts a check_hash query argument. Hash checking only happens if this argument's value is set to 1. #4609
• 🎆 Add a schema validation endpoint for entities: a new endpoint /schemas/:entity_name/validate can be used to validate an instance of any entity type in Kong without creating the entity itself. #4413
• 🎆 Add memory statistics to the /status endpoint. The response now includes a memory field, which contains the lua_shared_dicts and workers_lua_vms fields with statistics on shared dictionaries and workers Lua VM memory usage. #4592

PDK

• New function kong.node.get_memory_stats(). This function returns statistics on shared dictionaries and workers Lua VM memory usage, and powers the memory statistics newly exposed by the /status endpoint. #4632

Plugins

• 🎆 Newly open-sourced plugin: the HTTP proxy-cache plugin (previously only available in Enterprise) is now bundled in Kong. #4650
• 🎆 Newly open-sourced plugin capabilities: The request-transformer plugin now includes capabilities previously only available in Enterprise, among which templating and variables interpolation. #4658
• Logging plugins: log request TLS version, cipher, and verification status. #4581 #4626
• Plugin development: inheriting from BasePlugin is now optional. Avoiding the inheritance paradigm improves plugins' performance. #4590

Fixes

Core

• Active healthchecks: http checks are not performed for tcp and tls Services anymore; only tcp healthchecks are performed against such Services. #4616
• Fix an issue where updates in migrations would not correctly populate default values. #4635
• Improvements in the reentrancy of Cassandra migrations. #4611
• Fix an issue causing the PostgreSQL strategy to not bootstrap the schema when using a PostgreSQL account with limited permissions. #4506

CLI

• Fix kong db_import to support inserting entities without specifying a UUID for their primary key. Entities with a unique identifier (e.g. name for Services) can have their primary key omitted. #4657
• The kong migrations [up|finish] -f commands does not run anymore if there are no previously executed migrations. #4617

Plugins

• ldap-auth: ensure TLS connections are reused. #4620
• oauth2: ensured access tokens preserve their token_expiration value when migrating from previous Kong versions. #4572

Back to TOC

1.1.2

Released on: 2019/04/24

This is a patch release in the 1.0 series. Being a patch release, it strictly contains bugfixes. The are no new features or breaking changes.

Fixes

• core: address issue where field type "record" nested values reset on update #4495
• core: correctly manage primary keys of type "foreign" #4429
• core: declarative config is not parsed on db-mode anymore #4487 #4509
• db-less: Fixed a problem in Kong balancer timing out. #4534
• db-less: Accept declarative config directly in JSON requests. #4527
• db-less: do not mis-detect mesh mode #4498
• db-less: fix crash when field has same name as entity #4478
• basic-auth: ignore password if nil on basic auth credential patch #4470
• http-log: Simplify queueing mechanism. Fixed a bug where traces were lost in some cases. #4510
• request-transformer: validate header values in plugin configuration. Thanks, @rune-chan! #4512.
• rate-limiting: added index on rate-limiting metrics. Thanks, @mvanholsteijn! #4486

Back to TOC

1.1.1

Released on: 2019/03/28

This release contains a fix for 0.14 Kong clusters using Cassandra to safely migrate to Kong 1.1.

Fixes

• Ensure the 0.14 -> 1.1 migration path for Cassandra does not corrupt the database schema. #4450
• Allow the kong config init command to run without a pointing to a prefix directory. #4451

Back to TOC

1.1.0

Released on: 2019/03/27

This release introduces new features such as Declarative Configuration, DB-less Mode, Bulk Database Import, Tags, as well as Transparent Proxying. It contains a large number of other features and fixes, listed below. Also, the Plugin Development kit also saw a minor updated, bumped to version 1.1.

This release includes database migrations. Please take a few minutes to read the 1.1 Upgrade Path for more details regarding changes and migrations before planning to upgrade your Kong cluster.

🔶 Post-release note (as of 2019/03/28): an issue has been found when migrating from a 0.14 Kong cluster to 1.1.0 when running on top of Cassandra. Kong 1.1.1 has been released to address this issue. Kong clusters running on top of PostgreSQL are not affected by this issue, and can migrate to 1.1.0 or 1.1.1 safely.

Additions

Core

• 🎆 Kong can now run without a database, using in-memory storage only. When running Kong in DB-less mode, entities are loaded via a declarative configuration file, specified either through Kong's configuration file, or uploaded via the Admin API. #4315
• 🎆 Transparent proxying - the service attribute on Routes is now optional; a Route without an assigned Service will proxy transparently #4286
• Support for tags in entities #4275
  • Every core entity now adds a tags field
• New protocols field in the Plugin entity, allowing plugin instances to be set for specific protocols only (http, https, tcp or tls). #4248
  • It filters out plugins during execution according to their protocols field
  • It throws an error when trying to associate a Plugin to a Route which is not compatible, protocols-wise, or to a Service with no compatible routes.

Configuration

• New option in kong.conf: database=off to start Kong without a database
• New option in kong.conf: declarative_config=kong.yml to load a YAML file using Kong's new declarative config format
• New option in kong.conf: pg_schema to specify Postgres schema to be used
• The Stream subsystem now supports Nginx directive injections #4148
  • nginx_stream_* (or KONG_NGINX_STREAM_* environment variables) for injecting entries to the stream block
  • nginx_sproxy_* (or KONG_NGINX_SPROXY_* environment variables) for injecting entries to the server block inside stream

CLI

• 🎆 Bulk database import using the same declarative configuration format as the in-memory mode, using the new command: kong config db_import kong.yml. This command upserts all entities specified in the given kong.yml file in bulk #4284
• New command: kong config init to generate a template kong.yml file to get you started
• New command: kong config parse kong.yml to verify the syntax of the kong.yml file before using it
• New option --wait in kong quit to ease graceful termination when using orchestration tools #4201

Admin API

• New Admin API endpoint: /config to replace the configuration of Kong entities entirely, replacing it with the contents of a new declarative config file
  • When using the new database=off configuration option, the Admin API endpoints for entities (such as /routes and /services) are read-only, since the configuration can only be updated via /config #4308
• Admin API endpoints now support searching by tag (for example, /consumers?tags=example_tag)
  • You can search by multiple tags:
    • /services?tags=serv1,mobile to search for services matching tags serv1 and mobile
    • /services?tags=serv1/serv2 to search for services matching tags serv1 or serv2
• New Admin API endpoint /tags/ for listing entities by tag: /tags/example_tag

PDK

• New PDK function: kong.client.get_protocol for obtaining the protocol in use during the current request #4307
• New PDK function: kong.nginx.get_subsystem, so plugins can detect whether they are running on the HTTP or Stream subsystem #4358

Plugins

• 🎆 Support for ACL authenticated groups, so that authentication plugins that use a 3rd party (other than Kong) to store credentials can benefit from using a central ACL plugin to do authorization for them #4013
• The Kubernetes Sidecar Injection plugin is now bundled into Kong for a smoother K8s experience #4304
• aws-lambda: includes AWS China region. Thanks @wubins for the patch! #4176

Changes

Dependencies

• The required OpenResty version is still 1.13.6.2, but for a full feature set including stream routing and Service Mesh abilities with mutual TLS, Kong's openresty-patches must be applied (those patches are already bundled with our official distribution packages). The openresty-patches bundle was updated in Kong 1.1.0 to include the stream_realip_module as well. Kong in HTTP(S) Gateway scenarios does not require these patches. #4163
• Service Mesh abilities require at least OpenSSL version 1.1.1. In our official distribution packages, OpenSSL has been bumped to 1.1.1b. #4345, #4440

Fixes

Core

• Resolve hostnames properly during initialization of Cassandra contact points #4296, #4378
• Fix health checks for Targets that need two-level DNS resolution (e.g. SRV → A → IP) #4386
• Fix serialization of map types in the Cassandra backend #4383
• Fix target cleanup and cascade-delete for Targets #4319
• Avoid crash when failing to obtain list of Upstreams #4301
• Disallow invalid timeout value of 0ms for attributes in Services #4430
• DAO fix for foreign fields used as primary keys #4387

Admin API

• Proper support for PUT /{entities}/{entity}/plugins/{plugin} #4288
• Fix Admin API inferencing of map types using form-encoded #4368
• Accept UUID-like values in /consumers?custom_id= #4435

Plugins

• basic-auth, ldap-auth, key-auth, jwt, hmac-auth: fixed status code for unauthorized requests: they now return HTTP 401 instead of 403 #4238
• tcp-log: remove spurious trailing carriage return Thanks @cvuillemez for the patch! #4158
• jwt: fix typ handling for supporting JOSE (JSON Object Signature and Validation) Thanks @cdimascio for the patch! #4256
• Fixes to the best-effort auto-converter for legacy plugin schemas #4396

Back to TOC

1.0.3

Released on: 2019/01/31

This is a patch release addressing several regressions introduced some plugins, and improving the robustness of our migrations and core components.

Core

• Improve Cassandra schema consensus logic when running migrations. #4233
• Ensure Routes that don't have a regex_priority (e.g. if it was removed as part of a PATCH) don't prevent the router from being built. #4255
• Reduce rebuild time of the load balancer by retrieving larger sized pages of Target entities. #4206
• Ensure schema definitions of Arrays and Sets with default = {} are JSON-encoded as []. #4257

Plugins

• request-transformer: fix a regression causing the upstream Host header to be unconditionally set to that of the client request (effectively, as if the Route had preserve_host enabled). #4253
• cors: fix a regression that prevented regex origins from being matched. Regexes such as (.*[.])?example\.org can now be used to match all sub-domains, while regexes containing : will be evaluated against the scheme and port of an origin (i.e. ^https?://(.*[.])?example\.org(:8000)?$). #4261
• oauth2: fix a runtime error when using a global token against a plugin not configured as global (i.e. with global_credentials = false). #4262

Admin API

• Improve performance of the PUT method in auth plugins endpoints (e.g. /consumers/:consumers/basic-auth/:basicauth_credentials) by preventing a unnecessary read-before-write. #4206

Back to TOC

1.0.2

Released on: 2019/01/18

This is a hotfix release mainly addressing an issue when connecting to the datastore over TLS (Cassandra and PostgreSQL).

Fixes

Core

• Fix an issue that would prevent Kong from starting when connecting to its datastore over TLS. #4214 #4218
• Ensure plugins added via PUT get enabled without requiring a restart. #4220

Plugins

• zipkin
  • Fix a logging failure when DNS is not resolved. kong-plugin-zipkin@a563f51
  • Avoid sending redundant tags. kong-plugin-zipkin/pull/28
  • Move run_on field to top level plugin schema instead of its config. kong-plugin-zipkin/pull/38

Back to TOC

1.0.1

Released on: 2019/01/16

This is a patch release in the 1.0 series. Being a patch release, it strictly contains performance improvements and bugfixes. The are no new features or breaking changes.

🔴 Post-release note (as of 2019/01/17): A regression has been observed with this version, preventing Kong from starting when connecting to its datastore over TLS. Installing this version is discouraged; consider upgrading to 1.0.2.

Changes

Core

• 🚀 Assorted changes for warmup time improvements over Kong 1.0.0 #4138, #4164, #4178, #4179, #4182

Fixes

Configuration

• Ensure lua_ssl_verify_depth works even when lua_ssl_trusted_certificate is not set #4165. Thanks @rainest for the patch.
• Ensure Kong starts when only a stream listener is enabled #4195
• Ensure Postgres works with non-public schemas #4198

Core

• Fix an artifact in upstream migrations where created_at timestamps would occasionally display fractional values #4183, #4204
• Fixed issue with HTTP/2 support advertisement #4203

Admin API

• Fixed handling of invalid targets in /upstreams endpoints for health checks #4132, #4205
• Fixed the /plugins/schema/:name endpoint, as it was failing in some cases (e.g. the datadog plugin) and producing incorrect results in others (e.g. request-transformer). #4136, #4137 #4151, #4162

Plugins

• Fix PDK memory leaks in kong.service.response and kong.ctx #4143, #4172

Back to TOC

1.0.0

Released on: 2018/12/18

This is a major release, introducing new features such as Service Mesh and Stream Routing support, as well as a New Migrations framework. It also includes version 1.0.0 of the Plugin Development Kit. It contains a large number of other features and fixes, listed below. Also, all plugins included with Kong 1.0 are updated to use version 1.0 of the PDK.

As usual, major version upgrades require database migrations and changes to the Nginx configuration file (if you customized the default template). Please take a few minutes to read the 1.0 Upgrade Path for more details regarding breaking changes and migrations before planning to upgrade your Kong cluster.

Being a major version, all entities and concepts that were marked as deprecated in Kong 0.x are now removed in Kong 1.0. The deprecated features are retained in Kong 0.15, the final entry in the Kong 0.x series, which is being released simultaneously to Kong 1.0.

Changes

Kong 1.0 includes all breaking changes from 0.15, as well as the removal of deprecated concepts.

Dependencies

• The required OpenResty version is still 1.13.6.2, but for a full feature set including stream routing and Service Mesh abilities with mutual TLS, Kong's openresty-patches must be applied (those patches are already bundled with our official distribution packages). Kong in HTTP(S) Gateway scenarios does not require these patches.
• Service Mesh abilities require at least OpenSSL version 1.1.1. In our official distribution packages, OpenSSL has been bumped to 1.1.1. #4005

Configuration

• ⚠️ The custom_plugins directive is removed (deprecated since 0.14.0, July 2018). Use plugins instead.
• Modifications must be applied to the Nginx configuration. You are not affected by this change if you do not use a custom Nginx template. See the 1.0 Upgrade Path for a diff of changes to apply.
• The default value for cassandra_lb_policy changed from RoundRobin to RequestRoundRobin. This helps reducing the amount of new connections being opened during a request when using the Cassandra strategy. #4004

Core

• ⚠️ The API entity and related concepts such as the /apis endpoint, are removed (deprecated since 0.13.0, March 2018). Use Routes and Services instead.
• ⚠️ The old DAO implementation is removed, along with the old schema validation library (apis was the last entity using it). Use the new schema format instead in custom plugins. To ease the transition of plugins, the plugin loader in 1.0 includes a best-effort schema auto-translator, which should be sufficient for many plugins.
• Timestamps now bear millisecond precision in their decimal part. #3660
• The PDK function kong.request.get_body will now return nil, err, mime when the body is valid JSON but neither an object nor an array. #4063

CLI

• ⚠️ The new migrations framework (detailed below) has a different usage (and subcommands) compared to its predecessor. #3802

Admin API

• ⚠️ In the 0.14.x release, Upstreams, Targets, and Plugins were still implemented using the old DAO and Admin API. In 0.15.0 and 1.0.0, all core entities use the new kong.db DAO, and their endpoints have been upgraded to the new Admin API (see below for details). #3689 #3739 #3778

A summary of the changes introduced in the new Admin API:

• Pagination has been included in all "multi-record" endpoints, and pagination control fields are different than in 0.14.x.
• Filtering now happens via URL path changes (/consumers/x/plugins) instead of querystring fields (/plugins?consumer_id=x).
• Array values can't be coerced from comma-separated strings anymore. They must now be "proper" JSON values on JSON requests, or use a new syntax on form-url-encoded or multipart requests.
• Error messages have been been reworked from the ground up to be more consistent, precise and informative.
• The PUT method has been reimplemented with idempotent behavior and has been added to some entities that didn't have it.

For more details about the new Admin API, please visit the official docs: https://docs.konghq.com/

Plugins

• ⚠️ The galileo plugin has been removed (deprecated since 0.13.0). #3960
• ⚠️ Some internal modules that were occasionally used by plugin authors before the introduction of the Plugin Development Kit (PDK) in 0.14.0 are now removed:
  • The kong.tools.ip module was removed. Use kong.ip from the PDK instead.
  • The kong.tools.public module was removed. Use the various equivalent features from the PDK instead.
  • The kong.tools.responses module was removed. Please use kong.response.exit from the PDK instead. You might want to use kong.log.err to log internal server errors as well.
  • The kong.api.crud_helpers module was removed (deprecated since the introduction of the new DAO in 0.13.0). Use kong.api.endpoints instead if you need to customize the auto-generated endpoints.
• All bundled plugins' schemas and custom entities have been updated to the new kong.db module, and their APIs have been updated to the new Admin API, which is described in the above section. #3766 #3774 #3778 #3839
• ⚠️ All plugins migrations have been converted to the new migration framework. Custom plugins must use the new migration framework from 0.15 onwards.

Additions

🎆 Service Mesh and Stream Routes

Kong's Service Mesh support resulted in a number of additions to Kong's configuration, Admin API, and plugins that deserve their own section in this changelog.

• Support for TCP & TLS Stream Routes via the new stream_listen config option. #4009
• A new origins config property allows overriding hosts from Kong. #3679
• A transparent suffix added to stream listeners allows for setting up a dynamic Service Mesh with iptables. #3884
• Kong instances can now create a shared internal Certificate Authority, which is used for Service Mesh TLS traffic. #3906 #3861
• Plugins get a new run_on field to control how they behave in a Service Mesh environment. #3930 #4066
• There is a new phase called preread. This is where stream traffic routing is done.

Configuration

• A new dns_valid_ttl property can be set to forcefully override the TTL value of all resolved DNS records. #3730
• A new pg_timeout property can be set to configure the timeout of PostgreSQL connections. #3808
• upstream_keepalive can now be disabled when set to 0. Thanks @pryorda for the patch. #3716
• The new transparent suffix also applies to the proxy_listen directive.

CLI

• 🎆 New migrations framework. This new implementation supports no-downtime, Blue/Green migrations paths that will help sustain Kong 1.0's stability. It brings a considerable number of other improvements, such as new commands, better support for automation, improved CLI logging, and many more. Additionally, this new framework alleviates the old limitation around multiple nodes running concurrent migrations. See the related PR for a complete list of improvements. #3802

Core

• 🎆 Support for TLS 1.3. The support for OpenSSL 1.1.1 (bumped in our official distribution packages) not only enabled Service Mesh features, but also unlocks support for the latest version of the TLS protocol.
• 🎆 Support for HTTPS in active healthchecks. #3815
• 🎆 Improved router rebuilds resiliency by reducing database accesses in high concurrency scenarios. #3782
• 🎆 Significant performance improvements in the core's plugins runloop. #3794
• PDK improvements:
  • New kong.node module. #3826
  • New functions kong.response.get_path_with_query() and kong.request.get_start_time(). #3842
  • Getters and setters for Service, Route, Consumer, and Credential. #3916
  • kong.response.get_source() returns error on nginx-produced errors. #4006
  • kong.response.exit() can be used in the header_filter phase, but only without a body. #4039
• Schema improvements:
  • New field validators: distinct, ne, is_regex, contains, gt.
  • Adding a new field which has a default value to a schema no longer requires a migration. #3756

Admin API

• 🎆 Routes now have a name field (like Services). #3764
• Multipart parsing support. #3776
• Admin API errors expose the name of the current strategy. #3612

Plugins

• 🎆 aws-lambda: Support for Lambda Proxy Integration with the new is_proxy_integration property. Thanks @aloisbarreras for the patch! #3427.
• http-log: Support for buffering logging messages in a configurable logging queue. #3604
• Most plugins' logic has been rewritten with the PDK instead of using internal Kong functions or ngx_lua APIs.

Fixes

Core

• Fix an issue which would insert an extra / in the upstream URL when the request path was longer than the configured Route's path attribute. #3780
• Ensure better backwards-compatibility between the new DAO and existing core runloop code regarding null values. #3772 #3710
• Ensure support for Datastax Enterprise 6.x. Thanks @gchristidis for the patch! #3873
• Various issues with the PostgreSQL DAO strategy were addressed.
• Various issues related to the new schema library bundled with the new DAO were addressed.
• PDK improvements:
  • kong.request.get_path() and other functions now properly handle cases when $request_uri is nil. #3842

Admin API

• Ensure the /certificates endpoints properly returns all SNIs configured on a given certificate. #3722
• Ensure the upstreams/:upstream/targets/... endpoints returns an empty JSON array ([]) instead of an empty object ({}) when no targets exist. #4058
• Improved inferring of arguments with application/x-www-form-urlencoded. #3770
• Fix the handling of defaults values in some cases when using PATCH. #3910

Plugins

• cors:
  • Ensure Vary: Origin is set when config.credentials is enabled. Thanks @marckhouzam for the patch! #3765
  • Return HTTP 200 instead of 204 for preflight requests. Thanks @aslafy-z for the patch! #4029
  • Ensure request origins specified as flat strings are safely validated. #3872
• acl: Minor performance improvements by ensuring proper caching of computed values. #4040
• correlation-id: Prevent an error to be thrown when the access phase was skipped, such as on nginx-produced errors. #4006
• aws-lambda: When the client uses HTTP/2, strip response headers that are disallowed by the protocols. #4032
• rate-limiting & response-ratelimiting: Improve efficiency by avoiding unnecessary Redis SELECT operations. #3973

Back to TOC

0.15.0

Released on: 2018/12/18

This is the last release in the 0.x series, giving users one last chance to upgrade while still using some of the options and concepts that were marked as deprecated in Kong 0.x and were removed in Kong 1.0.

For a list of additions and fixes in Kong 0.15, see the 1.0.0 changelog. This release includes all new features included in 1.0 (Service Mesh, Stream Routes and New Migrations), but unlike Kong 1.0, it retains a lot of the deprecated functionality, like the API entity, around. Still, Kong 0.15 does have a number of breaking changes related to functionality that has changed since version 0.14 (see below).

If you are starting with Kong, we recommend you to use 1.0.0 instead of this release.

If you are already using Kong 0.14, our recommendation is to plan to move to 1.0 -- see the 1.0 Upgrade Path document for details. Upgrading to 0.15.0 is only recommended if you can't do away with the deprecated features but you need some fixes or new features right now.

Changes

Dependencies

• The required OpenResty version is still 1.13.6.2, but for a full feature set including stream routing and Service Mesh abilities with mutual TLS, Kong's openresty-patches must be applied (those patches are already bundled with our official distribution packages). Kong in HTTP(S) Gateway scenarios does not require these patches.
• Service Mesh abilities require at least OpenSSL version 1.1.1. In our official distribution packages, OpenSSL has been bumped to 1.1.1. #4005

Configuration

• The default value for cassandra_lb_policy changed from RoundRobin to RequestRoundRobin. This helps reducing the amount of new connections being opened during a request when using the Cassandra strategy. #4004

Core

• Timestamps now bear millisecond precision in their decimal part. #3660
• The PDK function kong.request.get_body will now return nil, err, mime when the body is valid JSON but neither an object nor an array. #4063

CLI

• ⚠️ The new migrations framework (detailed in the 1.0.0 changelog) has a different usage (and subcommands) compared to its predecessor. #3802

Admin API

• ⚠️ In the 0.14.x release, Upstreams, Targets, and Plugins were still implemented using the old DAO and Admin API. In 0.15.0 and 1.0.0, all core entities use the new kong.db DAO, and their endpoints have been upgraded to the new Admin API (see below for details). #3689 #3739 #3778

A summary of the changes introduced in the new Admin API:

• Pagination has been included in all "multi-record" endpoints, and pagination control fields are different than in 0.14.x.
• Filtering now happens via URL path changes (/consumers/x/plugins) instead of querystring fields (/plugins?consumer_id=x).
• Array values can't be coherced from comma-separated strings. They must be "proper" JSON values on JSON requests, or use a new syntax on form-url-encoded or multipart requests.
• Error messages have been been reworked from the ground up to be more consistent, precise and informative.
• The PUT method has been reimplemented with idempotent behavior and has been added to some entities that didn't have it.

For more details about the new Admin API, please visit the official docs: https://docs.konghq.com/

Plugins

• All bundled plugins' schemas and custom entities have been updated to the new kong.db module, and their APIs have been updated to the new Admin API, which is described in the above section. #3766 #3774 #3778 #3839
• ⚠️ All plugins migrations have been converted to the new migration framework. Custom plugins must use the new migration framework from 0.15 onwards.

Additions

Kong 0.15.0 contains the same additions as 1.0.0. See the 1.0.0 changelog for a complete list.

Fixes

Kong 0.15.0 contains the same fixes as 1.0.0. See the 1.0.0 changelog for a complete list.

Back to TOC

0.14.1

Released on: 2018/08/21

Additions

Plugins

• jwt: Support for tokens signed with HS384 and HS512. Thanks @kepkin for the patch. #3589
• acl: Add a new hide_groups_header configuration option. If enabled, this option prevents the plugin from injecting the X-Consumer-Groups header into the upstream request. Thanks @jeremyjpj0916 for the patch! #3703

Fixes

Core

• Prevent some plugins from breaking in subtle ways when manipulating some entities and their attributes. An example of such breaking behavior could be observed when Kong was wrongly injecting X-Consumer-Username: userdata: NULL in upstream requests headers, instead of not injecting this header at all. #3714
• Fix an issue which, in some cases, prevented the use of Kong with Cassandra in environments where DNS load-balancing is in effect for contact points provided as hostnames (e.g. Kubernetes with cassandra_contact_points = cassandra). #3693
• Fix an issue which prevented the use of UNIX domain sockets in some logging plugins, and custom plugins making use of such sockets. Thanks @rucciva for the patch. #3633
• Avoid logging false-negative error messages related to worker events. #3692

CLI

• Database connectivity errors are properly prefixed with the database name again (e.g. [postgres]). #3648

Plugins

• zipkin
  • Allow usage of the plugin with the deprecated "API" entity, and introduce a new kong.api tag. kong-plugin-zipkin/commit/4a645e9
  • Properly report the kong.credential tag. kong-plugin-zipkin/commit/c627c36
  • Ensure the plugin does not throw errors when no Route was matched. kong-plugin-zipkin#19
• basic-auth: Passwords with whitespaces are not trimmed anymore. Thanks @aloisbarreras for the patch. #3650
• hmac-auth: Ensure backward compatibility for clients generating signatures without the request's querystring, as is the case for Kong versions prior to 0.14.0, which broke this behavior. Users of this plugin on previous versions of Kong can now safely upgrade to the 0.14 family. Thanks @mlehner616 for the patch! #3699
• ldap-auth
  • Set the WWW-Authenticate header authentication scheme accordingly with the conf.header_type property, which allows browsers to show the authentication popup automatically. Thanks @francois-maillard for the patch. #3656
  • Invalid authentication attempts do not block subsequent valid attempts anymore. #3677

Back to TOC

0.14.0 - 2018/07/05

This release introduces the first version of the Plugin Development Kit: a Lua SDK, comprised of a set of functions to ease the development of custom plugins.

Additionally, it contains several major improvements consolidating Kong's feature set and flexibility, such as the support for PUT endpoints on the Admin API for idempotent workflows, the execution of plugins during Nginx-produced errors, and the injection of Nginx directives without having to rely on the custom Nginx configuration pattern!

Finally, new bundled plugins allow Kong to better integrate with Cloud Native environments, such as Zipkin and Prometheus.

As usual, major version upgrades require database migrations and changes to the Nginx configuration file (if you customized the default template). Please take a few minutes to read the 0.14 Upgrade Path for more details regarding breaking changes and migrations before planning to upgrade your Kong cluster.

Breaking Changes

Dependencies

• ⚠️ The required OpenResty version has been bumped to 1.13.6.2. If you are installing Kong from one of our distribution packages, you are not affected by this change. #3498
• ⚠️ Support for PostgreSQL 9.4 (deprecated in 0.12.0) is now dropped. #3490
• ⚠️ Support for Cassandra 2.1 (deprecated in 0.12.0) is now dropped. #3490

Configuration

• ⚠️ The server_tokens and latency_tokens configuration properties have been removed. Instead, a new headers configuration properties replaces them and allows for more granular settings of injected headers (e.g. Server, Via, X-Kong-*-Latency, etc...). #3300
• ⚠️ New required lua_shared_dict entries must be added to the Nginx configuration. You are not affected by this change if you do not use a custom Nginx template. #3557
• ⚠️ Other important modifications must be applied to the Nginx configuration. You are not affected by this change if you do not use a custom Nginx template. #3533

Plugins

• ⚠️ The Runscope plugin has been dropped, based on the EoL announcement made by Runscope about their Traffic Inspector product. #3495

Admin API

• ⚠️ The SSL Certificates and SNI entities have moved to the new DAO implementation. As such, the /certificates and /snis endpoints have received notable usability improvements, but suffer from a few breaking changes. #3386
• ⚠️ The Consumers entity has moved to the new DAO implementation. As such, the /consumers endpoint has received notable usability improvements, but suffers from a few breaking changes. #3437

Changes

Configuration

• The default value of db_cache_ttl is now 0 (disabled). Now that our level of confidence around the new caching mechanism introduced in 0.11.0 is high enough, we consider 0 (no TTL) to be an appropriate default for production environments, as it offers a smoother cache consumption behavior and reduces database pressure. #3492

Core

• 🎆 Serve stale data from the database cache when the datastore cannot be reached. Such stale items are "resurrected" for db_resurrect_ttl seconds (see configuration section). #3579
• Reduce LRU churning in the database cache against some workloads. #3550

Additions

Configuration

• 🎆 Support for injecting Nginx directives via configuration properties (in the kong.conf file or via environment variables)! This new way of customizing the Nginx configuration should render obsolete the old way of maintaining a custom Nginx template in most cases! #3530
• 🎆 Support for selectively disabling bundled plugins. A new plugins configuration property is introduced, and is used to specify which plugins should be loaded by the node. Custom plugins should now be specified in this new property, and the custom_plugins property is deprecated. If desired, Kong administrators can specify a minimal set of plugins to load (instead of the default, bundled plugins), and improve P99 latency thanks to the resulting decrease in database traffic. #3387
• The new headers configuration property allows for specifying the injection of a new header: X-Kong-Upstream-Status. When enabled, Kong will inject this header containing the HTTP status code of the upstream response in the client response. This is particularly useful for clients to distinguish upstream statuses upon rewriting of the response by Kong. #3263
• A new db_resurrect_ttl configuration property can be set to customize the amount of time stale data can be resurrected for when it cannot be refreshed. Defaults to 30 seconds. #3579
• Two new Cassandra load balancing policies are available: RequestRoundRobin and RequestDCAwareRoundRobin. Both policies guarantee that the same peer will be reused across several queries during the lifetime of a request, thus guaranteeing no new connection will be opened against a peer during this request. #3545

Core

• 🎆 Execute plugins on Nginx-produced errors. Now, when Nginx produces a 4xx error (upon invalid requests) or 5xx (upon failure from the load balancer to connect to a Service), Kong will execute the response phases of its plugins (header_filter, body_filter, log). As such, Kong logging plugins are not blind to such Nginx-produced errors anymore, and will start properly reporting them. Plugins should be built defensively against cases where their rewrite or access phases were not executed. #3533
• 🎆 Support for cookie-based load balancing! #3472

Plugins

• 🎆 Introduction of the Plugin Development Kit! A set of Lua functions and variables that will greatly ease and speed up the task of developing custom plugins. The Plugin Development Kit (PDK) allows the retrieval and manipulation of the request and response objects, as well as interacting with various core components (e.g. logging, load balancing, DAO, etc...) without having to rely on OpenResty functions, and with the guarantee of their forward-compatibility with future versions of Kong. #3556
• 🎆 New bundled plugin: Zipkin! This plugin allows Kong to sample traces and report them to a running Zipkin instance. (See: https://github.com/Kong/kong-plugin-zipkin) #3434
• 🎆 New bundled plugin: Prometheus! This plugin allows Kong to expose metrics in the Prometheus Exposition format. Available metrics include HTTP status codes, latencies histogram, bandwidth, and more... (See: https://github.com/Kong/kong-plugin-prometheus) #3547
• 🎆 New bundled plugin: Azure Functions! This plugin can be used to invoke Microsoft Azure Functions, similarly to the already existing AWS Lambda and OpenWhisk plugins. (See: https://github.com/Kong/kong-plugin-azure-functions) #3428
• 🎆 New bundled plugin: Serverless Functions! Dynamically run Lua without having to write a full-fledged plugin. Lua code snippets can be uploaded via the Admin API and be executed during Kong's access phase. (See: https://github.com/Kong/kong-plugin-serverless-functions) #3551
• jwt: Support for limiting the allowed expiration period of JWT tokens. A new config.maximum_expiration property can be set to indicate the maximum number of seconds the exp claim may be ahead in the future. Thanks @mvanholsteijn for the patch! #3331
• aws-lambda: Add us-gov-west-1 to the list of allowed regions. #3529

Admin API

• 🎆 Support for PUT in new endpoints (e.g. /services/{id or name}, /routes/{id}, /consumers/{id or username}), allowing the development of idempotent configuration workflows when scripting the Admin API. #3416
• Support for PATCH and DELETE on the /services/{name}, /consumers/{username}, and /snis/{name} endpoints. #3416

Fixes

Configuration

• Properly support IPv6 addresses in proxy_listen and admin_listen configuration properties. #3508

Core

• IPv6 nameservers with a scope are now ignored by the DNS resolver. #3478
• SRV records without a port number now returns the default port instead of 0. #3478
• Ensure DNS-based round robin load balancing starts at a randomized position to prevent all Nginx workers from starting with the same peer. #3478
• Properly report timeouts in passive health checks. Previously, connection timeouts were counted as tcp_failures, and upstream timeouts were ignored. Health check users should ensure that their timeout settings reflect their intended behavior. #3539
• Ensure active health check probe requests send the Host header. #3496
• Overall, more reliable health checks healthiness counters behavior. #3496
• Do not set Content-Type headers on HTTP 204 No Content responses. #3351
• Ensure the PostgreSQL connector of the new DAO (used by Services, Routes, Consumers, and SSL certs/SNIs) is now fully re-entrant and properly behaves in busy workloads (e.g. scripting requests to the Admin API). #3423
• Properly route HTTP/1.0 requests without a Host header when using the old deprecated "API" entity. #3438
• Ensure that all Kong-produced errors respect the headers configuration setting (previously server_tokens) and do not include the Server header if not configured. #3511
• Harden an existing Cassandra migration. #3532
• Prevent the load balancer from needlessly rebuilding its state when creating Targets. #3477
• Prevent some harmless error logs to be printed during startup when initialization takes more than a few seconds. #3443

Plugins

• hmac: Ensure that empty request bodies do not pass validation if there is no digest header. Thanks @mvanholsteijn for the patch! #3347
• response-transformer: Prevent the plugin from throwing an error when its access handler did not get a chance to run (e.g. on short-circuited, unauthorized requests). #3524
• aws-lambda: Ensure logging plugins subsequently run when this plugin terminates. #3512
• request-termination: Ensure logging plugins subsequently run when this plugin terminates. #3513

Admin API

• Requests to /healthy and /unhealthy endpoints for upstream health checks now properly propagate the new state to other nodes of a Kong cluster. #3464
• Do not produce an HTTP 500 error when POST-ing to /services with an empty url argument. #3452
• Ensure foreign keys are required when creating child entities (e.g. service.id when creating a Route). Previously some rows could have an empty service_id field. #3548
• Better type inference in new endpoints (e.g. /services, /routes, /consumers) when using application/x-www-form-urlencoded MIME type. #3416

Back to TOC

0.13.1 - 2018/04/23

This release contains numerous bug fixes and a few convenience features. Notably, a best-effort/backwards-compatible approach is followed to resolve no memory errors caused by the fragmentation of shared memory between the core and plugins.

Added

Core

• Cache misses are now stored in a separate shared memory zone from hits if such a zone is defined. This reduces cache turnover and can increase the cache hit ratio quite considerably. Users with a custom Nginx template are advised to define such a zone to benefit from this behavior: lua_shared_dict kong_db_cache_miss 12m;.
• We now ensure that the Cassandra or PostgreSQL instance Kong is connecting to falls within the supported version range. Deprecated versions result in warning logs. As a reminder, Kong 0.13.x supports Cassandra 2.2+, and PostgreSQL 9.5+. Cassandra 2.1 and PostgreSQL 9.4 are supported, but deprecated. #3310
• HTTP 494 errors thrown by Nginx are now caught by Kong and produce a native, Kong-friendly response. Thanks @ti-mo for the contribution! #3112

CLI

• Report errors when compiling custom Nginx templates. #3294

Admin API

• Friendlier behavior of Routes schema validation: PATCH requests can be made without specifying all three of methods, hosts, or paths if at least one of the three is specified in the body. #3364

Plugins

• jwt: Support for identity providers using JWKS by ensuring the config.key_claim_name values is looked for in the token header. Thanks @brycehemme for the contribution! #3313
• basic-auth: Allow specifying empty passwords. Thanks @zhouzhuojie and @perryao for the contributions! #3243

Fixed

Core

• Numerous users have reported no memory errors which were caused by circumstantial memory fragmentation. Such errors, while still possible if plugin authors are not careful, should now mostly be addressed. #3311

  If you are using a custom Nginx template, be sure to define the following shared memory zones to benefit from these fixes:

  lua_shared_dict kong_db_cache_miss 12m;
  lua_shared_dict kong_rate_limiting_counters 12m;
  

CLI

• Redirect Nginx's stdout and stderr output to kong start when nginx_daemon is enabled (such as when using the Kong Docker image). This also prevents growing log files when Nginx redirects logs to /dev/stdout and /dev/stderr but nginx_daemon is disabled. #3297

Admin API

• Set a Service's port to 443 when the url convenience parameter uses the https:// scheme. #3358
• Ensure PATCH requests do not return an error when un-setting foreign key fields with JSON null. #3355
• Ensure the /plugin/schema/:name endpoint does not corrupt plugins' schemas. #3348
• Properly URL-decode path segments of plugins endpoints accepting spaces (e.g. /consumers/<consumer>/basic-auth/John%20Doe/). #3250
• Properly serialize boolean filtering values when using Cassandra. #3362

Plugins

• rate-limiting/response-rate-limiting:
  • If defined in the Nginx configuration, will use a dedicated lua_shared_dict instead of using the kong_cache shared memory zone. This prevents memory fragmentation issues resulting in no memory errors observed by numerous users. Users with a custom Nginx template are advised to define such a zone to benefit from this fix: lua_shared_dict kong_rate_limiting_counters 12m;. #3311
  • When using the Redis strategy, ensure the correct Redis database is selected. This issue could occur when several request and response rate-limiting were configured using different Redis databases. Thanks @mengskysama for the patch! #3293
• key-auth: Respect request MIME type when re-encoding the request body if both config.key_in_body and config.hide_credentials are enabled. Thanks @p0pr0ck5 for the patch! #3213
• oauth2: Return HTTP 400 on invalid scope type. Thanks @Gman98ish for the patch! #3206
• ldap-auth: Ensure the plugin does not throw errors when configured as a global plugin. #3354
• hmac-auth: Verify signature against non-normalized ($request_uri) request line (instead of $uri). #3339
• aws-lambda: Fix a typo in upstream headers sent to the function. We now properly send the X-Amz-Log-Type header. #3398

Back to TOC

0.13.0 - 2018/03/22

This release introduces two new core entities that will improve the way you configure Kong: Routes & Services. Those entities replace the "API" entity and simplify the setup of non-naive use-cases by providing better separation of concerns and allowing for plugins to be applied to specific endpoints.

As usual, major version upgrades require database migrations and changes to the Nginx configuration file (if you customized the default template). Please take a few minutes to read the 0.13 Upgrade Path for more details regarding breaking changes and migrations before planning to upgrade your Kong cluster.

Breaking Changes

Configuration

• ⚠️ The proxy_listen and admin_listen configuration values have a new syntax. This syntax is more aligned with that of NGINX and is more powerful while also simpler. As a result, the following configuration values have been removed because superfluous: ssl, admin_ssl, http2, admin_http2, proxy_listen_ssl, and admin_listen_ssl. #3147

Plugins

• ⚠️ galileo: As part of the Galileo deprecation path, the galileo plugin is not enabled by default anymore, although still bundled with 0.13. Users are advised to stop using the plugin, but for the time being can keep enabling it by adding it to the custom_plugin configuration value. #3233
• ⚠️ rate-limiting (Cassandra): The default migration for including Routes and Services in plugins will remove and re-create the Cassandra rate-limiting counters table. This means that users that were rate-limited because of excessive API consumption will be able to consume the API until they reach their limit again. There is no such data deletion in PostgreSQL. def201f

Changes

Dependencies

• Note to Docker users: The latest tag on Docker Hub now points to the alpine image instead of CentOS. This also applies to the 0.13.0 tag.
• The OpenResty version shipped with our default packages has been bumped to 1.13.6.1. The 0.13.0 release should still be compatible with the OpenResty 1.11.2.x series for the time being.
• Bumped lua-resty-dns-client to 2.0.0. #3220
• Bumped lua-resty-http to 0.12. #3196
• Bumped lua-multipart to 0.5.5. #3318
• Bumped lua-resty-healthcheck to 0.4.0. #3321

Additions

Configuration

• 🎆 Support for control-plane and data-plane modes. The new syntax of proxy_listen and admin_listen supports off, which disables either one of those interfaces. It is now simpler than ever to make a Kong node "Proxy only" (data-plane) or "Admin only" (control-plane). #3147

Core

• 🎆 This release introduces two new entities: Routes and Services. Those entities will provide a better separation of concerns than the "API" entity offers. Routes will define rules for matching a client's request (e.g., method, host, path...), and Services will represent upstream services (or backends) that Kong should proxy those requests to. Plugins can also be added to both Routes and Services, enabling use-cases to apply plugins more granularly (e.g., per endpoint). Following this addition, the API entity and related Admin API endpoints are now deprecated. This release is backwards-compatible with the previous model and all of your currently defined APIs and matching rules are still supported, although we advise users to migrate to Routes and Services as soon as possible. #3224

Admin API

• 🎆 New endpoints: /routes and /services to interact with the new core entities. More specific endpoints are also available such as /services/{service id or name}/routes, /services/{service id or name}/plugins, and /routes/{route id}/plugins. #3224
• 🎆 Our new endpoints (listed above) provide much better responses with regards to producing responses for incomplete entities, errors, etc... In the future, existing endpoints will gradually be moved to using this new Admin API content producer. #3224
• 🎆 Improved argument parsing in form-urlencoded requests to the new endpoints as well. Kong now expects the following syntaxes for representing arrays: hosts[]=a.com&hosts[]=b.com, hosts[1]=a.com&hosts[2]=b.com, which avoid comma-separated arrays and related issues that can arise. In the future, existing endpoints will gradually be moved to using this new Admin API content parser. #3224

Plugins

• jwt: ngx.ctx.authenticated_jwt_token is available for other plugins to use. #2988
• statsd: The fields host, port and metrics are no longer marked as "required", since they have a default value. #3209

Fixes

Core

• Fix an issue causing nodes in a cluster to use the default health checks configuration when the user configured them from another node (event propagated via the cluster). #3319
• Increase the default load balancer wheel size from 100 to 10.000. This allows for a better distribution of the load between Targets in general. #3296

Admin API

• Fix several issues with application/multipart MIME type parsing of payloads. #3318
• Fix several issues with the parsing of health checks configuration values. #3306 #3321

Back to TOC

0.12.3 - 2018/03/12

Fixed

• Suppress a memory leak in the core introduced in 0.12.2. Thanks @mengskysama for the report. #3278

Back to TOC

0.12.2 - 2018/02/28

Added

Core

• Load balancers now log DNS errors to facilitate debugging. #3177
• Reports now can include custom immutable values. #3180

CLI

• The kong migrations reset command has a new --yes flag. This flag makes the command run non-interactively, and ensures no confirmation prompt will occur. #3189

Admin API

• A new endpoint /upstreams/:upstream_id/health will return the health of the specified upstream. #3232
• The / endpoint in the Admin API now exposes the node_id field. #3234

Fixed

Core

• HTTP/1.0 requests without a Host header are routed instead of being rejected. HTTP/1.1 requests without a Host are considered invalid and will still be rejected. Thanks to @rainiest for the patch! #3216
• Fix the load balancer initialization when some Targets would contain hostnames. #3187
• Fix incomplete handling of errors when initializing DAO objects. 637532e
• Remove bogus errors in the logs provoked by healthcheckers between the time they are unregistered and the time they are garbage-collected (#3207) and when receiving an HTTP status not tracked by healthy or unhealthy lists (c8eb5ae).
• Fix soft errors not being handled correctly inside the Kong cache. #3150

Migrations

• Better handling of already existing Cassandra keyspaces in migrations. #3203. Thanks to @pamiel for the patch!

Admin API

• Ensure GET /certificates/{uuid} does not return HTTP 500 when the given identifier does not exist. Thanks to @vdesjardins for the patch! #3148

Back to TOC

0.12.1 - 2018/01/18

This release addresses a few issues encountered with 0.12.0, including one which would prevent upgrading from a previous version. The 0.12 Upgrade Path is still relevant for upgrading existing clusters to 0.12.1.

Fixed

• Fix a migration between previous Kong versions and 0.12.0. #3159
• Ensure Lua errors are propagated when thrown in the access handler by plugins. 38580ff

Back to TOC

0.12.0 - 2018/01/16

This major release focuses on two new features we are very excited about: health checks and hash based load balancing!

We also took this as an opportunity to fix a few prominent issues, sometimes at the expense of breaking changes but overall improving the flexibility and usability of Kong! Do keep in mind that this is a major release, and as such, that we require of you to run the migrations step, via the kong migrations up command.

Please take a few minutes to thoroughly read the 0.12 Upgrade Path for more details regarding breaking changes and migrations before planning to upgrade your Kong cluster.

Deprecation notices

Starting with 0.12.0, we are announcing the deprecation of older versions of our supported databases:

• Support for PostgreSQL 9.4 is deprecated. Users are advised to upgrade to 9.5+
• Support for Cassandra 2.1 and below is deprecated. Users are advised to upgrade to 2.2+

Note that the above deprecated versions are still supported in this release, but will be dropped in subsequent ones.

Breaking changes

Core

• ⚠️ The required OpenResty version has been bumped to 1.11.2.5. If you are installing Kong from one of our distribution packages, you are not affected by this change. #3097
• ⚠️ As Kong now executes subsequent plugins when a request is being short-circuited (e.g. HTTP 401 responses from auth plugins), plugins that run in the header or body filter phases will be run upon such responses from the access phase. We consider this change a big improvement in the Kong run-loop as it allows for more flexibility for plugins. However, it is unlikely, but possible that some of these plugins (e.g. your custom plugins) now run in scenarios where they were not previously expected to run. #3079

Admin API

• ⚠️ By default, the Admin API now only listens on the local interface. We consider this change to be an improvement in the default security policy of Kong. If you are already using Kong, and your Admin API still binds to all interfaces, consider updating it as well. You can do so by updating the admin_listen configuration value, like so: admin_listen = 127.0.0.1:8001. Thanks @pduldig-at-tw for the suggestion and the patch. #3016

  🔴 Note to Docker users: Beware of this change as you may have to ensure that your Admin API is reachable via the host's interface. You can use the -e KONG_ADMIN_LISTEN argument when provisioning your container(s) to update this value; for example, -e KONG_ADMIN_LISTEN=0.0.0.0:8001.

• ⚠️ To reduce confusion, the /upstreams/:upstream_name_or_id/targets/ has been updated to not show the full list of Targets anymore, but only the ones that are currently active in the load balancer. To retrieve the full history of Targets, you can now query /upstreams/:upstream_name_or_id/targets/all. The /upstreams/:upstream_name_or_id/targets/active endpoint has been removed. Thanks @hbagdi for tackling this backlog item! #3049

• ⚠️ The orderlist property of Upstreams has been removed, along with any confusion it may have brought. The balancer is now able to fully function without it, yet with the same level of entropy in its load distribution. #2748

CLI

• ⚠️ The $ kong compile command which was deprecated in 0.11.0 has been removed. #3069

Plugins

• ⚠️ In logging plugins, the request.request_uri field has been renamed to request.url. #2445 #3098

Added

Core

• 🎆 Support for health checks! Kong can now short-circuit some of your upstream Targets (replicas) from its load balancer when it encounters too many TCP or HTTP errors. You can configure the number of failures, or the HTTP status codes that should be considered invalid, and Kong will monitor the failures and successes of proxied requests to each upstream Target. We call this feature passive health checks. Additionally, you can configure active health checks, which will make Kong perform periodic HTTP test requests to actively monitor the health of your upstream services, and pre-emptively short-circuit them. Upstream Targets can be manually taken up or down via two new Admin API endpoints: /healthy and /unhealthy. #3096
• 🎆 Support for hash based load balancing! Kong now offers consistent hashing/sticky sessions load balancing capabilities via the new hash_* attributes of the Upstream entity. Hashes can be based off client IPs, request headers, or Consumers! #2875
• 🎆 Logging plugins now log requests that were short-circuited by Kong! (e.g. HTTP 401 responses from auth plugins or HTTP 429 responses from rate limiting plugins, etc.) Kong now executes any subsequent plugins once a request has been short-circuited. Your plugin must be using the kong.tools.responses module for this behavior to be respected. #3079
• Kong is now compatible with OpenResty up to version 1.13.6.1. Be aware that the recommended (and default) version shipped with this release is still 1.11.2.5. #3070

CLI

• $ kong start now considers the commonly used /opt/openresty prefix when searching for the nginx executable. #3074

Admin API

• Two new endpoints, /healthy and /unhealthy can be used to manually bring upstream Targets up or down, as part of the new health checks feature of the load balancer. #3096

Plugins

• logging plugins: A new field upstream_uri now logs the value of the upstream request's path. This is useful to help debugging plugins or setups that aim at rewriting a request's URL during proxying. Thanks @shiprabehera for the patch! #2445
• tcp-log: Support for TLS handshake with the logs recipients for secure transmissions of logging data. #3091
• jwt: Support for JWTs passed in cookies. Use the new config.cookie_names property to configure the behavior to your liking. Thanks @mvanholsteijn for the patch! #2974
• oauth2
  • New config.auth_header_name property to customize the authorization header's name. Thanks @supraja93 #2928
  • New config.refresh_ttl property to customize the TTL of refresh tokens, previously hard-coded to 14 days. Thanks @bob983 for the patch! #2942
  • Avoid an error in the logs when trying to retrieve an access token from a request without a body. Thanks @WALL-E for the patch. #3063
• ldap: New config.header_type property to customize the authorization method in the Authorization header. Thanks @francois-maillard for the patch! #2963

Fixed

CLI

• Fix a potential vulnerability in which an attacker could read the Kong configuration file with insufficient permissions for a short window of time while Kong is being started. #3057
• Proper log message upon timeout in $ kong quit. #3061

Admin API

• The /certificates endpoint now properly supports the snis parameter in PUT and PATCH requests. Thanks @hbagdi for the contribution! #3040
• Avoid sending the HTTP/1.1 415 Unsupported Content Type response when receiving a request with a valid Content-Type, but with an empty payload. #3077

Plugins

• basic-auth:
  • Accept passwords containing :. Thanks @nico-acidtango for the patch! #3014
  • Performance improvements, courtesy of @nico-acidtango #3014

Back to TOC

0.11.2 - 2017/11/29

Added

Plugins

• key-auth: New endpoints to manipulate API keys. Thanks @hbagdi for the contribution. #2955
  • /key-auths/ to paginate through all keys.
  • /key-auths/:credential_key_or_id/consumer to retrieve the Consumer associated with a key.
• basic-auth: New endpoints to manipulate basic-auth credentials. Thanks @hbagdi for the contribution. #2998
  • /basic-auths/ to paginate through all basic-auth credentials.
  • /basic-auths/:credential_username_or_id/consumer to retrieve the Consumer associated with a credential.
• jwt: New endpoints to manipulate JWTs. Thanks @hbagdi for the contribution. #3003
  • /jwts/ to paginate through all JWTs.
  • /jwts/:jwt_key_or_id/consumer to retrieve the Consumer associated with a JWT.
• hmac-auth: New endpoints to manipulate hmac-auth credentials. Thanks @hbagdi for the contribution. #3009
  • /hmac-auths/ to paginate through all hmac-auth credentials.
  • /hmac-auths/:hmac_username_or_id/consumer to retrieve the Consumer associated with a credential.
• acl: New endpoints to manipulate ACLs. Thanks @hbagdi for the contribution. #3039
  • /acls/ to paginate through all ACLs.
  • /acls/:acl_id/consumer to retrieve the Consumer associated with an ACL.

Fixed

Core

• Avoid logging some unharmful error messages related to clustering. #3002
• Improve performance and memory footprint when parsing multipart request bodies. Kong/lua-multipart#13

Configuration

• Add a format check for the admin_listen_ssl property, ensuring it contains a valid port. #3031

Admin API

• PUT requests with payloads containing non-existing primary keys for entities now return HTTP 404 Not Found, instead of HTTP 200 OK without a response body. #3007
• On the / endpoint, ensure enabled_in_cluster shows up as an empty JSON Array ([]), instead of an empty JSON Object ({}). Thanks @hbagdi for the patch! #2982

Plugins

• hmac-auth: Better parsing of the Authorization header to avoid internal errors resulting in HTTP 500. Thanks @mvanholsteijn for the patch! #2996
• Improve the performance of the rate-limiting and response-rate-limiting plugins when using the Redis policy. #2956
• Improve the performance of the response-transformer plugin. #2977

0.11.1 - 2017/10/24

Changed

Configuration

• Drop the lua_code_cache configuration property. This setting has been considered harmful since 0.11.0 as it interferes with Kong's internals. #2854

Fixed

Core

• DNS: SRV records pointing to an A record are now properly handled by the load balancer when preserve_host is disabled. Such records used to throw Lua errors on the proxy code path. Kong/lua-resty-dns-client#19
• Fixed an edge-case where preserve_host would sometimes craft an upstream request with a Host header from a previous client request instead of the current one. #2832
• Ensure APIs with regex URIs are evaluated in the order that they are created. #2924
• Fixed a typo that caused the load balancing components to ignore the Upstream slots property. #2747

CLI

• Fixed the verification of self-signed SSL certificates for PostgreSQL and Cassandra in the kong migrations command. Self-signed SSL certificates are now properly verified during migrations according to the lua_ssl_trusted_certificate configuration property. #2908

Admin API

• The /upstream/{upstream}/targets/active endpoint used to return HTTP 405 Method Not Allowed when called with a trailing slash. Both notations (with and without the trailing slash) are now supported. #2884

Plugins

• bot-detection: Fixed an issue which would prevent the plugin from running and result in an HTTP 500 error if configured globally. #2906
• ip-restriction: Fixed support for the 0.0.0.0/0 CIDR block. This block is now supported and won't trigger an error when used in this plugin's properties. #2918

Added

Plugins

• aws-lambda: Added support to forward the client request's HTTP method, headers, URI, and body to the Lambda function. #2823
• key-auth: New run_on_preflight configuration option to control authentication on preflight requests. #2857
• jwt: New run_on_preflight configuration option to control authentication on preflight requests. #2857

Plugin development

• Ensure migrations have valid, unique names to avoid conflicts between custom plugins. Thanks @ikogan for the patch! #2821

Improved

Migrations & Deployments

• Improve migrations reliability for future major releases. #2869

Plugins

• Improve the performance of the acl and oauth2 plugins. #2736 #2806

Back to TOC

0.10.4 - 2017/10/24

Fixed

Core

• DNS: SRV records pointing to an A record are now properly handled by the load balancer when preserve_host is disabled. Such records used to throw Lua errors on the proxy code path. Kong/lua-resty-dns-client#19
• HTTP 400 errors thrown by Nginx are now correctly caught by Kong and return a native, Kong-friendly response. #2476
• Fix an edge-case where an API with multiple uris and strip_uri = true would not always strip the client URI. #2562
• Fix an issue where Kong would match an API with a shorter URI (from its uris value) as a prefix instead of a longer, matching prefix from another API. #2662
• Fixed a typo that caused the load balancing components to ignore the Upstream slots property. #2747

Configuration

• Octothorpes (#) can now be escaped (\#) and included in the Kong configuration values such as your datastore passwords or usernames. #2411

Admin API

• The data response field of the /upstreams/{upstream}/targets/active Admin API endpoint now returns a list ([]) instead of an object ({}) when no active targets are present. #2619

Plugins

• datadog: Avoid a runtime error if the plugin is configured as a global plugin but the downstream request did not match any configured API. Thanks @kjsteuer for the fix! #2702
• ip-restriction: Fixed support for the 0.0.0.0/0 CIDR block. This block is now supported and won't trigger an error when used in this plugin's properties. #2918

Back to TOC

0.11.0 - 2017/08/16

The latest and greatest version of Kong features improvements all over the board for a better and easier integration with your infrastructure!

The highlights of this release are:

• Support for regex URIs in routing, one of the oldest requested features from the community.
• Support for HTTP/2 traffic from your clients.
• Kong does not depend on Serf anymore, which makes deployment and networking requirements considerably simpler.
• A better integration with orchestration tools thanks to the support for non FQDNs in Kong's DNS resolver.

As per usual, our major releases include datastore migrations which are considered breaking changes. Additionally, this release contains numerous breaking changes to the deployment process and proxying behavior that you should be familiar with.

We strongly advise that you read this changeset thoroughly, as well as the 0.11 Upgrade Path if you are planning to upgrade a Kong cluster.

Breaking changes

Configuration

• ⚠️ Numerous updates were made to the Nginx configuration template. If you are using a custom template, you must apply those modifications. See the 0.11 Upgrade Path for a complete list of changes to apply.

Migrations & Deployment

• ⚠️ Migrations are not executed automatically by kong start anymore. Migrations are now a manual process, which must be executed via the kong migrations command. In practice, this means that you have to run kong migrations up [-c kong.conf] in one of your nodes before starting your Kong nodes. This command should be run from a single node/container to avoid several nodes running migrations concurrently and potentially corrupting your database. Once the migrations are up-to-date, it is considered safe to start multiple Kong nodes concurrently. #2421
• ⚠️ 🎆 Serf is not a dependency anymore. Kong nodes now handle cache invalidation events via a built-in database polling mechanism. See the new "Datastore Cache" section of the configuration file which contains 3 new documented properties: db_update_frequency, db_update_propagation, and db_cache_ttl. If you are using Cassandra, you should pay a particular attention to the db_update_propagation setting, as you should not use the default value of 0. #2561

Core

• ⚠️ Kong now requires OpenResty 1.11.2.4. OpenResty's LuaJIT can now be built with Lua 5.2 compatibility. #2489 #2790
• ⚠️ Previously, the X-Forwarded-* and X-Real-IP headers were trusted from any client by default, and forwarded upstream. With the introduction of the new trusted_ips property (see the below "Added" section) and to enforce best security practices, Kong does not trust any client IP address by default anymore. This will make Kong not forward incoming X-Forwarded-* headers if not coming from configured, trusted IP addresses blocks. This setting also affects the API check_https field, which itself relies on trusted X-Forwarded-Proto headers only. #2236
• ⚠️ The API Object property http_if_terminated is now set to false by default. For Kong to evaluate the client X-Forwarded-Proto header, you must now configure Kong to trust the client IP (see above change), and you must explicitly set this value to true. This affects you if you are doing SSL termination somewhere before your requests hit Kong, and if you have configured https_only on the API, or if you use a plugin that requires HTTPS traffic (e.g. OAuth2). #2588
• ⚠️ The internal DNS resolver now honours the search and ndots configuration options of your resolv.conf file. Make sure that DNS resolution is still consistent in your environment, and consider eventually not using FQDNs anymore. #2425

Admin API

• ⚠️ As a result of the Serf removal, Kong is now entirely stateless, and as such, the /cluster endpoint has disappeared. #2561
• ⚠️ The Admin API /status endpoint does not return a count of the database entities anymore. Instead, it now returns a database.reachable boolean value, which reflects the state of the connection between Kong and the underlying database. Please note that this flag does not reflect the health of the database itself. #2567

Plugin development

• ⚠️ The upstream URI is now determined via the Nginx $upstream_uri variable. Custom plugins using the ngx.req.set_uri() API will not be taken into consideration anymore. One must now set the ngx.var.upstream_uri variable from the Lua land. #2519
• ⚠️ The hooks.lua module for custom plugins is dropped, along with the database_cache.lua module. Database entities caching and eviction has been greatly improved to simplify and automate most caching use-cases. See the Plugins Development Guide and the 0.11 Upgrade Path for more details. #2561
• ⚠️ To ensure that the order of execution of plugins is still the same for vanilla Kong installations, we had to update the PRIORITY field of some of our bundled plugins. If your custom plugin must run after or before a specific bundled plugin, you might have to update your plugin's PRIORITY field as well. The complete list of plugins and their priorities is available on the Plugins Development Guide. #2489 #2813

Deprecated

CLI

• The kong compile command has been deprecated. Instead, prefer using the new kong prepare command. #2706

Changed

Core

• Performance around DNS resolution has been greatly improved in some cases. #2625
• Secret values are now generated with a kernel-level, Cryptographically Secure PRNG. #2536
• The .kong_env file created by Kong in its running prefix is now written without world-read permissions. #2611

Plugin development

• The marshall_event function on schemas is now ignored by Kong, and can be safely removed as the new cache invalidation mechanism natively handles safer events broadcasting. #2561

Added

Core

• 🎆 Support for regex URIs! You can now define regexes in your APIs uris property. Those regexes can have capturing groups which can be extracted by Kong during a request, and accessed later in the plugins (useful for URI rewriting). See the Proxy Guide for documentation on how to use regex URIs. #2681
• 🎆 Support for HTTP/2. A new http2 directive now enables HTTP/2 traffic on the proxy_listen_ssl address. #2541
• 🎆 Support for the search and ndots configuration options of your resolv.conf file. #2425
• Kong now forwards new headers to your upstream services: X-Forwarded-Host, X-Forwarded-Port, and X-Forwarded-Proto. #2236
• Support for the PROXY protocol. If the new real_ip_header configuration property is set to real_ip_header = proxy_protocol, then Kong will append the proxy_protocol parameter to the Nginx listen directive of the Kong proxy port. #2236
• Support for BDR compatibility in the PostgreSQL migrations. Thanks @AlexBloor for the patch! #2672

Configuration

• Support for DNS nameservers specified in IPv6 format. #2634
• A few new DNS configuration properties allow you to tweak the Kong DNS resolver, and in particular, how it handles the resolution of different record types or the eviction of stale records. #2625
• A new trusted_ips configuration property allows you to define a list of trusted IP address blocks that are known to send trusted X-Forwarded-* headers. Requests from trusted IPs will make Kong forward those headers upstream. Requests from non-trusted IP addresses will make Kong override the X-Forwarded-* headers with its own values. In addition, this property also sets the ngx_http_realip_module set_real_ip_from directive(s), which makes Kong trust the incoming X-Real-IP header as well, which is used for operations such as rate-limiting by IP address, and that Kong forwards upstream as well. #2236
• You can now configure the ngx_http_realip_module from the Kong configuration. In addition to trusted_ips which sets the set_real_ip_from directives(s), two new properties, real_ip_header and real_ip_recursive allow you to configure the ngx_http_realip_module directives bearing the same name. #2236
• Ability to hide Kong-specific response headers. Two new configuration fields: server_tokens and latency_tokens will respectively toggle whether the Server and X-Kong-*-Latency headers should be sent to downstream clients. #2259
• New configuration property to tune handling request body data via the client_max_body_size and client_body_buffer_size directives (mirroring their Nginx counterparts). Note these settings are only defined for proxy requests; request body handling in the Admin API remains unchanged. #2602
• New error_default_type configuration property. This setting is to specify a MIME type that will be used as the error response body format when Nginx encounters an error, but no Accept header was present in the request. The default value is text/plain for backwards compatibility. Thanks @therealgambo for the contribution! #2500
• New nginx_user configuration property, which interfaces with the Nginx user directive. Thanks @depay for the contribution! #2180

CLI

• New kong prepare command to prepare the Kong running prefix (creating log files, SSL certificates, etc...) and allow for Kong to be started via the nginx binary. This is useful for environments like containers, where the foreground process should be the Nginx master process. The kong compile command has been deprecated as a result of this addition. #2706

Admin API

• Ability to retrieve plugins added to a Consumer via two new endpoints: /consumers/:username_or_id/plugins/ and /consumers/:username_or_id/plugins/:plugin_id. #2714
• Support for JSON null in PATCH requests to unset a value on any entity. #2700

Plugins

• jwt: Support for RS512 signed tokens. Thanks @sarraz1 for the patch! #2666
• rate-limiting/response-ratelimiting: Optionally hide informative response headers. #2087
• aws-lambda: Define a custom response status when the upstream X-Amz-Function-Error header is "Unhandled". Thanks @erran for the contribution! #2587
• aws-lambda: Add new AWS regions that were previously unsupported. #2769
• hmac: New option to validate the client-provided SHA-256 of the request body. Thanks @vaibhavatul47 for the contribution! #2419
• hmac: Added support for enforce_headers option and added HMAC-SHA256, HMAC-SHA384, and HMAC-SHA512 support. #2644
• statsd: New metrics and more flexible configuration. Support for prefixes, configurable stat type, and added metrics. #2400
• datadog: New metrics and more flexible configuration. Support for prefixes, configurable stat type, and added metrics. #2394

Fixed

Core

• Kong now ensures that your clients URIs are transparently proxied upstream. No percent-encoding/decoding or querystring stripping will occur anymore. #2519
• Fix an issue where Kong would match an API with a shorter URI (from its uris value) as a prefix instead of a longer, matching prefix from another API. #2662
• Fix an edge-case where an API with multiple uris and strip_uri = true would not always strip the client URI. #2562
• HTTP 400 errors thrown by Nginx are now correctly caught by Kong and return a native, Kong-friendly response. #2476

Configuration

• Octothorpes (#) can now be escaped (\#) and included in the Kong configuration values such as your datastore passwords or usernames. #2411

Admin API

• The data response field of the /upstreams/{upstream}/targets/active Admin API endpoint now returns a list ([]) instead of an object ({}) when no active targets are present. #2619

Plugins

• The unique constraint on OAuth2 client_secrets has been removed. #2447
• The unique constraint on JWT Credentials secrets has been removed. #2548
• oauth2: When requesting a token from /oauth2/token, one can now pass the client_id as a request body parameter, while client_id:client_secret is passed via the Authorization header. This allows for better integration with some OAuth2 flows proposed out there, such as from Cloudflare Apps. Thanks @cedum for the patch! #2577
• datadog: Avoid a runtime error if the plugin is configured as a global plugin but the downstream request did not match any configured API. Thanks @kjsteuer for the fix! #2702
• Logging plugins: the produced logs latencies.kong field used to omit the time Kong spent in its Load Balancing logic, which includes DNS resolution time. This latency is now included in latencies.kong. #2494

Back to TOC

0.10.3 - 2017/05/24

Changed

• We noticed that some distribution packages were not building OpenResty against a JITable PCRE library. This happened on Ubuntu and RHEL environments where OpenResty was built against the system's PCRE installation. We now compile OpenResty against a JITable PCRE source for those platforms, which should result in significant performance improvements in regex matching. Mashape/kong-distributions #9
• TLS connections are now handled with a modern list of accepted ciphers, as per the Mozilla recommended TLS ciphers list. See https://wiki.mozilla.org/Security/Server_Side_TLS. This behavior is configurable via the newly introduced configuration properties described in the below "Added" section.
• Plugins:
  • rate-limiting: Performance improvements when using the cluster policy. The number of round trips to the database has been limited to the number of configured limits. #2488

Added

• New ssl_cipher_suite and ssl_ciphers configuration properties to configure the desired set of accepted ciphers, based on the Mozilla recommended TLS ciphers list. #2555
• New proxy_ssl_certificate and proxy_ssl_certificate_key configuration properties. These properties configure the Nginx directives bearing the same name, to set client certificates to Kong when connecting to your upstream services. #2556
• Proxy and Admin API access and error log paths are now configurable. Access logs can be entirely disabled if desired. #2552
• Plugins:
  • Logging plugins: The produced logs include a new tries field which contains, which includes the upstream connection successes and failures of the load-balancer. #2429
  • key-auth: Credentials can now be sent in the request body. #2493
  • cors: Origins can now be defined as regular expressions. #2482

Fixed

• APIs matching: prioritize APIs with longer uris when said APIs also define hosts and/or methods as well. Thanks @leonzz for the patch. #2523
• SSL connections to Cassandra can now properly verify the certificate in use (when cassandra_ssl_verify is enabled). #2531
• The DNS resolver no longer sends a A or AAAA DNS queries for SRV records. This should improve performance by avoiding unnecessary lookups. #2563 & Mashape/lua-resty-dns-client #12
• Plugins
  • All authentication plugins don't throw an error anymore when invalid credentials are given and the anonymous user isn't configured. #2508
  • rate-limiting: Effectively use the desired Redis database when the redis policy is in use and the config.redis_database property is set. #2481
  • cors: The regression introduced in 0.10.1 regarding not sending the * wildcard when conf.origin was not specified has been fixed. #2518
  • oauth2: properly check the client application ownership of a token before refreshing it. #2461

Back to TOC

0.10.2 - 2017/05/01

Changed

• The Kong DNS resolver now honors the MAXNS setting (3) when parsing the nameservers specified in resolv.conf. #2290
• Kong now matches incoming requests via the $request_uri property, instead of $uri, in order to better handle percent-encoded URIS. A more detailed explanation will be included in the below "Fixed" section. #2377
• Upstream calls do not unconditionally include a trailing / anymore. See the below "Added" section for more details. #2315
• Admin API:
  • The "active targets" endpoint now only return the most recent nonzero weight Targets, instead of all nonzero weight targets. This is to provide a better picture of the Targets currently in use by the Kong load balancer. #2310

Added

• 🎆 Plugins can implement a new rewrite handler to execute code in the Nginx rewrite phase. This phase is executed prior to matching a registered Kong API, and prior to any authentication plugin. As such, only global plugins (neither tied to an API or Consumer) will execute this phase. #2354
• Ability for the client to chose whether the upstream request (Kong <-> upstream) should contain a trailing slash in its URI. Prior to this change, Kong 0.10 would unconditionally append a trailing slash to all upstream requests. The added functionality is described in #2211, and was implemented in #2315.
• Ability to hide Kong-specific response headers. Two new configuration fields: server_tokens and latency_tokens will respectively toggle whether the Server and X-Kong-*-Latency headers should be sent to downstream clients. #2259
• New cassandra_schema_consensus_timeout configuration property, to allow for Kong to wait for the schema consensus of your Cassandra cluster during migrations. #2326
• Serf commands executed by a running Kong node are now logged in the Nginx error logs with a DEBUG level. #2410
• Ensure the required shared dictionaries are defined in the Nginx configuration. This will prevent custom Nginx templates from potentially resulting in a breaking upgrade for users. #2466
• Admin API:
  • Target Objects can now be deleted with their ID as well as their name. The endpoint becomes: /upstreams/:name_or_id/targets/:target_or_id. #2304
• Plugins:
  • 🎆 New Request termination plugin. This plugin allows to temporarily disable an API and return a pre-configured response status and body to your client. Useful for use-cases such as maintenance mode for your upstream services. Thanks to @pauldaustin for the contribution. #2051
  • Logging plugins: The produced logs include two new fields: a consumer field, which contains the properties of the authenticated Consumer (id, custom_id, and username), if any, and a tries field, which includes the upstream connection successes and failures of the load- balancer. #2367 #2429
  • http-log: Now set an upstream HTTP basic access authentication header if the configured conf.http_endpoint parameter includes an authentication section. Thanks @amir for the contribution. #2432
  • file-log: New config.reopen property to close and reopen the log file on every request, in order to effectively rotate the logs. #2348
  • jwt: Returns 401 Unauthorized on invalid claims instead of the previous 403 Forbidden status. #2433
  • key-auth: Allow setting API key header names with an underscore. #2370
  • cors: When config.credentials = true, we do not send an ACAO header with value *. The ACAO header value will be that of the request's Origin: header. #2451

Fixed

• Upstream connections over TLS now set their Client Hello SNI field. The SNI value is taken from the upstream Host header value, and thus also depends on the preserve_host setting of your API. Thanks @konrade for the original patch. #2225
• Correctly match APIs with percent-encoded URIs in their uris property. Generally, this change also avoids normalizing (and thus, potentially altering) the request URI when trying to match an API's uris value. Instead of relying on the Nginx $uri variable, we now use $request_uri. #2377
• Handle a routing edge-case under some conditions with the uris matching rule of APIs that would falsely lead Kong into believing no API was matched for what would actually be a valid request. #2343
• If no API was configured with a hosts matching rule, then the preserve_host flag would never be honored. #2344
• The X-Forwarded-For header sent to your upstream services by Kong is not set from the Nginx $proxy_add_x_forwarded_for variable anymore. Instead, Kong uses the $realip_remote_addr variable to append the real IP address of a client, instead of $remote_addr, which can come from a previous proxy hop. #2236
• CNAME records are now properly being cached by the DNS resolver. This results in a performance improvement over previous 0.10 versions. #2303
• When using Cassandra, some migrations would not be performed on the same coordinator as the one originally chosen. The same migrations would also require a response from other replicas in a cluster, but were not waiting  for a schema consensus beforehand, causing indeterministic failures in the migrations, especially if the cluster's inter-nodes communication is slow. #2326
• The cassandra_timeout configuration property is now correctly taken into consideration by Kong. #2326
• Correctly trigger plugins configured on the anonymous Consumer for anonymous requests (from auth plugins with the new config.anonymous parameter). #2424
• When multiple auth plugins were configured with the recent config.anonymous parameter for "OR" authentication, such plugins would override each other's results and response headers, causing false negatives. #2222
• Ensure the cassandra_contact_points property does not contain any port information. Those should be specified in cassandra_port. Thanks @Vermeille for the contribution. #2263
• Prevent an upstream or legitimate internal error in the load balancing code from throwing a Lua-land error as well. #2327
• Allow backwards compatibility with custom Nginx configurations that still define the resolver ${{DNS_RESOLVER}} directive. Vales from the Kong dns_resolver property will be flattened to a string and appended to the directive. #2386
• Plugins:
  • hmac: Better handling of invalid base64-encoded signatures. Previously Kong would return an HTTP 500 error. We now properly return HTTP 403 Forbidden. #2283
• Admin API:
  • Detect conflicts between SNI Objects in the /snis and /certificates endpoint. #2285
  • The /certificates route used to not return the total and data JSON fields. We now send those fields back instead of a root list of certificate objects. #2463
  • Endpoints with path parameters like /xxx_or_id will now also yield the proper result if the xxx field is formatted as a UUID. Most notably, this fixes a problem for Consumers whose username is a UUID, that could not be found when requesting /consumers/{username_as_uuid}. #2420
  • The "active targets" endpoint does not require a trailing slash anymore. #2307
  • Upstream Objects can now be deleted properly when using Cassandra. #2404

Back to TOC

0.10.1 - 2017/03/27

Changed

• ⚠️ Serf has been downgraded to version 0.7 in our distributions, although versions up to 0.8.1 are still supported. This fixes a problem when automatically detecting the first non-loopback private IP address, which was defaulted to 127.0.0.1 in Kong 0.10.0. Greater versions of Serf can still be used, but the IP address needs to be manually specified in the cluster_advertise configuration property.

• ⚠️ The CORS Plugin parameter config.origin is now config.origins. #2203

  🔴 Post-release note (as of 2017/05/12): A faulty behavior has been observed with this change. Previously, the plugin would send the * wildcard when config.origin was not specified. With this change, the plugin does not send the * wildcard by default anymore. You will need to specify it manually when configuring the plugin, with config.origins=*. This behavior is to be fixed in a future release.

  ✅ Update (2017/05/24): A fix to this regression has been released as part of 0.10.3. See the section of the Changelog related to this release for more details.

• Admin API:

  • Disable support for TLS/1.0. #2212

Added

• Admin API:
  • Active targets can be pulled with GET /upstreams/{name}/targets/active. #2230
  • Provide a convenience endpoint to disable targets at: DELETE /upstreams/{name}/targets/{target}. Under the hood, this creates a new target with weight = 0 (the correct way of disabling targets, which used to cause confusion). #2256
• Plugins:
  • cors: Support for configuring multiple Origin domains. #2203

Fixed

• Use an LRU cache for Lua-land entities caching to avoid exhausting the Lua VM memory in long-running instances. #2246
• Avoid potential deadlocks upon callback errors in the caching module for database entities. #2197
• Relax multipart MIME type parsing. A space is allowed in between values of the Content-Type header. #2215
• Admin API:
  • Better handling of non-supported HTTP methods on endpoints of the Admin API. In some cases this used to throw an internal error. Calling any endpoint with a non-supported HTTP method now always returns 405 Method Not Allowed as expected. #2213
• CLI:
  • Better error handling when missing Serf executable. #2218
  • Fix a bug in the kong migrations command that would prevent it to run correctly. #2238
  • Trim list values specified in the configuration file. #2206
  • Align the default configuration file's values to the actual, hard-coded default values to avoid confusion. #2254
• Plugins:
  • hmac: Generate an HMAC secret value if none is provided. #2158
  • oauth2: Don't try to remove credential values from request bodies if the MIME type is multipart, since such attempts would result in an error. #2176
  • ldap: This plugin should not be applied to a single Consumer, however, this was not properly enforced. It is now impossible to apply this plugin to a single Consumer (as per all authentication plugin). #2237
  • aws-lambda: Support for us-west-2 region in schema. #2257

Back to TOC

0.10.0 - 2017/03/07

Kong 0.10 is one of most significant releases to this day. It ships with exciting new features that have been heavily requested for the last few months, such as load balancing, Cassandra 3.0 compatibility, Websockets support, internal DNS resolution (A and SRV records without Dnsmasq), and more flexible matching capabilities for APIs routing.

On top of those new features, this release received a particular attention to performance, and brings many improvements and refactors that should make it perform significantly better than any previous version.

Changed

• ⚠️ API Objects (as configured via the Admin API) do not support the request_host and request_uri fields anymore. The 0.10 migrations should upgrade your current API Objects, but make sure to read the new 0.10 Proxy Guide to learn the new routing capabilities of Kong. On the good side, this means that Kong can now route incoming requests according to a combination of Host headers, URIs, and HTTP methods.
• ⚠️ Final slashes in upstream_url are no longer allowed. #2115
• ⚠️ The SSL plugin has been removed and dynamic SSL capabilities have been added to Kong core, and are configurable via new properties on the API entity. See the related PR for a detailed explanation of this change. #1970
• ⚠️ Drop the Dnsmasq dependency. We now internally resolve both A and SRV DNS records. #1587
• ⚠️ Dropping support for insecure TLS/1.0 and defaulting Upgrade responses to TLS/1.2. #2119
• Bump the compatible OpenResty version to 1.11.2.1 and 1.11.2.2. Support for OpenResty 1.11.2.2 requires the --without-luajit-lua52 compilation flag.
• Separate Admin API and Proxy error logs. Admin API logs are now written to logs/admin_access.log. #1782
• Auto-generates stronger SHA-256 with RSA encryption SSL certificates. #2117

Added

• 🎆 Support for Cassandra 3.x. #1709
• 🎆 SRV records resolution. #1587
• 🎆 Load balancing. When an A or SRV record resolves to multiple entries, Kong now rotates those upstream targets with a Round-Robin algorithm. This is a first step towards implementing more load balancing algorithms. Another way to specify multiple upstream targets is to use the newly introduced /upstreams and /targets entities of the Admin API. #1587 #1735
• 🎆 Multiple hosts and paths per API. Kong can now route incoming requests to your services based on a combination of Host headers, URIs and HTTP methods. See the related PR for a detailed explanation of the new properties and capabilities of the new router. #1970
• 🎆 Maintain upstream connection pools which should greatly improve performance, especially for HTTPS upstream connections. We now use HTTP/1.1 for upstream connections as well as an nginx upstream block with a configurablekeepalive directive, thanks to the new nginx_keepalive configuration property. #1587 #1827
• 🎆 Websockets support. Kong can now upgrade client connections to use the ws protocol when Upgrade: websocket is present. #1827
• Use an in-memory caching strategy for database entities in order to reduce CPU load during requests proxying. #1688
• Provide negative-caching for missed database entities. This should improve performance in some cases. #1914
• Support for serving the Admin API over SSL. This introduces new properties in the configuration file: admin_listen_ssl, admin_ssl, admin_ssl_cert and admin_ssl_cert_key. #1706
• Support for upstream connection timeouts. APIs now have 3 new fields: upstream_connect_timeout, upstream_send_timeout, upstream_read_timeout to specify, in milliseconds, a timeout value for requests between Kong and your APIs. #2036
• Support for clustering key rotation in the underlying Serf process:
  • new cluster_keyring_file property in the configuration file.
  • new kong cluster keys .. CLI commands that expose the underlying serf keys .. commands. #2069
• Support for lua_socket_pool_size property in configuration file. #2109
• Plugins:
  • 🎆 New AWS Lambda plugin. Thanks Tim Erickson for his collaboration on this new addition. #1777 #1190
  • Anonymous authentication for auth plugins. When such plugins receive the config.anonymous=<consumer_id> property, even non-authenticated requests will be proxied by Kong, with the traditional Consumer headers set to the designated anonymous consumer, but also with a X-Anonymous-Consumer header. Multiple auth plugins will work in a logical OR fashion. #1666 and #2035
  • request-transformer: Ability to change the HTTP method of the upstream request. #1635
  • jwt: Support for ES256 signatures. #1920
  • rate-limiting: Ability to select the Redis database to use via the new config.redis_database plugin property. #1941

Fixed

• Looking for Serf in known installation paths. #1997
• Including port in upstream Host header. #2045
• Clarify the purpose of the cluster_listen_rpc property in the configuration file. Thanks Jeremy Monin for the patch. #1860
• Admin API:
  • Properly Return JSON responses (instead of HTML) on HTTP 409 Conflict when adding Plugins. #2014
• CLI:
  • Avoid double-prefixing migration error messages with the database name (PostgreSQL/Cassandra).
• Plugins:
  • Fix fault tolerance logic and error reporting in rate-limiting plugins.
  • CORS: Properly return Access-Control-Allow-Credentials: false if Access-Control-Allow-Origin: *. #2104
  • key-auth: enforce key_names to be proper header names according to Nginx. #2142

Back to TOC

0.9.9 - 2017/02/02

Fixed

• Correctly put Cassandra sockets into the Nginx connection pool for later reuse. This greatly improves the performance for rate-limiting and response-ratelimiting plugins. f8f5306
• Correct length of a year in seconds for rate-limiting and response-ratelimiting plugins. A year was wrongly assumed to only be 360 days long. e4fdb2a
• Prevent misinterpretation of the % character in proxied URLs encoding. Thanks Thomas Jouannic for the patch. #1998 #2040

Back to TOC

0.9.8 - 2017/01/19

Fixed

• Properly set the admin IP in the Serf script.

Changed

• Provide negative-caching for missed database entities. This should improve performance in some cases. #1914

Fixed

• Plugins:
  • Fix fault tolerance logic and error reporting in rate-limiting plugins.

Back to TOC

0.9.7 - 2016/12/21

Fixed

• Fixed a performance issue in Cassandra by removing an old workaround that was forcing Cassandra to use LuaSocket instead of cosockets. #1916
• Fixed an issue that was causing a recursive attempt to stop Kong's services when an error was occurring. #1877
• Custom plugins are now properly loaded again. #1910
• Plugins:
  • Galileo: properly encode empty arrays. #1909
  • OAuth 2: implements a missing Postgres migration for redirect_uri in every OAuth 2 credential. #1911
  • OAuth 2: safely parse the request body even when no data has been sent. #1915

Back to TOC

0.9.6 - 2016/11/29

Fixed

• Resolve support for PostgreSQL SSL connections. #1720
• Ensure kong start honors the --conf flag is a config file already exists at one of the default locations (/etc/kong.conf, /etc/kong/kong.conf). #1681
• Obfuscate sensitive properties from the / Admin API route which returns the current node's configuration. #1650

Back to TOC

0.9.5 - 2016/11/07

Changed

• Dropping support for OpenResty 1.9.15.1 in favor of 1.11.2.1 #1797

Fixed

• Fixed an error (introduced in 0.9.4) in the auto-clustering event

Back to TOC

0.9.4 - 2016/11/02

Fixed

• Fixed the random string generator that was causing some problems, especially in Serf for clustering. #1754
• Seed random number generator in CLI. #1641
• Reducing log noise in the Admin API. #1781
• Fixed the reports lock implementation that was generating a periodic error message. #1783

Back to TOC

0.9.3 - 2016/10/07

Added

• Added support for Serf 0.8. #1693

Fixed

• Properly invalidate global plugins. #1723

Back to TOC

0.9.2 - 2016/09/20

Fixed

• Correctly report migrations errors. This was caused by an error being thrown from the error handler, and superseding the actual error. [#1605] (https://github.com/Kong/kong/pull/1605)
• Prevent Kong from silently failing to start. This would be caused by an erroneous error handler. [28f5d10] (https://github.com/Kong/kong/commit/28f5d10)
• Only report a random number generator seeding error when it is not already seeded. #1613
• Reduce intra-cluster noise by not propagating keepalive requests events. #1660
• Admin API:
  • Obfuscates sensitive configuration settings from the / route. #1650
• CLI:
  • Prevent a failed kong start to stop an already running Kong node. #1645
  • Remove unset configuration placeholders from the nginx configuration template. This would occur when no Internet connection would be available and would cause Kong to compile an erroneous nginx config. #1606
  • Properly count the number of executed migrations. #1649
• Plugins:
  • OAuth2: remove the "Kong" mentions in missing provision_key error messages. #1633
  • OAuth2: allow to correctly delete applications when using Cassandra. #1659
  • galileo: provide a default bodySize value when log_bodies=true but the current request/response has no body. #1657

Back to TOC

0.9.1 - 2016/09/02

Added

• Plugins:
  • ACL: allow to retrieve/update/delete an ACL by group name. #1544
  • Basic Authentication: allow to retrieve/update/delete a credential by username. #1570
  • HMAC Authentication: allow to retrieve/update/delete a credential by username. #1570
  • JWT Authentication: allow to retrieve/update/delete a credential by key. #1570
  • Key Authentication: allow to retrieve/update/delete a credential by key. #1570
  • OAuth2 Authentication: allow to retrieve/update/delete a credential by client_id and tokens by access_token. #1570

Fixed

• Correctly parse configuration file settings containing comments. #1569
• Prevent third-party Lua modules (and plugins) to override the seed for random number generation. This prevents the creation of conflicting UUIDs. #1558
• Use pgmoon-mashape 2.0.0 which properly namespaces our fork, avoiding conflicts with other versions of pgmoon, such as the one installed by Lapis. #1582
• Avoid exposing OpenResty's information on HTTP 4xx errors. #1567
• ulimit with unlimited value is now properly handled. #1545
• CLI:
  • Stop third-party services (Dnsmasq/Serf) when Kong could not start. #1588
  • Prefix database migration errors (such as Postgres' connection refused) with the database name (postgres/cassandra) to avoid confusions. #1583
• Plugins:
  • galileo: Use Content-Length header to get request/response body size when log_bodies is disabled. #1584
• Admin API:
  • Revert the /plugins/enabled endpoint's response to be a JSON array, and not an Object. #1529

Back to TOC

0.9.0 - 2016/08/18

The main focus of this release is Kong's new CLI. With a simpler configuration file, new settings, environment variables support, new commands as well as a new interpreter, the new CLI gives more power and flexibility to Kong users and allow for an easier integration in your deployment workflow, as well as better testing for developers and plugins authors. Additionally, some new plugins and performance improvements are included as well as the regular bug fixes.

Changed

• ⚠️ PostgreSQL is the new default datastore for Kong. If you were using Cassandra and you are upgrading, you need to explicitly set cassandra as your database.
• ⚠️ New CLI, with new commands and refined arguments. This new CLI uses the resty-cli interpreter (see lua-resty-cli) instead of LuaJIT. As a result, the resty executable must be available in your $PATH (resty-cli is shipped in the OpenResty bundle) as well as the bin/kong executable. Kong does not rely on Luarocks installing the bin/kong executable anymore. This change of behavior is taken care of if you are using one of the official Kong packages.
• ⚠️ Kong uses a new configuration file, with an easier syntax than the previous YAML file.
• New arguments for the CLI, such as verbose, debug and tracing flags. We also avoid requiring the configuration file as an argument to each command as per the previous CLI.
• Customization of the Nginx configuration can now be taken care of using two different approaches: with a custom Nginx configuration template and using kong start --template <file>, or by using kong compile to generate the Kong Nginx sub-configuration, and include it in a custom Nginx instance.
• Plugins:
  • Rate Limiting: the continue_on_error property is now called fault_tolerant.
  • Response Rate Limiting: the continue_on_error property is now called fault_tolerant.

Added

• 🎆 Support for overriding configuration settings with environment variables.
• 🎆 Support for SSL connections between Kong and PostgreSQL. #1425
• 🎆 Ability to apply plugins with more granularity: per-consumer, and global plugins are now possible. #1403
• New kong check command: validates a Kong configuration file.
• Better version check for third-party dependencies (OpenResty, Serf, Dnsmasq). #1307
• Ability to configure the validation depth of database SSL certificates from the configuration file. #1420
• request_host: internationalized url support; utf-8 domain names through punycode support and paths through %-encoding. #1300
• Implements caching locks when fetching database configuration (APIs, Plugins...) to avoid dog pile effect on cold nodes. #1402
• Plugins:
  • 🎆 New bot-detection plugin: protect your APIs by detecting and rejecting common bots and crawlers. #1413
  • correlation-id: new "tracker" generator, identifying requests per worker and connection. #1288
  • request/response-transformer: ability to add strings including colon characters. #1353
  • rate-limiting: support for new rate-limiting policies (cluster, local and redis), and for a new limit_by property to force rate-limiting by consumer, credential or ip.
  • response-rate-limiting: support for new rate-limiting policies (cluster, local and redis), and for a new limit_by property to force rate-limiting by consumer, credential or ip.
  • galileo: performance improvements of ALF serialization. ALFs are not discarded when exceeding 20MBs anymore. #1463
  • statsd: new upstream_stream latency metric. #1466
  • datadog: new upstream_stream latency metric and tagging support for each metric. #1473

Removed

• We now use lua-resty-jit-uuid for UUID generation, which is a pure Lua implementation of RFC 4122. As a result, libuuid is not a dependency of Kong anymore.

Fixed

• Sensitive configuration settings are not printed to stdout anymore. #1256
• Fixed bug that caused nodes to remove themselves from the database when they attempted to join the cluster. #1437
• Plugins:
  • request-size-limiting: use proper constant for MB units while setting the size limit. #1416
  • OAuth2: security and config validation fixes. #1409 #1112
  • request/response-transformer: better validation of fields provided without a value. #1399
  • JWT: handle some edge-cases that could result in HTTP 500 errors. #1362

internal

• new test suite using resty-cli and removing the need to monkey-patch the ngx global.
• custom assertions and new helper methods (wait_until()) to gracefully fail in case of timeout.
• increase atomicity of the testing environment.
• lighter testing instance, only running 1 worker and not using Dnsmasq by default.

Back to TOC

0.8.3 - 2016/06/01

This release includes some bugfixes:

Changed

• Switched the log level of the "No nodes found in cluster" warning to INFO, that was printed when starting up the first Kong node in a new cluster.
• Kong now requires OpenResty 1.9.7.5.

Fixed

• New nodes are now properly registered into the nodes table when running on the same machine. #1281
• Fixed a failed error parsing on Postgres. #1269
• Plugins:
  • Response Transformer: Slashes are now encoded properly, and fixed a bug that hang the execution of the plugin. #1257 and #1263
  • JWT: If a value for algorithm is missing, it's now HS256 by default. This problem occurred when migrating from older versions of Kong.
  • OAuth 2.0: Fixed a Postgres problem that was preventing an application from being created, and fixed a check on the redirect_uri field. #1264 and #1267

Back to TOC

0.8.2 - 2016/05/25

This release includes bugfixes and minor updates:

Added

• Support for a simple slash in request_path. #1227
• Plugins:
  • Response Rate Limiting: it now appends usage headers to the upstream requests in the form of X-Ratelimit-Remaining-{limit_name} and introduces a new config.block_on_first_violation property. #1235

Changed

• Plugins:
  • Mashape Analytics: The plugin is now called "Galileo", and added support for Galileo v3. #1159

Fixed

• Postgres now relies on the search_path configured on the database and its default value $user, public. #1196
• Kong now properly encodes an empty querystring parameter like ?param= when proxying the request. #1210
• The configuration now checks that cluster.ttl_on_failure is at least 60 seconds. #1199
• Plugins:
  • Loggly: Fixed an issue that was triggering 400 and 500 errors. #1184
  • JWT: The TYP value in the header is not optional and case-insensitive. #1192
  • Request Transformer: Fixed a bug when transforming request headers. #1202
  • OAuth 2.0: Multiple redirect URIs are now supported. #1112
  • IP Restriction: Fixed that prevented the plugin for working properly when added on an API. #1245
  • CORS: Fixed an issue when config.preflight_continue was enabled. #1240

Back to TOC

0.8.1 - 2016/04/27

This release includes some fixes and minor updates:

Added

• Adds X-Forwarded-Host and X-Forwarded-Prefix to the upstream request headers. #1180
• Plugins:
  • Datadog: Added two new metrics, unique_users and request_per_user, that log the consumer information. #1179

Fixed

• Fixed a DAO bug that affected full entity updates. #1163
• Fixed a bug when setting the authentication provider in Cassandra.
• Updated the Cassandra driver to v0.5.2.
• Properly enforcing required fields in PUT requests. #1177
• Fixed a bug that prevented to retrieve the hostname of the local machine on certain systems. #1178

Back to TOC

0.8.0 - 2016/04/18

This release includes support for PostgreSQL as Kong's primary datastore!

Breaking changes

• Remove support for the long deprecated /consumers/:consumer/keyauth/ and /consumers/:consumer/basicauth/ routes (deprecated in 0.5.0). The new routes (available since 0.5.0 too) use the real name of the plugin: /consumers/:consumer/key-auth and /consumers/:consumer/basic-auth.

Added

• Support for PostgreSQL 9.4+ as Kong's primary datastore. #331 #1054
• Configurable Cassandra reading/writing consistency. #1026
• Admin API: including pending and running timers count in the response to /. #992
• Plugins
  • New correlation-id plugin: assign unique identifiers to the requests processed by Kong. Courtesy of @opyate. #1094
  • LDAP: add support for LDAP authentication. #1133
  • StatsD: add support for StatsD logging. #1142
  • JWT: add support for RS256 signed tokens thanks to @kdstew! #1053
  • ACL: appends X-Consumer-Groups to the request, so the upstream service can check what groups the consumer belongs to. #1154
  • Galileo (mashape-analytics): increase batch sending timeout to 30s. #1091
• Added ttl_on_failure option in the cluster configuration, to configure the TTL of failed nodes. #1125

Fixed

• Introduce a new port option when connecting to your Cassandra cluster instead of using the CQL default (9042). #1139
• Plugins
  • Request/Response Transformer: add missing migrations for upgrades from <= 0.5.x. #1064
  • OAuth2
    • Error responses comply to RFC 6749. #1017
    • Handle multipart requests. #1067
    • Make access_tokens correctly expire. #1089

internal

• replace globals with singleton pattern thanks to @mars.
• fixed resolution mismatches when using deep paths in the path resolver.

Back to TOC

0.7.0 - 2016/02/24

Breaking changes

Due to the NGINX security fixes (CVE-2016-0742, CVE-2016-0746, CVE-2016-0747), OpenResty was bumped to 1.9.7.3 which is not backwards compatible, and thus requires changes to be made to the nginx property of Kong's configuration file. See the 0.7 upgrade path for instructions.

However by upgrading the underlying OpenResty version, source installations do not have to patch the NGINX core and use the old ssl-cert-by-lua branch of ngx_lua anymore. This will make source installations much easier.

Added

• Support for OpenResty 1.9.7.*. This includes NGINX security fixes (CVE-2016-0742, CVE-2016-0746, CVE-2016-0747). #906
• Plugins
  • New Runscope plugin: Monitor your APIs from Kong with Runscope. Courtesy of @mansilladev. #924
  • Datadog: New response.size metric. #923
  • Rate-Limiting and Response Rate-Limiting
    • New config.async option to asynchronously increment counters to reduce latency at the cost of slightly reducing the accuracy. #912
    • New config.continue_on_error option to keep proxying requests in case the datastore is unreachable. rate-limiting operations will be disabled until the datastore is responsive again. #953
• CLI
  • Perform a simple permission check on the NGINX working directory when starting, to prevent errors during execution. #939
• Send 50x errors with the appropriate format. #927 #970

Fixed

• Plugins
  • OAuth2
    • Better handling of redirect_uri (prevent the use of fragments and correctly handle querystrings). Courtesy of @PGBI. #930
    • Add PUT support to the /auth2_tokens route. #897
    • Better error message when the access_token is missing. #1003
  • IP restriction: Fix an issue that could arise when restarting Kong. Now Kong does not need to be restarted for the ip-restriction configuration to take effect. #782 #960
  • ACL: Properly invalidating entities when assigning a new ACL group. #996
  • SSL: Replace shelled out openssl calls with native ngx.ssl conversion utilities, which preserve the certificate chain. #968
• Avoid user warning on start when the user is not root. #964
• Store Serf logs in NGINX working directory to prevent eventual permission issues. #975
• Allow plugins configured on a Consumer without being configured on an API to run. #978 #980
• Fixed an edge-case where Kong nodes would not be registered in the nodes table. #1008

Back to TOC

0.6.1 - 2016/02/03

This release contains tiny bug fixes that were especially annoying for complex Cassandra setups and power users of the Admin API!

Added

• A timeout property for the Cassandra configuration. In ms, this timeout is effective as a connection and a reading timeout. #937

Fixed

• Correctly set the Cassandra SSL certificate in the Nginx configuration while starting Kong. #921
• Rename the user Cassandra property to username (Kong looks for username, hence user would fail). #922
• Allow Cassandra authentication with arbitrary plain text auth providers (such as Instaclustr uses), fixing authentication with them. #937
• Admin API
  • Fix the /plugins/:id route for PATCH method. #941
• Plugins
  • HTTP logging: remove the additional \r\n at the end of the logging request body. #926
  • Galileo: catch occasional internal errors happening when a request was cancelled by the client and fix missing shm for the retry policy. #931

Back to TOC

0.6.0 - 2016/01/22

Breaking changes

We would recommended to consult the suggested 0.6 upgrade path for this release.

• Serf is now a Kong dependency. It allows Kong nodes to communicate between each other opening the way to many features and improvements.
• The configuration file changed. Some properties were renamed, others were moved, and some are new. We would recommend checking out the new default configuration file.
• Drop the Lua 5.1 dependency which was only used by the CLI. The CLI now runs with LuaJIT, which is consistent with other Kong components (Luarocks and OpenResty) already relying on LuaJIT. Make sure the LuaJIT interpreter is included in your $PATH. #799

Added

One of the biggest new features of this release is the cluster-awareness added to Kong in #729, which deserves its own section:

• Each Kong node is now aware of belonging to a cluster through Serf. Nodes automatically join the specified cluster according to the configuration file's settings.
• The datastore cache is not invalidated by expiration time anymore, but following an invalidation strategy between the nodes of a same cluster, leading to improved performance.
• Admin API
  • Expose a /cache endpoint for retrieving elements stored in the in-memory cache of a node.
  • Expose a /cluster endpoint used to add/remove/list members of the cluster, and also used internally for data propagation.
• CLI
  • New kong cluster command for cluster management.
  • New kong status command for cluster healthcheck.

Other additions include:

• New Cassandra driver which makes Kong aware of the Cassandra cluster. Kong is now unaffected if one of your Cassandra nodes goes down as long as a replica is available on another node. Load balancing policies also improve the performance along with many other smaller improvements. #803
• Admin API
  • A new total field in API responses, that counts the total number of entities in the datastore. #635
• Configuration
  • Possibility to configure the keyspace replication strategy for Cassandra. It will be taken into account by the migrations when the configured keyspace does not already exist. #350
  • Dnsmasq is now optional. You can specify a custom DNS resolver address that Kong will use when resolving hostnames. This can be configured in kong.yml. #625
• Plugins
  • New "syslog" plugin: send logs to local system log. #698
  • New "loggly" plugin: send logs to Loggly over UDP. #698
  • New "datadog" plugin: send logs to Datadog server. #758
  • OAuth2
    • Add support for X-Forwarded-Proto header. #650
    • Expose a new /oauth2_tokens endpoint with the possibility to retrieve, update or delete OAuth 2.0 access tokens. #729
  • JWT
    • Support for base64 encoded secrets. #838 #577
    • Support to configure the claim in which the key is given into the token (not iss only anymore). #838
  • Request transformer
    • Support for more transformation options: remove, replace, add, append motivated by #393. See #824
    • Support JSON body transformation. #569
  • Response transformer
    • Support for more transformation options: remove, replace, add, append motivated by #393. See #822

Changed

• As mentioned in the breaking changes section, a new configuration file format and validation. All properties are now documented and commented out with their default values. This allows for a lighter configuration file and more clarity as to what properties relate to. It also catches configuration mistakes. #633
• Replace the UUID generator library with a new implementation wrapping lib-uuid, fixing eventual conflicts happening in cases such as described in #659. See #695
• Admin API
  • Increase the maximum body size to 10MB in order to handle configuration requests with heavy payloads. #700
  • Disable access logs for the /status endpoint.
  • The /status endpoint now includes database statistics, while the previous stats have been moved to a server response field. #635

Fixed

• Behaviors described in #603 related to the failure of Cassandra nodes thanks to the new driver. #803
• Latency headers are now properly included in responses sent to the client. #708
• strip_request_path does not add a trailing slash to the API's upstream_url anymore before proxying. #675
• Do not URL decode querystring before proxying the request to the upstream service. #749
• Handle cases when the request would be terminated prior to the Kong execution (that is, before ngx_lua reaches the access_by_lua context) in cases such as the use of a custom nginx module. #594
• Admin API
  • The PUT method now correctly updates boolean fields (such as strip_request_path). #765
  • The PUT method now correctly resets a plugin configuration. #720
  • PATCH correctly set previously unset fields. #861
  • In the responses, the next link is not being displayed anymore if there are no more entities to be returned. #635
  • Prevent the update of created_at fields. #820
  • Better request_path validation for APIs. "/" is not considered a valid path anymore. #881
• Plugins
  • Galileo: ensure the mimeType value is always a string in ALFs. #584
  • JWT: allow to update JWT credentials using the PATCH method. It previously used to reply with 405 Method not allowed because the PATCH method was not implemented. #667
  • Rate limiting: fix a warning when many periods are configured. #681
  • Basic Authentication: do not re-hash the password field when updating a credential. #726
  • File log: better permissions for on file creation for file-log plugin. #877
  • OAuth2
    • Implement correct responses when the OAuth2 challenges are refused. #737
    • Handle querystring on /authorize and /token URLs. #687
    • Handle punctuation in scopes on /authorize and /token endpoints. #658

internal

• Event bus for local and cluster-wide events propagation. Plans for this event bus is to be widely used among Kong in the future.
• The Kong Public Lua API (Lua helpers integrated in Kong such as DAO and Admin API helpers) is now documented with ldoc.
• Work has been done to restore the reliability of the CI platforms.
• Migrations can now execute DML queries (instead of DDL queries only). Handy for migrations implying plugin configuration changes, plugins renamings etc... #770

Back to TOC

0.5.4 - 2015/12/03

Fixed

• Mashape Analytics plugin (renamed Galileo):
  • Improve stability under heavy load. #757
  • base64 encode ALF request/response bodies, enabling proper support for Galileo bodies inspection capabilities. #747
  • Do not include JSON bodies in ALF postData.params field. #766

Back to TOC

0.5.3 - 2015/11/16

Fixed

• Avoids additional URL encoding when proxying to an upstream service. #691
• Potential timing comparison bug in HMAC plugin. #704

Added

• The Galileo plugin now supports arbitrary host, port and path values. #721

Back to TOC

0.5.2 - 2015/10/21

A few fixes requested by the community!

Fixed

• Kong properly search the nginx in your $PATH variable.
• Plugins:
  • OAuth2: can detect that the originating protocol for a request was HTTPS through the X-Forwarded-Proto header and work behind another reverse proxy (load balancer). #650
  • HMAC signature: support for X-Date header to sign the request for usage in browsers (since the Date header is protected). #641

Back to TOC

0.5.1 - 2015/10/13

Fixing a few glitches we let out with 0.5.0!

Added

• Basic Authentication and HMAC Authentication plugins now also send the X-Credential-Username to the upstream server.
• Admin API now accept JSON when receiving a CORS request. #580
• Add a WWW-Authenticate header for HTTP 401 responses for basic-auth and key-auth. #588

Changed

• Protect Kong from POODLE SSL attacks by omitting SSLv3 (CVE-2014-3566). #563
• Remove support for key-auth key in body. #566

Fixed

• Plugins
  • HMAC
    • The migration for this plugin is now correctly being run. #611
    • Wrong username doesn't return HTTP 500 anymore, but 403. #602
  • JWT: iss not being found doesn't return HTTP 500 anymore, but 403. #578
  • OAuth2: client credentials flow does not include a refresh token anymore. #562
• Fix an occasional error when updating a plugin without a config. #571

Back to TOC

0.5.0 - 2015/09/25

With new plugins, many improvements and bug fixes, this release comes with breaking changes that will require your attention.

Breaking changes

Several breaking changes are introduced. You will have to slightly change your configuration file and a migration script will take care of updating your database cluster. Please follow the instructions in UPGRADE.md for an update without downtime.

• Many plugins were renamed due to new naming conventions for consistency. #480
• In the configuration file, the Cassandra hosts property was renamed to contact_points. #513
• Properties belonging to APIs entities have been renamed for clarity. #513
  • public_dns -> request_host
  • path -> request_path
  • strip_path -> strip_request_path
  • target_url -> upstream_url
• plugins_configurations have been renamed to plugins, and their value property has been renamed to config to avoid confusions. #513
• The database schema has been updated to handle the separation of plugins outside of the core repository.
• The Key authentication and Basic authentication plugins routes have changed:

Old route                             New route
/consumers/:consumer/keyauth       -> /consumers/:consumer/key-auth
/consumers/:consumer/keyauth/:id   -> /consumers/:consumer/key-auth/:id
/consumers/:consumer/basicauth     -> /consumers/:consumer/basic-auth
/consumers/:consumer/basicauth/:id -> /consumers/:consumer/basic-auth/:id

The old routes are still maintained but will be removed in upcoming versions. Consider them deprecated.

• Admin API
  • The route to retrieve enabled plugins is now under /plugins/enabled.
  • The route to retrieve a plugin's configuration schema is now under /plugins/schema/{plugin name}.

Added

• Plugins
  • New Response Rate Limiting plugin: Give a usage quota to your users based on a parameter in your response. #247
  • New ACL (Access Control) plugin: Configure authorizations for your Consumers. #225
  • New JWT (JSON Web Token) plugin: Verify and authenticate JWTs. #519
  • New HMAC signature plugin: Verify and authenticate HMAC signed HTTP requests. #549
  • Plugins migrations. Each plugin can now have its own migration scripts if it needs to store data in your cluster. This is a step forward to improve Kong's pluggable architecture. #443
  • Basic Authentication: the password field is now sha1 encrypted. #33
  • Basic Authentication: now supports credentials in the Proxy-Authorization header. #460

Changed

• Basic Authentication and Key Authentication now require authentication parameters even when the Expect: 100-continue header is being sent. #408
• Key Auth plugin does not support passing the key in the request payload anymore. #566
• APIs' names cannot contain characters from the RFC 3986 reserved list. #589

Fixed

• Resolver
  • Making a request with a querystring will now correctly match an API's path. #496
• Admin API
  • Data associated to a given API/Consumer will correctly be deleted if related Consumer/API is deleted. #107 #438 #504
  • The /api/{api_name_or_id}/plugins/{plugin_name_or_id} changed to /api/{api_name_or_id}/plugins/{plugin_id} to avoid requesting the wrong plugin if two are configured for one API. #482
  • APIs created without a name but with a request_path will now have a name which defaults to the set request_path. #547
• Plugins
  • Mashape Analytics: More robust buffer and better error logging. #471
  • Mashape Analytics: Several ALF (API Log Format) serialization fixes. #515
  • Oauth2: A response is now returned on http://kong:8001/consumers/{consumer}/oauth2/{oauth2_id}. #469
  • Oauth2: Saving authenticated_userid on Password Grant. #476
  • Oauth2: Proper handling of the /oauth2/authorize and /oauth2/token endpoints in the OAuth 2.0 Plugin when an API with a path is being consumed using the public_dns instead. #503
  • OAuth2: Properly returning X-Authenticated-UserId in the client_credentials and password flows. #535
  • Response-Transformer: Properly handling JSON responses that have a charset specified in their Content-Type header.

Back to TOC

0.4.2 - 2015/08/10

Added

• Cassandra authentication and SSL encryption. #405
• preserve_host flag on APIs to preserve the Host header when a request is proxied. #444
• Added the Resource Owner Password Credentials Grant to the OAuth 2.0 Plugin. #448
• Auto-generation of default SSL certificate. #453

Changed

• Remove cassandra.port property in configuration. Ports are specified by having cassandra.hosts addresses using the host:port notation (RFC 3986). #457
• Default SSL certificate is now auto-generated and stored in the nginx_working_dir.
• OAuth 2.0 plugin now properly forces HTTPS.

Fixed

• Better handling of multi-nodes Cassandra clusters. #450
• mashape-analytics plugin: handling of numerical values in querystrings. #449
• Path resolver strip_path option wrongfully matching the path property multiple times in the request URI. #442
• File Log Plugin bug that prevented the file creation in some environments. #461
• Clean output of the Kong CLI. #235

Back to TOC

0.4.1 - 2015/07/23

Fixed

• Issues with the Mashape Analytics plugin. #425
• Handle hyphens when executing path routing with strip_path option enabled. #431
• Adding the Client Credentials OAuth 2.0 flow. #430
• A bug that prevented "dnsmasq" from being started on some systems, including Debian. f7da790
• File Log plugin: optimizations by avoiding the buffered I/O layer. 20bb478

Back to TOC

0.4.0 - 2015/07/15

Added

• Implement wildcard subdomains for APIs' public_dns. #381 #297
• Plugins
  • New OAuth 2.0 plugin. #341 #169
  • New Mashape Analytics plugin. #360 #272
  • New IP restriction plugin. #379
  • Ratelimiting: support for multiple limits. #382 #205
  • HTTP logging: support for HTTPS endpoint. #342
  • Logging plugins: new properties for logs timing. #351
  • Key authentication: now auto-generates a key if none is specified. #48
• Resolver
  • path property now accepts arbitrary depth. #310
• Admin API
  • Enable CORS by default. #371
  • Expose a new endpoint to get a plugin configuration's schema. #376 #309
  • Expose a new endpoint to retrieve a node's status. 417c137
• CLI
  • $ kong migrations reset now asks for confirmation. #365

Fixed

• Plugins
  • Basic authentication not being executed if added to an API with default configuration. 6d732cd
  • SSL plugin configuration parsing. #353
  • SSL plugin doesn't accept a consumer_id anymore, as this wouldn't make sense. #372 #322
  • Authentication plugins now return 401 when missing credentials. #375 #354
• Admin API
  • Non supported HTTP methods now return 405 instead of 500. 38f1b7f
  • Prevent PATCH requests from overriding a plugin's configuration if partially updated. 9a7388d
• Handle occasionally missing schema_migrations table. #365 #250

internal

• DAO:
  • Complete refactor. No more need for hard-coded queries. #346
• Schemas:
  • New self_check test for schema definitions. 5bfa7ca

Back to TOC

0.3.2 - 2015/06/08

Fixed

• Uppercase Cassandra keyspace bug that prevented Kong to work with kongdb.org
• Multipart requests not properly parsed in the admin API. #344

Back to TOC

0.3.1 - 2015/06/07

Fixed

• Schema migrations are now automatic, which was missing from previous releases. #303

Back to TOC

0.3.0 - 2015/06/04

Added

• Support for SSL.
• Plugins
  • New HTTP logging plugin. #226 #251
  • New SSL plugin.
  • New request size limiting plugin. #292
  • Default logging format improvements. #226 #262
  • File logging now logs to a custom file. #202
  • Keyauth plugin now defaults key_names to "apikey".
• Admin API
  • RESTful routing. Much nicer Admin API routing. Ex: /apis/{name_or_id}/plugins. #98 #257
  • Support PUT method for endpoints such as /apis/, /apis/plugins/, /consumers/
  • Support for application/json and x-www-form-urlencoded Content Types for all PUT, POST and PATCH endpoints by passing a Content-Type header. #236
• Resolver
  • Support resolving APIs by Path as well as by Header. #192 #282
  • Support for X-Host-Override as an alternative to Host for browsers. #203 #246
• Auth plugins now send user informations to your upstream services. #228
• Invalid target_url value are now being caught when creating an API. #149

Fixed

• Uppercase Cassandra keyspace causing migration failure. #249
• Guarantee that ratelimiting won't allow requests in case the atomicity of the counter update is not guaranteed. #289

internal

• Schemas:
  • New property type: array. #277
  • Entities schemas now live in their own files and are starting to be unit tested.
  • Subfields are handled better: (notify required subfields and auto-vivify is subfield has default values).
• Way faster unit tests. Not resetting the DB anymore between tests.
• Improved coverage computation (exclude vendor/).
• Travis now lints kong/.
• Way faster Travis setup.
• Added a new HTTP client for in-nginx usage, using the cosocket API.
• Various refactorings.
• Fix #196.
• Disabled ipv6 in resolver.

Back to TOC

0.2.1 - 2015/05/12

This is a maintenance release including several bug fixes and usability improvements.

Added

• Support for local DNS resolution. #194
• Support for Debian 8 and Ubuntu 15.04.
• DAO
  • Cassandra version bumped to 2.1.5
  • Support for Cassandra downtime. If Cassandra goes down and is brought back up, Kong will not need to restart anymore, statements will be re-prepared on-the-fly. This is part of an ongoing effort from jbochi/lua-resty-cassandra#47, #146 and #187. Queries effectuated during the downtime will still be lost. #11
  • Leverage reused sockets. If the DAO reuses a socket, it will not re-set their keyspace. This should give a small but appreciable performance improvement. #170
  • Cascade delete plugins configurations when deleting a Consumer or an API associated with it. #107
  • Allow Cassandra hosts listening on different ports than the default. #185
• CLI
  • Added a notice log when Kong tries to connect to Cassandra to avoid user confusion. #168
  • The CLI now tests if the ports are already being used before starting and warns.
• Admin API
  • name is now an optional property for APIs. If none is being specified, the name will be the API public_dns. #181
• Configuration
  • The memory cache size is now configurable. #208

Fixed

• Resolver
  • More explicit "API not found" message from the resolver if the Host was not found in the system. "API not found with Host: %s".
  • If multiple hosts headers are being sent, Kong will test them all to see if one of the API is in the system. #186
• Admin API: responses now have a new line after the body. #164
• DAO: keepalive property is now properly passed when Kong calls set_keepalive on Cassandra sockets.
• Multipart dependency throwing error at startup. #213

internal

• Separate Migrations from the DAO factory.
• Update dev config + Makefile rules (run becomes start).
• Introducing an ngx stub for unit tests and CLI.
• Switch many PCRE regexes to using patterns.

Back to TOC

0.2.0-2 - 2015/04/27

First public release of Kong. This version brings a lot of internal improvements as well as more usability and a few additional plugins.

Added

• Plugins
  • CORS plugin.
  • Request transformation plugin.
  • NGINX plus monitoring plugin.
• Configuration
  • New properties: proxy_port and api_admin_port. #142
• CLI
  • Better info, help and error messages. #118 #124
  • New commands: kong reload, kong quit. #114 Alias of version: kong --version #119
  • kong restart simply starts Kong if not previously running + better pid file handling. #131
• Package distributions: .rpm, .deb and .pkg for easy installs on most common platforms.

Fixed

• Admin API: trailing slash is not necessary anymore for core resources such as /apis or /consumers.
• Leaner default configuration. #156

internal

• All scripts moved to the CLI as "hidden" commands (kong db, kong config).
• More tests as always, and they are structured better. The coverage went down mainly because of plugins which will later move to their own repos. We are all eagerly waiting for that!
• src/ was renamed to kong/ for ease of development
• All system dependencies versions for package building and travis-ci are now listed in versions.sh
• DAO doesn't need to :prepare() prior to run queries. Queries can be prepared at runtime. #146

Back to TOC

0.1.1beta-2 - 2015/03/30

Fixed

• Wrong behavior of auto-migration in kong start.

Back to TOC

0.1.0beta-3 - 2015/03/25

First public beta. Includes caching and better usability.

Added

• Required Openresty is now 1.7.10.1.
• Freshly built CLI, rewritten in Lua
• kong start using a new DB keyspace will automatically migrate the schema. #68
• Anonymous error reporting on Proxy and API. #64
• Configuration
  • Simplified configuration file (unified in kong.yml).
  • In configuration, plugins_installed was renamed to plugins_available. #59
  • Order of plugins_available doesn't matter anymore. #17
  • Better handling of plugins: Kong now detects which plugins are configured and if they are installed on the current machine.
  • bin/kong now defaults on /etc/kong.yml for config and /var/logs/kong for output. #71
• Proxy: APIs/Consumers caching with expiration for faster authentication.
• Admin API: Plugins now use plain form parameters for configuration. #70
• Keep track of already executed migrations. rollback now behaves as expected. #8

Fixed

• Server header now sends Kong. #57
• migrations not being executed in order on Linux. This issue wasn't noticed until unit testing the migrations because for now we only have 1 migration file.
• Admin API: Errors responses are now sent as JSON. #58

internal

• We now have code linting and coverage.
• Faker and Migrations instances don't live in the DAO Factory anymore, they are only used in scripts and tests.
• scripts/config.lua allows environment based configurations. make dev generates a kong.DEVELOPMENT.yml and kong_TEST.yml. Different keyspaces and ports.
• spec_helpers.lua allows tests to not rely on the Makefile anymore. Integration tests can run 100% from busted.
• Switch integration testing from [httpbin.org] to [mockbin.com].
• core plugin was renamed to resolver.

Back to TOC

0.0.1alpha-1 - 2015/02/25

First version running with Cassandra.

Added

• Basic proxying.
• Built-in authentication plugin (api key, HTTP basic).
• Built-in ratelimiting plugin.
• Built-in TCP logging plugin.
• Configuration API (for consumers, apis, plugins).
• CLI bin/kong script.
• Database migrations (using db.lua).