github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
21487 Commits
1703 Branches
457 Tags
696 MiB
 
 
 
 
 
 
Tree: 1dfc265abe
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '1dfc265abe'
${ noResults }
consul/CHANGELOG.md

633 KiB
Raw Blame History

1.20.1 (October 29, 2024)

BREAKING CHANGES:

  • mesh: Enable Envoy HttpConnectionManager.normalize_path by default on inbound traffic to mesh proxies. This resolves CVE-2024-10005. [GH-21816]

SECURITY:

  • mesh: Add contains and ignoreCase to L7 Intentions HTTP header matching criteria to support configuration resilient to variable casing and multiple values. This resolves CVE-2024-10006. [GH-21816]
  • mesh: Add http.incoming.requestNormalization to Mesh configuration entry to support inbound service traffic request normalization. This resolves CVE-2024-10005 and CVE-2024-10006. [GH-21816]

IMPROVEMENTS:

  • api: remove dependency on proto-public, protobuf, and grpc [GH-21780]
  • snapshot agent: (Enterprise only) Implement Service Principal Auth for snapshot agent on azure.
  • xds: configures Envoy to load balance over all instances of an external service configured with hostnames when "envoy_dns_discovery_type" is set to "STRICT_DNS" [GH-21655]

1.20.0 (October 14, 2024)

SECURITY:

  • Explicitly set 'Content-Type' header to mitigate XSS vulnerability. [GH-21704]
  • Implement HTML sanitization for user-generated content to prevent XSS attacks in the UI. [GH-21711]
  • UI: Remove codemirror linting due to package dependency [GH-21726]
  • Upgrade Go to use 1.22.7. This addresses CVE CVE-2024-34155 [GH-21705]
  • Upgrade to support aws/aws-sdk-go v1.55.5 or higher. This resolves CVEs CVE-2020-8911 and CVE-2020-8912. [GH-21684]
  • ui: Pin a newer resolution of Braces [GH-21710]
  • ui: Pin a newer resolution of Codemirror [GH-21715]
  • ui: Pin a newer resolution of Markdown-it [GH-21717]
  • ui: Pin a newer resolution of ansi-html [GH-21735]

FEATURES:

  • grafana: added the dashboards service-to-service dashboard, service dashboard, and consul dataplane dashboard [GH-21806]
  • server: remove v2 tenancy, catalog, and mesh experiments [GH-21592]

IMPROVEMENTS:

  • security: upgrade ubi base image to 9.4 [GH-21750]
  • connect: Add Envoy 1.31 and 1.30 to support matrix [GH-21616]

BUG FIXES:

  • jwt-provider: change dns lookup family from the default of AUTO which would prefer ipv6 to ALL if LOGICAL_DNS is used or PREFER_IPV4 if STRICT_DNS is used to gracefully handle transitions to ipv6. [GH-21703]

1.20.0-rc1 (September 19, 2024)

SECURITY:

  • Explicitly set 'Content-Type' header to mitigate XSS vulnerability. [GH-21704]
  • Implement HTML sanitization for user-generated content to prevent XSS attacks in the UI. [GH-21711]
  • UI: Remove codemirror linting due to package dependency [GH-21726]
  • Upgrade Go to use 1.22.7. This addresses CVE CVE-2024-34155 [GH-21705]
  • Upgrade to support aws/aws-sdk-go v1.55.5 or higher. This resolves CVEs CVE-2020-8911 and CVE-2020-8912. [GH-21684]
  • ui: Pin a newer resolution of Braces [GH-21710]
  • ui: Pin a newer resolution of Codemirror [GH-21715]
  • ui: Pin a newer resolution of Markdown-it [GH-21717]
  • ui: Pin a newer resolution of ansi-html [GH-21735]

FEATURES:

  • server: remove v2 tenancy, catalog, and mesh experiments [GH-21592]

IMPROVEMENTS:

  • security: upgrade ubi base image to 9.4 [GH-21750]
  • connect: Add Envoy 1.31 and 1.30 to support matrix [GH-21616]

BUG FIXES:

  • jwt-provider: change dns lookup family from the default of AUTO which would prefer ipv6 to ALL if LOGICAL_DNS is used or PREFER_IPV4 if STRICT_DNS is used to gracefully handle transitions to ipv6. [GH-21703]

1.19.3 Enterprise (October 29, 2024)

BREAKING CHANGES:

  • mesh: (Enterprise Only) Enable Envoy HttpConnectionManager.normalize_path by default on inbound traffic to mesh proxies. This resolves CVE-2024-10005.

SECURITY:

  • Explicitly set 'Content-Type' header to mitigate XSS vulnerability. [GH-21704]
  • Implement HTML sanitization for user-generated content to prevent XSS attacks in the UI. [GH-21711]
  • UI: Remove codemirror linting due to package dependency [GH-21726]
  • Upgrade Go to use 1.22.7. This addresses CVE CVE-2024-34155 [GH-21705]
  • Upgrade to support aws/aws-sdk-go v1.55.5 or higher. This resolves CVEs CVE-2020-8911 and CVE-2020-8912. [GH-21684]
  • mesh: (Enterprise Only) Add contains and ignoreCase to L7 Intentions HTTP header matching criteria to support configuration resilient to variable casing and multiple values. This resolves CVE-2024-10006.
  • mesh: (Enterprise Only) Add http.incoming.requestNormalization to Mesh configuration entry to support inbound service traffic request normalization. This resolves CVE-2024-10005 and CVE-2024-10006.
  • ui: Pin a newer resolution of Braces [GH-21710]
  • ui: Pin a newer resolution of Codemirror [GH-21715]
  • ui: Pin a newer resolution of Markdown-it [GH-21717]
  • ui: Pin a newer resolution of ansi-html [GH-21735]

IMPROVEMENTS:

  • security: upgrade ubi base image to 9.4 [GH-21750]
  • api: remove dependency on proto-public, protobuf, and grpc [GH-21780]
  • xds: configures Envoy to load balance over all instances of an external service configured with hostnames when "envoy_dns_discovery_type" is set to "STRICT_DNS" [GH-21655]

BUG FIXES:

  • jwt-provider: change dns lookup family from the default of AUTO which would prefer ipv6 to ALL if LOGICAL_DNS is used or PREFER_IPV4 if STRICT_DNS is used to gracefully handle transitions to ipv6. [GH-21703]

1.19.2 (August 26, 2024)

SECURITY:

  • ui: Upgrade modules with d3-color as a dependency to address denial of service issue in d3-color < 3.1.0 [GH-21588]

IMPROVEMENTS:

  • Use Envoy's default for a route's validate_clusters option, which is false. This fixes a case where non-existent clusters could cause a route to no longer route to any of its backends, including existing ones. [GH-21587]

BUG FIXES:

  • api-gateway: (Enterprise only) ensure clusters are properly created for JWT providers with a remote URI for the JWKS endpoint [GH-21604]

1.18.5 Enterprise (October 29, 2024)

Enterprise LTS: Consul Enterprise 1.18 is a Long-Term Support (LTS) release. BREAKING CHANGES:

  • mesh: (Enterprise Only) Enable Envoy HttpConnectionManager.normalize_path by default on inbound traffic to mesh proxies. This resolves CVE-2024-10005.

SECURITY:

  • Explicitly set 'Content-Type' header to mitigate XSS vulnerability. [GH-21704]
  • Implement HTML sanitization for user-generated content to prevent XSS attacks in the UI. [GH-21711]
  • Upgrade Go to use 1.22.7. This addresses CVE CVE-2024-34155 [GH-21705]
  • Upgrade to support aws/aws-sdk-go v1.55.5 or higher. This resolves CVEs CVE-2020-8911 and CVE-2020-8912. [GH-21684]
  • mesh: (Enterprise Only) Add contains and ignoreCase to L7 Intentions HTTP header matching criteria to support configuration resilient to variable casing and multiple values. This resolves CVE-2024-10006.
  • mesh: (Enterprise Only) Add http.incoming.requestNormalization to Mesh configuration entry to support inbound service traffic request normalization. This resolves CVE-2024-10005 and CVE-2024-10006.
  • ui: Pin a newer resolution of Braces [GH-21710]
  • ui: Pin a newer resolution of Codemirror [GH-21715]
  • ui: Pin a newer resolution of Markdown-it [GH-21717]
  • ui: Pin a newer resolution of ansi-html [GH-21735]

IMPROVEMENTS:

  • security: upgrade ubi base image to 9.4 [GH-21750]
  • api: remove dependency on proto-public, protobuf, and grpc [GH-21780]
  • xds: configures Envoy to load balance over all instances of an external service configured with hostnames when "envoy_dns_discovery_type" is set to "STRICT_DNS" [GH-21655]

BUG FIXES:

  • jwt-provider: change dns lookup family from the default of AUTO which would prefer ipv6 to ALL if LOGICAL_DNS is used or PREFER_IPV4 if STRICT_DNS is used to gracefully handle transitions to ipv6. [GH-21703]

1.18.4 Enterprise (August 26, 2024)

Enterprise LTS: Consul Enterprise 1.18 is a Long-Term Support (LTS) release.

SECURITY:

  • ui: Upgrade modules with d3-color as a dependency to address denial of service issue in d3-color < 3.1.0

IMPROVEMENTS:

  • Use Envoy's default for a route's validate_clusters option, which is false. This fixes a case where non-existent clusters could cause a route to no longer route to any of its backends, including existing ones. [GH-21587]

1.17.7 Enterprise (August 26, 2024)

SECURITY:

  • ui: Upgrade modules with d3-color as a dependency to address denial of service issue in d3-color < 3.1.0

IMPROVEMENTS:

  • Use Envoy's default for a route's validate_clusters option, which is false. This fixes a case where non-existent clusters could cause a route to no longer route to any of its backends, including existing ones. [GH-21587]

1.15.15 Enterprise (October 29, 2024)

Enterprise LTS: Consul Enterprise 1.15 is a Long-Term Support (LTS) release. BREAKING CHANGES:

  • mesh: (Enterprise Only) Enable Envoy HttpConnectionManager.normalize_path by default on inbound traffic to mesh proxies. This resolves CVE-2024-10005.

SECURITY:

  • Explicitly set 'Content-Type' header to mitigate XSS vulnerability. [GH-21704]
  • Implement HTML sanitization for user-generated content to prevent XSS attacks in the UI. [GH-21711]
  • UI: Remove codemirror linting due to package dependency [GH-21726]
  • Upgrade Go to use 1.22.7. This addresses CVE CVE-2024-34155 [GH-21705]
  • Upgrade to support aws/aws-sdk-go v1.55.5 or higher. This resolves CVEs CVE-2020-8911 and CVE-2020-8912. [GH-21684]
  • mesh: (Enterprise Only) Add contains and ignoreCase to L7 Intentions HTTP header matching criteria to support configuration resilient to variable casing and multiple values. This resolves CVE-2024-10006.
  • mesh: (Enterprise Only) Add http.incoming.requestNormalization to Mesh configuration entry to support inbound service traffic request normalization. This resolves CVE-2024-10005 and CVE-2024-10006.
  • ui: Pin a newer resolution of Braces [GH-21710]
  • ui: Pin a newer resolution of Codemirror [GH-21715]
  • ui: Pin a newer resolution of Markdown-it [GH-21717]
  • ui: Pin a newer resolution of ansi-html [GH-21735]

IMPROVEMENTS:

  • security: upgrade ubi base image to 9.4 [GH-21750]
  • xds: configures Envoy to load balance over all instances of an external service configured with hostnames when "envoy_dns_discovery_type" is set to "STRICT_DNS" [GH-21655]

1.15.14 Enterprise (August 26, 2024)

Enterprise LTS: Consul Enterprise 1.15 is a Long-Term Support (LTS) release.

SECURITY:

  • ui: Upgrade modules with d3-color as a dependency to address denial of service issue in d3-color < 3.1.0 [GH-21588]

IMPROVEMENTS:

  • Use Envoy's default for a route's validate_clusters option, which is false. This fixes a case where non-existent clusters could cause a route to no longer route to any of its backends, including existing ones. [GH-21587]

1.19.1 (July 11, 2024)

SECURITY:

IMPROVEMENTS:

  • mesh: update supported envoy version 1.29.5 in addition to 1.28.4, 1.27.6. [GH-21277]

BUG FIXES:

  • core: Fix multiple incorrect type conversion for potential overflows [GH-21251]
  • core: Fix panic runtime error on AliasCheck [GH-21339]
  • dns: Fix a regression where DNS SRV questions were returning duplicate hostnames instead of encoded IPs. This affected Nomad integrations with Consul. [GH-21361]
  • dns: Fix a regression where DNS tags using the standard lookup syntax, tag.name.service.consul, were being disregarded. [GH-21361]
  • dns: Fixes a spam log message "Failed to parse TTL for prepared query..." that was always being logged on each prepared query evaluation. [GH-21381]
  • terminating-gateway: (Enterprise Only) Fixed issue where enterprise metadata applied to linked services was the terminating-gateways enterprise metadata and not the linked services enterprise metadata. [GH-21382]
  • txn: Fix a bug where mismatched Consul server versions could result in undetected data loss for when using newer Transaction verbs. [GH-21519]

1.18.3 Enterprise (July 11, 2024)

Enterprise LTS: Consul Enterprise 1.18 is a Long-Term Support (LTS) release.

SECURITY:

IMPROVEMENTS:

  • mesh: update supported envoy version 1.29.4
  • mesh: update supported envoy version 1.29.5 in addition to 1.28.4, 1.27.6. [GH-21277]
  • upgrade go version to v1.22.3. [GH-21113]
  • upgrade go version to v1.22.4. [GH-21265]

BUG FIXES:

  • core: Fix multiple incorrect type conversion for potential overflows [GH-21251]
  • core: Fix panic runtime error on AliasCheck [GH-21339]
  • dns: Fixes a spam log message "Failed to parse TTL for prepared query..." that was always being logged on each prepared query evaluation. [GH-21381]
  • terminating-gateway: (Enterprise Only) Fixed issue where enterprise metadata applied to linked services was the terminating-gateways enterprise metadata and not the linked services enterprise metadata. [GH-21382]
  • txn: Fix a bug where mismatched Consul server versions could result in undetected data loss for when using newer Transaction verbs. [GH-21519]
  • v2dns: Fix a regression where DNS SRV questions were returning duplicate hostnames instead of encoded IPs. This affected Nomad integrations with Consul. [GH-21361]
  • v2dns: Fix a regression where DNS tags using the standard lookup syntax, tag.name.service.consul, were being disregarded. [GH-21361]

1.17.6 Enterprise (July 11, 2024)

SECURITY:

IMPROVEMENTS:

  • upgrade go version to v1.22.3. [GH-21113]
  • upgrade go version to v1.22.4. [GH-21265]

BUG FIXES:

  • core: Fix panic runtime error on AliasCheck [GH-21339]
  • terminating-gateway: (Enterprise Only) Fixed issue where enterprise metadata applied to linked services was the terminating-gateways enterprise metadata and not the linked services enterprise metadata. [GH-21382]
  • txn: Fix a bug where mismatched Consul server versions could result in undetected data loss for when using newer Transaction verbs. [GH-21519]

1.15.13 Enterprise (July 11, 2024)

Enterprise LTS: Consul Enterprise 1.15 is a Long-Term Support (LTS) release.

SECURITY:

IMPROVEMENTS:

  • mesh: update supported envoy version 1.29.4
  • upgrade go version to v1.22.3. [GH-21113]
  • upgrade go version to v1.22.4. [GH-21265]

BUG FIXES:

  • core: Fix panic runtime error on AliasCheck [GH-21339]
  • terminating-gateway: (Enterprise Only) Fixed issue where enterprise metadata applied to linked services was the terminating-gateways enterprise metadata and not the linked services enterprise metadata. [GH-21382]
  • txn: Fix a bug where mismatched Consul server versions could result in undetected data loss for when using newer Transaction verbs. [GH-21519]

1.19.0 (June 12, 2024)

BREAKING CHANGES:

  • telemetry: State store usage metrics with a double consul element in the metric name have been removed. Please use the same metric without the second consul instead. As an example instead of consul.consul.state.config_entries use consul.state.config_entries [GH-20674]

SECURITY:

FEATURES:

  • dns: queries now default to a refactored DNS server that is v1 and v2 Catalog compatible. Use v1dns in the experiments agent config to disable. The legacy server will be removed in a future release of Consul. See the Consul 1.19.x Release Notes for removed DNS features. [GH-20715]
  • gateways: api-gateway can leverage listener TLS certificates available on the gateway's local filesystem by specifying the public certificate and private key path in the new file-system-certificate configuration entry [GH-20873]

IMPROVEMENTS:

  • dns: new version was not supporting partition or namespace being set to 'default' in CE version. [GH-21230]
  • mesh: update supported envoy version 1.29.4 in addition to 1.28.3, 1.27.5, 1.26.8. [GH-21142]
  • upgrade go version to v1.22.4. [GH-21265]
  • Upgrade github.com/envoyproxy/go-control-plane to 0.12.0. [GH-20973]
  • dns: DNS-over-grpc when using consul-dataplane now accepts partition, namespace, token as metadata to default those query parameters. consul-dataplane v1.5+ will send this information automatically. [GH-20899]
  • snapshot: Add consul snapshot decode CLI command to output a JSON object stream of all the snapshots data. [GH-20824]
  • telemetry: Add telemetry.disable_per_tenancy_usage_metrics in agent configuration to disable setting tenancy labels on usage metrics. This significantly decreases CPU utilization in clusters with many admin partitions or namespaces.
  • telemetry: Improved the performance usage metrics emission by not outputting redundant metrics. [GH-20674]

DEPRECATIONS:

  • snapshot agent: (Enterprise only) Top level single snapshot destinations local_storage, aws_storage, azure_blob_storage, and google_storage in snapshot agent configuration files are now deprecated. Use the backup_destinations config object instead.

BUG FIXES:

1.18.2 (May 14, 2024)

Enterprise LTS: Consul Enterprise 1.18 is a Long-Term Support (LTS) release.

SECURITY:

IMPROVEMENTS:

  • gateways: service defaults configuration entries can now be used to set default upstream limits for mesh-gateways [GH-20945]
  • connect: Add ability to disable Auto Host Header Rewrite on Terminating Gateway at the service level [GH-20802]

BUG FIXES:

  • dns: fix a bug with sameness group queries in DNS where responses did not respect DefaultForFailover. DNS requests against sameness groups without this field set will now error as intended.
  • error running consul server in 1.18.0: failed to configure SCADA provider user's home directory path: $HOME is not defined [GH-20926]
  • server: fix Ent snapshot restore on CE when CE downgrade is enabled [GH-20977]
  • xds: Make TCP external service registered with terminating gateway reachable from peered cluster [GH-19881]

1.17.5 Enterprise (May 14, 2024)

SECURITY:

BUG FIXES:

  • dns: fix a bug with sameness group queries in DNS where responses did not respect DefaultForFailover. DNS requests against sameness groups without this field set will now error as intended.
  • xds: Make TCP external service registered with terminating gateway reachable from peered cluster [GH-19881]

1.16.8 Enterprise (May 14, 2024)

SECURITY:

BUG FIXES:

  • dns: fix a bug with sameness group queries in DNS where responses did not respect DefaultForFailover. DNS requests against sameness groups without this field set will now error as intended.
  • xds: Make TCP external service registered with terminating gateway reachable from peered cluster [GH-19881]

1.15.12 Enterprise (May 14, 2024)

Enterprise LTS: Consul Enterprise 1.15 is a Long-Term Support (LTS) release.

SECURITY:

BUG FIXES:

  • xds: Make TCP external service registered with terminating gateway reachable from peered cluster [GH-19881]

1.18.1 (March 26, 2024)

Enterprise LTS: Consul Enterprise 1.18 is a Long-Term Support (LTS) release.

BREAKING CHANGES:

  • ui: Adds a "Link to HCP Consul Central" modal with integration to side-nav and link to HCP banner. There will be an option to disable the Link to HCP banner from the UI in a follow-up release. [GH-20474]

SECURITY:

IMPROVEMENTS:

  • api: Randomize the returned server list for the WatchServers gRPC endpoint. [GH-20866]
  • partitions: (Enterprise only) Allow disabling of Gossip per Partition [GH-20669]
  • snapshot agent: (Enterprise only) Add support for multiple snapshot destinations using the backup_destinations config file object.
  • xds: Improved the performance of xDS server side load balancing. Its slightly improved in Consul CE with drastic CPU usage reductions in Consul Enterprise. [GH-20672]

BUG FIXES:

  • audit-logs: (Enterprise Only) Fixes non ASCII characters in audit logs because of gzip. [GH-20345]
  • connect: Fix issue where Consul-dataplane xDS sessions would not utilize the streaming backend for wan-federated queries. [GH-20868]
  • connect: Fix potential goroutine leak in xDS stream handling. [GH-20866]
  • connect: Fix xDS deadlock that could result in proxies being unable to start. [GH-20867]
  • ingress-gateway: (Enterprise Only) Fix a bug where on update, Ingress Gateways lost all upstreams for listeners with wildcard services in a different namespace.

1.17.4 Enterprise (March 26, 2024)

SECURITY:

IMPROVEMENTS:

  • api: Randomize the returned server list for the WatchServers gRPC endpoint. [GH-20866]
  • snapshot agent: (Enterprise only) Add support for multiple snapshot destinations using the backup_destinations config file object.

BUG FIXES:

  • connect: Fix issue where Consul-dataplane xDS sessions would not utilize the streaming backend for wan-federated queries. [GH-20868]
  • connect: Fix potential goroutine leak in xDS stream handling. [GH-20866]
  • connect: Fix xDS deadlock that could result in proxies being unable to start. [GH-20867]
  • dns: SERVFAIL when resolving not found PTR records. [GH-20679]
  • ingress-gateway: (Enterprise Only) Fix a bug where on update, Ingress Gateways lost all upstreams for listeners with wildcard services in a different namespace.
  • snapshot-agent: (Enterprise only) Fix a bug with static AWS credentials where one of the key id or secret key is provided via config file and the other is provided via an environment variable.

1.16.7 Enterprise (March 26, 2024)

SECURITY:

IMPROVEMENTS:

  • api: Randomize the returned server list for the WatchServers gRPC endpoint. [GH-20866]
  • snapshot agent: (Enterprise only) Add support for multiple snapshot destinations using the backup_destinations config file object.

BUG FIXES:

  • connect: Fix issue where Consul-dataplane xDS sessions would not utilize the streaming backend for wan-federated queries. [GH-20868]
  • connect: Fix potential goroutine leak in xDS stream handling. [GH-20866]
  • connect: Fix xDS deadlock that could result in proxies being unable to start. [GH-20867]
  • ingress-gateway: (Enterprise Only) Fix a bug where on update, Ingress Gateways lost all upstreams for listeners with wildcard services in a different namespace.
  • snapshot-agent: (Enterprise only) Fix a bug with static AWS credentials where one of the key id or secret key is provided via config file and the other is provided via an environment variable.

1.15.11 Enterprise (March 26, 2024)

Enterprise LTS: Consul Enterprise 1.15 is a Long-Term Support (LTS) release.

SECURITY:

IMPROVEMENTS:

  • api: Randomize the returned server list for the WatchServers gRPC endpoint. [GH-20866]

BUG FIXES:

  • connect: Fix issue where Consul-dataplane xDS sessions would not utilize the streaming backend for wan-federated queries. [GH-20868]
  • connect: Fix potential goroutine leak in xDS stream handling. [GH-20866]
  • connect: Fix xDS deadlock that could result in proxies being unable to start. [GH-20867]
  • ingress-gateway: (Enterprise Only) Fix a bug where on update, Ingress Gateways lost all upstreams for listeners with wildcard services in a different namespace.
  • snapshot-agent: (Enterprise only) Fix a bug with static AWS credentials where one of the key id or secret key is provided via config file and the other is provided via an environment variable.

1.18.0 (February 27, 2024)

BREAKING CHANGES:

  • config-entries: Allow disabling request and idle timeouts with negative values in service router and service resolver config entries. [GH-19992]
  • telemetry: Adds fix to always use the value of telemetry.disable_hostname when determining whether to prefix gauge-type metrics with the hostname of the Consul agent. Previously, if only the default metric sink was enabled, this configuration was ignored and always treated as true, even though its default value is false. [GH-20312]

SECURITY:

FEATURES:

  • acl: add policy bindtype to binding rules. [GH-19499]
  • agent: Introduces a new agent config default_intention_policy to decouple the default intention behavior from ACLs [GH-20544]
  • agent: (Enterprise Only) Add fault injection filter support for Consul Service Mesh
  • cloud: Adds new API/CLI to initiate and manage linking a Consul cluster to HCP Consul Central [GH-20312]
  • dns: adds experimental support for a refactored DNS server that is v1 and v2 Catalog compatible. Use v2dns in the experiments agent config to enable. It will automatically be enabled when using the resource-apis (Catalog v2) experiment. The new DNS implementation will be the default in Consul 1.19. See the Consul 1.18.x Release Notes for deprecated DNS features. [GH-20643]
  • ui: Added a banner to let users link their clusters to HCP [GH-20275]
  • ui: Adds a redirect and warning message around unavailable UI with V2 enabled [GH-20359]
  • ui: adds V2CatalogEnabled to config that is passed to the ui [GH-20353]
  • v2: prevent use of the v2 experiments in secondary datacenters for now [GH-20299]

IMPROVEMENTS:

  • cloud: unconditionally add Access-Control-Expose-Headers HTTP header [GH-20220]
  • connect: Replace usage of deprecated Envoy field envoy.config.core.v3.HeaderValueOption.append. [GH-20078]
  • connect: Replace usage of deprecated Envoy fields envoy.config.route.v3.HeaderMatcher.safe_regex_match and envoy.type.matcher.v3.RegexMatcher.google_re2. [GH-20013]
  • docs: add Link API documentation [GH-20308]
  • resource: lowercase names enforced for v2 resources only. [GH-19218]

BUG FIXES:

  • dns: SERVFAIL when resolving not found PTR records. [GH-20679]
  • raft: Fix panic during downgrade from enterprise to oss. [GH-19311]
  • server: Ensure controllers are automatically restarted on internal stream errors. [GH-20642]
  • server: Ensure internal streams are properly terminated on snapshot restore. [GH-20642]
  • snapshot-agent: (Enterprise only) Fix a bug with static AWS credentials where one of the key id or secret key is provided via config file and the other is provided via an environment variable.

1.17.3 (February 13, 2024)

SECURITY:

FEATURES:

  • cli: Adds new command exported-services to list all services exported and their consumers. Refer to the CLI docs for more information. [GH-20331]

IMPROVEMENTS:

  • ProxyCfg: avoid setting a watch on Internal.ServiceDump when mesh gateway is not used. [GH-20168]
  • ProxyCfg: only return the nodes list when querying the Internal.ServiceDump watch from proxycfg [GH-20168]
  • Upgrade to use Go 1.21.7. [GH-20545]
  • api: add a new api(/v1/exported-services) to list all the exported service and their consumers. [GH-20015]
  • connect: Add CaseInsensitive flag to service-routers that allows paths and path prefixes to ignore URL upper and lower casing. [GH-19647]

BUG FIXES:

  • audit-logs: (Enterprise Only) Fixes non ASCII characters in audit logs because of gzip. [GH-20345]
  • connect: Fix issue where re-persisting existing proxy-defaults using http protocol fails with a protocol-mismatch error. [GH-20481]
  • connect: Fix regression with SAN matching on terminating gateways GH-20360 [GH-20417]
  • connect: Remove code coupling where the xDS capacity controller could negatively affect raft autopilot performance. [GH-20511]
  • logging: add /api prefix to v2 resource endpoint logs [GH-20352]
  • mesh: Fix bug where envoy extensions could not be configured with "permissive" mTLS mode. Note that envoy extensions currently do not apply to non-mTLS traffic in permissive mode. [GH-20406]

1.16.6 (February 13, 2024)

SECURITY:

IMPROVEMENTS:

  • ProxyCfg: avoid setting a watch on Internal.ServiceDump when mesh gateway is not used. [GH-20168]
  • ProxyCfg: only return the nodes list when querying the Internal.ServiceDump watch from proxycfg [GH-20168]
  • Upgrade to use Go 1.21.7. [GH-20545]

BUG FIXES:

  • audit-logs: (Enterprise Only) Fixes non ASCII characters in audit logs because of gzip. [GH-20345]
  • connect: Fix issue where re-persisting existing proxy-defaults using http protocol fails with a protocol-mismatch error. [GH-20481]
  • connect: Fix regression with SAN matching on terminating gateways GH-20360 [GH-20417]
  • connect: Remove code coupling where the xDS capacity controller could negatively affect raft autopilot performance. [GH-20511]
  • mesh: Fix bug where envoy extensions could not be configured with "permissive" mTLS mode. Note that envoy extensions currently do not apply to non-mTLS traffic in permissive mode. [GH-20406]

1.15.10 (February 13, 2024)

SECURITY:

IMPROVEMENTS:

  • ProxyCfg: avoid setting a watch on Internal.ServiceDump when mesh gateway is not used. [GH-20168]
  • ProxyCfg: only return the nodes list when querying the Internal.ServiceDump watch from proxycfg [GH-20168]
  • Upgrade to use Go 1.21.7. [GH-20545]
  • mesh: update supported envoy version 1.28.0 in addition to 1.27.2, 1.26.6 to support LTS release [GH-20323]

BUG FIXES:

  • audit-logs: (Enterprise Only) Fixes non ASCII characters in audit logs because of gzip. [GH-20345]
  • connect: Fix issue where re-persisting existing proxy-defaults using http protocol fails with a protocol-mismatch error. [GH-20481]
  • connect: Remove code coupling where the xDS capacity controller could negatively affect raft autopilot performance. [GH-20511]

1.17.2 (January 23, 2024)

KNOWN ISSUES:

  • connect: Consul versions 1.17.2 and 1.16.5 perform excessively strict TLS SAN verification on terminating gateways, which prevents connections outside of the mesh to upstream services. Terminating gateway users are advised to avoid deploying these Consul versions. A fix will be present in a future release of Consul 1.17.3 and 1.16.6. [GH-20360]

SECURITY:

  • Upgrade OpenShift container images to use ubi9-minimal:9.3 as the base image. [GH-20014]

IMPROVEMENTS:

  • connect: Remove usage of deprecated Envoy field match_subject_alt_names in favor of match_typed_subject_alt_names. [GH-19954]
  • connect: replace usage of deprecated Envoy field envoy.config.router.v3.WeightedCluster.total_weight. [GH-20011]
  • xds: Replace usage of deprecated Envoy field envoy.config.cluster.v3.Cluster.http_protocol_options [GH-20010]
  • xds: remove usages of deprecated Envoy fields: envoy.config.cluster.v3.Cluster.http2_protocol_options, envoy.config.bootstrap.v3.Admin.access_log_path [GH-19940]
  • xds: replace usage of deprecated Envoy field envoy.extensions.filters.http.lua.v3.Lua.inline_code [GH-20012]

DEPRECATIONS:

  • cli: Deprecate the -admin-access-log-path flag from consul connect envoy command in favor of: -admin-access-log-config. [GH-19943]

BUG FIXES:

  • prepared-query: (Enterprise-only) Fix issue where sameness-group failover targets to peers would attempt to query data from the default partition, rather than the sameness-group's partition always.
  • ui: update token list on Role details page to show only linked tokens [GH-19912]

1.16.5 (January 23, 2024)

KNOWN ISSUES:

  • connect: Consul versions 1.17.2 and 1.16.5 perform excessively strict TLS SAN verification on terminating gateways, which prevents connections outside of the mesh to upstream services. Terminating gateway users are advised to avoid deploying these Consul versions. A fix will be present in a future release of Consul 1.17.3 and 1.16.6 [GH-20360].

SECURITY:

  • Update RSA key generation to use a key size of at least 2048 bits. [GH-20112]
  • Upgrade OpenShift container images to use ubi9-minimal:9.3 as the base image. [GH-20014]

IMPROVEMENTS:

  • Upgrade to use Go 1.21.6. [GH-20062]
  • connect: Remove usage of deprecated Envoy field match_subject_alt_names in favor of match_typed_subject_alt_names. [GH-19954]
  • connect: replace usage of deprecated Envoy field envoy.config.router.v3.WeightedCluster.total_weight. [GH-20011]
  • xds: Replace usage of deprecated Envoy field envoy.config.cluster.v3.Cluster.http_protocol_options [GH-20010]
  • xds: remove usages of deprecated Envoy fields: envoy.config.cluster.v3.Cluster.http2_protocol_options, envoy.config.bootstrap.v3.Admin.access_log_path [GH-19940]
  • xds: replace usage of deprecated Envoy field envoy.extensions.filters.http.lua.v3.Lua.inline_code [GH-20012]

BUG FIXES:

  • prepared-query: (Enterprise-only) Fix issue where sameness-group failover targets to peers would attempt to query data from the default partition, rather than the sameness-group's partition always.
  • ui: update token list on Role details page to show only linked tokens [GH-19912]

1.15.9 (January 23, 2024)

SECURITY:

  • Update RSA key generation to use a key size of at least 2048 bits. [GH-20112]
  • Upgrade OpenShift container images to use ubi9-minimal:9.3 as the base image. [GH-20014]

IMPROVEMENTS:

BUG FIXES:

  • ui: update token list on Role details page to show only linked tokens [GH-19912]

1.17.1 (December 12, 2023)

SECURITY:

  • Update github.com/golang-jwt/jwt/v4 to v4.5.0 to address PRISMA-2022-0270. [GH-19705]
  • Upgrade to use Go 1.20.12. This resolves CVEs CVE-2023-45283: (path/filepath) recognize ??\ as a Root Local Device path prefix (Windows) CVE-2023-45284: recognize device names with trailing spaces and superscripts (Windows) CVE-2023-39326: (net/http) limit chunked data overhead CVE-2023-45285: (cmd/go) go get may unexpectedly fallback to insecure git [GH-19840]
  • connect: update supported envoy versions to 1.24.12, 1.25.11, 1.26.6, 1.27.2 to address CVE-2023-44487 [GH-19274]

FEATURES:

  • acl: Adds nomad client templated policy [GH-19827]
  • cli: Adds new subcommand peering exported-services to list services exported to a peer . Refer to the CLI docs for more information. [GH-19821]

IMPROVEMENTS:

  • mesh: parse the proxy-defaults protocol when write the config-entry to avoid parsing it when compiling the discovery chain. [GH-19829]
  • wan-federation: use a hash to diff config entries when replicating in the secondary DC to avoid unnecessary writes.. [GH-19795]
  • Replaces UI Side Nav with Helios Design System Side Nav. Adds dc/partition/namespace searching in Side Nav. [GH-19342]
  • acl: add api-gateway templated policy [GH-19728]
  • acl: add templated policy descriptions [GH-19735]
  • api: Add support for listing ACL tokens by service name when using templated policies. [GH-19666]
  • cli: stop simultaneous usage of -templated-policy and -templated-policy-file when creating a role or token. [GH-19389]
  • cloud: push additional server TLS metadata to HCP [GH-19682]
  • connect: Default stats_flush_interval to 60 seconds when using the Consul Telemetry Collector, unless custom stats sink are present or an explicit flush interval is configured. [GH-19663]
  • metrics: increment consul.client.rpc.failed if RPC fails because no servers are accessible [GH-19721]
  • metrics: modify consul.client.rpc metric to exclude internal retries for consistency with consul.client.rpc.exceeded and consul.client.rpc.failed [GH-19721]
  • ui: move nspace and partitions requests into their selector menus [GH-19594]

BUG FIXES:

  • CLI: fix a panic when deleting a non existing policy by name. [GH-19679]
  • Mesh Gateways: Fix a bug where replicated and peered mesh gateways with hostname-based WAN addresses fail to initialize. [GH-19268]
  • ca: Fix bug with Vault CA provider where renewing a retracted token would cause retries in a tight loop, degrading performance. [GH-19285]
  • ca: Fix bug with Vault CA provider where token renewal goroutines could leak if CA failed to initialize. [GH-19285]
  • connect: Solves an issue where two upstream services with the same name in different namespaces were not getting routed to correctly by API Gateways. [GH-19860]
  • federation: (Enterprise Only) Fixed an issue where namespace reconciliation could result into the secondary having dangling instances of namespaces marked for deletion
  • ui: clear peer on home logo link [GH-19549]
  • ui: fix being able to view peered services from non-default namnespaces [GH-19586]
  • ui: stop manually reconciling services if peering is enabled [GH-19907]
  • wan-federation: Fix a bug where servers wan-federated through mesh-gateways could crash due to overlapping LAN IP addresses. [GH-19503]
  • xds: Add configurable xds_fetch_timeout_ms option to proxy registrations that allows users to prevent endpoints from dropping when they have proxies with a large number of upstreams. [GH-19871]
  • xds: ensure child resources are re-sent to Envoy when the parent is updated even if the child already has pending updates. [GH-19866]

1.16.4 (December 12, 2023)

SECURITY:

  • Update github.com/golang-jwt/jwt/v4 to v4.5.0 to address PRISMA-2022-0270. [GH-19705]
  • Upgrade to use Go 1.20.12. This resolves CVEs CVE-2023-45283: (path/filepath) recognize ??\ as a Root Local Device path prefix (Windows) CVE-2023-45284: recognize device names with trailing spaces and superscripts (Windows) CVE-2023-39326: (net/http) limit chunked data overhead CVE-2023-45285: (cmd/go) go get may unexpectedly fallback to insecure git [GH-19840]

IMPROVEMENTS:

  • mesh: parse the proxy-defaults protocol when write the config-entry to avoid parsing it when compiling the discovery chain. [GH-19829]
  • wan-federation: use a hash to diff config entries when replicating in the secondary DC to avoid unnecessary writes.. [GH-19795]
  • cli: Adds cli support for checking TCP connection for ports. If -ports flag is not given, it will check for default ports of consul listed here - https://developer.hashicorp.com/consul/docs/install/ports [GH-18329]
  • cloud: push additional server TLS metadata to HCP [GH-19682]
  • connect: Default stats_flush_interval to 60 seconds when using the Consul Telemetry Collector, unless custom stats sink are present or an explicit flush interval is configured. [GH-19663]
  • metrics: increment consul.client.rpc.failed if RPC fails because no servers are accessible [GH-19721]
  • metrics: modify consul.client.rpc metric to exclude internal retries for consistency with consul.client.rpc.exceeded and consul.client.rpc.failed [GH-19721]

BUG FIXES:

  • CLI: fix a panic when deleting a non existing policy by name. [GH-19679]
  • connect: Solves an issue where two upstream services with the same name in different namespaces were not getting routed to correctly by API Gateways. [GH-19860]
  • federation: (Enterprise Only) Fixed an issue where namespace reconciliation could result into the secondary having dangling instances of namespaces marked for deletion
  • ui: only show hcp link if url is present [GH-19443]
  • wan-federation: Fix a bug where servers wan-federated through mesh-gateways could crash due to overlapping LAN IP addresses. [GH-19503]
  • xds: Add configurable xds_fetch_timeout_ms option to proxy registrations that allows users to prevent endpoints from dropping when they have proxies with a large number of upstreams. [GH-19871]
  • xds: ensure child resources are re-sent to Envoy when the parent is updated even if the child already has pending updates. [GH-19866]

1.15.8 (December 12, 2023)

SECURITY:

  • Update github.com/golang-jwt/jwt/v4 to v4.5.0 to address PRISMA-2022-0270. [GH-19705]
  • Upgrade to use Go 1.20.12. This resolves CVEs CVE-2023-45283: (path/filepath) recognize ??\ as a Root Local Device path prefix (Windows) CVE-2023-45284: recognize device names with trailing spaces and superscripts (Windows) CVE-2023-39326: (net/http) limit chunked data overhead CVE-2023-45285: (cmd/go) go get may unexpectedly fallback to insecure git [GH-19840]

IMPROVEMENTS:

  • mesh: parse the proxy-defaults protocol when write the config-entry to avoid parsing it when compiling the discovery chain. [GH-19829]
  • wan-federation: use a hash to diff config entries when replicating in the secondary DC to avoid unnecessary writes.. [GH-19795]
  • cli: Adds cli support for checking TCP connection for ports. If -ports flag is not given, it will check for default ports of consul listed here - https://developer.hashicorp.com/consul/docs/install/ports [GH-18329]
  • connect: Default stats_flush_interval to 60 seconds when using the Consul Telemetry Collector, unless custom stats sink are present or an explicit flush interval is configured. [GH-19663]
  • metrics: increment consul.client.rpc.failed if RPC fails because no servers are accessible [GH-19721]
  • metrics: modify consul.client.rpc metric to exclude internal retries for consistency with consul.client.rpc.exceeded and consul.client.rpc.failed [GH-19721]

BUG FIXES:

  • CLI: fix a panic when deleting a non existing policy by name. [GH-19679]
  • connect: Solves an issue where two upstream services with the same name in different namespaces were not getting routed to correctly by API Gateways. [GH-19860]
  • federation: (Enterprise Only) Fixed an issue where namespace reconciliation could result into the secondary having dangling instances of namespaces marked for deletion
  • ui: only show back-to-hcp link when url is present [GH-19444]
  • wan-federation: Fix a bug where servers wan-federated through mesh-gateways could crash due to overlapping LAN IP addresses. [GH-19503]
  • xds: Add configurable xds_fetch_timeout_ms option to proxy registrations that allows users to prevent endpoints from dropping when they have proxies with a large number of upstreams. [GH-19871]
  • xds: ensure child resources are re-sent to Envoy when the parent is updated even if the child already has pending updates. [GH-19866]

1.17.0 (October 31, 2023)

BREAKING CHANGES:

  • api: RaftLeaderTransfer now requires an id string. An empty string can be specified to keep the old behavior. [GH-17107]
  • audit-logging: (Enterprise only) allowing timestamp based filename only on rotation. initially the filename will be just file.json [GH-18668]

DEPRECATIONS:

  • cli: Deprecate the -admin-access-log-path flag from consul connect envoy command in favor of: -admin-access-log-config. [GH-15946]

SECURITY:

FEATURE PREVIEW: Catalog v2

This release provides the ability to preview Consul's v2 Catalog and Resource API if enabled. The new model supports multi-port application deployments with only a single Envoy proxy. Note that the v1 and v2 catalogs are not cross compatible, and not all Consul features are available within this v2 feature preview. See the v2 Catalog and Resource API documentation for more information. The v2 Catalog and Resources API should be considered a feature preview within this release and should not be used in production environments.

Limitations

  • The v2 catalog API feature preview does not support connections with client agents. As a result, it is only available for Kubernetes deployments, which use Consul dataplanes instead of client agents.
  • The v1 and v2 catalog APIs cannot run concurrently.
  • The Consul UI does not support multi-port services or the v2 catalog API in this release.
  • HCP Consul does not support multi-port services or the v2 catalog API in this release.

Significant Pull Requests

FEATURES:

  • Support custom watches on the Consul Controller framework. [GH-18439]
  • Windows: support consul connect envoy command on Windows [GH-17694]
  • acl: Add BindRule support for templated policies. Add new BindType: templated-policy and BindVar field for templated policy variables. [GH-18719]
  • acl: Add new acl.tokens.dns config field which specifies the token used implicitly during dns checks. [GH-17936]
  • acl: Added ACL Templated policies to simplify getting the right ACL token. [GH-18708]
  • acl: Adds a new ACL rule for workload identities [GH-18769]
  • acl: Adds workload identity templated policy [GH-19077]
  • api-gateway: Add support for response header modifiers on http-route configuration entry [GH-18646]
  • api-gateway: add retry and timeout filters [GH-18324]
  • cli: Add bind-var flag to consul acl binding-rule for templated policy variables. [GH-18719]
  • cli: Add consul acl templated-policy commands to read, list and preview templated policies. [GH-18816]
  • config-entry(api-gateway): (Enterprise only) Add GatewayPolicy to APIGateway Config Entry listeners
  • config-entry(api-gateway): (Enterprise only) Add JWTFilter to HTTPRoute Filters
  • dataplane: Allow getting bootstrap parameters when using V2 APIs [GH-18504]
  • gateway: (Enterprise only) Add JWT authentication and authorization to APIGateway Listeners and HTTPRoutes.
  • mesh: (Enterprise only) Adds rate limiting config to service-defaults [GH-18583]
  • xds: Add a built-in Envoy extension that appends OpenTelemetry Access Logging (otel-access-logging) to the HTTP Connection Manager filter. [GH-18336]
  • xds: Add support for patching outbound listeners to the built-in Envoy External Authorization extension. [GH-18336]

IMPROVEMENTS:

  • raft: upgrade raft-wal library version to 0.4.1. [GH-19314]
  • xds: Use downstream protocol when connecting to local app [GH-18573]
  • Windows: Integration tests for Consul Windows VMs [GH-18007]
  • acl: Use templated policy to generate synthetic policies for tokens/roles with node and/or service identities [GH-18813]
  • api: added CheckRegisterOpts to Agent API [GH-18943]
  • api: added Token field to ServiceRegisterOpts type in Agent API [GH-18983]
  • ca: Vault CA provider config no longer requires root_pki_path for secondary datacenters [GH-17831]
  • cli: Added -templated-policy, -templated-policy-file, -replace-templated-policy, -append-templated-policy, -replace-templated-policy-file, -append-templated-policy-file and -var flags for creating or updating tokens/roles. [GH-18708]
  • config: Add new tls.defaults.verify_server_hostname configuration option. This specifies the default value for any interfaces that support the verify_server_hostname option. [GH-17155]
  • connect: update supported envoy versions to 1.24.10, 1.25.9, 1.26.4, 1.27.0 [GH-18300]
  • ui: Use Community verbiage [GH-18560]

BUG FIXES:

  • api: add custom marshal/unmarshal for ServiceResolverConfigEntry.RequestTimeout so config entries that set this field can be read using the API. [GH-19031]
  • ca: ensure Vault CA provider respects Vault Enterprise namespace configuration. [GH-19095]
  • catalog api: fixes a bug with catalog api where filter query parameter was not working correctly for the /v1/catalog/services endpoint [GH-18322]
  • connect: (Enterprise only) Fix bug where incorrect service-defaults entries were fetched to determine an upstream's protocol whenever the upstream did not explicitly define the namespace / partition. When this bug occurs, upstreams would use the protocol from a service-default entry in the default namespace / partition, rather than their own namespace / partition.
  • connect: Fix bug where uncleanly closed xDS connections would influence connection balancing for too long and prevent envoy instances from starting. Two new configuration fields performance.grpc_keepalive_timeout and performance.grpc_keepalive_interval now exist to allow for configuration on how often these dead connections will be cleaned up. [GH-19339]
  • dev-mode: Fix dev mode has new line in responses. Now new line is added only when url has pretty query parameter. [GH-18367]
  • dns: (Enterprise only) Fix bug where sameness group queries did not correctly inherit the agent's partition.
  • docs: fix list of telemetry metrics [GH-17593]
  • gateways: Fix a bug where a service in a peered datacenter could not access an external node service through a terminating gateway [GH-18959]
  • server: (Enterprise Only) Fixed an issue where snake case keys were rejected when configuring the control-plane-request-limit config entry
  • telemetry: emit consul version metric on a regular interval. [GH-6876]
  • tlsutil: Default setting of ServerName field in outgoing TLS configuration for checks now handled by crypto/tls. [GH-17481]

1.16.3 (October 31, 2023)

SECURITY:

BUG FIXES:

  • Mesh Gateways: Fix a bug where replicated and peered mesh gateways with hostname-based WAN addresses fail to initialize. [GH-19268]
  • api-gateway: fix matching for different hostnames on the same listener [GH-19120]
  • api: add custom marshal/unmarshal for ServiceResolverConfigEntry.RequestTimeout so config entries that set this field can be read using the API. [GH-19031]
  • ca: Fix bug with Vault CA provider where renewing a retracted token would cause retries in a tight loop, degrading performance. [GH-19285]
  • ca: Fix bug with Vault CA provider where token renewal goroutines could leak if CA failed to initialize. [GH-19285]
  • ca: ensure Vault CA provider respects Vault Enterprise namespace configuration. [GH-19095]
  • catalog api: fixes a bug with catalog api where filter query parameter was not working correctly for the /v1/catalog/services endpoint [GH-18322]
  • connect: Fix bug where uncleanly closed xDS connections would influence connection balancing for too long and prevent envoy instances from starting. Two new configuration fields performance.grpc_keepalive_timeout and performance.grpc_keepalive_interval now exist to allow for configuration on how often these dead connections will be cleaned up. [GH-19339]
  • dns: (Enterprise only) Fix bug where sameness group queries did not correctly inherit the agent's partition.
  • gateways: Fix a bug where a service in a peered datacenter could not access an external node service through a terminating gateway [GH-18959]
  • server: (Enterprise Only) Fixed an issue where snake case keys were rejected when configuring the control-plane-request-limit config entry

1.15.7 (October 31, 2023)

SECURITY:

BUG FIXES:

  • Mesh Gateways: Fix a bug where replicated and peered mesh gateways with hostname-based WAN addresses fail to initialize. [GH-19268]
  • api: add custom marshal/unmarshal for ServiceResolverConfigEntry.RequestTimeout so config entries that set this field can be read using the API. [GH-19031]
  • ca: Fix bug with Vault CA provider where renewing a retracted token would cause retries in a tight loop, degrading performance. [GH-19285]
  • ca: Fix bug with Vault CA provider where token renewal goroutines could leak if CA failed to initialize. [GH-19285]
  • ca: ensure Vault CA provider respects Vault Enterprise namespace configuration. [GH-19095]
  • catalog api: fixes a bug with catalog api where filter query parameter was not working correctly for the /v1/catalog/services endpoint [GH-18322]
  • connect: Fix bug where uncleanly closed xDS connections would influence connection balancing for too long and prevent envoy instances from starting. Two new configuration fields performance.grpc_keepalive_timeout and performance.grpc_keepalive_interval now exist to allow for configuration on how often these dead connections will be cleaned up. [GH-19339]
  • gateways: Fix a bug where a service in a peered datacenter could not access an external node service through a terminating gateway [GH-18959]

1.14.11 (October 31, 2023)

SECURITY:

BUG FIXES:

  • Mesh Gateways: Fix a bug where replicated and peered mesh gateways with hostname-based WAN addresses fail to initialize. [GH-19268]
  • api: add custom marshal/unmarshal for ServiceResolverConfigEntry.RequestTimeout so config entries that set this field can be read using the API. [GH-19031]
  • ca: ensure Vault CA provider respects Vault Enterprise namespace configuration. [GH-19095]
  • catalog api: fixes a bug with catalog api where filter query parameter was not working correctly for the /v1/catalog/services endpoint [GH-18322]
  • connect: Fix bug where uncleanly closed xDS connections would influence connection balancing for too long and prevent envoy instances from starting. Two new configuration fields performance.grpc_keepalive_timeout and performance.grpc_keepalive_interval now exist to allow for configuration on how often these dead connections will be cleaned up. [GH-19339]

1.17.0-rc1 (October 11, 2023)

BREAKING CHANGES:

  • api: RaftLeaderTransfer now requires an id string. An empty string can be specified to keep the old behavior. [GH-17107]
  • audit-logging: (Enterprise only) allowing timestamp based filename only on rotation. initially the filename will be just file.json [GH-18668]

FEATURE PREVIEW: Catalog v2

This release provides the ability to preview Consul's v2 Catalog and Resource API if enabled. The new model supports multi-port application deployments with only a single Envoy proxy. Note that the v1 and v2 catalogs are not cross compatible, and not all Consul features are available within this v2 feature preview. See the v2 Catalog and Resource API documentation for more information. The v2 Catalog and Resources API should be considered a feature preview within this release and should not be used in production environments.

Limitations

  • The v2 catalog API feature preview does not support connections with client agents. As a result, it is only available for Kubernetes deployments, which use Consul dataplanes instead of client agents.
  • The v1 and v2 catalog APIs cannot run concurrently.
  • The Consul UI does not support multi-port services or the v2 catalog API in this release.
  • HCP Consul does not support multi-port services or the v2 catalog API in this release.
  • The v2 API only supports transparent proxy mode where services that have permissions to connect to each other can use Kube DNS to connect.

Known Issues

  • When using the v2 API with transparent proxy, Kubernetes pods cannot use L7 liveness, readiness, or startup probes.

Significant Pull Requests

FEATURES:

  • Support custom watches on the Consul Controller framework. [GH-18439]
  • Windows: support consul connect envoy command on Windows [GH-17694]
  • acl: Add BindRule support for templated policies. Add new BindType: templated-policy and BindVar field for templated policy variables. [GH-18719]
  • acl: Add new acl.tokens.dns config field which specifies the token used implicitly during dns checks. [GH-17936]
  • acl: Added ACL Templated policies to simplify getting the right ACL token. [GH-18708]
  • acl: Adds a new ACL rule for workload identities [GH-18769]
  • api-gateway: Add support for response header modifiers on http-route configuration entry [GH-18646]
  • api-gateway: add retry and timeout filters [GH-18324]
  • cli: Add bind-var flag to consul acl binding-rule for templated policy variables. [GH-18719]
  • cli: Add consul acl templated-policy commands to read, list and preview templated policies. [GH-18816]
  • config-entry(api-gateway): (Enterprise only) Add GatewayPolicy to APIGateway Config Entry listeners
  • config-entry(api-gateway): (Enterprise only) Add JWTFilter to HTTPRoute Filters
  • dataplane: Allow getting bootstrap parameters when using V2 APIs [GH-18504]
  • gateway: (Enterprise only) Add JWT authentication and authorization to APIGateway Listeners and HTTPRoutes.
  • mesh: (Enterprise only) Adds rate limiting config to service-defaults [GH-18583]
  • xds: Add a built-in Envoy extension that appends OpenTelemetry Access Logging (otel-access-logging) to the HTTP Connection Manager filter. [GH-18336]
  • xds: Add support for patching outbound listeners to the built-in Envoy External Authorization extension. [GH-18336]

IMPROVEMENTS:

  • xds: Use downstream protocol when connecting to local app [GH-18573]
  • Windows: Integration tests for Consul Windows VMs [GH-18007]
  • acl: Use templated policy to generate synthetic policies for tokens/roles with node and/or service identities [GH-18813]
  • api: added CheckRegisterOpts to Agent API [GH-18943]
  • api: added Token field to ServiceRegisterOpts type in Agent API [GH-18983]
  • ca: Vault CA provider config no longer requires root_pki_path for secondary datacenters [GH-17831]
  • cli: Added -templated-policy, -templated-policy-file, -replace-templated-policy, -append-templated-policy, -replace-templated-policy-file, -append-templated-policy-file and -var flags for creating or updating tokens/roles. [GH-18708]
  • config: Add new tls.defaults.verify_server_hostname configuration option. This specifies the default value for any interfaces that support the verify_server_hostname option. [GH-17155]
  • connect: update supported envoy versions to 1.24.10, 1.25.9, 1.26.4, 1.27.0 [GH-18300]
  • ui: Use Community verbiage [GH-18560]

BUG FIXES:

  • api: add custom marshal/unmarshal for ServiceResolverConfigEntry.RequestTimeout so config entries that set this field can be read using the API. [GH-19031]
  • dev-mode: Fix dev mode has new line in responses. Now new line is added only when url has pretty query parameter. [GH-18367]
  • telemetry: emit consul version metric on a regular interval. [GH-6876]
  • tlsutil: Default setting of ServerName field in outgoing TLS configuration for checks now handled by crypto/tls. [GH-17481]

1.16.2 (September 19, 2023)

SECURITY:

IMPROVEMENTS:

  • Adds flag -append-filename (which works on values version, dc, node and status) to consul snapshot save command. Adding the flag -append-filename version,dc,node,status will add consul version, consul datacenter, node name and leader/follower (status) in the file name given in the snapshot save command before the file extension. [GH-18625]
  • Reduce the frequency of metric exports from Consul to HCP from every 10s to every 1m [GH-18584]
  • api: Add support for listing ACL tokens by service name. [GH-18667]
  • checks: It is now possible to configure agent TCP checks to use TLS with optional server SNI and mutual authentication. To use TLS with a TCP check, the check must enable the tcp_use_tls boolean. By default the agent will use the TLS configuration in the tls.default stanza. [GH-18381]
  • command: Adds -since flag in consul debug command which internally calls hcdiag for debug information in the past. [GH-18797]
  • log: Currently consul logs files like this consul-{timestamp}.log. This change makes sure that there is always consul.log file with the latest logs in it. [GH-18617]

BUG FIXES:

  • Inherit locality from services when registering sidecar proxies. [GH-18437]
  • UI : Nodes list view was breaking for synthetic-nodes. Fix handles non existence of consul-version meta for node. [GH-18464]
  • api: Fix /v1/agent/self not returning latest configuration [GH-18681]
  • ca: Vault provider now cleans up the previous Vault issuer and key when generating a new leaf signing certificate [GH-18779] [GH-18773]
  • check: prevent go routine leakage when existing Defercheck of same check id is not nil [GH-18558]
  • connect: Fix issue where Envoy endpoints would not populate correctly after a snapshot restore. [GH-18636]
  • gateways: Fix a bug where gateway to service mappings weren't being cleaned up properly when externally registered proxies were being deregistered. [GH-18831]
  • telemetry: emit consul version metric on a regular interval. [GH-18724]

1.15.6 (September 19, 2023)

SECURITY:

IMPROVEMENTS:

  • Adds flag -append-filename (which works on values version, dc, node and status) to consul snapshot save command. Adding the flag -append-filename version,dc,node,status will add consul version, consul datacenter, node name and leader/follower (status) in the file name given in the snapshot save command before the file extension. [GH-18625]
  • Reduce the frequency of metric exports from Consul to HCP from every 10s to every 1m [GH-18584]
  • api: Add support for listing ACL tokens by service name. [GH-18667]
  • command: Adds -since flag in consul debug command which internally calls hcdiag for debug information in the past. [GH-18797]
  • log: Currently consul logs files like this consul-{timestamp}.log. This change makes sure that there is always consul.log file with the latest logs in it. [GH-18617]

BUG FIXES:

  • api: Fix /v1/agent/self not returning latest configuration [GH-18681]
  • ca: Vault provider now cleans up the previous Vault issuer and key when generating a new leaf signing certificate [GH-18779] [GH-18773]
  • check: prevent go routine leakage when existing Defercheck of same check id is not nil [GH-18558]
  • gateways: Fix a bug where gateway to service mappings weren't being cleaned up properly when externally registered proxies were being deregistered. [GH-18831]
  • telemetry: emit consul version metric on a regular interval. [GH-18724]

1.14.10 (September 19, 2023)

SECURITY:

IMPROVEMENTS:

  • Adds flag -append-filename (which works on values version, dc, node and status) to consul snapshot save command. Adding the flag -append-filename version,dc,node,status will add consul version, consul datacenter, node name and leader/follower (status) in the file name given in the snapshot save command before the file extension. [GH-18625]
  • api: Add support for listing ACL tokens by service name. [GH-18667]
  • command: Adds -since flag in consul debug command which internally calls hcdiag for debug information in the past. [GH-18797]
  • log: Currently consul logs files like this consul-{timestamp}.log. This change makes sure that there is always consul.log file with the latest logs in it. [GH-18617]

BUG FIXES:

  • api: Fix /v1/agent/self not returning latest configuration [GH-18681]
  • ca: Vault provider now cleans up the previous Vault issuer and key when generating a new leaf signing certificate [GH-18779] [GH-18773]
  • gateways: Fix a bug where gateway to service mappings weren't being cleaned up properly when externally registered proxies were being deregistered. [GH-18831]
  • telemetry: emit consul version metric on a regular interval. [GH-18724]

1.16.1 (August 8, 2023)

KNOWN ISSUES:

  • connect: Consul versions 1.16.0 and 1.16.1 may have issues when a snapshot restore is performed and the servers are hosting xDS streams. When this bug triggers, it will cause Envoy to incorrectly populate upstream endpoints. This bug only impacts agent-less service mesh and should be fixed in Consul 1.16.2 by GH-18636.

SECURITY:

FEATURES:

  • cli: consul members command uses -filter expression to filter members based on bexpr. [GH-18223]
  • cli: consul operator raft list-peers command shows the number of commits each follower is trailing the leader by to aid in troubleshooting. [GH-17582]
  • cli: consul watch command uses -filter expression to filter response from checks, services, nodes, and service. [GH-17780]
  • reloadable config: Made enable_debug config reloadable and enable pprof command to work when config toggles to true [GH-17565]
  • ui: consul version is displayed in nodes list with filtering and sorting based on versions [GH-17754]

IMPROVEMENTS:

  • Fix some typos in metrics docs [GH-18080]
  • acl: added builtin ACL policy that provides global read-only access (builtin/global-read-only) [GH-18319]
  • acl: allow for a single slash character in policy names [GH-18319]
  • connect: Add capture group labels from Envoy cluster FQDNs to Envoy exported metric labels [GH-17888]
  • connect: Improve transparent proxy support for virtual services and failovers. [GH-17757]
  • connect: update supported envoy versions to 1.23.12, 1.24.10, 1.25.9, 1.26.4 [GH-18303]
  • debug: change default setting of consul debug command. now default duration is 5ms and default log level is 'TRACE' [GH-17596]
  • extensions: Improve validation and error feedback for property-override builtin Envoy extension [GH-17759]
  • hcp: Add dynamic configuration support for the export of server metrics to HCP. [GH-18168]
  • hcp: Removes requirement for HCP to provide a management token [GH-18140]
  • http: GET API operator/usage endpoint now returns node count cli: consul operator usage command now returns node count [GH-17939]
  • mesh: Expose remote jwks cluster configuration through jwt-provider config entry [GH-17978]
  • mesh: Stop jwt providers referenced by intentions from being deleted. [GH-17755]
  • ui: the topology view now properly displays services with mixed connect and non-connect instances. [GH-13023]
  • xds: Explicitly enable WebSocket connection upgrades in HTTP connection manager [GH-18150]

BUG FIXES:

  • Fix a bug that wrongly trims domains when there is an overlap with DC name. [GH-17160]
  • api-gateway: fix race condition in proxy config generation when Consul is notified of the bound-api-gateway config entry before it is notified of the api-gateway config entry. [GH-18291]
  • api: Fix client deserialization errors by marking new Enterprise-only prepared query fields as omit empty [GH-18184]
  • ca: Fixes a Vault CA provider bug where updating RootPKIPath but not IntermediatePKIPath would not renew leaf signing certificates [GH-18112]
  • connect/ca: Fixes a bug preventing CA configuration updates in secondary datacenters [GH-17846]
  • connect: (Enterprise only) Fix bug where intentions referencing sameness groups would not always apply to members properly.
  • connect: Fix incorrect protocol config merging for transparent proxy implicit upstreams. [GH-17894]
  • connect: Removes the default health check from the consul connect envoy command when starting an API Gateway. This health check would always fail. [GH-18011]
  • connect: fix a bug with Envoy potentially starting with incomplete configuration by not waiting enough for initial xDS configuration. [GH-18024]
  • gateway: Fixes a bug where envoy would silently reject RSA keys that are smaller than 2048 bits, we now reject those earlier in the process when we validate the certificate. [GH-17911]
  • http: fixed API endpoint PUT /acl/token/:AccessorID (update token), no longer requires AccessorID in the request body. Web UI can now update tokens. [GH-17739]
  • mesh: (Enterprise Only) Require that jwt-provider config entries are created in the default namespace. [GH-18325]
  • snapshot: fix access denied and handle is invalid when we call snapshot save on windows - skip sync() for folders in windows in https://github.com/rboyer/safeio/pull/3 [GH-18302]
  • xds: Prevent partial application of non-Required Envoy extensions in the case of failure. [GH-18068]

1.15.5 (August 8, 2023)

SECURITY:

FEATURES:

  • cli: consul members command uses -filter expression to filter members based on bexpr. [GH-18223]
  • cli: consul watch command uses -filter expression to filter response from checks, services, nodes, and service. [GH-17780]
  • reloadable config: Made enable_debug config reloadable and enable pprof command to work when config toggles to true [GH-17565]

IMPROVEMENTS:

  • Fix some typos in metrics docs [GH-18080]
  • acl: added builtin ACL policy that provides global read-only access (builtin/global-read-only) [GH-18319]
  • acl: allow for a single slash character in policy names [GH-18319]
  • connect: Add capture group labels from Envoy cluster FQDNs to Envoy exported metric labels [GH-17888]
  • connect: update supported envoy versions to 1.22.11, 1.23.12, 1.24.10, 1.25.9 [GH-18304]
  • hcp: Add dynamic configuration support for the export of server metrics to HCP. [GH-18168]
  • hcp: Removes requirement for HCP to provide a management token [GH-18140]
  • xds: Explicitly enable WebSocket connection upgrades in HTTP connection manager [GH-18150]

BUG FIXES:

  • Fix a bug that wrongly trims domains when there is an overlap with DC name. [GH-17160]
  • api-gateway: fix race condition in proxy config generation when Consul is notified of the bound-api-gateway config entry before it is notified of the api-gateway config entry. [GH-18291]
  • connect/ca: Fixes a bug preventing CA configuration updates in secondary datacenters [GH-17846]
  • connect: Fix incorrect protocol config merging for transparent proxy implicit upstreams. [GH-17894]
  • connect: Removes the default health check from the consul connect envoy command when starting an API Gateway. This health check would always fail. [GH-18011]
  • connect: fix a bug with Envoy potentially starting with incomplete configuration by not waiting enough for initial xDS configuration. [GH-18024]
  • snapshot: fix access denied and handle is invalid when we call snapshot save on windows - skip sync() for folders in windows in https://github.com/rboyer/safeio/pull/3 [GH-18302]

1.14.9 (August 8, 2023)

SECURITY:

FEATURES:

  • cli: consul members command uses -filter expression to filter members based on bexpr. [GH-18223]
  • cli: consul watch command uses -filter expression to filter response from checks, services, nodes, and service. [GH-17780]
  • reloadable config: Made enable_debug config reloadable and enable pprof command to work when config toggles to true [GH-17565]

IMPROVEMENTS:

  • Fix some typos in metrics docs [GH-18080]
  • acl: added builtin ACL policy that provides global read-only access (builtin/global-read-only) [GH-18319]
  • acl: allow for a single slash character in policy names [GH-18319]
  • connect: update supported envoy versions to 1.21.6, 1.22.11, 1.23.12, 1.24.10 [GH-18305]
  • hcp: Removes requirement for HCP to provide a management token [GH-18140]
  • xds: Explicitly enable WebSocket connection upgrades in HTTP connection manager [GH-18150]

BUG FIXES:

  • Fix a bug that wrongly trims domains when there is an overlap with DC name. [GH-17160]
  • connect/ca: Fixes a bug preventing CA configuration updates in secondary datacenters [GH-17846]
  • connect: Fix incorrect protocol config merging for transparent proxy implicit upstreams. [GH-17894]
  • connect: fix a bug with Envoy potentially starting with incomplete configuration by not waiting enough for initial xDS configuration. [GH-18024]
  • snapshot: fix access denied and handle is invalid when we call snapshot save on windows - skip sync() for folders in windows in https://github.com/rboyer/safeio/pull/3 [GH-18302]

1.16.0 (June 26, 2023)

KNOWN ISSUES:

  • connect: Consul versions 1.16.0 and 1.16.1 may have issues when a snapshot restore is performed and the servers are hosting xDS streams. When this bug triggers, it will cause Envoy to incorrectly populate upstream endpoints. This bug only impacts agent-less service mesh and should be fixed in Consul 1.16.2 by GH-18636.

BREAKING CHANGES:

  • api: The /v1/health/connect/ and /v1/health/ingress/ endpoints now immediately return 403 "Permission Denied" errors whenever a token with insufficient service:read permissions is provided. Prior to this change, the endpoints returned a success code with an empty result list when a token with insufficient permissions was provided. [GH-17424]
  • peering: Removed deprecated backward-compatibility behavior. Upstream overrides in service-defaults will now only apply to peer upstreams when the peer field is provided. Visit the 1.16.x upgrade instructions for more information. [GH-16957]

SECURITY:

  • Bump Dockerfile base image to alpine:3.18. [GH-17719]
  • audit-logging: (Enterprise only) limit v1/operator/audit-hash endpoint to ACL token with operator:read privileges.

FEATURES:

  • api: (Enterprise only) Add POST /v1/operator/audit-hash endpoint to calculate the hash of the data used by the audit log hash function and salt.
  • cli: (Enterprise only) Add a new consul operator audit hash command to retrieve and compare the hash of the data used by the audit log hash function and salt.
  • cli: Adds new command - consul services export - for exporting a service to a peer or partition [GH-15654]
  • connect: (Consul Enterprise only) Implement order-by-locality failover.
  • mesh: Add new permissive mTLS mode that allows sidecar proxies to forward incoming traffic unmodified to the application. This adds AllowEnablingPermissiveMutualTLS setting to the mesh config entry and the MutualTLSMode setting to proxy-defaults and service-defaults. [GH-17035]
  • mesh: Support configuring JWT authentication in Envoy. [GH-17452]
  • server: (Enterprise Only) added server side RPC requests IP based read/write rate-limiter. [GH-4633]
  • server: (Enterprise Only) allow automatic license utilization reporting. [GH-5102]
  • server: added server side RPC requests global read/write rate-limiter. [GH-16292]
  • xds: Add property-override built-in Envoy extension that directly patches Envoy resources. [GH-17487]
  • xds: Add a built-in Envoy extension that inserts External Authorization (ext_authz) network and HTTP filters. [GH-17495]
  • xds: Add a built-in Envoy extension that inserts Wasm HTTP filters. [GH-16877]
  • xds: Add a built-in Envoy extension that inserts Wasm network filters. [GH-17505]

IMPROVEMENTS:

    • api: Support filtering for config entries. [GH-17183]
    • cli: Add -filter option to consul config list for filtering config entries. [GH-17183]
  • agent: remove agent cache dependency from service mesh leaf certificate management [GH-17075]
  • api: Enable setting query options on agent force-leave endpoint. [GH-15987]
  • audit-logging: (Enterprise only) enable error response and request body logging
  • ca: automatically set up Vault's auto-tidy setting for tidy_expired_issuers when using Vault as a CA provider. [GH-17138]
  • ca: support Vault agent auto-auth config for Vault CA provider using AliCloud authentication. [GH-16224]
  • ca: support Vault agent auto-auth config for Vault CA provider using AppRole authentication. [GH-16259]
  • ca: support Vault agent auto-auth config for Vault CA provider using Azure MSI authentication. [GH-16298]
  • ca: support Vault agent auto-auth config for Vault CA provider using JWT authentication. [GH-16266]
  • ca: support Vault agent auto-auth config for Vault CA provider using Kubernetes authentication. [GH-16262]
  • command: Adds ACL enabled to status output on agent startup. [GH-17086]
  • command: Allow creating ACL Token TTL with greater than 24 hours with the -expires-ttl flag. [GH-17066]
  • connect: (Enterprise Only) Add support for specifying "Partition" and "Namespace" in Prepared Queries failover rules.
  • connect: update supported envoy versions to 1.23.10, 1.24.8, 1.25.7, 1.26.2 [GH-17546]
  • connect: update supported envoy versions to 1.23.8, 1.24.6, 1.25.4, 1.26.0 [GH-5200]
  • fix metric names in /docs/agent/telemetry [GH-17577]
  • gateway: Change status condition reason for invalid certificate on a listener from "Accepted" to "ResolvedRefs". [GH-17115]
  • http: accept query parameters datacenter, ap (enterprise-only), and namespace (enterprise-only). Both short-hand and long-hand forms of these query params are now supported via the HTTP API (dc/datacenter, ap/partition, ns/namespace). [GH-17525]
  • systemd: set service type to notify. [GH-16845]
  • ui: Update alerts to Hds::Alert component [GH-16412]
  • ui: Update to use Hds::Toast component to show notifications [GH-16519]
  • ui: update from and to design-system-components button Hds::Button [GH-16251]
  • ui: update typography to styles from hds [GH-16577]

BUG FIXES:

  • Fix a race condition where an event is published before the data associated is commited to memdb. [GH-16871]
  • connect: Fix issue where changes to service exports were not reflected in proxies. [GH-17775]
  • gateways: (Enterprise only) Fixed a bug in API gateways where gateway configuration objects in non-default partitions did not reconcile properly. [GH-17581]
  • gateways: Fixed a bug in API gateways where binding a route that only targets a service imported from a peer results in the programmed gateway having no routes. [GH-17609]
  • gateways: Fixed a bug where API gateways were not being taken into account in determining xDS rate limits. [GH-17631]
  • namespaces: (Enterprise only) fixes a bug where agent health checks stop syncing for all services on a node if the namespace of any service has been removed from the server.
  • namespaces: (Enterprise only) fixes a bug where namespaces are stuck in a deferred deletion state indefinitely under some conditions. Also fixes the Consul query metadata present in the HTTP headers of the namespace read and list endpoints.
  • peering: Fix a bug that caused server agents to continue cleaning up peering resources even after loss of leadership. [GH-17483]
  • peering: Fixes a bug where the importing partition was not added to peered failover targets, which causes issues when the importing partition is a non-default partition. [GH-16673]
  • ui: fixes ui tests run on CI [GH-16428]
  • xds: Fixed a bug where modifying ACLs on a token being actively used for an xDS connection caused all xDS updates to fail. [GH-17566]

1.15.4 (June 26, 2023)

FEATURES:

  • cli: consul operator raft list-peers command shows the number of commits each follower is trailing the leader by to aid in troubleshooting. [GH-17582]
  • server: (Enterprise Only) allow automatic license utilization reporting. [GH-5102]

IMPROVEMENTS:

  • connect: update supported envoy versions to 1.22.11, 1.23.9, 1.24.7, 1.25.6 [GH-17545]
  • debug: change default setting of consul debug command. now default duration is 5ms and default log level is 'TRACE' [GH-17596]
  • fix metric names in /docs/agent/telemetry [GH-17577]
  • gateway: Change status condition reason for invalid certificate on a listener from "Accepted" to "ResolvedRefs". [GH-17115]
  • systemd: set service type to notify. [GH-16845]

BUG FIXES:

  • cache: fix a few minor goroutine leaks in leaf certs and the agent cache [GH-17636]
  • docs: fix list of telemetry metrics [GH-17593]
  • gateways: (Enterprise only) Fixed a bug in API gateways where gateway configuration objects in non-default partitions did not reconcile properly. [GH-17581]
  • gateways: Fixed a bug in API gateways where binding a route that only targets a service imported from a peer results in the programmed gateway having no routes. [GH-17609]
  • gateways: Fixed a bug where API gateways were not being taken into account in determining xDS rate limits. [GH-17631]
  • http: fixed API endpoint PUT /acl/token/:AccessorID (update token), no longer requires AccessorID in the request body. Web UI can now update tokens. [GH-17739]
  • namespaces: (Enterprise only) fixes a bug where agent health checks stop syncing for all services on a node if the namespace of any service has been removed from the server.
  • namespaces: (Enterprise only) fixes a bug where namespaces are stuck in a deferred deletion state indefinitely under some conditions. Also fixes the Consul query metadata present in the HTTP headers of the namespace read and list endpoints.
  • peering: Fix a bug that caused server agents to continue cleaning up peering resources even after loss of leadership. [GH-17483]
  • xds: Fixed a bug where modifying ACLs on a token being actively used for an xDS connection caused all xDS updates to fail. [GH-17566]

1.14.8 (June 26, 2023)

SECURITY:

  • Update to UBI base image to 9.2. [GH-17513]

FEATURES:

  • cli: consul operator raft list-peers command shows the number of commits each follower is trailing the leader by to aid in troubleshooting. [GH-17582]
  • server: (Enterprise Only) allow automatic license utilization reporting. [GH-5102]

IMPROVEMENTS:

  • connect: update supported envoy versions to 1.21.6, 1.22.11, 1.23.9, 1.24.7 [GH-17547]
  • debug: change default setting of consul debug command. now default duration is 5ms and default log level is 'TRACE' [GH-17596]
  • fix metric names in /docs/agent/telemetry [GH-17577]
  • peering: gRPC queries for TrustBundleList, TrustBundleRead, PeeringList, and PeeringRead now support blocking semantics, reducing network and CPU demand. The HTTP APIs for Peering List and Read have been updated to support blocking. [GH-17426]
  • raft: Remove expensive reflection from raft/mesh hot path [GH-16552]
  • systemd: set service type to notify. [GH-16845]

BUG FIXES:

  • cache: fix a few minor goroutine leaks in leaf certs and the agent cache [GH-17636]
  • connect: reverts #17317 fix that caused a downstream error for Ingress/Mesh/Terminating GWs when their respective config entry does not already exist. [GH-17541]
  • namespaces: (Enterprise only) fixes a bug where agent health checks stop syncing for all services on a node if the namespace of any service has been removed from the server.
  • namespaces: (Enterprise only) fixes a bug where namespaces are stuck in a deferred deletion state indefinitely under some conditions. Also fixes the Consul query metadata present in the HTTP headers of the namespace read and list endpoints.
  • namespaces: adjusts the return type from HTTP list API to return the api module representation of a namespace. This fixes an error with the consul namespace list command when a namespace has a deferred deletion timestamp.
  • peering: Fix a bug that caused server agents to continue cleaning up peering resources even after loss of leadership. [GH-17483]
  • peering: Fix issue where modifying the list of exported services did not correctly replicate changes for services that exist in a non-default namespace. [GH-17456]

1.13.9 (June 26, 2023)

BREAKING CHANGES:

  • connect: Disable peering by default in connect proxies for Consul 1.13. This change was made to prevent inefficient polling queries from having a negative impact on server performance. Peering in Consul 1.13 is an experimental feature and is not recommended for use in production environments. If you still wish to use the experimental peering feature, ensure peering.enabled = true is set on all clients and servers. [GH-17731]

SECURITY:

  • Update to UBI base image to 9.2. [GH-17513]

FEATURES:

  • server: (Enterprise Only) allow automatic license utilization reporting. [GH-5102]

IMPROVEMENTS:

  • debug: change default setting of consul debug command. now default duration is 5ms and default log level is 'TRACE' [GH-17596]
  • systemd: set service type to notify. [GH-16845]

BUG FIXES:

  • cache: fix a few minor goroutine leaks in leaf certs and the agent cache [GH-17636]
  • namespaces: (Enterprise only) fixes a bug where namespaces are stuck in a deferred deletion state indefinitely under some conditions. Also fixes the Consul query metadata present in the HTTP headers of the namespace read and list endpoints.
  • namespaces: adjusts the return type from HTTP list API to return the api module representation of a namespace. This fixes an error with the consul namespace list command when a namespace has a deferred deletion timestamp.
  • peering: Fix a bug that caused server agents to continue cleaning up peering resources even after loss of leadership. [GH-17483]

1.16.0-rc1 (June 12, 2023)

BREAKING CHANGES:

  • api: The /v1/health/connect/ and /v1/health/ingress/ endpoints now immediately return 403 "Permission Denied" errors whenever a token with insufficient service:read permissions is provided. Prior to this change, the endpoints returned a success code with an empty result list when a token with insufficient permissions was provided. [GH-17424]
  • peering: Removed deprecated backward-compatibility behavior. Upstream overrides in service-defaults will now only apply to peer upstreams when the peer field is provided. Visit the 1.16.x upgrade instructions for more information. [GH-16957]

SECURITY:

  • audit-logging: (Enterprise only) limit v1/operator/audit-hash endpoint to ACL token with operator:read privileges.

FEATURES:

  • api: (Enterprise only) Add POST /v1/operator/audit-hash endpoint to calculate the hash of the data used by the audit log hash function and salt.
  • cli: (Enterprise only) Add a new consul operator audit hash command to retrieve and compare the hash of the data used by the audit log hash function and salt.
  • cli: Adds new command - consul services export - for exporting a service to a peer or partition [GH-15654]
  • connect: (Consul Enterprise only) Implement order-by-locality failover.
  • mesh: Add new permissive mTLS mode that allows sidecar proxies to forward incoming traffic unmodified to the application. This adds AllowEnablingPermissiveMutualTLS setting to the mesh config entry and the MutualTLSMode setting to proxy-defaults and service-defaults. [GH-17035]
  • mesh: Support configuring JWT authentication in Envoy. [GH-17452]
  • server: (Enterprise Only) added server side RPC requests IP based read/write rate-limiter. [GH-4633]
  • server: (Enterprise Only) allow automatic license utilization reporting. [GH-5102]
  • server: added server side RPC requests global read/write rate-limiter. [GH-16292]
  • xds: Add property-override built-in Envoy extension that directly patches Envoy resources. [GH-17487]
  • xds: Add a built-in Envoy extension that inserts External Authorization (ext_authz) network and HTTP filters. [GH-17495]
  • xds: Add a built-in Envoy extension that inserts Wasm HTTP filters. [GH-16877]
  • xds: Add a built-in Envoy extension that inserts Wasm network filters. [GH-17505]

IMPROVEMENTS:

    • api: Support filtering for config entries. [GH-17183]
    • cli: Add -filter option to consul config list for filtering config entries. [GH-17183]
  • api: Enable setting query options on agent force-leave endpoint. [GH-15987]
  • audit-logging: (Enterprise only) enable error response and request body logging [GH-5669]
  • audit-logging: (Enterprise only) enable error response and request body logging
  • ca: automatically set up Vault's auto-tidy setting for tidy_expired_issuers when using Vault as a CA provider. [GH-17138]
  • ca: support Vault agent auto-auth config for Vault CA provider using AliCloud authentication. [GH-16224]
  • ca: support Vault agent auto-auth config for Vault CA provider using AppRole authentication. [GH-16259]
  • ca: support Vault agent auto-auth config for Vault CA provider using Azure MSI authentication. [GH-16298]
  • ca: support Vault agent auto-auth config for Vault CA provider using JWT authentication. [GH-16266]
  • ca: support Vault agent auto-auth config for Vault CA provider using Kubernetes authentication. [GH-16262]
  • command: Adds ACL enabled to status output on agent startup. [GH-17086]
  • command: Allow creating ACL Token TTL with greater than 24 hours with the -expires-ttl flag. [GH-17066]
  • connect: (Enterprise Only) Add support for specifying "Partition" and "Namespace" in Prepared Queries failover rules.
  • connect: update supported envoy versions to 1.23.10, 1.24.8, 1.25.7, 1.26.2 [GH-17546]
  • connect: update supported envoy versions to 1.23.8, 1.24.6, 1.25.4, 1.26.0 [GH-5200]
  • fix metric names in /docs/agent/telemetry [GH-17577]
  • gateway: Change status condition reason for invalid certificate on a listener from "Accepted" to "ResolvedRefs". [GH-17115]
  • http: accept query parameters datacenter, ap (enterprise-only), and namespace (enterprise-only). Both short-hand and long-hand forms of these query params are now supported via the HTTP API (dc/datacenter, ap/partition, ns/namespace). [GH-17525]
  • systemd: set service type to notify. [GH-16845]
  • ui: Update alerts to Hds::Alert component [GH-16412]
  • ui: Update to use Hds::Toast component to show notifications [GH-16519]
  • ui: update from and to design-system-components button Hds::Button [GH-16251]
  • ui: update typography to styles from hds [GH-16577]

BUG FIXES:

  • Fix a race condition where an event is published before the data associated is commited to memdb. [GH-16871]
  • gateways: (Enterprise only) Fixed a bug in API gateways where gateway configuration objects in non-default partitions did not reconcile properly. [GH-17581]
  • gateways: Fixed a bug in API gateways where binding a route that only targets a service imported from a peer results in the programmed gateway having no routes. [GH-17609]
  • gateways: Fixed a bug where API gateways were not being taken into account in determining xDS rate limits. [GH-17631]
  • peering: Fixes a bug where the importing partition was not added to peered failover targets, which causes issues when the importing partition is a non-default partition. [GH-16673]
  • ui: fixes ui tests run on CI [GH-16428]
  • xds: Fixed a bug where modifying ACLs on a token being actively used for an xDS connection caused all xDS updates to fail. [GH-17566]

1.15.3 (June 1, 2023)

BREAKING CHANGES:

  • extensions: The Lua extension now targets local proxy listeners for the configured service's upstreams, rather than remote downstream listeners for the configured service, when ListenerType is set to outbound in extension configuration. See CVE-2023-2816 changelog entry for more details. [GH-17415]

SECURITY:

FEATURES:

  • hcp: Add new metrics sink to collect, aggregate and export server metrics to HCP in OTEL format. [GH-17460]

IMPROVEMENTS:

  • Fixes a performance issue in Raft where commit latency can increase by 100x or more when under heavy load. For more details see https://github.com/hashicorp/raft/pull/541. [GH-17081]
  • agent: add a configurable maximimum age (default: 7 days) to prevent servers re-joining a cluster with stale data [GH-17171]
  • agent: add new metrics to track cpu disk and memory usage for server hosts (defaults to: enabled) [GH-17038]
  • connect: update supported envoy versions to 1.22.11, 1.23.8, 1.24.6, 1.25.4 [GH-16889]
  • envoy: add MaxEjectionPercent and BaseEjectionTime to passive health check configs. [GH-15979]
  • hcp: Add support for linking existing Consul clusters to HCP management plane. [GH-16916]
  • logging: change snapshot log header from agent.server.snapshot to agent.server.raft.snapshot [GH-17236]
  • peering: allow re-establishing terminated peering from new token without deleting existing peering first. [GH-16776]
  • peering: gRPC queries for TrustBundleList, TrustBundleRead, PeeringList, and PeeringRead now support blocking semantics, reducing network and CPU demand. The HTTP APIs for Peering List and Read have been updated to support blocking. [GH-17426]
  • raft: Remove expensive reflection from raft/mesh hot path [GH-16552]
  • xds: rename envoy_hcp_metrics_bind_socket_dir to envoy_telemetry_collector_bind_socket_dir to remove HCP naming references. [GH-17327]

BUG FIXES:

  • Fix an bug where decoding some Config structs with unset pointer fields could fail with reflect: call of reflect.Value.Type on zero Value. [GH-17048]
  • acl: (Enterprise only) Check permissions in correct partition/namespace when resolving service in non-default partition/namespace
  • acl: Fix an issue where the anonymous token was synthesized in non-primary datacenters which could cause permission errors when federating clusters with ACL replication enabled. [GH-17231]
  • acls: Fix ACL bug that can result in sidecar proxies having incorrect endpoints.
  • connect: Fix multiple inefficient behaviors when querying service health. [GH-17241]
  • gateways: Fix an bug where targeting a virtual service defined by a service-resolver was broken for HTTPRoutes. [GH-17055]
  • grpc: ensure grpc resolver correctly uses lan/wan addresses on servers [GH-17270]
  • namespaces: adjusts the return type from HTTP list API to return the api module representation of a namespace. This fixes an error with the consul namespace list command when a namespace has a deferred deletion timestamp.
  • peering: Fix issue where modifying the list of exported services did not correctly replicate changes for services that exist in a non-default namespace. [GH-17456]
  • peering: Fix issue where peer streams could incorrectly deregister services in various scenarios. [GH-17235]
  • peering: ensure that merged central configs of peered upstreams for partitioned downstreams work [GH-17179]
  • xds: Fix possible panic that can when generating clusters before the root certificates have been fetched. [GH-17185]

1.14.7 (May 16, 2023)

SECURITY:

IMPROVEMENTS:

  • connect: update supported envoy versions to 1.21.6, 1.22.11, 1.23.8, 1.24.6 [GH-16888]
  • envoy: add MaxEjectionPercent and BaseEjectionTime to passive health check configs. [GH-15979]
  • hcp: Add support for linking existing Consul clusters to HCP management plane. [GH-16916]
  • logging: change snapshot log header from agent.server.snapshot to agent.server.raft.snapshot [GH-17236]
  • peering: allow re-establishing terminated peering from new token without deleting existing peering first. [GH-16776]

BUG FIXES:

  • Fix an bug where decoding some Config structs with unset pointer fields could fail with reflect: call of reflect.Value.Type on zero Value. [GH-17048]
  • acl: (Enterprise only) Check permissions in correct partition/namespace when resolving service in non-default partition/namespace
  • acls: Fix ACL bug that can result in sidecar proxies having incorrect endpoints.
  • connect: Fix multiple inefficient behaviors when querying service health. [GH-17241]
  • connect: fix a bug with Envoy potentially starting with incomplete configuration by not waiting enough for initial xDS configuration. [GH-17317]
  • grpc: ensure grpc resolver correctly uses lan/wan addresses on servers [GH-17270]
  • peering: Fix issue where peer streams could incorrectly deregister services in various scenarios. [GH-17235]
  • proxycfg: ensure that an irrecoverable error in proxycfg closes the xds session and triggers a replacement proxycfg watcher [GH-16497]
  • xds: Fix possible panic that can when generating clusters before the root certificates have been fetched. [GH-17185]

1.13.8 (May 16, 2023)

SECURITY:

IMPROVEMENTS:

  • api: updated the go module directive to 1.18. [GH-15297]
  • connect: update supported envoy versions to 1.20.7, 1.21.6, 1.22.11, 1.23.8 [GH-16891]
  • sdk: updated the go module directive to 1.18. [GH-15297]

BUG FIXES:

  • Fix an bug where decoding some Config structs with unset pointer fields could fail with reflect: call of reflect.Value.Type on zero Value. [GH-17048]
  • audit-logging: (Enterprise only) Fix a bug where /agent/monitor and /agent/metrics endpoints return a Streaming not supported error when audit logs are enabled. This also fixes the delay receiving logs when running consul monitor against an agent with audit logs enabled. [GH-16700]
  • ca: Fixes a bug where updating Vault CA Provider config would cause TLS issues in the service mesh [GH-16592]
  • connect: Fix multiple inefficient behaviors when querying service health. [GH-17241]
  • grpc: ensure grpc resolver correctly uses lan/wan addresses on servers [GH-17270]
  • peering: Fixes a bug that can lead to peering service deletes impacting the state of local services [GH-16570]
  • xds: Fix possible panic that can when generating clusters before the root certificates have been fetched. [GH-17185]

1.15.2 (March 30, 2023)

FEATURES:

  • xds: Allow for configuring connect proxies to send service mesh telemetry to an HCP metrics collection service. [GH-16585]

BUG FIXES:

  • audit-logging: (Enterprise only) Fix a bug where /agent/monitor and /agent/metrics endpoints return a Streaming not supported error when audit logs are enabled. This also fixes the delay receiving logs when running consul monitor against an agent with audit logs enabled. [GH-16700]
  • ca: Fixes a bug where updating Vault CA Provider config would cause TLS issues in the service mesh [GH-16592]
  • cache: revert cache refactor which could cause blocking queries to never return [GH-16818]
  • gateway: (Enterprise only) Fix bug where namespace/partition would fail to unmarshal for TCPServices. [GH-16781]
  • gateway: (Enterprise only) Fix bug where namespace/partition would fail to unmarshal. [GH-16651]
  • gateway: (Enterprise only) Fix bug where parent refs and service refs for a route in the same namespace as the route would fallback to the default namespace if the namespace was not specified in the configuration rather than falling back to the routes namespace. [GH-16789]
  • gateway: (Enterprise only) Fix bug where routes defined in a different namespace than a gateway would fail to register. [GH-16677].
  • gateways: Adds validation to ensure the API Gateway has a listener defined when created [GH-16649]
  • gateways: Fixes a bug API gateways using HTTP listeners were taking upwards of 15 seconds to get configured over xDS. [GH-16661]
  • peering: (Consul Enterprise only) Fix issue where connect-enabled services with peer upstreams incorrectly required service:write access in the default namespace to query data, which was too restrictive. Now having service:write to any namespace is sufficient to query the peering data.
  • peering: (Consul Enterprise only) Fix issue where resolvers, routers, and splitters referencing peer targets may not work correctly for non-default partitions and namespaces. Enterprise customers leveraging peering are encouraged to upgrade both servers and agents to avoid this problem.
  • peering: Fix issue resulting in prepared query failover to cluster peers never un-failing over. [GH-16729]
  • peering: Fixes a bug that can lead to peering service deletes impacting the state of local services [GH-16570]
  • peering: Fixes a bug where the importing partition was not added to peered failover targets, which causes issues when the importing partition is a non-default partition. [GH-16675]
  • raft_logstore: Fixes a bug where restoring a snapshot when using the experimental WAL storage backend causes a panic. [GH-16647]
  • ui: fix PUT token request with adding missed AccessorID property to requestBody [GH-16660]
  • ui: fix rendering issues on Overview and empty-states by addressing isHTMLSafe errors [GH-16574]

1.14.6 (March 30, 2023)

BUG FIXES:

  • audit-logging: (Enterprise only) Fix a bug where /agent/monitor and /agent/metrics endpoints return a Streaming not supported error when audit logs are enabled. This also fixes the delay receiving logs when running consul monitor against an agent with audit logs enabled. [GH-16700]
  • ca: Fixes a bug where updating Vault CA Provider config would cause TLS issues in the service mesh [GH-16592]
  • peering: (Consul Enterprise only) Fix issue where connect-enabled services with peer upstreams incorrectly required service:write access in the default namespace to query data, which was too restrictive. Now having service:write to any namespace is sufficient to query the peering data.
  • peering: (Consul Enterprise only) Fix issue where resolvers, routers, and splitters referencing peer targets may not work correctly for non-default partitions and namespaces. Enterprise customers leveraging peering are encouraged to upgrade both servers and agents to avoid this problem.
  • peering: Fix issue resulting in prepared query failover to cluster peers never un-failing over. [GH-16729]
  • peering: Fixes a bug that can lead to peering service deletes impacting the state of local services [GH-16570]
  • peering: Fixes a bug where the importing partition was not added to peered failover targets, which causes issues when the importing partition is a non-default partition. [GH-16693]
  • ui: fix PUT token request with adding missed AccessorID property to requestBody [GH-16660]

1.15.1 (March 7, 2023)

IMPROVEMENTS:

  • cli: added -append-policy-id, -append-policy-name, -append-role-name, and -append-role-id flags to the consul token update command. These flags allow updates to a token's policies/roles without having to override them completely. [GH-16288]
  • cli: added -append-service-identity and -append-node-identity flags to the consul token update command. These flags allow updates to a token's node identities/service identities without having to override them. [GH-16506]
  • connect: Bump Envoy 1.22.5 to 1.22.7, 1.23.2 to 1.23.4, 1.24.0 to 1.24.2, add 1.25.1, remove 1.21.5 [GH-16274]
  • mesh: Add ServiceResolver RequestTimeout for route timeouts to make request timeouts configurable [GH-16495]
  • ui: support filtering API gateways in the ui and displaying their documentation links [GH-16508]

DEPRECATIONS:

  • cli: Deprecate the -merge-node-identites and -merge-service-identities flags from the consul token update command in favor of: -append-node-identity and -append-service-identity. [GH-16506]
  • cli: Deprecate the -merge-policies and -merge-roles flags from the consul token update command in favor of: -append-policy-id, -append-policy-name, -append-role-name, and -append-role-id. [GH-16288]

BUG FIXES:

  • cli: Fixes an issue with consul connect envoy where a log to STDOUT could malform JSON when used with -bootstrap. [GH-16530]
  • cli: Fixes an issue with consul connect envoy where grpc-disabled agents were not error-handled correctly. [GH-16530]
  • cli: ensure acl token read -self works [GH-16445]
  • cli: fix panic read non-existent acl policy [GH-16485]
  • gateways: fix HTTPRoute bug where service weights could be less than or equal to 0 and result in a downstream envoy protocol error [GH-16512]
  • gateways: fix HTTPRoute bug where services with a weight not divisible by 10000 are never registered properly [GH-16531]
  • mesh: Fix resolution of service resolvers with subsets for external upstreams [GH-16499]
  • proxycfg: ensure that an irrecoverable error in proxycfg closes the xds session and triggers a replacement proxycfg watcher [GH-16497]
  • proxycfg: fix a bug where terminating gateways were not cleaning up deleted service resolvers for their referenced services [GH-16498]
  • ui: Fix issue with lists and filters not rendering properly [GH-16444]

1.14.5 (March 7, 2023)

SECURITY:

IMPROVEMENTS:

  • container: Upgrade container image to use to Alpine 3.17. [GH-16358]
  • mesh: Add ServiceResolver RequestTimeout for route timeouts to make request timeouts configurable [GH-16495]

BUG FIXES:

  • mesh: Fix resolution of service resolvers with subsets for external upstreams [GH-16499]
  • peering: Fix bug where services were incorrectly imported as connect-enabled. [GH-16339]
  • peering: Fix issue where mesh gateways would use the wrong address when contacting a remote peer with the same datacenter name. [GH-16257]
  • peering: Fix issue where secondary wan-federated datacenters could not be used as peering acceptors. [GH-16230]
  • proxycfg: fix a bug where terminating gateways were not cleaning up deleted service resolvers for their referenced services [GH-16498]

1.13.7 (March 7, 2023)

SECURITY:

IMPROVEMENTS:

  • xds: Removed a bottleneck in Envoy config generation. [GH-16269]
  • container: Upgrade container image to use to Alpine 3.17. [GH-16358]
  • mesh: Add ServiceResolver RequestTimeout for route timeouts to make request timeouts configurable [GH-16495]

BUG FIXES:

  • mesh: Fix resolution of service resolvers with subsets for external upstreams [GH-16499]
  • proxycfg: fix a bug where terminating gateways were not cleaning up deleted service resolvers for their referenced services [GH-16498]

1.15.0 (February 23, 2023)

KNOWN ISSUES:

  • connect: A race condition can cause some service instances to lose their ability to communicate in the mesh after 72 hours (LeafCertTTL) due to a problem with leaf certificate rotation. This bug is fixed in Consul v1.15.2 by GH-16818.

BREAKING CHANGES:

  • acl errors: Delete and get requests now return descriptive errors when the specified resource cannot be found. Other ACL request errors provide more information about when a resource is missing. Add error for when the ACL system has not been bootstrapped.
    • Delete Token/Policy/AuthMethod/Role/BindingRule endpoints now return 404 when the resource cannot be found.
      • New error formats: "Requested * does not exist: ACL not found", "* not found in namespace $NAMESPACE: ACL not found"
    • Read Token/Policy/Role endpoints now return 404 when the resource cannot be found.
      • New error format: "Cannot find * to delete"
    • Logout now returns a 401 error when the supplied token cannot be found
      • New error format: "Supplied token does not exist"
    • Token Self endpoint now returns 404 when the token cannot be found.
      • New error format: "Supplied token does not exist" [GH-16105]
  • acl: remove all acl migration functionality and references to the legacy acl system. [GH-15947]
  • acl: remove all functionality and references for legacy acl policies. [GH-15922]
  • config: Deprecate -join, -join-wan, start_join, and start_join_wan. These options are now aliases of -retry-join, -retry-join-wan, retry_join, and retry_join_wan, respectively. [GH-15598]
  • connect: Add peer field to service-defaults upstream overrides. The addition of this field makes it possible to apply upstream overrides only to peer services. Prior to this change, overrides would be applied based on matching the namespace and name fields only, which means users could not have different configuration for local versus peer services. With this change, peer upstreams are only affected if the peer field matches the destination peer name. [GH-15956]
  • connect: Consul will now error and exit when using the consul connect envoy command if the Envoy version is incompatible. To ignore this check use flag --ignore-envoy-compatibility [GH-15818]
  • extensions: Refactor Lambda integration to get configured with the Envoy extensions field on service-defaults configuration entries. [GH-15817]
  • ingress-gateway: upstream cluster will have empty outlier_detection if passive health check is unspecified [GH-15614]
  • xds: Remove the connect.enable_serverless_plugin agent configuration option. Now Lambda integration is enabled by default. [GH-15710]

SECURITY:

FEATURES:

  • API Gateway (Beta) This version adds support for API gateway on VMs. API gateway provides a highly-configurable ingress for requests coming into a Consul network. For more information, refer to the API gateway documentation. [GH-16369]
  • acl: Add new acl.tokens.config_file_registration config field which specifies the token used to register services and checks that are defined in config files. [GH-15828]
  • acl: anonymous token is logged as 'anonymous token' instead of its accessor ID [GH-15884]
  • cli: adds new CLI commands consul troubleshoot upstreams and consul troubleshoot proxy to troubleshoot Consul's service mesh configuration and network issues. [GH-16284]
  • command: Adds the operator usage instances subcommand for displaying total services, connect service instances and billable service instances in the local datacenter or globally. [GH-16205]
  • config-entry(ingress-gateway): support outlier detection (passive health check) for upstream cluster [GH-15614]
  • connect: adds support for Envoy access logging. Access logging can be enabled using the proxy-defaults config entry. [GH-15864]
  • xds: Add a built-in Envoy extension that inserts Lua HTTP filters. [GH-15906]
  • xds: Insert originator service identity into Envoy's dynamic metadata under the consul namespace. [GH-15906]

IMPROVEMENTS:

  • connect: for early awareness of Envoy incompatibilities, when using the consul connect envoy command the Envoy version will now be checked for compatibility. If incompatible Consul will error and exit. [GH-15818]
  • grpc: client agents will switch server on error, and automatically retry on RESOURCE_EXHAUSTED responses [GH-15892]
  • raft: add an operator api endpoint and a command to initiate raft leadership transfer. [GH-14132]
  • acl: Added option to allow for an operator-generated bootstrap token to be passed to the acl bootstrap command. [GH-14437]
  • agent: Give better error when client specifies wrong datacenter when auto-encrypt is enabled. [GH-14832]
  • api: updated the go module directive to 1.18. [GH-15297]
  • ca: support Vault agent auto-auth config for Vault CA provider using AWS/GCP authentication. [GH-15970]
  • cli: always use name "global" for proxy-defaults config entries [GH-14833]
  • cli: connect envoy command errors if grpc ports are not open [GH-15794]
  • client: add support for RemoveEmptyTags in Prepared Queries templates. [GH-14244]
  • connect: Warn if ACLs are enabled but a token is not provided to envoy [GH-15967]
  • container: Upgrade container image to use to Alpine 3.17. [GH-16358]
  • dns: support RFC 2782 SRV lookups for prepared queries using format _<query id or name>._tcp.query[.<datacenter>].<domain>. [GH-14465]
  • ingress-gateways: Don't log error when gateway is registered without a config entry [GH-15001]
  • licensing: (Enterprise Only) Consul Enterprise non-terminating production licenses do not degrade or terminate Consul upon expiration. They will only fail when trying to upgrade to a newer version of Consul. Evaluation licenses still terminate.
  • raft: Added experimental wal backend for log storage. [GH-16176]
  • sdk: updated the go module directive to 1.18. [GH-15297]
  • telemetry: Added a consul.xds.server.streamsUnauthenticated metric to track the number of active xDS streams handled by the server that are unauthenticated because ACLs are not enabled or ACL tokens were missing. [GH-15967]
  • ui: Update sidebar width to 280px [GH-16204]
  • ui: update Ember version to 3.27; [GH-16227]

DEPRECATIONS:

  • acl: Deprecate the token query parameter and warn when it is used for authentication. [GH-16009]
  • cli: The -id flag on acl token operations has been changed to -accessor-id for clarity in documentation. The -id flag will continue to work, but operators should use -accessor-id in the future. [GH-16044]

BUG FIXES:

  • agent configuration: Fix issue of using unix socket when https is used. [GH-16301]
  • cache: refactor agent cache fetching to prevent unnecessary fetches on error [GH-14956]
  • cli: fatal error if config file does not have HCL or JSON extension, instead of warn and skip [GH-15107]
  • cli: fix ACL token processing unexpected precedence [GH-15274]
  • peering: Fix bug where services were incorrectly imported as connect-enabled. [GH-16339]
  • peering: Fix issue where mesh gateways would use the wrong address when contacting a remote peer with the same datacenter name. [GH-16257]
  • peering: Fix issue where secondary wan-federated datacenters could not be used as peering acceptors. [GH-16230]

1.14.4 (January 26, 2023)

BREAKING CHANGES:

  • connect: Fix configuration merging for transparent proxy upstreams. Proxy-defaults and service-defaults config entries were not correctly merged for implicit upstreams in transparent proxy mode and would result in some configuration not being applied. To avoid issues when upgrading, ensure that any proxy-defaults or service-defaults have correct configuration for upstreams, since all fields will now be properly used to configure proxies. [GH-16000]
  • peering: Newly created peering connections must use only lowercase characters in the name field. Existing peerings with uppercase characters will not be modified, but they may encounter issues in various circumstances. To maintain forward compatibility and avoid issues, it is recommended to destroy and re-create any invalid peering connections so that they do not have a name containing uppercase characters. [GH-15697]

FEATURES:

  • connect: add flags envoy-ready-bind-port and envoy-ready-bind-address to the consul connect envoy command that allows configuration of readiness probe on proxy for any service kind. [GH-16015]
  • deps: update to latest go-discover to provide ECS auto-discover capabilities. [GH-13782]

IMPROVEMENTS:

  • acl: relax permissions on the WatchServers, WatchRoots and GetSupportedDataplaneFeatures gRPC endpoints to accept any valid ACL token [GH-15346]
  • connect: Add support for ConsulResolver to specifies a filter expression [GH-15659]
  • grpc: Use new balancer implementation to reduce periodic WARN logs when shuffling servers. [GH-15701]
  • partition: (Consul Enterprise only) when loading service from on-disk config file or sending API request to agent endpoint, if the partition is unspecified, consul will default the partition in the request to agent's partition [GH-16024]

BUG FIXES:

  • agent: Fix assignment of error when auto-reloading cert and key file changes. [GH-15769]
  • agent: Fix issue where the agent cache would incorrectly mark protobuf objects as updated. [GH-15866]
  • cli: Fix issue where consul connect envoy was unable to configure TLS over unix-sockets to gRPC. [GH-15913]
  • connect: (Consul Enterprise only) Fix issue where upstream configuration from proxy-defaults and service-defaults was not properly merged. This could occur when a mixture of empty-strings and "default" were used for the namespace or partition fields.
  • connect: Fix issue where service-resolver protocol checks incorrectly errored for failover peer targets. [GH-15833]
  • connect: Fix issue where watches on upstream failover peer targets did not always query the correct data. [GH-15865]
  • xds: fix bug where sessions for locally-managed services could fail with "this server has too many xDS streams open" [GH-15789]

1.13.6 (January 26, 2023)

FEATURES:

  • connect: add flags envoy-ready-bind-port and envoy-ready-bind-address to the consul connect envoy command that allows configuration of readiness probe on proxy for any service kind. [GH-16015]
  • deps: update to latest go-discover to provide ECS auto-discover capabilities. [GH-13782]

IMPROVEMENTS:

  • grpc: Use new balancer implementation to reduce periodic WARN logs when shuffling servers. [GH-15701]
  • partition: (Consul Enterprise only) when loading service from on-disk config file or sending API request to agent endpoint, if the partition is unspecified, consul will default the partition in the request to agent's partition [GH-16024]

BUG FIXES:

  • agent: Fix assignment of error when auto-reloading cert and key file changes. [GH-15769]

1.12.9 (January 26, 2023)

FEATURES:

  • deps: update to latest go-discover to provide ECS auto-discover capabilities. [GH-13782]

IMPROVEMENTS:

  • grpc: Use new balancer implementation to reduce periodic WARN logs when shuffling servers. [GH-15701]

BUG FIXES:

  • agent: Fix assignment of error when auto-reloading cert and key file changes. [GH-15769]

1.14.3 (December 13, 2022)

SECURITY:

  • Upgrade to use Go 1.19.4. This resolves a vulnerability where restricted files can be read on Windows. CVE-2022-41720 [GH-15705]
  • Upgrades golang.org/x/net to prevent a denial of service by excessive memory usage caused by HTTP2 requests. CVE-2022-41717 [GH-15737]

FEATURES:

  • ui: Add field for fallback server addresses to peer token generation form [GH-15555]

IMPROVEMENTS:

  • connect: ensure all vault connect CA tests use limited privilege tokens [GH-15669]

BUG FIXES:

  • agent: (Enterprise Only) Ensure configIntentionsConvertToList does not compare empty strings with populated strings when filtering intentions created prior to AdminPartitions.
  • connect: Fix issue where DialedDirectly configuration was not used by Consul Dataplane. [GH-15760]
  • connect: Fix peering failovers ignoring local mesh gateway configuration. [GH-15690]
  • connect: Fixed issue where using Vault 1.11+ as CA provider in a secondary datacenter would eventually break Intermediate CAs [GH-15661]

1.13.5 (December 13, 2022)

SECURITY:

  • Upgrade to use Go 1.18.9. This resolves a vulnerability where restricted files can be read on Windows. CVE-2022-41720 [GH-15706]
  • Upgrades golang.org/x/net to prevent a denial of service by excessive memory usage caused by HTTP2 requests. CVE-2022-41717 [GH-15743]

IMPROVEMENTS:

  • connect: ensure all vault connect CA tests use limited privilege tokens [GH-15669]

BUG FIXES:

  • agent: (Enterprise Only) Ensure configIntentionsConvertToList does not compare empty strings with populated strings when filtering intentions created prior to AdminPartitions.
  • cli: (Enterprise Only) Fix issue where consul partition update subcommand was not registered and therefore not available through the cli.
  • connect: Fixed issue where using Vault 1.11+ as CA provider in a secondary datacenter would eventually break Intermediate CAs [GH-15661]

1.12.8 (December 13, 2022)

SECURITY:

  • Upgrade to use Go 1.18.9. This resolves a vulnerability where restricted files can be read on Windows. CVE-2022-41720 [GH-15727]
  • Upgrades golang.org/x/net to prevent a denial of service by excessive memory usage caused by HTTP2 requests. CVE-2022-41717 [GH-15746]

IMPROVEMENTS:

  • connect: ensure all vault connect CA tests use limited privilege tokens [GH-15669]

BUG FIXES:

  • agent: (Enterprise Only) Ensure configIntentionsConvertToList does not compare empty strings with populated strings when filtering intentions created prior to AdminPartitions.
  • cli: (Enterprise Only) Fix issue where consul partition update subcommand was not registered and therefore not available through the cli.
  • connect: Fixed issue where using Vault 1.11+ as CA provider in a secondary datacenter would eventually break Intermediate CAs [GH-15661]

1.14.2 (November 30, 2022)

FEATURES:

  • connect: Add local_idle_timeout_ms to allow configuring the Envoy route idle timeout on local_app connect: Add IdleTimeout to service-router to allow configuring the Envoy route idle timeout [GH-14340]
  • snapshot: (Enterprise Only) Add support for the snapshot agent to use an IAM role for authentication/authorization when managing snapshots in S3.

IMPROVEMENTS:

  • dns: Add support for cluster peering .service and .node DNS queries. [GH-15596]

BUG FIXES:

  • acl: avoid debug log spam in secondary datacenter servers due to management token not being initialized. [GH-15610]
  • agent: Fixed issue where blocking queries with short waits could timeout on the client [GH-15541]
  • ca: Fixed issue where using Vault as Connect CA with Vault-managed policies would error on start-up if the intermediate PKI mount existed but was empty [GH-15525]
  • cli: (Enterprise Only) Fix issue where consul partition update subcommand was not registered and therefore not available through the cli.
  • connect: Fixed issue where using Vault 1.11+ as CA provider would eventually break Intermediate CAs in primary datacenters. A separate fix is needed to address the same issue in secondary datacenters. [GH-15217] [GH-15253]
  • namespace: (Enterprise Only) Fix a bug that caused blocking queries during namespace replication to timeout
  • peering: better represent non-passing states during peer check flattening [GH-15615]
  • peering: fix the limit of replication gRPC message; set to 8MB [GH-15503]

1.13.4 (November 30, 2022)

IMPROVEMENTS:

  • auto-config: Relax the validation on auto-config JWT authorization to allow non-whitespace, non-quote characters in node names. [GH-15370]
  • raft: Allow nonVoter to initiate an election to avoid having an election infinite loop when a Voter is converted to NonVoter [GH-14897]
  • raft: Cap maximum grpc wait time when heartbeating to heartbeatTimeout/2 [GH-14897]
  • raft: Fix a race condition where the snapshot file is closed without being opened [GH-14897]

BUG FIXES:

  • agent: Fixed issue where blocking queries with short waits could timeout on the client [GH-15541]
  • ca: Fixed issue where using Vault as Connect CA with Vault-managed policies would error on start-up if the intermediate PKI mount existed but was empty [GH-15525]
  • connect: Fixed issue where using Vault 1.11+ as CA provider would eventually break Intermediate CAs in primary datacenters. A separate fix is needed to address the same issue in secondary datacenters. [GH-15217] [GH-15253]
  • connect: fixed bug where endpoint updates for new xDS clusters could block for 15s before being sent to Envoy. [GH-15083]
  • connect: strip port from DNS SANs for ingress gateway leaf certificate to avoid an invalid hostname error when using the Vault provider. [GH-15320]
  • debug: fixed bug that caused consul debug CLI to error on ACL-disabled clusters [GH-15155]
  • deps: update go-memdb, fixing goroutine leak [GH-15010] [GH-15068]
  • namespace: (Enterprise Only) Fix a bug that caused blocking queries during namespace replication to timeout
  • namespace: (Enterprise Only) Fixed a bug where a client may incorrectly log that namespaces were not enabled in the local datacenter
  • peering: better represent non-passing states during peer check flattening [GH-15615]
  • peering: fix the error of wan address isn't taken by the peering token. [GH-15065]
  • peering: when wan address is set, peering stream should use the wan address. [GH-15108]

1.12.7 (November 30, 2022)

BUG FIXES:

  • agent: Fixed issue where blocking queries with short waits could timeout on the client [GH-15541]
  • ca: Fixed issue where using Vault as Connect CA with Vault-managed policies would error on start-up if the intermediate PKI mount existed but was empty [GH-15525]
  • connect: Fixed issue where using Vault 1.11+ as CA provider would eventually break Intermediate CAs in primary datacenters. A separate fix is needed to address the same issue in secondary datacenters. [GH-15217] [GH-15253]
  • connect: fixed bug where endpoint updates for new xDS clusters could block for 15s before being sent to Envoy. [GH-15083]
  • connect: strip port from DNS SANs for ingress gateway leaf certificate to avoid an invalid hostname error when using the Vault provider. [GH-15320]
  • debug: fixed bug that caused consul debug CLI to error on ACL-disabled clusters [GH-15155]
  • deps: update go-memdb, fixing goroutine leak [GH-15010] [GH-15068]
  • namespace: (Enterprise Only) Fix a bug that caused blocking queries during namespace replication to timeout
  • namespace: (Enterprise Only) Fixed a bug where a client may incorrectly log that namespaces were not enabled in the local datacenter

1.14.1 (November 21, 2022)

BUG FIXES:

  • cli: Fix issue where consul connect envoy incorrectly uses the HTTPS API configuration for xDS connections. [GH-15466]
  • sdk: Fix SDK testutil backwards compatibility by only configuring grpc_tls port for new Consul versions. [GH-15423]

1.14.0 (November 15, 2022)

KNOWN ISSUES:

  • cli: consul connect envoy incorrectly enables TLS for gRPC connections when the HTTP API is TLS-enabled.

BREAKING CHANGES:

  • config: Add new ports.grpc_tls configuration option. Introduce a new port to better separate TLS config from the existing ports.grpc config. The new ports.grpc_tls only supports TLS encrypted communication. The existing ports.grpc now only supports plain-text communication. [GH-15339]
  • config: update 1.14 config defaults: Enable peering and connect by default. [GH-15302]
  • config: update 1.14 config defaults: Set gRPC TLS port default value to 8503 [GH-15302]
  • connect: Removes support for Envoy 1.20 [GH-15093]
  • peering: Rename PeerName to Peer on prepared queries and exported services. [GH-14854]
  • xds: Convert service mesh failover to use Envoy's aggregate clusters. This changes the names of some Envoy dynamic HTTP metrics. [GH-14178]

SECURITY:

  • Ensure that data imported from peers is filtered by ACLs at the UI Nodes/Services endpoints CVE-2022-3920 [GH-15356]

FEATURES:

  • DNS-proxy support via gRPC request. [GH-14811]
  • cli: Add -node-name flag to redirect-traffic command to support running in environments without client agents. [GH-14933]
  • cli: Add -consul-dns-port flag to the consul connect redirect-traffic command to allow forwarding DNS traffic to a specific Consul DNS port. [GH-15050]
  • connect: Add Envoy connection balancing configuration fields. [GH-14616]
  • grpc: Added metrics for external gRPC server. Added server_type=internal|external label to gRPC metrics. [GH-14922]
  • http: Add new get-or-empty operation to the txn api. Refer to the API docs for more information. [GH-14474]
  • peering: Add mesh gateway local mode support for cluster peering. [GH-14817]
  • peering: Add support for stale queries for trust bundle lookups [GH-14724]
  • peering: Add support to failover to services running on cluster peers. [GH-14396]
  • peering: Add support to redirect to services running on cluster peers with service resolvers. [GH-14445]
  • peering: Ensure un-exported services get deleted even if the un-export happens while cluster peering replication is down. [GH-14797]
  • peering: add support for routine peering control-plane traffic through mesh gateways [GH-14981]
  • sdk: Configure iptables to forward DNS traffic to a specific DNS port. [GH-15050]
  • telemetry: emit memberlist size metrics and broadcast queue depth metric. [GH-14873]
  • ui: Added support for central config merging [GH-14604]
  • ui: Create peerings detail page [GH-14947]
  • ui: Detect a TokenSecretID cookie and passthrough to localStorage [GH-14495]
  • ui: Display notice banner on nodes index page if synthetic nodes are being filtered. [GH-14971]
  • ui: Filter agentless (synthetic) nodes from the nodes list page. [GH-14970]
  • ui: Filter out node health checks on agentless service instances [GH-14986]
  • ui: Remove node meta on service instances when using agentless and consolidate external-source labels on service instances page if they all match. [GH-14921]
  • ui: Removed reference to node name on service instance page when using agentless [GH-14903]
  • ui: Use withCredentials for all HTTP API requests [GH-14343]
  • xds: servers will limit the number of concurrent xDS streams they can handle to balance the load across all servers [GH-14397]

IMPROVEMENTS:

  • peering: Add peering datacenter and partition to initial handshake. [GH-14889]
  • xds: Added a rate limiter to the delivery of proxy config updates, to prevent updates to "global" resources such as wildcard intentions from overwhelming servers (see: xds.update_max_per_second config field) [GH-14960]
  • xds: Removed a bottleneck in Envoy config generation, enabling a higher number of dataplanes per server [GH-14934]
  • agent/hcp: add initial HashiCorp Cloud Platform integration [GH-14723]
  • agent: Added configuration option cloud.scada_address. [GH-14936]
  • api: Add filtering support to Catalog's List Services (v1/catalog/services) [GH-11742]
  • api: Increase max number of operations inside a transaction for requests to /v1/txn (128) [GH-14599]
  • auto-config: Relax the validation on auto-config JWT authorization to allow non-whitespace, non-quote characters in node names. [GH-15370]
  • config-entry: Validate that service-resolver Failovers and Redirects only specify Partition and Namespace on Consul Enterprise. This prevents scenarios where OSS Consul would save service-resolvers that require Consul Enterprise. [GH-14162]
  • connect: Add Envoy 1.24.0 to support matrix [GH-15093]
  • connect: Bump Envoy 1.20 to 1.20.7, 1.21 to 1.21.5 and 1.22 to 1.22.5 [GH-14831]
  • connect: service-router destinations have gained a RetryOn field for specifying the conditions when Envoy should retry requests beyond specific status codes and generic connection failure which already exists. [GH-12890]
  • dns/peering: (Enterprise Only) Support addresses in the formats <servicename>.virtual.<namespace>.ns.<partition>.ap.<peername>.peer.consul and <servicename>.virtual.<partition>.ap.<peername>.peer.consul. This longer form address that allows specifying .peer would need to be used for tproxy DNS requests made within non-default partitions for imported services.
  • dns: (Enterprise Only) All enterprise locality labels are now optional in DNS lookups. For example, service lookups support the following format: [<tag>.]<service>.service[.<namespace>.ns][.<partition>.ap][.<datacenter>.dc]<domain>. [GH-14679]
  • integ test: fix flakiness due to test condition from retry app endoint [GH-15233]
  • metrics: Service RPC calls less than 1ms are now emitted as a decimal number. [GH-12905]
  • peering: adds an internally managed server certificate for automatic TLS between servers in peer clusters. [GH-14556]
  • peering: require TLS for peering connections using server cert signed by Connect CA [GH-14796]
  • peering: return information about the health of the peering when the leader is queried to read a peering. [GH-14747]
  • raft: Allow nonVoter to initiate an election to avoid having an election infinite loop when a Voter is converted to NonVoter [GH-14897]
  • raft: Cap maximum grpc wait time when heartbeating to heartbeatTimeout/2 [GH-14897]
  • raft: Fix a race condition where the snapshot file is closed without being opened [GH-14897]
  • telemetry: Added a consul.xds.server.streamStart metric to measure time taken to first generate xDS resources for an xDS stream. [GH-14957]
  • ui: Improve guidance around topology visualisation [GH-14527]
  • xds: Set max_ejection_percent on Envoy's outlier detection to 100% for peered services. [GH-14373]
  • xds: configure Envoy alpn_protocols for connect-proxy and ingress-gateway based on service protocol. [GH-14356]

BUG FIXES:

  • checks: Do not set interval as timeout value [GH-14619]
  • checks: If set, use proxy address for automatically added sidecar check instead of service address. [GH-14433]
  • cli: Fix Consul kv CLI 'GET' flags 'keys' and 'recurse' to be set together [GH-13493]
  • connect: Fix issue where mesh-gateway settings were not properly inherited from configuration entries. [GH-15186]
  • connect: fixed bug where endpoint updates for new xDS clusters could block for 15s before being sent to Envoy. [GH-15083]
  • connect: strip port from DNS SANs for ingress gateway leaf certificate to avoid an invalid hostname error when using the Vault provider. [GH-15320]
  • debug: fixed bug that caused consul debug CLI to error on ACL-disabled clusters [GH-15155]
  • deps: update go-memdb, fixing goroutine leak [GH-15010] [GH-15068]
  • grpc: Merge proxy-defaults and service-defaults in GetEnvoyBootstrapParams response. [GH-14869]
  • metrics: Add duplicate metrics that have only a single "consul_" prefix for all existing metrics with double ("consul_consul_") prefix, with the intent to standardize on single prefixes. [GH-14475]
  • namespace: (Enterprise Only) Fixed a bug where a client may incorrectly log that namespaces were not enabled in the local datacenter
  • peering: Fix a bug that resulted in /v1/agent/metrics returning an error. [GH-15178]
  • peering: fix nil pointer in calling handleUpdateService [GH-15160]
  • peering: fix the error of wan address isn't taken by the peering token. [GH-15065]
  • peering: when wan address is set, peering stream should use the wan address. [GH-15108]
  • proxycfg(mesh-gateway): Fix issue where deregistered services are not removed from mesh-gateway clusters. [GH-15272]
  • server: fix goroutine/memory leaks in the xDS subsystem (these were present regardless of whether or not xDS was in-use) [GH-14916]
  • server: fixes the error trying to source proxy configuration for http checks, in case of proxies using consul-dataplane. [GH-14924]
  • xds: Central service configuration (proxy-defaults and service-defaults) is now correctly applied to Consul Dataplane proxies [GH-14962]

NOTES:

  • deps: Upgrade to use Go 1.19.2 [GH-15090]

1.13.3 (October 19, 2022)

FEATURES:

  • agent: Added a new config option rpc_client_timeout to tune timeouts for client RPC requests [GH-14965]
  • config-entry(ingress-gateway): Added support for max_connections for upstream clusters [GH-14749]

IMPROVEMENTS:

  • connect/ca: Log a warning message instead of erroring when attempting to update the intermediate pki mount when using the Vault provider. [GH-15035]
  • connect: Added gateway options to Envoy proxy config for enabling tcp keepalives on terminating gateway upstreams and mesh gateways in remote datacenters. [GH-14800]
  • connect: Bump Envoy 1.20 to 1.20.7, 1.21 to 1.21.5 and 1.22 to 1.22.5 [GH-14828]
  • licensing: (Enterprise Only) Consul Enterprise production licenses do not degrade or terminate Consul upon expiration. They will only fail when trying to upgrade to a newer version of Consul. Evaluation licenses still terminate. [GH-1990]

BUG FIXES:

  • agent: avoid leaking the alias check runner goroutine when the check is de-registered [GH-14935]
  • ca: fix a masked bug in leaf cert generation that would not be notified of root cert rotation after the first one [GH-15005]
  • cache: prevent goroutine leak in agent cache [GH-14908]
  • checks: Fixed a bug that prevented registration of UDP health checks from agent configuration files, such as service definition files with embedded health check definitions. [GH-14885]
  • connect: Fixed a bug where transparent proxy does not correctly spawn listeners for upstreams to service-resolvers. [GH-14751]
  • snapshot-agent: (Enterprise only) Fix a bug when a session is not found in Consul, which leads the agent to panic.

1.12.6 (October 19, 2022)

FEATURES:

  • agent: Added a new config option rpc_client_timeout to tune timeouts for client RPC requests [GH-14965]
  • agent: Added information about build date alongside other version information for Consul. Extended /agent/self endpoint and consul version commands to report this. Agent also reports build date in log on startup. [GH-13357]
  • config-entry(ingress-gateway): Added support for max_connections for upstream clusters [GH-14749]

IMPROVEMENTS:

  • connect/ca: Log a warning message instead of erroring when attempting to update the intermediate pki mount when using the Vault provider. [GH-15035]
  • connect: Added gateway options to Envoy proxy config for enabling tcp keepalives on terminating gateway upstreams and mesh gateways in remote datacenters. [GH-14800]
  • connect: Bump Envoy 1.20 to 1.20.7, 1.21 to 1.21.5 and 1.22 to 1.22.5 [GH-14829]
  • licensing: (Enterprise Only) Consul Enterprise production licenses do not degrade or terminate Consul upon expiration. They will only fail when trying to upgrade to a newer version of Consul. Evaluation licenses still terminate. [GH-1990]

BUG FIXES:

  • agent: avoid leaking the alias check runner goroutine when the check is de-registered [GH-14935]
  • ca: fix a masked bug in leaf cert generation that would not be notified of root cert rotation after the first one [GH-15005]
  • cache: prevent goroutine leak in agent cache [GH-14908]
  • connect: Fixed a bug where transparent proxy does not correctly spawn listeners for upstreams to service-resolvers. [GH-14751]
  • snapshot-agent: (Enterprise only) Fix a bug when a session is not found in Consul, which leads the agent to panic.

1.11.11 (October 19, 2022)

FEATURES:

  • agent: Added a new config option rpc_client_timeout to tune timeouts for client RPC requests [GH-14965]
  • config-entry(ingress-gateway): Added support for max_connections for upstream clusters [GH-14749]

IMPROVEMENTS:

  • connect/ca: Log a warning message instead of erroring when attempting to update the intermediate pki mount when using the Vault provider. [GH-15035]
  • connect: Added gateway options to Envoy proxy config for enabling tcp keepalives on terminating gateway upstreams and mesh gateways in remote datacenters. [GH-14800]
  • connect: Bump Envoy 1.20 to 1.20.7 [GH-14830]

BUG FIXES:

  • agent: avoid leaking the alias check runner goroutine when the check is de-registered [GH-14935]
  • ca: fix a masked bug in leaf cert generation that would not be notified of root cert rotation after the first one [GH-15005]
  • cache: prevent goroutine leak in agent cache [GH-14908]
  • snapshot-agent: (Enterprise only) Fix a bug when a session is not found in Consul, which leads the agent to panic.

1.11.10 (September 22, 2022)

BUG FIXES:

  • kvs: Fixed a bug where query options were not being applied to KVS.Get RPC operations. [GH-13344]

1.13.2 (September 20, 2022)

BREAKING CHANGES:

  • ca: If using Vault as the service mesh CA provider, the Vault policy used by Consul now requires the update capability on the intermediate PKI's tune mount configuration endpoint, such as /sys/mounts/connect_inter/tune. The breaking nature of this change is resolved in 1.13.3. Refer to upgrade guidance for more information.

SECURITY:

  • auto-config: Added input validation for auto-config JWT authorization checks. Prior to this change, it was possible for malicious actors to construct requests which incorrectly pass custom JWT claim validation for the AutoConfig.InitialConfiguration endpoint. Now, only a subset of characters are allowed for the input before evaluating the bexpr. [GH-14577]
  • connect: Added URI length checks to ConnectCA CSR requests. Prior to this change, it was possible for a malicious actor to designate multiple SAN URI values in a call to the ConnectCA.Sign endpoint. The endpoint now only allows for exactly one SAN URI to be specified. [GH-14579]

FEATURES:

  • cli: Adds new subcommands for peering workflows. Refer to the CLI docs for more information. [GH-14423]
  • connect: Server address changes are streamed to peers [GH-14285]
  • service-defaults: Added support for local_request_timeout_ms and local_connect_timeout_ms in servicedefaults config entry [GH-14395]

IMPROVEMENTS:

  • connect: Bump latest Envoy to 1.23.1 in test matrix [GH-14573]
  • connect: expose new tracing configuration on envoy [GH-13998]
  • envoy: adds additional Envoy outlier ejection parameters to passive health check configurations. [GH-14238]
  • metrics: add labels of segment, partition, network area, network (lan or wan) to serf and memberlist metrics [GH-14161]
  • peering: Validate peering tokens for server name conflicts [GH-14563]
  • snapshot agent: (Enterprise only) Add support for path-based addressing when using s3 backend.
  • ui: Reuse connections for requests to /v1/internal/ui/metrics-proxy/ [GH-14521]

BUG FIXES:

  • agent: Fixes an issue where an agent that fails to start due to bad addresses won't clean up any existing listeners [GH-14081]
  • api: Fix a breaking change caused by renaming QueryDatacenterOptions to QueryFailoverOptions. This adds QueryDatacenterOptions back as an alias to QueryFailoverOptions and marks it as deprecated. [GH-14378]
  • ca: Fixed a bug with the Vault CA provider where the intermediate PKI mount and leaf cert role were not being updated when the CA configuration was changed. [GH-14516]
  • cli: When launching a sidecar proxy with consul connect envoy or consul connect proxy, the -sidecar-for service ID argument is now treated as case-insensitive. [GH-14034]
  • connect: Fix issue where auto_config and auto_encrypt could unintentionally enable TLS for gRPC xDS connections. [GH-14269]
  • connect: Fixed a bug where old root CAs would be removed from the primary datacenter after switching providers and restarting the cluster. [GH-14598]
  • connect: Fixed an issue where intermediate certificates could build up in the root CA because they were never being pruned after expiring. [GH-14429]
  • connect: Fixed some spurious issues during peering establishment when a follower is dialed [GH-14119]
  • envoy: validate name before deleting proxy default configurations. [GH-14290]
  • peering: Fix issue preventing deletion and recreation of peerings in TERMINATED state. [GH-14364]
  • rpc: Adds max jitter to client deadlines to prevent i/o deadline errors on blocking queries [GH-14233]
  • tls: undo breaking change that prevented setting TLS for gRPC when using config flags available in Consul v1.11. [GH-14668]
  • ui: Removed Overview page from HCP instalations [GH-14606]

1.12.5 (September 20, 2022)

BREAKING CHANGES:

  • ca: If using Vault as the service mesh CA provider, the Vault policy used by Consul now requires the update capability on the intermediate PKI's tune mount configuration endpoint, such as /sys/mounts/connect_inter/tune. The breaking nature of this change is resolved in 1.12.6. Refer to upgrade guidance for more information.

SECURITY:

  • auto-config: Added input validation for auto-config JWT authorization checks. Prior to this change, it was possible for malicious actors to construct requests which incorrectly pass custom JWT claim validation for the AutoConfig.InitialConfiguration endpoint. Now, only a subset of characters are allowed for the input before evaluating the bexpr. [GH-14577]
  • connect: Added URI length checks to ConnectCA CSR requests. Prior to this change, it was possible for a malicious actor to designate multiple SAN URI values in a call to the ConnectCA.Sign endpoint. The endpoint now only allows for exactly one SAN URI to be specified. [GH-14579]

IMPROVEMENTS:

  • envoy: adds additional Envoy outlier ejection parameters to passive health check configurations. [GH-14238]
  • metrics: add labels of segment, partition, network area, network (lan or wan) to serf and memberlist metrics [GH-14161]
  • snapshot agent: (Enterprise only) Add support for path-based addressing when using s3 backend.
  • ui: Reuse connections for requests to /v1/internal/ui/metrics-proxy/ [GH-14521]

BUG FIXES:

  • ca: Fixed a bug with the Vault CA provider where the intermediate PKI mount and leaf cert role were not being updated when the CA configuration was changed. [GH-14516]
  • cli: When launching a sidecar proxy with consul connect envoy or consul connect proxy, the -sidecar-for service ID argument is now treated as case-insensitive. [GH-14034]
  • connect: Fixed a bug where old root CAs would be removed from the primary datacenter after switching providers and restarting the cluster. [GH-14598]
  • connect: Fixed an issue where intermediate certificates could build up in the root CA because they were never being pruned after expiring. [GH-14429]
  • envoy: validate name before deleting proxy default configurations. [GH-14290]
  • rpc: Adds max jitter to client deadlines to prevent i/o deadline errors on blocking queries [GH-14233]
  • ui: Removed Overview page from HCP instalations [GH-14606]

1.11.9 (September 20, 2022)

BREAKING CHANGES:

  • ca: If using Vault as the service mesh CA provider, the Vault policy used by Consul now requires the update capability on the intermediate PKI's tune mount configuration endpoint, such as /sys/mounts/connect_inter/tune. The breaking nature of this change is resolved in 1.11.11. Refer to upgrade guidance for more information.

SECURITY:

  • auto-config: Added input validation for auto-config JWT authorization checks. Prior to this change, it was possible for malicious actors to construct requests which incorrectly pass custom JWT claim validation for the AutoConfig.InitialConfiguration endpoint. Now, only a subset of characters are allowed for the input before evaluating the bexpr. [GH-14577]
  • connect: Added URI length checks to ConnectCA CSR requests. Prior to this change, it was possible for a malicious actor to designate multiple SAN URI values in a call to the ConnectCA.Sign endpoint. The endpoint now only allows for exactly one SAN URI to be specified. [GH-14579]

IMPROVEMENTS:

  • metrics: add labels of segment, partition, network area, network (lan or wan) to serf and memberlist metrics [GH-14161]
  • snapshot agent: (Enterprise only) Add support for path-based addressing when using s3 backend.

BUG FIXES:

  • ca: Fixed a bug with the Vault CA provider where the intermediate PKI mount and leaf cert role were not being updated when the CA configuration was changed. [GH-14516]
  • cli: When launching a sidecar proxy with consul connect envoy or consul connect proxy, the -sidecar-for service ID argument is now treated as case-insensitive. [GH-14034]
  • connect: Fixed a bug where old root CAs would be removed from the primary datacenter after switching providers and restarting the cluster. [GH-14598]
  • connect: Fixed an issue where intermediate certificates could build up in the root CA because they were never being pruned after expiring. [GH-14429]
  • rpc: Adds a deadline to client RPC calls, so that streams will no longer hang indefinitely in unstable network conditions. [GH-8504] [GH-11500]
  • rpc: Adds max jitter to client deadlines to prevent i/o deadline errors on blocking queries [GH-14233]

1.13.1 (August 11, 2022)

BUG FIXES:

  • agent: Fixed a compatibility issue when restoring snapshots from pre-1.13.0 versions of Consul [GH-14107] [GH-14149]
  • connect: Fixed some spurious issues during peering establishment when a follower is dialed [GH-14119]

1.12.4 (August 11, 2022)

BUG FIXES:

  • cli: when acl token read is used with the -self and -expanded flags, return an error instead of panicking [GH-13787]
  • connect: Fixed a goroutine/memory leak that would occur when using the ingress gateway. [GH-13847]
  • connect: Ingress gateways with a wildcard service entry should no longer pick up non-connect services as upstreams. connect: Terminating gateways with a wildcard service entry should no longer pick up connect services as upstreams. [GH-13958]
  • ui: Fixes an issue where client side validation errors were not showing in certain areas [GH-14021]

1.11.8 (August 11, 2022)

BUG FIXES:

  • connect: Fixed a goroutine/memory leak that would occur when using the ingress gateway. [GH-13847]
  • connect: Ingress gateways with a wildcard service entry should no longer pick up non-connect services as upstreams. connect: Terminating gateways with a wildcard service entry should no longer pick up connect services as upstreams. [GH-13958]

1.13.0 (August 9, 2022)

BREAKING CHANGES:

  • config-entry: Exporting a specific service name across all namespace is invalid.
  • connect: contains an upgrade compatibility issue when restoring snapshots containing service mesh proxy registrations from pre-1.13 versions of Consul [GH-14107]. Fixed in 1.13.1 [GH-14149]. Refer to 1.13 upgrade guidance for more information.
  • connect: if using auto-encrypt or auto-config, TLS is required for gRPC communication between Envoy and Consul as of 1.13.0; this TLS for gRPC requirement will be removed in a future 1.13 patch release. Refer to 1.13 upgrade guidance for more information.
  • connect: if a pre-1.13 Consul agent's HTTPS port was not enabled, upgrading to 1.13 may turn on TLS for gRPC communication for Envoy and Consul depending on the agent's TLS configuration. Refer to 1.13 upgrade guidance for more information.
  • connect: Removes support for Envoy 1.19 [GH-13807]
  • telemetry: config flag telemetry { disable_compat_1.9 = (true|false) } has been removed. Before upgrading you should remove this flag from your config if the flag is being used. [GH-13532]

FEATURES:

  • Cluster Peering (Beta) This version adds a new model to federate Consul clusters for both service mesh and traditional service discovery. Cluster peering allows for service interconnectivity with looser coupling than the existing WAN federation. For more information refer to the cluster peering documentation.
  • Transparent proxying through terminating gateways This version adds egress traffic control to destinations outside of Consul's catalog, such as APIs on the public internet. Transparent proxies can dial destinations defined in service-defaults and have the traffic routed through terminating gateways. For more information refer to the terminating gateway documentation.
  • acl: It is now possible to login and logout using the gRPC API [GH-12935]
  • agent: Added information about build date alongside other version information for Consul. Extended /agent/self endpoint and consul version commands to report this. Agent also reports build date in log on startup. [GH-13357]
  • ca: Leaf certificates can now be obtained via the gRPC API: Sign [GH-12787]
  • checks: add UDP health checks.. [GH-12722]
  • cli: A new flag for config delete to delete a config entry in a valid config file, e.g., config delete -filename intention-allow.hcl [GH-13677]
  • connect: Adds a new destination field to the service-default config entry that allows routing egress traffic through a terminating gateway in transparent proxy mode without modifying the catalog. [GH-13613]
  • grpc: New gRPC endpoint to return envoy bootstrap parameters. [GH-12825]
  • grpc: New gRPC endpoint to return envoy bootstrap parameters. [GH-1717]
  • grpc: New gRPC service and endpoint to return the list of supported consul dataplane features [GH-12695]
  • server: broadcast the public grpc port using lan serf and update the consul service in the catalog with the same data [GH-13687]
  • streaming: Added topic that can be used to consume updates about the list of services in a datacenter [GH-13722]
  • streaming: Added topics for ingress-gateway, mesh, service-intentions and service-resolver config entry events. [GH-13658]

IMPROVEMENTS:

  • api: merge-central-config query parameter support added to /catalog/node-services/:node-name API, to view a fully resolved service definition (especially when not written into the catalog that way). [GH-13450]
  • api: merge-central-config query parameter support added to /catalog/node-services/:node-name API, to view a fully resolved service definition (especially when not written into the catalog that way). [GH-2046]
  • api: merge-central-config query parameter support added to some catalog and health endpoints to view a fully resolved service definition (especially when not written into the catalog that way). [GH-13001]
  • api: add the ability to specify a path prefix for when consul is behind a reverse proxy or API gateway [GH-12914]
  • catalog: Add per-node indexes to reduce watchset firing for unrelated nodes and services. [GH-12399]
  • connect: add validation to ensure connect native services have a port or socketpath specified on catalog registration. This was the only missing piece to ensure all mesh services are validated for a port (or socketpath) specification on catalog registration. [GH-12881]
  • ui: Add new CopyableCode component and use it in certain pre-existing areas [GH-13686]
  • acl: Clarify node/service identities must be lowercase [GH-12807]
  • command: Add support for enabling TLS in the Envoy Prometheus endpoint via the consul connect envoy command. Adds the -prometheus-ca-file, -prometheus-ca-path, -prometheus-cert-file and -prometheus-key-file flags. [GH-13481]
  • connect: Add Envoy 1.23.0 to support matrix [GH-13807]
  • connect: Added a max_inbound_connections setting to service-defaults for limiting the number of concurrent inbound connections to each service instance. [GH-13143]
  • grpc: Add a new ServerDiscovery.WatchServers gRPC endpoint for being notified when the set of ready servers has changed. [GH-12819]
  • telemetry: Added consul.raft.thread.main.saturation and consul.raft.thread.fsm.saturation metrics to measure approximate saturation of the Raft goroutines [GH-12865]
  • ui: removed external dependencies for serving UI assets in favor of Go's native embed capabilities [GH-10996]
  • ui: upgrade ember-composable-helpers to v5.x [GH-13394]

BUG FIXES:

  • acl: Fixed a bug where the ACL down policy wasn't being applied on remote errors from the primary datacenter. [GH-12885]
  • cli: when acl token read is used with the -self and -expanded flags, return an error instead of panicking [GH-13787]
  • connect: Fixed a goroutine/memory leak that would occur when using the ingress gateway. [GH-13847]
  • connect: Ingress gateways with a wildcard service entry should no longer pick up non-connect services as upstreams. connect: Terminating gateways with a wildcard service entry should no longer pick up connect services as upstreams. [GH-13958]
  • proxycfg: Fixed a minor bug that would cause configuring a terminating gateway to watch too many service resolvers and waste resources doing filtering. [GH-13012]
  • raft: upgrade to v1.3.8 which fixes a bug where non cluster member can still be able to participate in an election. [GH-12844]
  • rpc: Adds a deadline to client RPC calls, so that streams will no longer hang indefinitely in unstable network conditions. [GH-8504] [GH-11500]
  • serf: upgrade serf to v0.9.8 which fixes a bug that crashes Consul when serf keyrings are listed [GH-13062]
  • ui: Fixes an issue where client side validation errors were not showing in certain areas [GH-14021]

1.12.3 (July 13, 2022)

IMPROVEMENTS:

  • Support Vault namespaces in Connect CA by adding RootPKINamespace and IntermediatePKINamespace fields to the config. [GH-12904]
  • connect: Update Envoy support matrix to latest patch releases (1.22.2, 1.21.3, 1.20.4, 1.19.5) [GH-13431]
  • dns: Added support for specifying admin partition in node lookups. [GH-13421]
  • telemetry: Added a consul.server.isLeader metric to track if a server is a leader or not. [GH-13304]

BUG FIXES:

  • agent: Fixed a bug in HTTP handlers where URLs were being decoded twice [GH-13256]
  • deps: Update go-grpc/grpc, resolving connection memory leak [GH-13051]
  • fix a bug that caused an error when creating grpc or http2 ingress gateway listeners with multiple services [GH-13127]
  • ui: Fix incorrect text on certain page empty states [GH-13409]
  • xds: Fix a bug that resulted in Lambda services not using the payload-passthrough option as expected. [GH-13607]
  • xds: Fix a bug where terminating gateway upstream clusters weren't configured properly when the service protocol was http2. [GH-13699]

1.11.7 (July 13, 2022)

IMPROVEMENTS:

  • connect: Update supported Envoy versions to 1.20.4, 1.19.5, 1.18.6, 1.17.4 [GH-13434]

BUG FIXES:

  • agent: Fixed a bug in HTTP handlers where URLs were being decoded twice [GH-13265]
  • fix a bug that caused an error when creating grpc or http2 ingress gateway listeners with multiple services [GH-13127]
  • xds: Fix a bug where terminating gateway upstream clusters weren't configured properly when the service protocol was http2. [GH-13699]

1.10.12 (July 13, 2022)

BUG FIXES:

  • agent: Fixed a bug in HTTP handlers where URLs were being decoded twice [GH-13264]
  • fix a bug that caused an error when creating grpc or http2 ingress gateway listeners with multiple services [GH-13127]

1.12.2 (June 3, 2022)

BUG FIXES:

  • kvs: Fixed a bug where query options were not being applied to KVS.Get RPC operations. [GH-13344]

1.12.1 (May 25, 2022)

FEATURES:

  • xds: Add the ability to invoke AWS Lambdas through sidecar proxies. [GH-12956]

IMPROVEMENTS:

  • config: introduce telemetry.retry_failed_connection in agent configuration to retry on failed connection to any telemetry backend. This prevents the agent from exiting if the given DogStatsD DNS name is unresolvable, for example. [GH-13091]
  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids
  • xds: Envoy now inserts x-forwarded-client-cert for incoming proxy connections [GH-12878]

BUG FIXES:

  • Fix a bug when configuring an add_headers directive named Host the header is not set for v1/internal/ui/metrics-proxy/ endpoint. [GH-13071]
  • api: Fix a bug that causes partition to be ignored when creating a namespace [GH-12845]
  • api: agent/self now returns version with +ent suffix for Enterprise Consul [GH-12961]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • ca: fix a bug that caused a non blocking leaf cert query after a blocking leaf cert query to block [GH-12820]
  • config: fix backwards compatibility bug where setting the (deprecated) top-level verify_incoming option would enable TLS client authentication on the gRPC port [GH-13118]
  • health: ensure /v1/health/service/:service endpoint returns the most recent results when a filter is used with streaming #12640 [GH-12640]
  • rpc: Adds a deadline to client RPC calls, so that streams will no longer hang indefinitely in unstable network conditions. [GH-8504] [GH-11500]
  • snapshot-agent: (Enterprise only) Fix a bug where providing the ACL token to the snapshot agent via a CLI or ENV variable without a license configured results in an error during license auto-retrieval.
  • ui: Re-instate '...' icon for row actions [GH-13183]

NOTES:

  • ci: change action to pull v1 instead of main [GH-12846]

1.11.6 (May 25, 2022)

IMPROVEMENTS:

  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids

BUG FIXES:

  • Fix a bug when configuring an add_headers directive named Host the header is not set for v1/internal/ui/metrics-proxy/ endpoint. [GH-13071]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • ca: fix a bug that caused a non blocking leaf cert query after a blocking leaf cert query to block [GH-12820]
  • health: ensure /v1/health/service/:service endpoint returns the most recent results when a filter is used with streaming #12640 [GH-12640]
  • snapshot-agent: (Enterprise only) Fix a bug where providing the ACL token to the snapshot agent via a CLI or ENV variable without a license configured results in an error during license auto-retrieval.

NOTES:

  • ci: change action to pull v1 instead of main [GH-12846]

1.12.0 (April 20, 2022)

BREAKING CHANGES:

  • connect: Removes support for Envoy 1.17.4 [GH-12777]
  • connect: Removes support for Envoy 1.18.6 [GH-12805]
  • sdk: several changes to the testutil configuration structs (removed ACLMasterToken, renamed Master to InitialManagement, and AgentMaster to AgentRecovery) [GH-11827]
  • telemetry: the disable_compat_1.9 option now defaults to true. 1.9 style consul.http... metrics can still be enabled by setting disable_compat_1.9 = false. However, we will remove these metrics in 1.13. [GH-12675]

FEATURES:

  • acl: Add token information to PermissionDeniedErrors [GH-12567]
  • acl: Added an AWS IAM auth method that allows authenticating to Consul using AWS IAM identities [GH-12583]
  • ca: Root certificates can now be consumed from a gRPC streaming endpoint: WatchRoots [GH-12678]
  • cli: The token read command now supports the -expanded flag to display detailed role and policy information for the token. [GH-12670]
  • config: automatically reload config when a file changes using the auto-reload-config CLI flag or auto_reload_config config option. [GH-12329]
  • server: Ensure that service-defaults Meta is returned with the response to the ConfigEntry.ResolveServiceConfig RPC. [GH-12529]
  • server: discovery chains now include a response field named "Default" to indicate if they were not constructed from any service-resolver, service-splitter, or service-router config entries [GH-12511]
  • server: ensure that service-defaults meta is incorporated into the discovery chain response [GH-12511]
  • tls: it is now possible to configure TLS differently for each of Consul's listeners (i.e. HTTPS, gRPC and the internal multiplexed RPC listener) using the tls stanza [GH-12504]
  • ui: Added support for AWS IAM Auth Methods [GH-12786]
  • ui: Support connect-native services in the Topology view. [GH-12098]
  • xds: Add the ability to invoke AWS Lambdas through terminating gateways. [GH-12681]
  • xds: adding control of the mesh-wide min/max TLS versions and cipher suites from the mesh config entry [GH-12601]

IMPROVEMENTS:

  • Refactor ACL denied error code and start improving error details [GH-12308]
  • acl: Provide fuller detail in the error messsage when an ACL denies access. [GH-12470]
  • agent: Allow client agents to perform keyring operations [GH-12442]
  • agent: add additional validation to TLS config [GH-12522]
  • agent: add support for specifying TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 and TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 cipher suites [GH-12522]
  • agent: bump default min version for connections to TLS 1.2 [GH-12522]
  • api: add QueryBackend to QueryMeta so an api user can determine if a query was served using which backend (streaming or blocking query). [GH-12791]
  • ci: include 'enhancement' entry type in IMPROVEMENTS section of changelog. [GH-12376]
  • ui: Exclude Service Instance Health from Health Check reporting on the Node listing page. The health icons on each individual row now only reflect Node health. [GH-12248]
  • ui: Improve usability of Topology warning/information panels [GH-12305]
  • ui: Slightly improve usability of main navigation [GH-12334]
  • ui: Use @hashicorp/flight icons for all our icons. [GH-12209]
  • Removed impediments to using a namespace prefixed IntermediatePKIPath in a CA definition. [GH-12655]
  • acl: Improve handling of region-specific endpoints in the AWS IAM auth method. As part of this, the STSRegion field was removed from the auth method config. [GH-12774]
  • api: Improve error message if service or health check not found by stating that the entity must be referred to by ID, not name [GH-10894]
  • autopilot: Autopilot state is now tracked on Raft followers in addition to the leader. Stale queries may be used to query for the non-leaders state. [GH-12617]
  • autopilot: The autopilot.healthy and autopilot.failure_tolerance metrics are now regularly emitted by all servers. [GH-12617]
  • ci: Enable security scanning for CRT [GH-11956]
  • connect: Add Envoy 1.21.1 to support matrix, remove 1.17.4 [GH-12777]
  • connect: Add Envoy 1.22.0 to support matrix, remove 1.18.6 [GH-12805]
  • connect: reduce raft apply on CA configuration when no change is performed [GH-12298]
  • deps: update to latest go-discover to fix vulnerable transitive jwt-go dependency [GH-12739]
  • grpc, xds: improved reliability of grpc and xds servers by adding recovery-middleware to return and log error in case of panic. [GH-10895]
  • http: if a GET request has a non-empty body, log a warning that suggests a possible problem (parameters were meant for the query string, but accidentally placed in the body) [GH-11821]
  • metrics: The consul.raft.boltdb.writeCapacity metric was added and indicates a theoretical number of writes/second that can be performed to Consul. [GH-12646]
  • sdk: Add support for Partition and RetryJoin to the TestServerConfig struct. [GH-12126]
  • telemetry: Add new leader label to consul.rpc.server.call and optional target_datacenter, locality, allow_stale, and blocking optional labels. [GH-12727]
  • ui: In the datacenter selector order Datacenters by Primary, Local then alpanumerically [GH-12478]
  • ui: Include details on ACL policy dispositions required for unauthorized views [GH-12354]
  • ui: Move icons away from depending on a CSS preprocessor [GH-12461]
  • version: Improved performance of the version.GetHumanVersion function by 50% on memory allocation. [GH-11507]

DEPRECATIONS:

  • acl: The consul.acl.ResolveTokenToIdentity metric is no longer reported. The values that were previous reported as part of this metric will now be part of the consul.acl.ResolveToken metric. [GH-12166]
  • agent: deprecate older syntax for specifying TLS min version values [GH-12522]
  • agent: remove support for specifying insecure TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 and TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 cipher suites [GH-12522]
  • config: setting cert_file, key_file, ca_file, ca_path, tls_min_version, tls_cipher_suites, verify_incoming, verify_incoming_rpc, verify_incoming_https, verify_outgoing and verify_server_hostname at the top-level is now deprecated, use the tls stanza instead [GH-12504]

BUG FIXES:

  • acl: Fix parsing of IAM user and role tags in IAM auth method [GH-12797]
  • dns: allow max of 63 character DNS labels instead of 64 per RFC 1123 [GH-12535]
  • logging: fix a bug with incorrect severity syslog messages (all messages were sent with NOTICE severity). [GH-12079]
  • ui: Added Tags tab to gateways(just like exists for non-gateway services) [GH-12400]
  • ui: Ensure proxy instance health is taken into account in Service Instance Listings [GH-12279]
  • ui: Fixes an issue with the version footer wandering when scrolling [GH-11850]

NOTES:

1.11.5 (April 13, 2022)

SECURITY:

  • agent: Added a new check field, disable_redirects, that allows for disabling the following of redirects for HTTP checks. The intention is to default this to true in a future release so that redirects must explicitly be enabled. [GH-12685]
  • connect: Properly set SNI when configured for services behind a terminating gateway. [GH-12672]

IMPROVEMENTS:

  • agent: improve log messages when a service with a critical health check is deregistered due to exceeding the deregister_critical_service_after timeout [GH-12725]
  • xds: ensure that all connect timeout configs can apply equally to tproxy direct dial connections [GH-12711]

BUG FIXES:

  • acl: (Enterprise Only) fixes a bug preventing ACL policies configured with datacenter restrictions from being created if the cluster had been upgraded to Consul 1.11+ from an earlier version.
  • connect/ca: cancel old Vault renewal on CA configuration. Provide a 1 - 6 second backoff on repeated token renewal requests to prevent overwhelming Vault. [GH-12607]
  • namespace: (Enterprise Only) Unreserve consul namespace to allow K8s namespace mirroring when deploying in consul K8s namespace .
  • raft: upgrade to v1.3.6 which fixes a bug where a read replica node could attempt bootstrapping raft and prevent other nodes from bootstrapping at all [GH-12496]
  • replication: Fixed a bug which could prevent ACL replication from continuing successfully after a leader election. [GH-12565]
  • server: fix spurious blocking query suppression for discovery chains [GH-12512]
  • ui: Fixes a visual bug where our loading icon can look cut off [GH-12479]
  • usagemetrics: (Enterprise only) Fix a bug where Consul usage metrics stopped being reported when upgrading servers from 1.10 to 1.11 or later.

1.11.4 (February 28, 2022)

FEATURES:

  • ca: support using an external root CA with the vault CA provider [GH-11910]

IMPROVEMENTS:

  • connect: Update supported Envoy versions to include 1.19.3 and 1.18.6 [GH-12449]
  • connect: update Envoy supported version of 1.20 to 1.20.2 [GH-12433]
  • connect: update Envoy supported version of 1.20 to 1.20.2 [GH-12443]
  • debug: reduce the capture time for trace to only a single interval instead of the full duration to make trace.out easier to open without running into OOM errors. [GH-12359]
  • raft: add additional logging of snapshot restore progress [GH-12325]
  • rpc: improve blocking queries for items that do not exist, by continuing to block until they exist (or the timeout). [GH-12110]
  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids
  • server: conditionally avoid writing a config entry to raft if it was already the same [GH-12321]
  • server: suppress spurious blocking query returns where multiple config entries are involved [GH-12362]

BUG FIXES:

  • agent: Parse datacenter from Create/Delete requests for AuthMethods and BindingRules. [GH-12370]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • catalog: compare node names case insensitively in more places [GH-12444]
  • checks: populate interval and timeout when registering services [GH-11138]
  • local: fixes a data race in anti-entropy sync that could cause the wrong tags to be applied to a service when EnableTagOverride is used [GH-12324]
  • raft: fixed a race condition in leadership transfer that could result in reelection of the current leader [GH-12325]
  • server: (Enterprise only) Namespace deletion will now attempt to delete as many namespaced config entries as possible instead of halting on the first deletion that failed.
  • server: partly fix config entry replication issue that prevents replication in some circumstances [GH-12307]
  • state: fix bug blocking snapshot restore when a node check and node differed in casing of the node string [GH-12444]
  • ui: Ensure we always display the Policy default preview in the Namespace editing form [GH-12316]
  • ui: Fix missing helper javascript error [GH-12358]
  • xds: Fixed Envoy http features such as outlier detection and retry policy not working correctly with transparent proxy. [GH-12385]

1.11.3 (February 11, 2022)

IMPROVEMENTS:

  • connect: update Envoy supported version of 1.20 to 1.20.1 [GH-11895]
  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids
  • streaming: Improved performance when the server is handling many concurrent subscriptions and has a high number of CPU cores [GH-12080]
  • systemd: Support starting/stopping the systemd service for linux packages when the optional EnvironmentFile does not exist. [GH-12176]

BUG FIXES:

  • Fix a data race when a service is added while the agent is shutting down.. [GH-12302]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • ca: adjust validation of PrivateKeyType/Bits with the Vault provider, to remove the error when the cert is created manually in Vault. [GH-12267]
  • config-entry: fix a panic when creating an ingress gateway config-entry and a proxy service instance, where both provided the same upstream and downstream mapping. [GH-12277]
  • connect: fixes bug where passthrough addressses for transparent proxies dialed directly weren't being cleaned up. [GH-12223]
  • partitions: (Enterprise only) Do not leave a serf partition when the partition is deleted
  • serf: update serf v0.9.7, complete the leave process if broadcasting leave timeout. [GH-12057]
  • ui: Ensure proxy instance health is taken into account in Service Instance Listings [GH-12279]
  • ui: Fix up a problem where occasionally an intention can visually disappear from the listing after saving [GH-12315]
  • ui: Fixed a bug with creating multiple nested KVs in one interaction [GH-12081]
  • ui: Include partition data when saving an intention from the topology visualization [GH-12317]
  • xds: allow only one outstanding delta request at a time [GH-12236]
  • xds: fix for delta xDS reconnect bug in LDS/CDS [GH-12174]
  • xds: prevents tight loop where the Consul client agent would repeatedly re-send config that Envoy has rejected. [GH-12195]

1.11.2 (January 12, 2022)

FEATURES:

  • ingress: allow setting TLS min version and cipher suites in ingress gateway config entries [GH-11576]

IMPROVEMENTS:

  • api: URL-encode/decode resource names for v1/agent endpoints in API. [GH-11335]
  • api: Return 404 when de-registering a non-existent check [GH-11950]
  • connect: Add support for connecting to services behind a terminating gateway when using a transparent proxy. [GH-12049]
  • http: when a user attempts to access the UI but can't because it's disabled, explain this and how to fix it [GH-11820]
  • raft: Consul leaders will attempt to transfer leadership to another server as part of gracefully leaving the cluster. [GH-11376]
  • ui: Added a notice for non-primary intention creation [GH-11985]

BUG FIXES:

  • Mutate NodeService struct properly to avoid a data race. [GH-11940]
  • Upgrade to raft 1.3.3 which fixes a bug where a read replica node can trigger a raft election and become a leader. [GH-11958]
  • cli: Display assigned node identities in output of consul acl token list. [GH-11926]
  • cli: when creating a private key, save the file with mode 0600 so that only the user has read permission. [GH-11781]
  • config: include all config errors in the error message, previously some could be hidden. [GH-11918]
  • memberlist: fixes a bug which prevented members from joining a cluster with large amounts of churn [GH-253] [GH-12042]
  • snapshot: the snapshot save command now saves the snapshot with read permission for only the current user. [GH-11918]
  • ui: Differentiate between Service Meta and Node Meta when choosing search fields in Service Instance listings [GH-11774]
  • ui: Ensure a login buttons appear for some error states, plus text amends [GH-11892]
  • ui: Ensure partition query parameter is passed through to all OIDC related API requests [GH-11979]
  • ui: Fix an issue where attempting to delete a policy from the policy detail page when attached to a token would result in the delete button disappearing and no deletion being attempted [GH-11868]
  • ui: Fixes a bug where proxy service health checks would sometimes not appear until refresh [GH-11903]
  • ui: Fixes a bug with URL decoding within KV area [GH-11931]
  • ui: Fixes a visual issue with some border colors [GH-11959]
  • ui: Fixes an issue saving intentions when editing per service intentions [GH-11937]
  • ui: Fixes an issue where once a 403 page is displayed in some circumstances its diffcult to click back to where you where before receiving a 403 [GH-11891]
  • ui: Prevent disconnection notice appearing with auth change on certain pages [GH-11905]
  • ui: Temporarily remove KV pre-flight check for KV list permissions [GH-11968]
  • windows: Fixes a bug with empty log files when Consul is run as a Windows Service [GH-11960]
  • xds: fix a deadlock when the snapshot channel already have a snapshot to be consumed. [GH-11924]

1.11.1 (December 15, 2021)

SECURITY:

FEATURES:

  • Admin Partitions (Consul Enterprise only) This version adds admin partitions, a new entity defining administrative and networking boundaries within a Consul deployment. For more information refer to the Admin Partition documentation. [GH-11855]
  • networking: (Enterprise Only) Make segment_limit configurable, cap at 256.

BUG FIXES:

  • ui: Fixes an issue with the version footer wandering when scrolling [GH-11850]

1.11.0 (December 14, 2021)

BREAKING CHANGES:

  • acl: The legacy ACL system that was deprecated in Consul 1.4.0 has been removed. Before upgrading you should verify that nothing is still using the legacy ACL system. See the Migrate Legacy ACL Tokens Learn Guide for more information. [GH-11232]
  • cli: consul acl set-agent-token master has been replaced with consul acl set-agent-token recovery [GH-11669]

SECURITY:

  • namespaces: (Enterprise only) Creating or editing namespaces that include default ACL policies or ACL roles now requires acl:write permission in the default namespace. This change fixes CVE-2021-41805.
  • rpc: authorize raft requests CVE-2021-37219 [GH-10925]

FEATURES:

  • Admin Partitions (Consul Enterprise only) This version adds admin partitions, a new entity defining administrative and networking boundaries within a Consul deployment. For more information refer to the Admin Partition documentation.
  • ca: Add a configurable TTL for Connect CA root certificates. The configuration is supported by the Vault and Consul providers. [GH-11428]
  • ca: Add a configurable TTL to the AWS ACM Private CA provider root certificate. [GH-11449]
  • health-checks: add support for h2c in http2 ping health checks [GH-10690]
  • ui: Add UI support to use Vault as an external source for a service [GH-10769]
  • ui: Adding support of Consul API Gateway as an external source. [GH-11371]
  • ui: Adds a copy button to each composite row in tokens list page, if Secret ID returns an actual ID [GH-10735]
  • ui: Adds visible Consul version information [GH-11803]
  • ui: Topology - New views for scenarios where no dependencies exist or ACLs are disabled [GH-11280]

IMPROVEMENTS:

  • acls: Show AuthMethodNamespace when reading/listing ACL tokens. [GH-10598]
  • acl: replication routine to report the last error message. [GH-10612]
  • agent: add variation of force-leave that exclusively works on the WAN [GH-11722]
  • api: Enable setting query options on agent health and maintenance endpoints. [GH-10691]
  • api: responses that contain only a partial subset of results, due to filtering by ACL policies, may now include an X-Consul-Results-Filtered-By-ACLs header [GH-11569]
  • checks: add failures_before_warning setting for interval checks. [GH-10969]
  • ci: Upgrade to use Go 1.17.5 [GH-11799]
  • ci: Allow configuring graceful stop in testutil. [GH-10566]
  • cli: Add -cas and -modify-index flags to the consul config delete command to support Check-And-Set (CAS) deletion of config entries [GH-11419]
  • config: (Enterprise Only) Allow specifying permission mode for audit logs. [GH-10732]
  • config: Support Check-And-Set (CAS) deletion of config entries [GH-11419]
  • config: add dns_config.recursor_strategy flag to control the order which DNS recursors are queried [GH-10611]
  • config: warn the user if client_addr is empty because client services won't be listening [GH-11461]
  • connect/ca: cease including the common name field in generated x509 non-CA certificates [GH-10424]
  • connect: Add low-level feature to allow an Ingress to retrieve TLS certificates from SDS. [GH-10903]
  • connect: Consul will now generate a unique virtual IP for each connect-enabled service (this will also differ across namespace/partition in Enterprise). [GH-11724]
  • connect: Support Vault auth methods for the Connect CA Vault provider. Currently, we support any non-deprecated auth methods the latest version of Vault supports (v1.8.5), which include AppRole, AliCloud, AWS, Azure, Cloud Foundry, GitHub, Google Cloud, JWT/OIDC, Kerberos, Kubernetes, LDAP, Oracle Cloud Infrastructure, Okta, Radius, TLS Certificates, and Username & Password. [GH-11573]
  • connect: Support manipulating HTTP headers in the mesh. [GH-10613]
  • connect: add Namespace configuration setting for Vault CA provider [GH-11477]
  • connect: ingress gateways may now enable built-in TLS for a subset of listeners. [GH-11163]
  • connect: service-resolver subset filters are validated for valid go-bexpr syntax on write [GH-11293]
  • connect: update supported envoy versions to 1.19.1, 1.18.4, 1.17.4, 1.16.5 [GH-11115]
  • connect: update supported envoy versions to 1.20.0, 1.19.1, 1.18.4, 1.17.4 [GH-11277]
  • debug: Add a new /v1/agent/metrics/stream API endpoint for streaming of metrics [GH-10399]
  • debug: rename cluster capture target to members, to be more consistent with the terms used by the API. [GH-10804]
  • dns: Added a virtual endpoint for querying the assigned virtual IP for a service. [GH-11725]
  • http: when a URL path is not found, include a message with the 404 status code to help the user understand why (e.g., HTTP API endpoint path not prefixed with /v1/) [GH-11818]
  • raft: Added a configuration to disable boltdb freelist syncing [GH-11720]
  • raft: Emit boltdb related performance metrics [GH-11720]
  • raft: Use bbolt instead of the legacy boltdb implementation [GH-11720]
  • sdk: Add support for iptable rules that allow DNS lookup redirection to Consul DNS. [GH-11480]
  • segments: (Enterprise only) ensure that the serf_lan_allowed_cidrs applies to network segments [GH-11495]
  • telemetry: add a new agent.tls.cert.expiry metric for tracking when the Agent TLS certificate expires. [GH-10768]
  • telemetry: add a new mesh.active-root-ca.expiry metric for tracking when the root certificate expires. [GH-9924]
  • telemetry: added metrics to track certificates expiry. [GH-10504]
  • types: add TLSVersion and TLSCipherSuite [GH-11645]
  • ui: Change partition URL segment prefix from - to _ [GH-11801]
  • ui: Add upstream icons for upstreams and upstream instances [GH-11556]
  • ui: Add uri guard to prevent future URL encoding issues [GH-11117]
  • ui: Move the majority of our SASS variables to use native CSS custom properties [GH-11200]
  • ui: Removed informational panel from the namespace selector menu when editing namespaces [GH-11130]
  • ui: Update UI browser support to 'roughly ~2 years back' [GH-11505]
  • ui: Update global notification styling [GH-11577]
  • ui: added copy to clipboard button in code editor toolbars [GH-11474]

DEPRECATIONS:

  • api: /v1/agent/token/agent_master is deprecated and will be removed in a future major release - use /v1/agent/token/agent_recovery instead [GH-11669]
  • config: acl.tokens.master has been renamed to acl.tokens.initial_management, and acl.tokens.agent_master has been renamed to acl.tokens.agent_recovery - the old field names are now deprecated and will be removed in a future major release [GH-11665]
  • tls: With the upgrade to Go 1.17, the ordering of tls_cipher_suites will no longer be honored, and tls_prefer_server_cipher_suites is now ignored. [GH-11364]

BUG FIXES:

  • acl: (Enterprise only) fix namespace and namespace_prefix policy evaluation when both govern an authz request
  • api: Fix default values used for optional fields in autopilot configuration update (POST to /v1/operator/autopilot/configuration) [GH-10558] [GH-10559]
  • api: ensure new partition fields are omit empty for compatibility with older versions of consul [GH-11585]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time.
  • areas: (Enterprise only) make the gRPC server tracker network area aware [GH-11748]
  • ca: fixes a bug that caused non blocking leaf cert queries to return the same cached response regardless of ca rotation or leaf cert expiry [GH-11693]
  • ca: fixes a bug that caused the SigningKeyID to be wrong in the primary DC, when the Vault provider is used, after a CA config creates a new root. [GH-11672]
  • ca: fixes a bug that caused the intermediate cert used to sign leaf certs to be missing from the /connect/ca/roots API response when the Vault provider was used. [GH-11671]
  • check root and intermediate CA expiry before using it to sign a leaf certificate. [GH-10500]
  • connect/ca: ensure edits to the key type/bits for the connect builtin CA will regenerate the roots [GH-10330]
  • connect/ca: require new vault mount points when updating the key type/bits for the vault connect CA provider [GH-10331]
  • connect: fix race causing xDS generation to lock up when discovery chains are tracked for services that are no longer upstreams. [GH-11826]
  • dns: Fixed an issue where on DNS requests made with .alt_domain response was returned as .domain [GH-11348]
  • dns: return an empty answer when asked for an addr dns with type other then A and AAAA. [GH-10401]
  • macos: fixes building with a non-Apple LLVM (such as installed via Homebrew) [GH-11586]
  • namespaces: (Enterprise only) ensure the namespace replicator doesn't replicate deleted namespaces
  • proxycfg: ensure all of the watches are canceled if they are cancelable [GH-11824]
  • snapshot: (Enterprise only) fixed a bug where the snapshot agent would ignore the license_path setting in config files
  • ui: Change partitions to expect [] from the listing API [GH-11791]
  • ui: Don't offer to save an intention with a source/destination wildcard partition [GH-11804]
  • ui: Ensure all types of data get reconciled with the backend data [GH-11237]
  • ui: Ensure dc selector correctly shows the currently selected dc [GH-11380]
  • ui: Ensure we check intention permissions for specific services when deciding whether to show action buttons for per service intention actions [GH-11409]
  • ui: Ensure we filter tokens by policy when showing which tokens use a certain policy whilst editing a policy [GH-11311]
  • ui: Ensure we show a readonly designed page for readonly intentions [GH-11767]
  • ui: Filter the global intentions list by the currently selected parition rather than a wildcard [GH-11475]
  • ui: Fix inline-code brand styling [GH-11578]
  • ui: Fix visual issue with slight table header overflow [GH-11670]
  • ui: Fixes an issue where under some circumstances after logging we present the data loaded previous to you logging in. [GH-11681]
  • ui: Gracefully recover from non-existant DC errors [GH-11077]
  • ui: Include Service.Namespace into available variables for dashboard_url_templates [GH-11640]
  • ui: Revert to depending on the backend, 'post-user-action', to report permissions errors rather than using UI capabilities 'pre-user-action' [GH-11520]
  • ui: Topology - Fix up Default Allow and Permissive Intentions notices [GH-11216]
  • ui: code editor styling (layout consistency + wide screen support) [GH-11474]
  • use the MaxQueryTime instead of RPCHoldTimeout for blocking RPC queries [GH-8978]. [GH-10299]
  • windows: fixes arm and arm64 builds [GH-11586]

NOTES:

  • Renamed the agent_master field to agent_recovery in the acl-tokens.json file in which tokens are persisted on-disk (when acl.enable_token_persistence is enabled) [GH-11744]

1.10.11 (May 25, 2022)

SECURITY:

  • agent: Use SHA256 instead of MD5 to generate persistence file names.

IMPROVEMENTS:

  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids

BUG FIXES:

  • Fix a bug when configuring an add_headers directive named Host the header is not set for v1/internal/ui/metrics-proxy/ endpoint. [GH-13071]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • ca: fix a bug that caused a non blocking leaf cert query after a locking leaf cert query to block [GH-12820]
  • health: ensure /v1/health/service/:service endpoint returns the most recent results when a filter is used with streaming #12640 [GH-12640]
  • snapshot-agent: (Enterprise only) Fix a bug where providing the ACL token to the snapshot agent via a CLI or ENV variable without a license configured results in an error during license auto-retrieval.

NOTES:

  • ci: change action to pull v1 instead of main [GH-12846]

1.10.10 (April 13, 2022)

SECURITY:

  • agent: Added a new check field, disable_redirects, that allows for disabling the following of redirects for HTTP checks. The intention is to default this to true in a future release so that redirects must explicitly be enabled. [GH-12685]
  • connect: Properly set SNI when configured for services behind a terminating gateway. [GH-12672]

IMPROVEMENTS:

  • xds: ensure that all connect timeout configs can apply equally to tproxy direct dial connections [GH-12711]

DEPRECATIONS:

  • tls: With the upgrade to Go 1.17, the ordering of tls_cipher_suites will no longer be honored, and tls_prefer_server_cipher_suites is now ignored. [GH-12766]

BUG FIXES:

  • connect/ca: cancel old Vault renewal on CA configuration. Provide a 1 - 6 second backoff on repeated token renewal requests to prevent overwhelming Vault. [GH-12607]
  • raft: upgrade to v1.3.6 which fixes a bug where a read replica node could attempt bootstrapping raft and prevent other nodes from bootstrapping at all [GH-12496]
  • replication: Fixed a bug which could prevent ACL replication from continuing successfully after a leader election. [GH-12565]
  • server: fix spurious blocking query suppression for discovery chains [GH-12512]

1.10.9 (February 28, 2022)

SECURITY:

  • agent: Use SHA256 instead of MD5 to generate persistence file names.

FEATURES:

  • ca: support using an external root CA with the vault CA provider [GH-11910]

IMPROVEMENTS:

  • connect: Update supported Envoy versions to include 1.18.6 [GH-12450]
  • connect: update Envoy supported version of 1.20 to 1.20.2 [GH-12434]
  • debug: reduce the capture time for trace to only a single interval instead of the full duration to make trace.out easier to open without running into OOM errors. [GH-12359]
  • raft: add additional logging of snapshot restore progress [GH-12325]
  • rpc: improve blocking queries for items that do not exist, by continuing to block until they exist (or the timeout). [GH-12110]
  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids
  • server: conditionally avoid writing a config entry to raft if it was already the same [GH-12321]
  • server: suppress spurious blocking query returns where multiple config entries are involved [GH-12362]

BUG FIXES:

  • agent: Parse datacenter from Create/Delete requests for AuthMethods and BindingRules. [GH-12370]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • raft: fixed a race condition in leadership transfer that could result in reelection of the current leader [GH-12325]
  • server: (Enterprise only) Namespace deletion will now attempt to delete as many namespaced config entries as possible instead of halting on the first deletion that failed.
  • server: partly fix config entry replication issue that prevents replication in some circumstances [GH-12307]
  • ui: Ensure we always display the Policy default preview in the Namespace editing form [GH-12316]
  • xds: Fixed Envoy http features such as outlier detection and retry policy not working correctly with transparent proxy. [GH-12385]

1.10.8 (February 11, 2022)

SECURITY:

  • agent: Use SHA256 instead of MD5 to generate persistence file names.

IMPROVEMENTS:

  • raft: Consul leaders will attempt to transfer leadership to another server as part of gracefully leaving the cluster. [GH-11376]
  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids

BUG FIXES:

  • Fix a data race when a service is added while the agent is shutting down.. [GH-12302]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • config-entry: fix a panic when creating an ingress gateway config-entry and a proxy service instance, where both providedthe same upstream and downstrem mapping. [GH-12277]
  • config: include all config errors in the error message, previously some could be hidden. [GH-11918]
  • connect: fixes bug where passthrough addressses for transparent proxies dialed directly weren't being cleaned up. [GH-12223]
  • memberlist: fixes a bug which prevented members from joining a cluster with large amounts of churn [GH-253] [GH-12047]
  • snapshot: the snapshot save command now saves the snapshot with read permission for only the current user. [GH-11918]
  • xds: allow only one outstanding delta request at a time [GH-12236]
  • xds: fix for delta xDS reconnect bug in LDS/CDS [GH-12174]
  • xds: prevents tight loop where the Consul client agent would repeatedly re-send config that Envoy has rejected. [GH-12195]a

1.10.7 (January 12, 2022)

SECURITY:

  • namespaces: (Enterprise only) Creating or editing namespaces that include default ACL policies or ACL roles now requires acl:write permission in the default namespace. This change fixes CVE-2021-41805.

FEATURES:

  • ui: Adds visible Consul version information [GH-11803]

BUG FIXES:

  • Mutate NodeService struct properly to avoid a data race. [GH-11940]
  • Upgrade to raft 1.3.3 which fixes a bug where a read replica node can trigger a raft election and become a leader. [GH-11958]
  • ca: fixes a bug that caused non blocking leaf cert queries to return the same cached response regardless of ca rotation or leaf cert expiry [GH-11693]
  • ca: fixes a bug that caused the SigningKeyID to be wrong in the primary DC, when the Vault provider is used, after a CA config creates a new root. [GH-11672]
  • ca: fixes a bug that caused the intermediate cert used to sign leaf certs to be missing from the /connect/ca/roots API response when the Vault provider was used. [GH-11671]
  • cli: Display assigned node identities in output of consul acl token list. [GH-11926]
  • cli: when creating a private key, save the file with mode 0600 so that only the user has read permission. [GH-11781]
  • snapshot: (Enterprise only) fixed a bug where the snapshot agent would ignore the license_path setting in config files
  • structs: (Enterprise only) Remove partition field parsing from 1.10 to prevent further 1.11 upgrade compatibility issues.
  • ui: Differentiate between Service Meta and Node Meta when choosing search fields in Service Instance listings [GH-11774]
  • ui: Ensure we show a readonly designed page for readonly intentions [GH-11767]
  • ui: Fix an issue where attempting to delete a policy from the policy detail page when attached to a token would result in the delete button disappearing and no deletion being attempted [GH-11868]
  • ui: Fix visual issue with slight table header overflow [GH-11670]
  • ui: Fixes an issue where once a 403 page is displayed in some circumstances its diffcult to click back to where you where before receiving a 403 [GH-11891]
  • ui: Fixes an issue where under some circumstances after logging we present the data loaded previous to you logging in. [GH-11681]
  • ui: Include Service.Namespace into available variables for dashboard_url_templates [GH-11640]
  • ui: Revert to depending on the backend, 'post-user-action', to report permissions errors rather than using UI capabilities 'pre-user-action' [GH-11520]
  • ui: Temporarily remove KV pre-flight check for KV list permissions [GH-11968]
  • windows: Fixes a bug with empty log files when Consul is run as a Windows Service [GH-11960]
  • xds: fix a deadlock when the snapshot channel already have a snapshot to be consumed. [GH-11924]

1.10.6 (December 15, 2021)

SECURITY:

1.10.5 (December 13, 2021)

SECURITY:

BUG FIXES:

  • agent: (Enterprise only) fix bug where 1.10.x agents would deregister serf checks from 1.11.x servers [GH-11700]

1.10.4 (November 11, 2021)

SECURITY:

  • agent: Use SHA256 instead of MD5 to generate persistence file names. [GH-11491]
  • namespaces: (Enterprise only) Creating or editing namespaces that include default ACL policies or ACL roles now requires acl:write permission in the default namespace. This change fixes CVE-2021-41805.

IMPROVEMENTS:

  • ci: Artifact builds will now only run on merges to the release branches or to main [GH-11417]
  • ci: The Linux packages are now available for all supported Linux architectures including arm, arm64, 386, and amd64 [GH-11417]
  • ci: The Linux packaging service configs and pre/post install scripts are now available under [.release/linux] [GH-11417]
  • connect/ca: Return an error when querying roots from uninitialized CA. [GH-11514]
  • telemetry: Add new metrics for the count of connect service instances and configuration entries. [GH-11222]

BUG FIXES:

  • acl: fixes the fallback behaviour of down_policy with setting extend-cache/async-cache when the token is not cached. [GH-11136]
  • api: fixed backwards compatibility issue with AgentService SocketPath field. [GH-11318]
  • connect/ca: Allow secondary initialization to resume after being deferred due to unreachable or incompatible primary DC servers. [GH-11514]
  • connect: fix issue with attempting to generate an invalid upstream cluster from UpstreamConfig.Defaults. [GH-11245]
  • raft: do not trigger an election if not part of the servers list. [GH-11375]
  • rpc: only attempt to authorize the DNSName in the client cert when verify_incoming_rpc=true [GH-11255]
  • server: (Enterprise only) Ensure that servers leave network segments when leaving other gossip pools
  • snapshot: (Enterprise only) snapshot agent no longer attempts to refresh its license from the server when a local license is provided (i.e. via config or an environment variable)
  • telemetry: Consul Clients no longer emit Autopilot metrics. [GH-11241]
  • telemetry: fixes a bug with Prometheus consul_autopilot_failure_tolerance metric where 0 is reported instead of NaN on follower servers. [GH-11399]
  • telemetry: fixes a bug with Prometheus consul_autopilot_healthy metric where 0 is reported instead of NaN on servers. [GH-11231]
  • ui: (Enterprise only) When no namespace is selected, make sure to default to the tokens default namespace when requesting permissions [GH-11472]
  • ui: Ensure we check intention permissions for specific services when deciding whether to show action buttons for per service intention actions [GH-11270]
  • ui: Fixed styling of Role remove dialog on the Token edit page [GH-11298]
  • xds: fixes a bug where replacing a mesh gateway node used for WAN federation (with another that has a different IP) could leave gateways in the other DC unable to re-establish the connection [GH-11522]

BUG FIXES:

  • Fixing SOA record to return proper domain when alt domain in use. [GH-10431]

1.10.3 (September 27, 2021)

FEATURES:

  • sso/oidc: (Enterprise only) Add support for providing acr_values in OIDC auth flow [GH-11026]

IMPROVEMENTS:

  • audit-logging: (Enterprise Only) Audit logs will now include select HTTP headers in each logs payload. Those headers are: Forwarded, Via, X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Proto. [GH-11107]
  • connect: update supported envoy versions to 1.18.4, 1.17.4, 1.16.5 [GH-10961]
  • telemetry: Add new metrics for the count of KV entries in the Consul store. [GH-11090]

BUG FIXES:

  • api: Revert early out errors from license APIs to allow v1.10+ clients to manage licenses on older servers [GH-10952]
  • connect: Fix upstream listener escape hatch for prepared queries [GH-11109]
  • grpc: strip local ACL tokens from RPCs during forwarding if crossing datacenters [GH-11099]
  • tls: consider presented intermediates during server connection tls handshake. [GH-10964]
  • ui: (Enterprise Only) Fix saving intentions with namespaced source/destination [GH-11095]
  • ui: Don't show a CRD warning for read-only intentions [GH-11149]
  • ui: Ensure routing-config page blocking queries are cleaned up correctly [GH-10915]
  • ui: Ignore reported permissions for KV area meaning the KV is always enabled for both read/write access if the HTTP API allows. [GH-10916]
  • ui: hide create button for policies/roles/namespace if users token has no write permissions to those areas [GH-10914]
  • xds: ensure the active streams counters are 64 bit aligned on 32 bit systems [GH-11085]
  • xds: fixed a bug where Envoy sidecars could enter a state where they failed to receive xds updates from Consul [GH-10987]

1.10.2 (August 27, 2021)

KNOWN ISSUES:

  • tls: The fix for CVE-2021-37219 introduced an issue that could prevent TLS certificate validation when intermediate CA certificates used to sign server certificates are transmitted in the TLS session but are not present in all Consul server's configured CA certificates. This has the effect of preventing Raft RPCs between the affected servers. As a work around until the next patch releases, ensure that all intermediate CA certificates are present in all Consul server configurations prior to using certificates that they have signed.

SECURITY:

FEATURES:

  • connect: add support for unix domain socket config via API/CLI [GH-10758]
  • ui: Adding support in Topology view for Routing Configurations [GH-10872]
  • ui: Create Routing Configurations route and page [GH-10835]
  • ui: Splitting up the socket mode and socket path in the Upstreams Instance List [GH-10581]

IMPROVEMENTS:

  • areas: (Enterprise only) Add 15s timeout to opening streams over pooled connections.
  • areas: (Enterprise only) Apply backpressure to area gossip packet ingestion when more than 512 packets are waiting to be ingested.
  • areas: (Enterprise only) Make implementation of WriteToAddress non-blocking to avoid slowing down memberlist's packetListen routine.
  • checks: Add Interval and Timeout to API response. [GH-10717]
  • ci: make changelog-checker only validate PR number against main base [GH-10844]
  • ci: upgrade to use Go 1.16.7 [GH-10856]
  • deps: update to gogo/protobuf v1.3.2 [GH-10813]
  • proxycfg: log correlation IDs for the proxy configuration snapshot's blocking queries. [GH-10689]

BUG FIXES:

  • acl: fixes a bug that prevented the default user token from being used to authorize service registration for connect proxies. [GH-10824]
  • ca: fixed a bug when ca provider fail and provider state is stuck in INITIALIZING state. [GH-10630]
  • ca: report an error when setting the ca config fail because of an index check. [GH-10657]
  • cli: Ensure the metrics endpoint is accessible when Envoy is configured to use a non-default admin bind address. [GH-10757]
  • cli: Fix a bug which prevented initializing a watch when using a namespaced token. [GH-10795]
  • cli: Fix broken KV import command on Windows. [GH-10820]
  • connect: ensure SAN validation for prepared queries validates against all possible prepared query targets [GH-10873]
  • connect: fix crash that would result from multiple instances of a service resolving service config on a single agent. [GH-10647]
  • connect: proxy upstreams inherit namespace from service if none are defined. [GH-10688]
  • dns: fixes a bug with edns truncation where the response could exceed the size limit in some cases. [GH-10009]
  • grpc: ensure that streaming gRPC requests work over mesh gateway based wan federation [GH-10838]
  • http: log cancelled requests as such at the INFO level, instead of logging them as errored requests. [GH-10707]
  • streaming: set the default wait timeout for health queries [GH-10707]
  • txn: fixes Txn.Apply to properly authorize service registrations. [GH-10798]
  • ui: Disabling policy form fields from users with 'read' permissions [GH-10902]
  • ui: Fix Health Checks in K/V form Lock Sessions Info section [GH-10767]
  • ui: Fix dropdown option duplication in the new intentions form [GH-10706]
  • ui: Hide all metrics for ingress gateway services [GH-10858]
  • ui: Properly encode non-URL safe characters in OIDC responses [GH-10901]
  • ui: fixes a bug with some service failovers not showing the routing tab visualization [GH-10913]

1.10.1 (July 15, 2021)

KNOWN ISSUES:

  • The change to enable streaming by default uncovered an incompatibility between streaming and WAN federation over mesh gateways causing traffic to fall back to attempting a direct WAN connection rather than transiting through the gateways. We currently suggest explicitly setting use_streaming_backend=false if using WAN federation over mesh gateways when upgrading to 1.10.1 and are working to address this issue in a future patch release.

SECURITY:

FEATURES:

  • cli: allow running redirect-traffic command in a provided Linux namespace. [GH-10564]
  • sdk: allow applying iptables rules in a provided Linux namespace. [GH-10564]

IMPROVEMENTS:

  • acl: Return secret ID when listing tokens if accessor has acl:write [GH-10546]
  • structs: prevent service-defaults upstream configs from using wildcard names or namespaces [GH-10475]
  • ui: Move all CSS icons to use standard CSS custom properties rather than SASS variables [GH-10298]

DEPRECATIONS:

  • connect/ca: remove the RotationPeriod field from the Consul CA provider, it was not used for anything. [GH-10552]

BUG FIXES:

  • agent: fix a panic on 32-bit platforms caused by misaligned struct fields used with sync/atomic. [GH-10515]
  • ca: Fixed a bug that returned a malformed certificate chain when the certificate did not having a trailing newline. [GH-10411]
  • checks: fixes the default ServerName used with TLS health checks. [GH-10490]
  • connect/proxy: fixes logic bug preventing builtin/native proxy from starting upstream listeners [GH-10486]
  • streaming: fix a bug that was preventing streaming from being enabled. [GH-10514]
  • ui: (Enterprise only) Ensure permissions are checked based on the actively selected namespace [GH-10608]
  • ui: Ensure in-folder KVs are created in the correct folder [GH-10569]
  • ui: Fix KV editor syntax highlighting [GH-10605]
  • ui: Send service name down to Stats to properly call endpoint for Upstreams and Downstreams metrics [GH-10535]
  • ui: Show ACLs disabled page at Tokens page instead of 403 error when ACLs are disabled [GH-10604]
  • ui: Use the token's namespace instead of the default namespace when not specifying a namespace in the URL [GH-10503]

1.10.0 (June 22, 2021)

BREAKING CHANGES:

  • connect: Disallow wildcard as name for service-defaults. [GH-10069]
  • connect: avoid encoding listener info in ingress and terminating gateway listener stats names. [GH-10404]
  • licensing: (Enterprise Only) Consul Enterprise 1.10 has removed API driven licensing of servers in favor of license loading via configuration. The PUT and DELETE methods on the /v1/operator/license endpoint will now return 405s, the consul license put and consul license reset CLI commands have been removed and the LicensePut and LicenseReset methods in the API client have been altered to always return an error. [GH-10211]
  • licensing: (Enterprise Only) Consul Enterprise client agents now require a valid non-anonymous ACL token for retrieving their license from the servers. Additionally client agents rely on the value of the start_join and retry_join configurations for determining the servers to query for the license. Therefore one must be set to use license auto-retrieval. [GH-10248]
  • licensing: (Enterprise Only) Consul Enterprise has removed support for temporary licensing. All server agents must have a valid license at startup and client agents must have a license at startup or be able to retrieve one from the servers. [GH-10248]

FEATURES:

  • checks: add H2 ping health checks. [GH-8431]
  • cli: Add additional flags to the consul connect redirect-traffic command to allow excluding inbound and outbound ports, outbound CIDRs, and additional user IDs from traffic redirection. [GH-10134]
  • cli: Add new consul connect redirect-traffic command for applying traffic redirection rules when Transparent Proxy is enabled. [GH-9910]
  • cli: Add prefix option to kv import command [GH-9792]
  • cli: Automatically exclude ports from envoy_prometheus_bind_addr, envoy_stats_bind_addr, and ListenerPort from Expose config from inbound traffic redirection rules if proxy-id flag is provided to the consul connect redirect-traffic command. [GH-10134]
  • cli: snapshot inspect command provides KV usage breakdown [GH-9098]
  • cli: snapshot inspect command supports JSON output [GH-9006]
  • connect: Add local_request_timeout_ms to allow configuring the Envoy request timeout on local_app [GH-9554]
  • connect: add support for unix domain sockets addresses for service upstreams and downstreams [GH-9981]
  • connect: add toggle to globally disable wildcard outbound network access when transparent proxy is enabled [GH-9973]
  • connect: generate upstream service labels for terminating gateway listener stats. [GH-10404]
  • sdk: Add new iptables package for applying traffic redirection rules with iptables. [GH-9910]
  • sdk: Allow excluding inbound and outbound ports, outbound CIDRs, and additional user IDs from traffic redirection in the iptables package. [GH-10134]
  • ui: Add Unix Domain Socket support [GH-10287]
  • ui: Create a collapsible notices component for the Topology tab [GH-10270]
  • ui: Read-only ACL Auth Methods view [GH-9617]
  • ui: Transparent Proxy - Service mesh visualization updates [GH-10002]
  • xds: emit a labeled gauge of connected xDS streams by version [GH-10243]
  • xds: exclusively support the Incremental xDS protocol when using xDS v3 [GH-9855]

IMPROVEMENTS:

  • acl: extend the auth-methods list endpoint to include MaxTokenTTL and TokenLocality fields. [GH-9741]
  • acl: use the presence of a management policy in the state store as a sign that we already migrated to v2 acls [GH-9505]
  • agent: Save exposed Envoy ports to the agent's state when Expose.Checks is true in proxy's configuration. [GH-10173]
  • api: Add ExposedPort to the health check API resource. [GH-10173]
  • api: Enable setting query options on agent endpoints. [GH-9903]
  • api: The Content-Type header is now always set when a body is present in a request. [GH-10204]
  • cli: snapshot inspect command can now inspect raw snapshots from a server's data dir. [GH-10089]
  • cli: the consul connect envoy --envoy_statsd_url flag will now resolve the $HOST_IP environment variable, as part of a full url. [GH-8564]
  • command: Exclude exposed Envoy ports from traffic redirection when providing -proxy-id and Expose.Checks is set. [GH-10173]
  • connect: Add support for transparently proxying traffic through Envoy. [experimental] [GH-9894]
  • connect: Allow per-upstream configuration to be set in service-defaults. [experimental] [GH-9872]
  • connect: Ensures passthrough tproxy cluster is created even when mesh config doesn't exist. [GH-10301]
  • connect: Support dialing individual service IP addresses through transparent proxies. [GH-10329]
  • connect: The builtin connect proxy no longer advertises support for h2 via ALPN. [GH-4466]. [GH-9920]
  • connect: Update the service mesh visualization to account for transparent proxies. [GH-10016]
  • connect: adds new flags prometheus-backend-port and prometheus-scrape-port to consul connect envoy to support envoy_prometheus_bind_addr pointing to the merged metrics port when using Consul Connect on K8s. [GH-9768]
  • connect: allow exposing duplicate HTTP paths through a proxy instance. [GH-10394]
  • connect: rename cluster config entry to mesh. [GH-10127]
  • connect: restrict transparent proxy mode to only match on the tagged virtual IP address. [GH-10162]
  • connect: update supported envoy versions to 1.18.2, 1.17.2, 1.16.3, 1.15.4 [GH-10101]
  • connect: update supported envoy versions to 1.18.3, 1.17.3, 1.16.4, and 1.15.5 [GH-10231]
  • debug: capture a single stream of logs, and single pprof profile and trace for the whole duration [GH-10279]
  • grpc: move gRPC INFO logs to be emitted as TRACE logs from Consul [GH-10395]
  • licensing: (Enterprise Only) Consul Enterprise has gained the consul license inspect CLI command for inspecting a license without applying it..
  • licensing: (Enterprise Only) Consul Enterprise has gained the ability to autoload a license via configuration. This can be specified with the license_path configuration, the CONSUL_LICENSE environment variable or the CONSUL_LICENSE_PATH environment variable [GH-10210]
  • licensing: (Enterprise Only) Consul Enterprise has gained the ability update its license via a configuration reload. The same environment variables and configurations will be used to determine the new license. [GH-10267]
  • monitoring: optimize the monitoring endpoint to avoid losing logs when under high load. [GH-10368]
  • raft: allow reloading of raft trailing logs and snapshot timing to allow recovery from some replication failure modes. telemetry: add metrics and documentation for monitoring for replication issues. [GH-10129]
  • streaming: change use_streaming_backend to default to true so that streaming is used by default when it is supported. [GH-10149]
  • ui: Add 'optional route segments' and move namespaces to use them [GH-10212]
  • ui: Adding a notice about how TransparentProxy mode affects the Upstreams list at the top of tab view [GH-10136]
  • ui: Improve loader centering with new side navigation [GH-10181]
  • ui: Move to a sidebar based main navigation [GH-9553]
  • ui: Show a message to explain that health checks may be out of date if the serf health check is in a critical state [GH-10194]
  • ui: Updating the wording for the banner and the popover for a service with an upstream that is not explicitly defined. [GH-10133]
  • ui: Use older (~2016) native ES6 features to reduce transpilation and UI JS payload [GH-9729]
  • ui: add permanently visible indicator when ACLs are disabled [GH-9864]
  • ui: improve accessibility of modal dialogs [GH-9819]
  • ui: restrict the viewing/editing of certain UI elements based on the users ACL token [GH-9687]
  • ui: updates the ui with the new consul brand assets [GH-10081]
  • xds: add support for envoy 1.17.0 [GH-9658]
  • xds: default to speaking xDS v3, but allow for v2 to be spoken upon request [GH-9658]
  • xds: ensure that all envoyproxy/go-control-plane protobuf symbols are linked into the final binary [GH-10131]
  • xds: remove deprecated usages of xDS and drop support for envoy 1.13.x [GH-9602]

BUG FIXES:

  • checks: add TLSServerName field to allow setting the TLS server name for HTTPS health checks. [GH-9475]
  • config: Fixed a bug where rpc_max_conns_per_client could not be changed by reloading the config. [GH-8696]
  • connect: Fix bug that prevented transparent proxies from working when mesh config restricted routing to catalog destinations. [GH-10365]
  • memberlist: fixes a couple bugs which allowed malformed input to cause a crash in a Consul client or server. [GH-10161]
  • monitor: fix monitor to produce json format logs when requested [GH-10358]
  • proxycfg: Ensure that endpoints for explicit upstreams in other datacenters are watched in transparent mode. [GH-10391]
  • proxycfg: avoid panic when transparent proxy upstream is added and then removed. [GH-10423]
  • streaming: fixes a bug that would cause context cancellation errors when a cache entry expired while requests were active. [GH-10112]
  • streaming: lookup in health properly handle case-sensitivity and perform filtering based on tags and node-meta [GH-9703]
  • telemetry: fixes a bug with Prometheus metrics where Gauges and Summaries were incorrectly being expired. [GH-10161]
  • ui: Adding conditional to prevent Service Mesh from breaking when there are no Upstreams [GH-10122]
  • ui: Fix text searching through upstream instances. [GH-10151]
  • ui: Update conditional for topology empty state [GH-10124]
  • ui: ensure proxy instance API requests perform blocking queries correctly [GH-10039]
  • xds: (beta-only) ensure that dependent xDS resources are reconfigured during primary type warming [GH-10381]

NOTES:

  • legal: (Enterprise only) Enterprise binary downloads will now include a copy of the EULA and Terms of Evaluation in the zip archive

1.9.17 (April 13, 2022)

SECURITY:

  • agent: Added a new check field, disable_redirects, that allows for disabling the following of redirects for HTTP checks. The intention is to default this to true in a future release so that redirects must explicitly be enabled. [GH-12685]
  • connect: Properly set SNI when configured for services behind a terminating gateway. [GH-12672]

DEPRECATIONS:

  • tls: With the upgrade to Go 1.17, the ordering of tls_cipher_suites will no longer be honored, and tls_prefer_server_cipher_suites is now ignored. [GH-12767]

BUG FIXES:

  • connect/ca: cancel old Vault renewal on CA configuration. Provide a 1 - 6 second backoff on repeated token renewal requests to prevent overwhelming Vault. [GH-12607]
  • memberlist: fixes a bug which prevented members from joining a cluster with large amounts of churn [GH-253] [GH-12046]
  • replication: Fixed a bug which could prevent ACL replication from continuing successfully after a leader election. [GH-12565]

1.9.16 (February 28, 2022)

FEATURES:

  • ca: support using an external root CA with the vault CA provider [GH-11910]

IMPROVEMENTS:

  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids
  • server: conditionally avoid writing a config entry to raft if it was already the same [GH-12321]

BUG FIXES:

  • agent: Parse datacenter from Create/Delete requests for AuthMethods and BindingRules. [GH-12370]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • server: (Enterprise only) Namespace deletion will now attempt to delete as many namespaced config entries as possible instead of halting on the first deletion that failed.
  • server: partly fix config entry replication issue that prevents replication in some circumstances [GH-12307]
  • ui: Ensure we always display the Policy default preview in the Namespace editing form [GH-12316]

1.9.15 (February 11, 2022)

IMPROVEMENTS:

  • sentinel: (Enterprise Only) Sentinel now uses SHA256 to generate policy ids

BUG FIXES:

  • Fix a data race when a service is added while the agent is shutting down.. [GH-12302]
  • areas: (Enterprise Only) Fixes a bug when using Yamux pool ( for servers version 1.7.3 and later), the entire pool was locked while connecting to a remote location, which could potentially take a long time. [GH-1368]
  • config-entry: fix a panic when creating an ingress gateway config-entry and a proxy service instance, where both provided the same upstream and downstream mapping. [GH-12277]
  • config: include all config errors in the error message, previously some could be hidden. [GH-11918]
  • snapshot: the snapshot save command now saves the snapshot with read permission for only the current user. [GH-11918]

1.9.14 (January 12, 2022)

SECURITY:

  • namespaces: (Enterprise only) Creating or editing namespaces that include default ACL policies or ACL roles now requires acl:write permission in the default namespace. This change fixes CVE-2021-41805.

BUG FIXES:

  • ca: fixes a bug that caused non blocking leaf cert queries to return the same cached response regardless of ca rotation or leaf cert expiry [GH-11693]
  • ca: fixes a bug that caused the intermediate cert used to sign leaf certs to be missing from the /connect/ca/roots API response when the Vault provider was used. [GH-11671]
  • cli: Display assigned node identities in output of consul acl token list. [GH-11926]
  • cli: when creating a private key, save the file with mode 0600 so that only the user has read permission. [GH-11781]
  • snapshot: (Enterprise only) fixed a bug where the snapshot agent would ignore the license_path setting in config files
  • ui: Differentiate between Service Meta and Node Meta when choosing search fields in Service Instance listings [GH-11774]
  • ui: Fixes an issue where under some circumstances after logging we present the data loaded previous to you logging in. [GH-11681]
  • ui: Fixes an issue where under some circumstances the namespace selector could become 'stuck' on the default namespace [GH-11830]
  • ui: Include Service.Namespace into available variables for dashboard_url_templates [GH-11640]
  • ui: Prevent disconnection notice appearing with auth change on certain pages [GH-11905]
  • xds: fix a deadlock when the snapshot channel already have a snapshot to be consumed. [GH-11924]

1.9.13 (December 15, 2021)

SECURITY:

1.9.12 (December 13, 2021)

SECURITY:

1.9.11 (November 11, 2021)

SECURITY:

  • agent: Use SHA256 instead of MD5 to generate persistence file names. [GH-11491]
  • namespaces: (Enterprise only) Creating or editing namespaces that include default ACL policies or ACL roles now requires acl:write permission in the default namespace. This change fixes CVE-2021-41805.

IMPROVEMENTS:

  • ci: Artifact builds will now only run on merges to the release branches or to main [GH-11417]
  • ci: The Linux packages are now available for all supported Linux architectures including arm, arm64, 386, and amd64 [GH-11417]
  • ci: The Linux packaging service configs and pre/post install scripts are now available under [.release/linux] [GH-11417]
  • telemetry: Add new metrics for the count of connect service instances and configuration entries. [GH-11222]

BUG FIXES:

  • acl: fixes the fallback behaviour of down_policy with setting extend-cache/async-cache when the token is not cached. [GH-11136]
  • rpc: only attempt to authorize the DNSName in the client cert when verify_incoming_rpc=true [GH-11255]
  • server: (Enterprise only) Ensure that servers leave network segments when leaving other gossip pools
  • ui: Fixed styling of Role remove dialog on the Token edit page [GH-11298]
  • xds: fixes a bug where replacing a mesh gateway node used for WAN federation (with another that has a different IP) could leave gateways in the other DC unable to re-establish the connection [GH-11522]

1.9.10 (September 27, 2021)

FEATURES:

  • sso/oidc: (Enterprise only) Add support for providing acr_values in OIDC auth flow [GH-11026]

IMPROVEMENTS:

  • audit-logging: (Enterprise Only) Audit logs will now include select HTTP headers in each logs payload. Those headers are: Forwarded, Via, X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Proto. [GH-11107]
  • connect: update supported envoy versions to 1.16.5 [GH-10961]
  • telemetry: Add new metrics for the count of KV entries in the Consul store. [GH-11090]

BUG FIXES:

  • tls: consider presented intermediates during server connection tls handshake. [GH-10964]
  • ui: (Enterprise Only) Fix saving intentions with namespaced source/destination [GH-11095]

1.9.9 (August 27, 2021)

KNOWN ISSUES:

  • tls: The fix for CVE-2021-37219 introduced an issue that could prevent TLS certificate validation when intermediate CA certificates used to sign server certificates are transmitted in the TLS session but are not present in all Consul server's configured CA certificates. This has the effect of preventing Raft RPCs between the affected servers. As a work around until the next patch releases, ensure that all intermediate CA certificates are present in all Consul server configurations prior to using certificates that they have signed.

SECURITY:

IMPROVEMENTS:

  • areas: (Enterprise only) Add 15s timeout to opening streams over pooled connections.
  • areas: (Enterprise only) Apply backpressure to area gossip packet ingestion when more than 512 packets are waiting to be ingested.
  • areas: (Enterprise only) Make implementation of WriteToAddress non-blocking to avoid slowing down memberlist's packetListen routine.
  • deps: update to gogo/protobuf v1.3.2 [GH-10813]

BUG FIXES:

  • acl: fixes a bug that prevented the default user token from being used to authorize service registration for connect proxies. [GH-10824]
  • ca: fixed a bug when ca provider fail and provider state is stuck in INITIALIZING state. [GH-10630]
  • ca: report an error when setting the ca config fail because of an index check. [GH-10657]
  • cli: Ensure the metrics endpoint is accessible when Envoy is configured to use a non-default admin bind address. [GH-10757]
  • cli: Fix a bug which prevented initializing a watch when using a namespaced token. [GH-10795]
  • connect: proxy upstreams inherit namespace from service if none are defined. [GH-10688]
  • dns: fixes a bug with edns truncation where the response could exceed the size limit in some cases. [GH-10009]
  • txn: fixes Txn.Apply to properly authorize service registrations. [GH-10798]
  • ui: Fix dropdown option duplication in the new intentions form [GH-10706]
  • ui: Hide all metrics for ingress gateway services [GH-10858]
  • ui: Properly encode non-URL safe characters in OIDC responses [GH-10901]
  • ui: fixes a bug with some service failovers not showing the routing tab visualization [GH-10913]

1.9.8 (July 15, 2021)

SECURITY:

BUG FIXES:

  • ca: Fixed a bug that returned a malformed certificate chain when the certificate did not having a trailing newline. [GH-10411]
  • ui: Send service name down to Stats to properly call endpoint for Upstreams and Downstreams metrics [GH-10535]

1.9.7 (June 21, 2021)

IMPROVEMENTS:

  • debug: capture a single stream of logs, and single pprof profile and trace for the whole duration [GH-10279]
  • licensing: (Enterprise Only) In order to have forward compatibility with Consul Enterprise v1.10, the ability to parse licenses from the configuration or environment has been added. This can be specified with the license_path configuration, the CONSUL_LICENSE environment variable or the CONSUL_LICENSE_PATH environment variable. On server agents this configuration will be ignored. Client agents and the snapshot agent will use the configured license instead of automatically retrieving one. [GH-10441]
  • monitoring: optimize the monitoring endpoint to avoid losing logs when under high load. [GH-10368]

BUG FIXES:

  • license: (Enterprise only) Fixed an issue that would cause client agents on versions before 1.10 to not be able to retrieve the license from a 1.10+ server. [GH-10432]
  • monitor: fix monitor to produce json format logs when requested [GH-10358]

1.9.6 (June 04, 2021)

IMPROVEMENTS:

  • acl: Give more descriptive error if auth method not found. [GH-10163]
  • areas: (Enterprise only) Use server agent's gossip_wan config when setting memberlist configuration for network areas. Previously they used memberlists WAN defaults.
  • cli: added a -force-without-cross-signing flag to the ca set-config command. connect/ca: The ForceWithoutCrossSigning field will now work as expected for CA providers that support cross signing. [GH-9672]
  • connect: update supported envoy versions to 1.16.3, 1.15.4, 1.14.7, 1.13.7 [GH-10105]
  • connect: update supported envoy versions to 1.16.4, 1.15.5, 1.14.6, and 1.13.7 [GH-10232]
  • telemetry: Add new metrics for status of secondary datacenter replication. [GH-10073]
  • telemetry: The usage data in the metrics API now includes cluster member counts, reporting clients on a per segment basis. [GH-10340]
  • ui: Added CRD popover 'informed action' for intentions managed by CRDs [GH-10100]
  • ui: Added humanized formatting to lock session durations [GH-10062]
  • ui: Only show a partial list of intention permissions, with the option to show all [GH-10174]
  • ui: updates the ui with the new consul brand assets [GH-10090]

BUG FIXES:

  • agent: ensure we hash the non-deprecated upstream fields on ServiceConfigRequest [GH-10240]
  • agent: fix logging output by removing leading whitespace from every log line [GH-10338]
  • api: include the default value of raft settings in the output of /v1/agent/self [GH-8812]
  • areas: (Enterprise only) Revert to the 10s dial timeout used before connection pooling was introduced in 1.7.3.
  • areas: (Enterprise only) Selectively merge gossip_wan config for network areas to avoid attempting to enable gossip encryption where it was not intended or necessary.
  • autopilot: (Enterprise only) Fixed an issue where autopilot could cause a new leader to demote the wrong voter when redundancy zones are in use and the previous leader failed. [GH-10306]
  • cli: removes the need to set debug_enabled=true to collect debug data from the CLI. Now the CLI behaves the same way as the API and accepts either an ACL token with operator:read, or debug_enabled=true. [GH-10273]
  • cli: snapshot inspect command would panic on invalid input. [GH-10091]
  • envoy: fixes a bug where a large envoy config could cause the consul connect envoy command to deadlock when attempting to start envoy. [GH-10324]
  • http: fix a bug that caused the X-Consul-Effective-Consistency header to be missing on request for service health [GH-10189]
  • local: agents will no longer persist the default user token along with a service or check. [GH-10188]
  • namespaces: (Enterprise only) fixes a problem where the logs would contain many warnings about namespaces not being licensed.
  • server: ensure that central service config flattening properly resets the state each time [GH-10239]
  • ui: Add conditionals to lock sessions tab [GH-10121]
  • ui: De-duplicate tags in rendered tag listings [GH-10186]
  • ui: Don't render a DOM element for empty namespace descriptions [GH-10157]
  • ui: Reflect the change of Session API response shape for Checks in post 1.7 Consul [GH-10225]
  • ui: Removes the extra rendering of namespace in service upstream list [GH-10152]

1.9.5 (April 15, 2021)

SECURITY:

  • Add content-type headers to raw KV responses to prevent XSS attacks CVE-2020-25864 [GH-10023]
  • audit-logging: Parse endpoint URL to prevent requests from bypassing the audit log CVE-2021-28156

IMPROVEMENTS:

  • api: AutopilotServerHelath now handles the 429 status code returned by the v1/operator/autopilot/health endpoint and still returned the parsed reply which will indicate server healthiness [GH-8599]
  • client: when a client agent is attempting to dereigster a service, anddoes not have access to the ACL token used to register a service, attempt to use the agent token instead of the default user token. If no agent token is set, fall back to the default user token. [GH-9683]
  • connect: Automatically rewrite the Host header for Terminating Gateway HTTP services [GH-9042]
  • ui: support stricter content security policies [GH-9847]

BUG FIXES:

  • api: ensure v1/health/ingress/:service endpoint works properly when streaming is enabled [GH-9967]
  • areas: Fixes a bug which would prevent newer servers in a network areas from connecting to servers running a version of Consul prior to 1.7.3.
  • audit-logging: (Enterprise only) Fixed an issue that resulted in usage of the agent master token or managed service provider tokens from being resolved properly. [GH-10013]
  • cache: fix a bug in the client agent cache where streaming could potentially leak resources. [GH-9978]. [GH-9978]
  • cache: fix a bug in the client agent cache where streaming would disconnect every 20 minutes and cause delivery delays. [GH-9979]. [GH-9979]
  • command: when generating envoy bootstrap configs to stdout do not mix informational logs into the json [GH-9980]
  • config: correct config key from advertise_addr_ipv6 to advertise_addr_wan_ipv6 [GH-9851]
  • http: fix a bug in Consul Enterprise that would cause the UI to believe namespaces were supported, resulting in warning logs and incorrect UI behaviour. [GH-9923]
  • snapshot: fixes a bug that would cause snapshots to be missing all but the first ACL Auth Method. [GH-10025]
  • ui: Fix intention form cancel button [GH-9901]

1.9.4 (March 04, 2021)

IMPROVEMENTS:

  • connect: if the token given to the vault provider returns no data avoid a panic [GH-9806]
  • connect: update supported envoy point releases to 1.16.2, 1.15.3, 1.14.6, 1.13.7 [GH-9737]
  • xds: only try to create an ipv6 expose checks listener if ipv6 is supported by the kernel [GH-9765]

BUG FIXES:

  • api: Remove trailing periods from the gateway internal HTTP API endpoint [GH-9752]
  • cache: Prevent spamming the logs for days when a cached request encounters an "ACL not found" error. [GH-9738]
  • connect: connect CA Roots in the primary datacenter should use a SigningKeyID derived from their local intermediate [GH-9428]
  • proxycfg: avoid potential deadlock in delivering proxy snapshot to watchers. [GH-9689]
  • replication: Correctly log all replication warnings that should not be suppressed [GH-9320]
  • streaming: fixes a bug caused by caching an incorrect snapshot, that would cause clients to error until the cache expired. [GH-9772]
  • ui: Exclude proxies when showing the total number of instances on a node. [GH-9749]
  • ui: Fixed a bug in older browsers relating to String.replaceAll and fieldset w/flexbox usage [GH-9715]
  • xds: deduplicate mesh gateway listeners by address in a stable way to prevent some LDS churn [GH-9650]
  • xds: prevent LDS flaps in mesh gateways due to unstable datacenter lists; also prevent some flaps in terminating gateways as well [GH-9651]

1.9.3 (February 01, 2021)

FEATURES:

  • ui: Add additional search/filter status pills for viewing and removing current filters in listing views [GH-9442]

IMPROVEMENTS:

  • cli: Add new -cluster-id and common-name to consul tls ca create to support creating a CA for Consul Connect. [GH-9585]
  • license: (Enterprise only) Temporary client license duration was increased from 30m to 6h.
  • server: (Enterprise Only) Validate source namespaces in service-intentions config entries. [GH-9527]
  • server: use the presence of stored federation state data as a sign that we already activated the federation state feature flag [GH-9519]

BUG FIXES:

  • autopilot: Fixed a bug that would cause snapshot restoration to stop autopilot on the leader. [GH-9626]
  • server: When wan federating via mesh gateways after initial federation default to using the local mesh gateways unless the heuristic indicates a bypass is required. [GH-9528]
  • server: When wan federating via mesh gateways only do heuristic primary DC bypass on the leader. [GH-9366]
  • ui: Fixed a bug that would cause missing or duplicate service instance healthcheck listings. [GH-9660]

1.9.2 (January 20, 2021)

FEATURES:

  • agent: add config flag MaxHeaderBytes to control the maximum size of the http header per client request. [GH-9067]
  • cli: The consul intention command now has a new list subcommand to allow the listing of configured intentions. It also supports the -namespace= option. [GH-9468]

IMPROVEMENTS:

  • server: deletions of intentions by name using the intention API is now idempotent [GH-9278]
  • streaming: display a warning on agent(s) when incompatible streaming parameters are used [GH-9530]
  • ui: Various accessibility scan test improvements [GH-9485]

DEPRECATIONS:

  • api: the tag, node-meta, and passing query parameters for various health and catalog endpoints are now deprecated. The filter query parameter should be used as a replacement for all of the deprecated fields. The deprecated query parameters will be removed in a future version of Consul. [GH-9262]

BUG FIXES:

  • client: Help added in Prometheus in relases 1.9.0 does not generate warnings anymore in logs [GH-9510]
  • client: properly set GRPC over RPC magic numbers when encryption was not set or partially set in the cluster with streaming enabled [GH-9512]
  • connect: Fixed a bug in the AWS PCA Connect CA provider that could cause the intermediate PKI path to be deleted after reconfiguring the CA [GH-9498]
  • connect: Fixed a bug in the Vault Connect CA provider that could cause the intermediate PKI path to be deleted after reconfiguring the CA [GH-9498]
  • connect: Fixed an issue that would prevent updating the Connect CA configuration if the CA provider didn't complete initialization previously. [GH-9498]
  • leader: Fixed a bug that could cause Connect CA initialization failures from allowing leader establishment to complete resulting in potentially infinite leader elections. [GH-9498]
  • rpc: Prevent misleading RPC error claiming the lack of a leader when Raft is ok but there are issues with client agents gossiping with the leader. [GH-9487]
  • server: Fixes a server panic introduced in 1.9.0 where Connect service mesh is being used. Node de-registration could panic if it hosted services with multiple upstreams. [GH-9589]
  • state: fix computation of usage metrics to account for various places that can modify multiple services in a single transaction. [GH-9440]
  • ui: Display LockDelay in nanoseconds as a temporary fix to the formatting [GH-9594]
  • ui: Fix an issue where registering an ingress-gateway with no central config would result in a JS error due to the API reponse returning null [GH-9593]
  • ui: Fixes an issue where clicking backwards and forwards between a service instance can result in a 404 error [GH-9524]
  • ui: Fixes an issue where intention description or metadata could be overwritten if saved from the topology view. [GH-9513]
  • ui: Fixes an issue with setting -ui-content-path flag/config [GH-9569]
  • ui: ensure namespace is used for node API requests [GH-9410]
  • ui: request intention listing with ns=* parameter to retrieve all intentions across namespaces [GH-9432]

1.9.1 (December 11, 2020)

FEATURES:

  • ui: add copyable IDs to the Role and Policy views [GH-9296]

IMPROVEMENTS:

  • cli: (Enterprise only) A new -read-replica flag can now be used to enable running a server as a read only replica. Previously this was enabled with the now deprecated -non-voting-server flag. [GH-9191]
  • config: (Enterprise only) A new read_replica configuration setting can now be used to enable running a server as a read only replica. Previously this was enabled with the now deprecated non_voting_server setting. [GH-9191]

DEPRECATIONS:

  • cli: (Enterprise only) The -non-voting-server flag is deprecated in favor of the new -read-replica flag. The -non-voting-server flag is still present along side the new flag but it will be removed in a future release. [GH-9191]
  • config: (Enterprise only) The non_voting_server configuration setting is deprecated in favor of the new read_replica setting. The non_voting_server configuration setting is still present but will be removed in a future release. [GH-9191]
  • gossip: (Enterprise only) Read replicas now advertise themselves by setting the read_replica tag. The old nonvoter tag is still present but is deprecated and will be removed in a future release. [GH-9191]
  • server: (Enterprise only) Addition of the nonvoter tag to the service registration made for read replicas is deprecated in favor of the new tag name of read_replica. Both are present in the registration but the nonvoter tag will be completely removed in a future release. [GH-9191]

BUG FIXES:

  • agent: prevent duplicate services and check registrations from being synced to servers. [GH-9284]
  • connect: fixes a case when updating the CA config in a secondary datacenter to correctly trigger the creation of a new intermediate certificate [GH-9009]
  • connect: only unset the active root in a secondary datacenter when a new one is replacing it [GH-9318]
  • namespaces: (Enterprise only) Prevent stalling of replication in secondary datacenters due to conflicts between the namespace replicator and other replicators. [GH-9271]
  • streaming: ensure the order of results provided by /health/service/:serviceName is consistent with and without streaming enabled [GH-9247]

1.9.0 (November 24, 2020)

BREAKING CHANGES:

  • agent: The enable_central_service_config option now defaults to true. [GH-8746]
  • connect: Switch the default gateway port from 443 to 8443 to avoid assumption of Envoy running as root. [GH-9113]
  • connect: Update Envoy metrics names and labels for proxy listeners so that attributes like datacenter and namespace can be extracted. [GH-9207]
  • connect: intention destinations can no longer be reassigned [GH-8834]
  • raft: Raft protocol v2 is no longer supported. If currently using protocol v2 then an intermediate upgrade to a version supporting both v2 and v3 protocols will be necessary (1.0.0 - 1.8.x). Note that the Raft protocol configured with the raft_protocol setting and the Consul RPC protocol configured with the protocol setting and output by the consul version command are distinct and supported Consul RPC protocol versions are not altered. [GH-9103]
  • sentinel: (Consul Enterprise only) update to v0.16.0, which replaces whitelist and blacklist with allowlist and denylist
  • server: (Enterprise only) Pre-existing intentions defined with non-existent destination namespaces were non-functional and are erased during the upgrade process. This should not matter as these intentions had nothing to enforce. [GH-9186]
  • server: (OSS only) Pre-existing intentions defined with either a source or destination namespace value that is not "default" are rewritten or deleted during the upgrade process. Wildcards first attempt to downgrade to "default" unless an intention already exists, otherwise these non-functional intentions are deleted. [GH-9186]
  • xds: Drop support for Envoy versions 1.12.0, 1.12.1, 1.12.2, and 1.13.0, due to a lack of support for url_path in RBAC. [GH-8839]

SECURITY:

  • Fix Consul Enterprise Namespace Config Entry Replication DoS. Previously an operator with service:write ACL permissions in a Consul Enterprise cluster could write a malicious config entry that caused infinite raft writes due to issues with the namespace replication logic. [CVE-2020-25201] [GH-9024]
  • Increase the permissions to read from the /connect/ca/configuration endpoint to operator:write. Previously Connect CA configuration, including the private key, set via this endpoint could be read back by an operator with operator:read privileges. CVE-2020-28053 [GH-9240]

FEATURES:

  • agent: Add a new RPC endpoint for streaming cluster state change events to clients.
  • agent: Allow client agents to be configured with an advertised reconnect timeout to control how long until the nodes are reaped by others in the cluster. [GH-8781]
  • agent: moved ui config options to a new ui_config stanza in agent configuration and added new options to display service metrics in the UI. [GH-8694]
  • agent: return the default ACL policy to callers as a header [GH-9101]
  • autopilot: A new /v1/operator/autopilot/state HTTP API was created to give greater visibility into what autopilot is doing and how it has classified all the servers it is tracking. [GH-9103]
  • autopilot: Added a new consul operator autopilot state command to retrieve and view the Autopilot state from consul. [GH-9142]
  • cli: update snapshot inspect command to provide more detailed snapshot data [GH-8787]
  • connect: support defining intentions using layer 7 criteria [GH-8839]
  • telemetry: add initialization and definition for non-expiring key metrics in Prometheus [GH-9088]
  • telemetry: track node and service counts and emit them as metrics [GH-8603]
  • ui: If Prometheus is being used for monitoring the sidecars, the topology view can be configured to display overview metrics for the services. [GH-8858]
  • ui: Services using Connect with Envoy sidecars have a topology tab in the UI showing their upstream and downstream services. [GH-8788]
  • xds: use envoy's rbac filter to handle intentions entirely within envoy [GH-8569]

IMPROVEMENTS:

  • agent: Return HTTP 429 when connections per clients limit (limits.http_max_conns_per_client) has been reached. [GH-8221]
  • agent: add path_allowlist config option to restrict metrics proxy queries [GH-9059]
  • agent: allow the /v1/connect/intentions/match endpoint to use the agent cache [GH-8875]
  • agent: protect the metrics proxy behind ACLs [GH-9099]
  • api: The v1/connect/ca/roots endpoint now accepts a pem=true query parameter and will return a PEM encoded certificate chain of all the certificates that would normally be in the JSON version of the response. [GH-8774]
  • api: support GetMeta() and GetNamespace() on all config entry kinds [GH-8764]
  • autopilot: (Enterprise Only) Autopilot now supports using both Redundancy Zones and Automated Upgrades together. [GH-9103]
  • checks: add health status to the failure message when gRPC healthchecks fail. [GH-8726]
  • chore: Update to Go 1.15 with mitigation for golang/go#42138 [GH-9036]
  • command: remove conditional envoy bootstrap generation for versions <=1.10.0 since those are not supported [GH-8855]
  • connect: The Vault provider will now automatically renew the lease of the token used, if supported. [GH-8560]
  • connect: add support for specifying load balancing policy in service-resolver [GH-8585]
  • connect: intentions are now managed as a new config entry kind "service-intentions" [GH-8834]
  • raft: Update raft to v1.2.0 to prevent non-voters from becoming eligible for leader elections and adding peer id as metric label to reduce cardinality in metric names [GH-8822]
  • server: (Consul Enterprise only) ensure that we also shutdown network segment serf instances on server shutdown [GH-8786]
  • server: break up Intention.Apply monolithic method [GH-9007]
  • server: create new memdb table for storing system metadata [GH-8703]
  • server: make sure that the various replication loggers use consistent logging [GH-8745]
  • server: remove config entry CAS in legacy intention API bridge code [GH-9151]
  • snapshot agent: Deregister critical snapshotting TTL check if leadership is transferred.
  • telemetry: All metrics should be present and available to prometheus scrapers when Consul starts. If any non-deprecated metrics are missing please submit an issue with its name. [GH-9198]
  • telemetry: add config flag telemetry { disable_compat_1.9 = (true|false) } to disable deprecated metrics in 1.9 [GH-8877]
  • telemetry: add counter consul.api.http with labels for each HTTP path and method. This is intended to replace consul.http... [GH-8877]
  • ui: Add the Upstreams and Exposed Paths tabs for services in mesh [GH-9141]
  • ui: Moves the Proxy health checks to be displayed with the Service health check under the Health Checks tab [GH-9141]
  • ui: Upstream and downstream services in the topology tab will show a visual indication if a deny intention or intention with L7 policies is configured. [GH-8846]
  • ui: add dashboard_url_template config option for external dashboard links [GH-9002]

DEPRECATIONS:

  • Go 1.15 has dropped support for 32-bit binaries for Darwin, so darwin_386 builds will not be available for any 1.9.x+ releases. [GH-9036]
  • agent: ui, ui_dir and ui_content_path are now deprecated for use in agent configuration files. Use ui_config.{enabled, dir, content_path} instead. The command arguments -ui, -ui-dir, and -ui-content-path remain supported. [GH-8694]
  • telemetry: The measurements in all of the consul.http... prefixed metrics have been migrated to consul.api.http. consul.http... prefixed metrics will be removed in a future version of Consul. [GH-8877]
  • telemetry: the disable_compat_1.9 config will cover more metrics deprecations in future 1.9 point releases. These metrics will be emitted twice for backwards compatibility - if the flag is true, only the new metric name will be written. [GH-9181]

BUG FIXES:

  • agent: make the json/hcl decoding of ConnectProxyConfig fully work with CamelCase and snake_case [GH-8741]
  • agent: when enable_central_service_config is enabled ensure agent reload doesn't revert check state to critical [GH-8747]
  • api: Fixed a bug where the Check.GRPCUseTLS field could not be set using snake case. [GH-8771]
  • api: Fixed a bug where additional headers configured with http_config.response_headers would not be served on index and error pages [GH-8694]
  • autopilot: (Enterprise Only) Previously servers in other zones would not be promoted when all servers in a second zone had failed. Now the actual behavior matches the docs and autopilot will promote a healthy non-voter from any zone to replace failure of an entire zone. [GH-9103]
  • autopilot: Prevent panic when requesting the autopilot health immediately after a leader is elected. [GH-9204]
  • command: when generating envoy bootstrap configs use the datacenter returned from the agent services endpoint [GH-9229]
  • connect: Fixed an issue where the Vault intermediate was not renewed in the primary datacenter. [GH-8784]
  • connect: fix Vault provider not respecting IntermediateCertTTL [GH-8646]
  • connect: fix connect sidecars registered via the API not being automatically deregistered with their parent service after an agent restart by persisting the LocallyRegisteredAsSidecar property. [GH-8924]
  • connect: use stronger validation that ingress gateways have compatible protocols defined for their upstreams [GH-8470]
  • license: (Enterprise only) Fixed an issue where the UI would see Namespaces and SSO as licensed when they were not.
  • license: (Enterprise only) Fixed an issue where warnings about Namespaces being unlicensed would be emitted erroneously.
  • namespace: (Enterprise Only) Fixed a bug that could case snapshot restoration to fail when it contained a namespace marked for deletion while still containing other resources in that namespace. [GH-9156]
  • namespace: (Enterprise Only) Fixed an issue where namespaced services and checks were not being deleted when the containing namespace was deleted.
  • raft: (Enterprise only) properly update consul server meta non_voter for non-voting Enterprise Consul servers [GH-8731]
  • server: skip deleted and deleting namespaces when migrating intentions to config entries [GH-9186]
  • telemetry: fixed a bug that caused logs to be flooded with [WARN] agent.router: Non-server in server-only area [GH-8685]
  • ui: show correct datacenter for gateways [GH-8704]

1.8.19 (December 15, 2021)

SECURITY:

1.8.18 (December 13, 2021)

SECURITY:

  • ci: Upgrade to Go 1.16.12 to address CVE-2021-44716 [GH-11806]
  • namespaces: (Enterprise only) Creating or editing namespaces that include default ACL policies or ACL roles now requires acl:write permission in the default namespace. This change fixes CVE-2021-41805.

BUG FIXES:

  • snapshot: (Enterprise only) fixed a bug where the snapshot agent would ignore the license_path setting in config files
  • ui: Fixes an issue where under some circumstances after logging we present the data loaded previous to you logging in. [GH-11681]
  • ui: Include Service.Namespace into available variables for dashboard_url_templates [GH-11640]

1.8.17 (November 11, 2021)

SECURITY:

  • namespaces: (Enterprise only) Creating or editing namespaces that include default ACL policies or ACL roles now requires acl:write permission in the default namespace. This change fixes CVE-2021-41805.

IMPROVEMENTS:

  • ci: Artifact builds will now only run on merges to the release branches or to main [GH-11417]
  • ci: The Linux packages are now available for all supported Linux architectures including arm, arm64, 386, and amd64 [GH-11417]
  • ci: The Linux packaging service configs and pre/post install scripts are now available under [.release/linux] [GH-11417]

BUG FIXES:

  • acl: fixes the fallback behaviour of down_policy with setting extend-cache/async-cache when the token is not cached. [GH-11136]
  • raft: Consul leaders will attempt to transfer leadership to another server as part of gracefully leaving the cluster. [GH-11242]
  • rpc: only attempt to authorize the DNSName in the client cert when verify_incoming_rpc=true [GH-11255]
  • server: (Enterprise only) Ensure that servers leave network segments when leaving other gossip pools
  • ui: Fixed styling of Role delete confirmation button with the Token edit page [GH-11297]
  • xds: fixes a bug where replacing a mesh gateway node used for WAN federation (with another that has a different IP) could leave gateways in the other DC unable to re-establish the connection [GH-11522]

1.8.16 (September 27, 2021)

FEATURES:

  • sso/oidc: (Enterprise only) Add support for providing acr_values in OIDC auth flow [GH-11026]

IMPROVEMENTS:

  • audit-logging: (Enterprise Only) Audit logs will now include select HTTP headers in each logs payload. Those headers are: Forwarded, Via, X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Proto. [GH-11107]

BUG FIXES:

  • tls: consider presented intermediates during server connection tls handshake. [GH-10964]
  • ui: (Enterprise Only) Fixes a visual issue where namespaces would "double up" in the Source/Destination select menu when creating/editing intentions [GH-11102]

1.8.15 (August 27, 2021)

KNOWN ISSUES:

  • tls: The fix for CVE-2021-37219 introduced an issue that could prevent TLS certificate validation when intermediate CA certificates used to sign server certificates are transmitted in the TLS session but are not present in all Consul server's configured CA certificates. This has the effect of preventing Raft RPCs between the affected servers. As a work around until the next patch releases, ensure that all intermediate CA certificates are present in all Consul server configurations prior to using certificates that they have signed.

SECURITY:

IMPROVEMENTS:

  • areas: (Enterprise only) Add 15s timeout to opening streams over pooled connections.
  • areas: (Enterprise only) Apply backpressure to area gossip packet ingestion when more than 512 packets are waiting to be ingested.
  • areas: (Enterprise only) Make implementation of WriteToAddress non-blocking to avoid slowing down memberlist's packetListen routine.
  • deps: update to gogo/protobuf v1.3.2 [GH-10813]

BUG FIXES:

  • acl: fixes a bug that prevented the default user token from being used to authorize service registration for connect proxies. [GH-10824]
  • ca: fixed a bug when ca provider fail and provider state is stuck in INITIALIZING state. [GH-10630]
  • ca: report an error when setting the ca config fail because of an index check. [GH-10657]
  • cli: Ensure the metrics endpoint is accessible when Envoy is configured to use a non-default admin bind address. [GH-10757]
  • cli: Fix a bug which prevented initializing a watch when using a namespaced token. [GH-10795]
  • connect: proxy upstreams inherit namespace from service if none are defined. [GH-10688]
  • dns: fixes a bug with edns truncation where the response could exceed the size limit in some cases. [GH-10009]
  • txn: fixes Txn.Apply to properly authorize service registrations. [GH-10798]

1.8.14 (July 15, 2021)

SECURITY:

BUG FIXES:

  • ca: Fixed a bug that returned a malformed certificate chain when the certificate did not having a trailing newline. [GH-10411]

1.8.13 (June 21, 2021)

IMPROVEMENTS:

  • debug: capture a single stream of logs, and single pprof profile and trace for the whole duration [GH-10279]
  • licensing: (Enterprise Only) In order to have forward compatibility with Consul Enterprise v1.10, the ability to parse licenses from the configuration or environment has been added. This can be specified with the license_path configuration, the CONSUL_LICENSE environment variable or the CONSUL_LICENSE_PATH environment variable. On server agents this configuration will be ignored. Client agents and the snapshot agent will use the configured license instead of automatically retrieving one. [GH-10442]
  • monitoring: optimize the monitoring endpoint to avoid losing logs when under high load. [GH-10368]

BUG FIXES:

  • license: (Enterprise only) Fixed an issue that would cause client agents on versions before 1.10 to not be able to retrieve the license from a 1.10+ server. [GH-10432]
  • monitor: fix monitor to produce json format logs when requested [GH-10358]

1.8.12 (June 04, 2021)

BUG FIXES:

  • agent: fix logging output by removing leading whitespace from every log line [GH-10338]
  • cli: removes the need to set debug_enabled=true to collect debug data from the CLI. Now the CLI behaves the same way as the API and accepts either an ACL token with operator:read, or debug_enabled=true. [GH-10273]
  • envoy: fixes a bug where a large envoy config could cause the consul connect envoy command to deadlock when attempting to start envoy. [GH-10324]
  • namespaces: (Enterprise only) fixes a problem where the logs would contain many warnings about namespaces not being licensed.

1.8.11 (June 03, 2021)

IMPROVEMENTS:

  • areas: (Enterprise only) Use server agent's gossip_wan config when setting memberlist configuration for network areas. Previously they used memberlists WAN defaults.
  • cli: added a -force-without-cross-signing flag to the ca set-config command. connect/ca: The ForceWithoutCrossSigning field will now work as expected for CA providers that support cross signing. [GH-9672]
  • connect: update supported envoy versions to 1.14.7, 1.13.7, 1.12.7, 1.11.2 [GH-10106]
  • telemetry: Add new metrics for status of secondary datacenter replication. [GH-10073]

BUG FIXES:

  • agent: ensure we hash the non-deprecated upstream fields on ServiceConfigRequest [GH-10240]
  • api: include the default value of raft settings in the output of /v1/agent/self [GH-8812]
  • areas: (Enterprise only) Revert to the 10s dial timeout used before connection pooling was introduced in 1.7.3.
  • areas: (Enterprise only) Selectively merge gossip_wan config for network areas to avoid attempting to enable gossip encryption where it was not intended or necessary.
  • local: agents will no longer persist the default user token along with a service or check. [GH-10188]
  • server: ensure that central service config flattening properly resets the state each time [GH-10239]

1.8.10 (April 15, 2021)

SECURITY:

  • Add content-type headers to raw KV responses to prevent XSS attacks CVE-2020-25864 [GH-10023]
  • audit-logging: Parse endpoint URL to prevent requests from bypassing the audit log CVE-2021-28156

BUG FIXES:

  • areas: Fixes a bug which would prevent newer servers in a network areas from connecting to servers running a version of Consul prior to 1.7.3.
  • audit-logging: (Enterprise only) Fixed an issue that resulted in usage of the agent master token or managed service provider tokens from being resolved properly. [GH-10013]
  • command: when generating envoy bootstrap configs to stdout do not mix informational logs into the json [GH-9980]
  • config: correct config key from advertise_addr_ipv6 to advertise_addr_wan_ipv6 [GH-9851]
  • snapshot: fixes a bug that would cause snapshots to be missing all but the first ACL Auth Method. [GH-10025]

1.8.9 (March 04, 2021)

IMPROVEMENTS:

  • cli: Add new -cluster-id and common-name to consul tls ca create to support creating a CA for Consul Connect. [GH-9585]
  • connect: if the token given to the vault provider returns no data avoid a panic [GH-9806]
  • connect: update supported envoy point releases to 1.14.6, 1.13.7, 1.12.7, 1.11.2 [GH-9739]
  • license: (Enterprise only) Temporary client license duration was increased from 30m to 6h.
  • server: use the presense of stored federation state data as a sign that we already activated the federation state feature flag [GH-9519]
  • xds: only try to create an ipv6 expose checks listener if ipv6 is supported by the kernel [GH-9765]

BUG FIXES:

  • api: Remove trailing periods from the gateway internal HTTP API endpoint [GH-9752]
  • cache: Prevent spamming the logs for days when a cached request encounters an "ACL not found" error. [GH-9738]
  • connect: connect CA Roots in the primary datacenter should use a SigningKeyID derived from their local intermediate [GH-9428]
  • proxycfg: avoid potential deadlock in delivering proxy snapshot to watchers. [GH-9689]
  • server: When wan federating via mesh gateways after initial federation default to using the local mesh gateways unless the heuristic indicates a bypass is required. [GH-9528]
  • server: When wan federating via mesh gateways only do heuristic primary DC bypass on the leader. [GH-9366]
  • xds: deduplicate mesh gateway listeners by address in a stable way to prevent some LDS churn [GH-9650]
  • xds: prevent LDS flaps in mesh gateways due to unstable datacenter lists; also prevent some flaps in terminating gateways as well [GH-9651]

BUG FIXES:

  • connect: Fixed a bug in the AWS PCA Connect CA provider that could cause the intermediate PKI path to be deleted after reconfiguring the CA [GH-9498]
  • connect: Fixed a bug in the Vault Connect CA provider that could cause the intermediate PKI path to be deleted after reconfiguring the CA [GH-9498]
  • connect: Fixed an issue that would prevent updating the Connect CA configuration if the CA provider didn't complete initialization previously. [GH-9498]
  • leader: Fixed a bug that could cause Connect CA initialization failures from allowing leader establishment to complete resulting in potentially infinite leader elections. [GH-9498]
  • rpc: Prevent misleading RPC error claiming the lack of a leader when Raft is ok but there are issues with client agents gossiping with the leader. [GH-9487]
  • ui: ensure namespace is used for node API requests [GH-9488]

1.8.7 (December 10, 2020)

BUG FIXES:

  • acl: global tokens created by auth methods now correctly replicate to secondary datacenters [GH-9351]
  • connect: fixes a case when updating the CA config in a secondary datacenter to correctly trigger the creation of a new intermediate certificate [GH-9009]
  • connect: only unset the active root in a secondary datacenter when a new one is replacing it [GH-9318]
  • license: (Enterprise only) Fixed an issue where the UI would see Namespaces and SSO as licensed when they were not.
  • license: (Enterprise only) Fixed an issue where warnings about Namespaces being unlicensed would be emitted erroneously.
  • namespace: (Enterprise Only) Fixed a bug that could case snapshot restoration to fail when it contained a namespace marked for deletion while still containing other resources in that namespace. [GH-9156]
  • namespace: (Enterprise Only) Fixed an issue where namespaced services and checks were not being deleted when the containing namespace was deleted.
  • namespaces: (Enterprise only) Prevent stalling of replication in secondary datacenters due to conflicts between the namespace replicator and other replicators. [GH-9271]

1.8.6 (November 19, 2020)

SECURITY:

  • Increase the permissions to read from the /connect/ca/configuration endpoint to operator:write. Previously Connect CA configuration, including the private key, set via this endpoint could be read back by an operator with operator:read privileges. CVE-2020-28053 [GH-9240]

1.8.5 (October 23, 2020)

SECURITY:

  • Fix Consul Enterprise Namespace Config Entry Replication DoS. Previously an operator with service:write ACL permissions in a Consul Enterprise cluster could write a malicious config entry that caused infinite raft writes due to issues with the namespace replication logic. [CVE-2020-25201] [GH-9024]

IMPROVEMENTS:

  • api: The v1/connect/ca/roots endpoint now accepts a pem=true query parameter and will return a PEM encoded certificate chain of all the certificates that would normally be in the JSON version of the response. [GH-8774]
  • connect: The Vault provider will now automatically renew the lease of the token used, if supported. [GH-8560]
  • connect: update supported envoy releases to 1.14.5, 1.13.6, 1.12.7, 1.11.2 for 1.8.x [GH-8999]

BUG FIXES:

  • agent: when enable_central_service_config is enabled ensure agent reload doesn't revert check state to critical [GH-8747]
  • connect: Fixed an issue where the Vault intermediate was not renewed in the primary datacenter. [GH-8784]
  • connect: fix Vault provider not respecting IntermediateCertTTL [GH-8646]
  • connect: fix connect sidecars registered via the API not being automatically deregistered with their parent service after an agent restart by persisting the LocallyRegisteredAsSidecar property. [GH-8924]
  • fixed a bug that caused logs to be flooded with [WARN] agent.router: Non-server in server-only area [GH-8685]
  • ui: show correct datacenter for gateways [GH-8704]

1.8.4 (September 11, 2020)

FEATURES:

  • agent: expose the list of supported envoy versions on /v1/agent/self [GH-8545]
  • cache: Config parameters for cache throttling are now reloaded automatically on agent reload. Restarting the agent is not needed anymore. [GH-8552]
  • connect: all config entries pick up a meta field [GH-8596]

IMPROVEMENTS:

  • api: Added ACLMode method to the AgentMember type to determine what ACL mode the agent is operating in. [GH-8575]
  • api: Added IsConsulServer method to the AgentMember type to easily determine whether the agent is a server. [GH-8575]
  • api: Added constants for common tag keys and values in the Tags field of the AgentMember struct. [GH-8575]
  • api: Allow for the client to use TLS over a Unix domain socket. [GH-8602]
  • api: GET v1/operator/keyring also lists primary keys. [GH-8522]
  • connect: Add support for http2 and grpc to ingress gateways [GH-8458]
  • serf: update to v0.9.4 which supports primary keys in the ListKeys operation. [GH-8522]

BUGFIXES:

  • connect: use stronger validation that ingress gateways have compatible protocols defined for their upstreams [GH-8494]
  • agent: ensure that we normalize bootstrapped config entries [GH-8547]
  • api: Fixed a panic caused by an api request with Connect=null [GH-8537]
  • connect: connect envoy command now respects the -ca-path flag [GH-8606]
  • connect: fix bug in preventing some namespaced config entry modifications [GH-8601]
  • connect: fix renewing secondary intermediate certificates [GH-8588]
  • ui: fixed a bug related to in-folder KV creation [GH-8613]

1.8.3 (August 12, 2020)

BUGFIXES:

  • catalog: fixed a bug where nodes, services, and checks would not be restored with the correct Create/ModifyIndex when restoring from a snapshot [GH-8485]
  • vendor: update github.com/armon/go-metrics to v0.3.4 to mitigate a potential panic when emitting Prometheus metrics at an interval longer than the metric expiry time [GH-8478]
  • connect: (Consul Enterprise only) Fixed a regression that prevented mesh gateways from routing to services in their local datacenter that reside outside of the default namespace.

1.8.2 (August 07, 2020)

  • auto_config: Fixed an issue where auto-config could be enabled in secondary DCs without enabling token replication when ACLs were enabled. [GH-8451]
  • xds: revert setting set_node_on_first_message_only to true when generating envoy bootstrap config [GH-8440]

1.8.1 (July 30, 2020)

FEATURES:

IMPROVEMENTS:

  • acl: allow auth methods created in the primary datacenter to optionally create global tokens [GH-7899]
  • agent: Allow to restrict servers that can join a given Serf Consul cluster. [GH-7628]
  • agent: new configuration options allow ratelimiting of the agent-cache: cache.entry_fetch_rate and cache.entry_fetch_max_burst. [GH-8226]
  • api: Added methods to allow passing query options to leader and peers endpoints to mirror HTTP API [GH-8395]
  • auto_config: when configuring auto_config, connect is turned on automatically [GH-8433]
  • connect: various changes to make namespaces for intentions work more like for other subsystems [GH-8194]
  • connect: Append port number to expected ingress hosts [GH-8190]
  • connect: add support for envoy 1.15.0 and drop support for 1.11.x [GH-8424]
  • connect: support Envoy v1.14.4, v1.13.4, v1.12.6 [GH-8216]
  • dns: Improve RCODE of response when query targets a non-existent datacenter. [GH-8102],[GH-8218]
  • version: The version CLI subcommand was altered to always show the git revision the binary was built from on the second line of output. Additionally the command gained a -format flag with the option now of outputting the version information in JSON form. NOTE This change has the potential to break any parsing done by users of the version commands output. In many cases nothing will need to be done but it is possible depending on how the output is parsed. [GH-8268]

BUGFIXES:

  • agent: Fixed a bug where Consul could crash when verify_outgoing was set to true but no client certificate was used. [GH-8211]
  • agent: Fixed an issue with lock contention during RPCs when under load while using the Prometheus metrics sink. [GH-8372]
  • auto_encrypt: Fixed an issue where auto encrypt certificate signing wasn't using the connect signing rate limiter. [GH-8211]
  • auto_encrypt: Fixed several issues around retrieving the first TLS certificate where it would have the wrong CN and SANs. This was being masked by a second bug (also fixed) causing that certificate to immediately be discarded with a second certificate request being made afterwards. [GH-8211]
  • auto_encrypt: Fixed an issue that caused auto encrypt certificates to not be updated properly if the agents token was changed and the old token was deleted. [GH-8311]
  • autopilot: (Consul Enterprise only) Fixed an issue where using autopilot with redundancy zones wouldn't demote extra voters in a zone to match the "one voter per zone" desired state when rebalancing.
  • connect: fix crash that would result if a mesh or terminating gateway's upstream has a hostname as an address and no healthy service instances available. [GH-8158]
  • connect: Fixed issue where specifying a prometheus bind address would cause ingress gateways to fail to start up [GH-8371]
  • gossip: Avoid issue where two unique leave events for the same node could lead to infinite rebroadcast storms [GH-8343]
  • router: Mark its own cluster as healthy when rebalancing. [GH-8406]
  • snapshot: (Consul Enterprise only) Fixed a regression when using Azure blob storage.
  • xds: version sniff envoy and switch regular expressions from 'regex' to 'safe_regex' on newer envoy versions [GH-8222]

1.8.0 (June 18, 2020)

BREAKING CHANGES:

  • acl: Remove deprecated acl_enforce_version_8 option [GH-7991]

FEATURES:

  • Terminating Gateway: Envoy can now be run as a gateway to enable services in a Consul service mesh to connect to external services through their local proxy. Terminating gateways unlock several of the benefits of a service mesh in the cases where a sidecar proxy cannot be deployed alongside services such as legacy applications or managed cloud databases.

  • Ingress Gateway: Envoy can now be run as a gateway to ingress traffic into the Consul service mesh, enabling a more incremental transition for applications.

  • WAN Federation over Mesh Gateways: Allows Consul datacenters to federate by forwarding WAN gossip and RPC traffic through Mesh Gateways rather than requiring the servers to be exposed to the WAN directly.

  • JSON Web Token (JWT) Auth Method: Allows exchanging a signed JWT from a trusted external identity provider for a Consul ACL token.

  • Single Sign-On (SSO) [Enterprise]: Lets an operator configure Consul to use an external OpenID Connect (OIDC) provider to automatically handle the lifecycle of creating, distributing and managing ACL tokens for performing CLI operations or accessing the UI.

  • Audit Logging [Enterprise]: Adds instrumentation to record a trail of events (both attempted and authorized) by users of Consul’s HTTP API for purposes of regulatory compliance.

  • acl: add DisplayName field to auth methods [GH-7769]

  • acl: add MaxTokenTTL field to auth methods [GH-7779]

  • agent/xds: add support for configuring passive health checks [GH-7713]

  • cli: Add -config flag to "acl authmethod update/create" [GH-7776]

  • serf: allow to restrict servers that can join a given Serf Consul cluster. [GH-7628]

  • ui: Help menu to provide further documentation/learn links [GH-7310]

  • ui: (Consul Enterprise only) SSO support [GH-7742] [GH-7771] [GH-7790]

  • ui: Support for termininating and ingress gateways [GH-7858] [GH-7865]

IMPROVEMENTS:

  • acl: change authmethod.Validator to take a logger [GH-7758]
  • agent: show warning when enable_script_checks is enabled without safety net [GH-7437]
  • api: Added filtering support to the v1/connect/intentions endpoint. [GH-7478]
  • auto_encrypt: add validations for auto_encrypt.{tls,allow_tls} [GH-7704]
  • build: switched to compile with Go 1.14.1 [GH-7481]
  • config: validate system limits against limits.http_max_conns_per_client [GH-7434]
  • connect: support envoy 1.12.3, 1.13.1, and 1.14.1. Envoy 1.10 is no longer officially supported. [GH-7380],[GH-7624]
  • connect: add DNSSAN and IPSAN to cache key for ConnectCALeafRequest [GH-7597]
  • connect: Added a new expose CLI command for ingress gateways [GH-8099]
  • license: (Consul Enterprise only) Update licensing to align with the current modules licensing structure.
  • logging: catch problems with the log destination earlier by creating the file immediately [GH-7469]
  • proxycfg: support path exposed with non-HTTP2 protocol [GH-7510]
  • tls: remove old ciphers [GH-7282]
  • ui: Show the last 8 characters of AccessorIDs in listing views [GH-7327]
  • ui: Make all tabs within the UI linkable/bookmarkable and include in history [GH-7592]
  • ui: Redesign of all service pages [GH-7605] [GH-7632] [GH-7655] [GH-7683]
  • ui: Show intentions per individual service [GH-7615]
  • ui: Improved login/logout flow [GH-7790]
  • ui: Revert search to search as you type, add sort control for the service listing page [GH-7489]
  • ui: Omit proxy services from the service listing view and mark services as being proxied [GH-7820]
  • ui: Display proxies in a proxy info tab with the service instance detail page [GH-7745]
  • ui: Add live updates/blocking queries to gateway listings [GH-7967]
  • ui: Improved 'empty states' [GH-7940]
  • ui: Add ability to sort services based on health [GH-7989]
  • ui: Add explanatory tooltip panels for gateway services [GH-8048]
  • ui: Reduce discovery-chain log errors [GH-8065]

BUGFIXES:

  • agent: (Consul Enterprise only) Fixed several bugs related to Network Area and Network Segment compatibility with other features caused by incorrectly doing version or serf tag checking. [GH-7491]
  • agent: rewrite checks with proxy address, not local service address [GH-7518]
  • agent: Preserve ModifyIndex for unchanged entry in KV transaciton [GH-7832]
  • agent: use default resolver scheme for gRPC dialing [GH-7617]
  • cache: Fix go routine leak in the agent cache which could cause increasing memory usage. [GH-8092]
  • cli: enable TLS when CONSUL_HTTP_ADDR has an https scheme [GH-7608]
  • connect: Internal refactoring to allow Connect proxy config to contain lists of structured configuration [GH-7963][GH-7964]
  • license: (Consul Enterprise only) Fixed a bug that would cause a license reset request to only be applied on the leader server.
  • sdk: Fix race condition in freeport [GH-7567]
  • server: strip local ACL tokens from RPCs during forwarding if crossing datacenters [GH-7419]
  • ui: Quote service names when filtering intentions to prevent 500 errors when accessing a service [GH-7896] [GH-7888]
  • ui: Miscellaneous amends for Safari and Firefox [GH-7904] [GH-7907]
  • ui: Ensure a value is always passed to CONSUL_SSO_ENABLED [GH-7913]

1.7.14 (April 15, 2021)

SECURITY:

BUG FIXES:

  • command: when generating envoy bootstrap configs to stdout do not mix informational logs into the json [GH-9980]
  • config: correct config key from advertise_addr_ipv6 to advertise_addr_wan_ipv6 [GH-9851]
  • snapshot: fixes a bug that would cause snapshots to be missing all but the first ACL Auth Method. [GH-10025]

1.7.13 (March 04, 2021)

IMPROVEMENTS:

  • connect: update supported envoy point releases to 1.13.7, 1.12.7, 1.11.2, 1.10.0 [GH-9740]
  • license: (Enterprise only) Temporary client license duration was increased from 30m to 6h.
  • xds: only try to create an ipv6 expose checks listener if ipv6 is supported by the kernel [GH-9765]

BUG FIXES:

  • cache: Prevent spamming the logs for days when a cached request encounters an "ACL not found" error. [GH-9738]
  • connect: connect CA Roots in the primary datacenter should use a SigningKeyID derived from their local intermediate [GH-9428]
  • xds: deduplicate mesh gateway listeners by address in a stable way to prevent some LDS churn [GH-9650]
  • xds: prevent LDS flaps in mesh gateways due to unstable datacenter lists; also prevent some flaps in terminating gateways as well [GH-9651]

1.7.12 (January 22, 2021)

BUG FIXES:

  • rpc: Prevent misleading RPC error claiming the lack of a leader when Raft is ok but there are issues with client agents gossiping with the leader. [GH-9487]
  • ui: ensure namespace is used for node API requests [GH-9488]

1.7.11 (December 10, 2020)

BUG FIXES:

  • license: (Enterprise only) Fixed an issue where warnings about Namespaces being unlicensed would be emitted erroneously.
  • namespace: (Enterprise Only) Fixed a bug that could case snapshot restoration to fail when it contained a namespace marked for deletion while still containing other resources in that namespace. [GH-9156]
  • namespace: (Enterprise Only) Fixed an issue where namespaced services and checks were not being deleted when the containing namespace was deleted.
  • namespaces: (Enterprise only) Prevent stalling of replication in secondary datacenters due to conflicts between the namespace replicator and other replicators. [GH-9271]

1.7.10 (November 19, 2020)

SECURITY:

  • Increase the permissions to read from the /connect/ca/configuration endpoint to operator:write. Previously Connect CA configuration, including the private key, set via this endpoint could be read back by an operator with operator:read privileges. CVE-2020-28053 [GH-9240]

1.7.9 (October 26, 2020)

SECURITY:

  • Fix Consul Enterprise Namespace Config Entry Replication DoS. Previously an operator with service:write ACL permissions in a Consul Enterprise cluster could write a malicious config entry that caused infinite raft writes due to issues with the namespace replication logic. [CVE-2020-25201] (https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-25201) [GH-9024]

IMPROVEMENTS:

  • connect: update supported envoy releases to 1.13.6, 1.12.7, 1.11.2, 1.10.0 for 1.7.x [GH-9000]

BUG FIXES:

  • agent: when enable_central_service_config is enabled ensure agent reload doesn't revert check state to critical [GH-8747]

1.7.8 (September 11, 2020)

FEATURES:

  • agent: expose the list of supported envoy versions on /v1/agent/self [GH-8545]

BUG FIXES:

  • connect: fix bug in preventing some namespaced config entry modifications [GH-8601]
  • api: fixed a panic caused by an api request with Connect=null [GH-8537]

1.7.7 (August 12, 2020)

BUGFIXES:

  • catalog: fixed a bug where nodes, services, and checks would not be restored with the correct Create/ModifyIndex when restoring from a snapshot [GH-8486]
  • vendor: update github.com/armon/go-metrics to v0.3.4 to mitigate a potential panic when emitting Prometheus metrics at an interval longer than the metric expiry time [GH-8478]

1.7.6 (August 07, 2020)

BUG FIXES:

  • xds: revert setting set_node_on_first_message_only to true when generating envoy bootstrap config [GH-8441]
  • telemetry: fix for a lock contention issue with the go-metrics Prometheus sink that could cause performance issues [GH-8372]
  • telemetry: fix for a lock contention issue with the go-metrics Dogstatsd sink that could cause performance issues [GH-8372]

1.7.5 (July 30, 2020)

BUG FIXES:

  • agent: Fixed an issue with lock contention during RPCs when under load while using the Prometheus metrics sink. [GH-8372]
  • gossip: Avoid issue where two unique leave events for the same node could lead to infinite rebroadcast storms [GH-8353]
  • snapshot: (Consul Enterprise only) Fixed a regression when using Azure blob storage.
  • Return a service splitter's weight or a zero [GH-8355]

1.7.4 (June 10, 2020)

SECURITY:

  • Adding an option http_config.use_cache to disable agent caching for http endpoints, because Consul’s DNS and HTTP API expose a caching feature susceptible to DoS. CVE-2020-13250 [GH-8023]
  • Propagate and enforce changes to legacy ACL tokens rules in secondary data centers. CVE-2020-12797 [GH-8047]
  • Only resolve local acl token in the datacenter it belongs to. CVE-2020-13170 [GH-8068]
  • Requiring service:write permissions, a service-router entry without a destination no longer crashes Consul servers. CVE-2020-12758 [GH-7783]

BUG FIXES:

  • acl: Fixed an issue where legacy management tokens could not be used in secondary datacenters. [GH-7908]
  • agent: Fixed a race condition that could cause an agent to crash when first starting. [GH-7955]
  • connect: ensure proxy-defaults protocol is used for upstreams [GH-7938]
  • connect: setup intermediate_pki_path on secondary when using vault [GH-8001]

1.7.3 (May 05, 2020)

IMPROVEMENTS:

  • acl: (Consul Enterprise only) - Disable the ACL.Bootstrap RPC endpoints when managed service provider tokens are in use. [GH-7614]
  • acl: (Consul Enterprise only) - Consul agents will now use the first managed service provider token for the agents token when any are present.
  • acl: Added a v1/acl/policy/name/:name HTTP endpoint to read a policy by name. [GH-6615]
  • acl: Added JSON format output to all of the ACL CLI commands. [GH-7141]
  • agent/xds: Update mesh gateway to use the service resolver connect timeout when configured [GH-6370]
  • cli: Log "newer version available" message at INFO level [GH-7457]
  • config: Consul Enterprise specific configuration are now parseable in OSS but will emit warnings about them not being used. [GH-7714
  • network areas: (Consul Enterprise only) - Network areas are using memberlist with TCP and for every message a new connection was established. Now the connections multiplexed with yamux, which means that way fewer connections are created.
  • network segments: (Consul Enterprise only) - The segment configuration is no longer stored in serf node tags. There is now an RPC endpoint for the same information, which means that the number of network segment is no longer limited by node meta tag size.
  • snapshot agent: (Consul Enterprise only) - Azure has different environments, of which it was only possible to use the public one so far. A new flag was added so that every other environment can be used as well, like Azure China.

BUGFIXES:

  • agent: don't let left nodes hold onto their node-id [GH-7775]
  • agent: (Consul Enterprise only) Fixed several bugs related to Network Area ann Network Segment compatibility with other features caused by incorrectly doing version or serf tag checking. [GH-7491]
  • cli: ensure that 'snapshot save' is fsync safe and also only writes to the requested file on success [GH-7698]
  • cli: fix usage of gzip.Reader to better detect corrupt snapshots during save/restore [GH-7697]
  • connect: Fix panic when validating a service-router config entry with no destination [GH-7783]
  • namespace: (Consul Enterprise only) Fixed several bugs where results from multiple namespaces would be returned when only a single namespace was being queried when the token making the request had permissions to see all of them.
  • snapshot agent (Consul Enterprise only): Ensure snapshots persisted with the local backend are fsync safe and also only writes to the requested file on success.
  • snapshot agent (Consul Enterprise only): Verify integrity of snapshots locally before storing with the configured backend.
  • ui: Ensure blocking queries are used in the service instance page instead of polling [GH-7543]
  • ui: Fix a refreshing/rescrolling issue for the healthcheck listings [GH-7550] [GH-7365]
  • ui: Fix token duplication action bug [GH-7552]
  • ui: Lazily detect HTTP protocol along with a fallback for non-detection [GH-7644] [GH-7643]
  • ui: Ensure KV names using 'special' terms within the default namespace are editable when the URL doesn't include the default namespace [GH-7734]
  • xds: Fix flapping of mesh gateway connect-service watches [GH-7575]

1.7.2 (March 16, 2020)

IMPROVEMENTS:

  • agent: add option to configure max request length for /v1/txn endpoint [GH-7388]
  • build: bump the expected go language version of the main module to 1.13 [GH-7429]
  • agent: add http_config.response header to the UI headers [GH-7369]
  • agent: Added documentation and error messages related to kv_max_value_size option [GH-7405]]
  • agent: Take Prometheus MIME-type header into account [GH-7371]]

BUGFIXES:

  • acl: Updated token resolution so managed service provider token applies to all endpoints. [GH-7431]
  • agent: Fixed error output when agent crashes early [GH-7411]
  • agent: Handle bars in node names when displaying lists in CLI like consul members [GH-6652]]
  • agent: Avoid discarding health check status on consul reload [GH-7345]]
  • network areas: (Consul Enterprise only) - Fixed compatibility issues with network areas and v1.4.0+ ACLs as well as network areas and namespaces. The issue was that secondary datacenters connected to the primary via a network area were not properly detecting that the primary DC supported those other features.
  • sessions: Fixed backwards incompatibility with 1.6.x and earlier [GH-7395][GH-7399]
  • sessions: Fixed backwards incompatibility with 1.6.x and earlier [GH-7395][GH-7398]
  • ui: Fixed a DOM refreshing bug on the node detail page which forced an scroll reset [GH-7365][GH-7377]
  • ui: Fix blocking query requests for the coordinates API requests [GH-7378]
  • ui: Enable recovery from an unreachable datacenter [GH-7404]

1.7.1 (February 20, 2020)

IMPROVEMENTS:

  • agent: sensible keyring error [GH-7272]
  • agent: add server raft.{last,applied}_index gauges [GH-6694]
  • build: Switched to compile with Go 1.13.7 [GH-7262]
  • config: increase http_max_conns_per_client default to 200 [GH-7289]
  • tls: support TLS 1.3 [GH-7325]

BUGFIXES:

  • acl: (Consul Enterprise only) Fixed an issue that prevented remote policy and role resolution from working when namespace policy or role defaults were configured.
  • dns: Fixed an issue that could cause the DNS server to consume excessive CPU resources when trying to parse IPv6 recursor addresses: [GH-6120]
  • dns: Fixed an issue that caused Consul to setup a root zone handler when no alt_domain was configured. [GH-7323]
  • sessions: Fixed an issue that was causing deletions of a non-existent session to return a 500 when ACLs were enabled. [GH-6840]
  • xds: Fix envoy retryOn behavior when multiple behaviors are configured [GH-7280]
  • xds: Mesh Gateway fixes to prevent configuring extra clusters and for properly handling a service-resolvers default subset. [GH-7294]
  • ui: Gracefully cope with errors in discovery-chain when connect is disabled [GH-7291]

1.7.0 (February 11, 2020)

NOTES:

  • cli: Our Windows 32-bit and 64-bit executables for this version and up will be signed with a HashiCorp certificate. Windows users will no longer see a warning about an "unknown publisher" when running our software.

  • cli: Our darwin releases for this version and up will be signed and notarized according to Apple's requirements.

Prior to this release, MacOS 10.15+ users attempting to run our software may see the error: "'consul' cannot be opened because the developer cannot be verified." This error affected all MacOS 10.15+ users who downloaded our software directly via web browsers, and was caused by changes to Apple's third-party software requirements.

MacOS 10.15+ users should plan to upgrade to 1.7.0+.

SECURITY:

  • dns: Updated miekg/dns dependency to fix a memory leak and CVE-2019-19794. [GH-6984], [GH-7252]
  • updated to compile with [Go 1.12.16] which includes a fix for CVE-2020-0601 on windows [GH-7153]

BREAKING CHANGES:

  • http: The HTTP API no longer accepts JSON fields that are unknown to it. Instead errors will be returned with 400 status codes [GH-6874]
  • dns: PTR record queries now return answers that contain the Consul datacenter as a label between service and the domain. [GH-6909]
  • agent: The ACL requirement for the agent/force-leave endpoint is now operator:write rather than agent:write. [GH-7033]
  • logging: Switch over to using go-hclog and allow emitting either structured or unstructured logs. This changes the log format quite a bit and could break any log parsing users may have in place. [GH-1249][GH-7130]
  • intentions: Change the ACL requirement and enforcement for wildcard rules. Previously this would look for an ACL rule that would grant access to the service/intention *. Now, in order to write a wildcard intention requires write access to all intentions and reading a wildcard intention requires read access to any intention that would match. Additionally intention listing and reading allow access if the requester can read either side of the intention whereas before it only allowed it for permissions on the destination side. [GH-7028]
  • telemetry: consul.rpc.query has changed to only measure the start of srv.blockingQuery() calls. In certain rare cases where there are lots of idempotent updates this will cause the metric to report lower than before. The counter should now provides more meaningful behavior that maps to the rate of client-initiated requests. [GH-7224]

FEATURES:

  • Namespaces (Consul Enterprise only) This version adds namespacing to Consul. Namespaces help reduce operational challenges by removing restrictions around uniqueness of resource names across distinct teams, and enable operators to provide self-service through delegation of administrative privileges. Namespace support was added to:
    • ACLs
    • Key/Value Store
    • Sessions
    • Catalog
    • Connect
    • UI [GH6639]
  • agent: Add Cloud Auto-join support for Tencent Cloud [GH-6818]
  • connect: Added a new CA provider allowing Connect certificates to be managed by AWS ACM Private CA.
  • connect: Allow configuration of upstream connection limits in Envoy [GH-6829]
  • ui: Adds UI support for Exposed Checks [GH6575]
  • ui: Visualisation of the Discovery Chain [GH6746]

IMPROVEMENTS:

  • acl: Use constant time comparison when checking for the ACL agent master token. [GH-6943]
  • acl: Add accessorID of token when ops are denied by ACL system [GH-7117]
  • agent: default the primary_datacenter to the datacenter if not configured [GH-7111]
  • agent: configurable MaxQueryTime and DefaultQueryTime [GH-3777]
  • agent: do not deregister service checks twice [GH-6168]
  • agent: remove service sidecars in cleanupRegistration [GH-7022]
  • agent: setup grpc server with auto_encrypt certs and add -https-port [GH-7086
  • agent: some check types now support configuring a number of consecutive failure and success before the check status is updated in the catalog. [GH-5739]
  • agent: clients should only attempt to remove pruned nodes once per call [GH-6591]
  • agent: Consul HTTP checks can now send a configurable body in the request. [GH-6602]
  • agent: increase watchLimit to 8192. [GH-7200]
  • api: A new /v1/catalog/node-services/:node endpoint was added that mirrors the existing /v1/catalog/node/:node endpoint but has a response structure that contains a slice of services instead of a map of service ids to services. This new endpoint allows retrieving all services in all namespaces for a node. [GH-7115]
  • api: add option to set TLS options in-memory for API client [GH-7093]
  • api: add replace-existing-checks param to the api package [GH-7136]
  • auto_encrypt: set dns and ip san for k8s and provide configuration [GH-6944]
  • cli: improve the file safety of 'consul tls' subcommands [GH-7186]
  • cli: give feedback to CLI user on forceleave command if node does not exist [GH-6841]
  • connect: Envoy's whole stats endpoint can now be exposed to allow integrations like DataDog agent [GH-7070]
  • connect: check if intermediate cert needs to be renewed. [GH-6835]
  • connect: Allow inlining of the TLS certificate in the Envoy configuration. [GH-6360]
  • dns: Improvement to enable dual stack IPv4/IPv6 addressing of services and lookup via DNS [GH-6531]
  • lock: consul lock will now receive shutdown signals during the lock-acquisition process. [GH-5909]
  • raft: increase raft notify buffer [GH-6863]
  • raft: update raft to v1.1.2 [GH-7079]
  • router: do not surface left servers [GH-6420]
  • rpc: log method when a server/server RPC call fails [GH-4548]
  • sentinel: (Consul Enterprise only) The Sentinel framework was upgraded to v0.13.0. See the Sentinel Release Notes for more information.
  • telemetry: Added consul.rpc.queries_blocking gauge to measure the current number of in-flight blocking queries. [GH-7224]
  • ui: Discovery chain improvements for clarifying the default router [GH-7222]
  • ui: Added unique browser titles to each page [GH-7118]
  • ui: Add live updates/blocking queries to the Intention listing page [GH-7161]
  • ui: Use more consistent icons with other HashiCorp products in the UI [GH-6851]
  • ui: Improvements to the Discovery Chain visualisation in respect to redirects [GH-7036]
  • ui: Improvement keyboard navigation of the main menu [GH-7090]
  • ui: New row confirmation dialogs [GH-7007]
  • ui: Various visual CSS amends and alterations [GH6495] GH6881(https://github.com/hashicorp/consul/
  • ui: Hides the Routing tab for a service proxy [GH-7195]
  • ui: Add ability to search nodes listing page with IP Address [GH-7204]
  • xds: mesh gateway CDS requests are now allowed to receive an empty CDS reply [GH-6787]
  • xds: Verified integration test suite with Envoy 1.12.2 & 1.13.0 [GH-6947]
  • agent: Added ACL token for Consul managed service providers [GH-7218]

BUGFIXES:

  • agent: fix watch event behavior [GH-5265]
  • agent: ensure node info sync and full sync [GH-7189]
  • autopilot: Fixed dead server removal condition to use correct failure tolerance. [GH-4017]
  • cli: services register command now correctly registers an unamed healthcheck [GH-6800]
  • cli: remove -dev from consul version in ARM builds in the 1.6.2 release [GH-6875]
  • cli: ui_content_path config option fix [GH-6601]
  • config: Fixed a bug that caused some config parsing to be case-sensitive: [GH-7191]
  • connect: CAs can now use RSA keys correctly to sign EC leafs [GH-6638]
  • connect: derive connect certificate serial numbers from a memdb index instead of the provider table max index [GH-7011]
  • connect: ensure that updates to the secondary root CA configuration use the correct signing key ID values for comparison [GH-7012]
  • connect: use correct subject key id for leaf certificates. [GH-7091]
  • log: handle discard all logfiles properly [GH-6945]
  • state: restore a few more service-kind index updates so blocking in ServiceDump works in more cases [GH-6948]
  • tls: fix behavior related to auto_encrypt and verify_incoming (#6899) [GH-6811]
  • ui: Ensure the main navigation menu is closed on click [GH-7164]
  • ui: Ensure KV flags are passed through to Consul on update [GH-7216]
  • ui: Fix positioning of active icon in main navigation menu [GH-7233]
  • ui: Ensure the Namespace property is sent to Consul in OSS [GH-7238]
  • ui: Remove the Policy/Service Identity selector from namespace policy form [GH-7124]
  • ui: Fix positioning of active icon in the selected menu item [GH-7148]
  • ui: Discovery-Chain: Improve parsing of redirects [GH-7174]
  • ui: Fix styling of ‘duplicate intention’ error message [GH6936]

1.6.10 (November 19, 2020)

SECURITY:

  • Increase the permissions to read from the /connect/ca/configuration endpoint to operator:write. Previously Connect CA configuration, including the private key, set via this endpoint could be read back by an operator with operator:read privileges. CVE-2020-28053 [GH-9240]

1.6.9 (September 11, 2020)

BUG FIXES:

  • api: fixed a panic caused by an api request with Connect=null [GH-8537]

1.6.8 (August 12, 2020)

BUG FIXES:

  • vendor: update github.com/armon/go-metrics to v0.3.4 to mitigate a potential panic when emitting Prometheus metrics at an interval longer than the metric expiry time [GH-8478]

1.6.7 (July 30, 2020)

BUG FIXES:

  • agent: Fixed an issue with lock contention during RPCs when under load while using the Prometheus metrics sink. [GH-8372]
  • gossip: Avoid issue where two unique leave events for the same node could lead to infinite rebroadcast storms [GH-8345]

1.6.6 (June 10, 2020)

SECURITY:

  • Adding an option http_config.use_cache to disable agent caching for http endpoints, because Consul’s DNS and HTTP API expose a caching feature susceptible to DoS. CVE-2020-13250 [GH-8023]
  • Propagate and enforce changes to legacy ACL tokens rules in secondary data centers. CVE-2020-12797 [GH-8047]
  • Only resolve local acl token in the datacenter it belongs to. CVE-2020-13170 [GH-8068]

BUG FIXES:

  • acl: Fixed an issue where legacy management tokens could not be used in secondary datacenters. [GH-7908]
  • agent: Fixed a race condition that could cause an agent to crash when first starting. [GH-7955]

1.6.5 (April 14, 2020)

BUG FIXES:

  • agent: (Consul Enterprise only) Fixed several bugs related to Network Area and Network Segment compatibility with other features caused by incorrectly doing version or serf tag checking. [GH-7551]

1.6.4 (February 20, 2020)

SECURITY:

  • dns: Updated miekg/dns dependency to fix a memory leak and CVE-2019-19794. [GH-6984], [GH-7261]

1.6.3 (January 30, 2020)

SECURITY

  • agent: mitigate potential DoS vector allowing unbounded server resource usage from unauthenticated connections [GH-7159]
  • acl: add ACL enforcement to the v1/agent/health/service/* endpoints [GH-7160]

IMPROVEMENTS

  • tls: auto_encrypt and verify_incoming [GH-6811]

BUG FIXES

  • agent: output proper HTTP status codes for Txn requests that are too large [GH-7158]
  • connect: derive connect certificate serial numbers from a memdb index instead of the provider table max index [GH-7011]
  • connect: ensure that updates to the secondary root CA configuration use the correct signing key ID values for comparison [GH-7012]

1.6.2 (November 13, 2019)

SECURITY

  • Updated to compile with Go 1.12.13 which includes a fix for CVE-2019-17596 in [Go 1.12.11] [GH-6319]

FEATURES

  • agent: store check type in catalog [GH-6561]
  • agent: update force-leave to allow for complete removal of members [GH-6571]
  • agent: updates to the agent token trigger anti-entropy full syncs [GH-6577]
  • snapshot agent (Consul Enterprise): Added support for saving snapshots to Google Cloud Storage.
  • connect: Added proxy config stanza to allow exposing HTTP paths through Envoy for non-Connect-enabled services [GH-5396]

IMPROVEMENTS

  • licensing (Consul Enterprise): Increase initial server temporary license duration to 6 hours to allow for longer upgrades/migrations.
  • server: ensure the primary datacenter and ACL datacenter match [GH-6634]
  • sdk: ignore panics due to stray goroutines logging after a test completes [GH-6632]
  • agent: allow mesh gateways to initialize even if there are no connect services registered yet [GH-6576]
  • agent: endpoint performance improvements, Txn endpoint in particular. [GH-6680]
  • sdk: add NewTestServerT, deprecate NewTestServer in testutil to prevent nil point dereference [GH-6761]
  • agent: auto_encrypt provided TLS certificates can now be used to enable HTTPS on clients [GH-6489]
  • sentinel (Consul Enterprise): update to v0.13.0, see Sentinel changelog for more details

BUG FIXES

  • ARM release binaries: Starting with v1.6.2, Consul will ship three separate versions of ARM builds. The previous ARM binaries of Consul could potentially crash due to the way the Go runtime manages internal pointers to its Go routine management constructs and how it keeps track of them especially during signal handling. From v1.6.2 forward, it is recommended to use:
    • consul_{version}_linux_armelv5.zip for all 32-bit armel systems
    • consul_{version}_linux_armhfv6.zip for all armhf systems with v6+ architecture
    • consul_{version}_linux_arm64.zip for all v8 64-bit architectures
  • agent: Parse the HTTP Authorization header as case-insensitive. [GH-6568]
  • agent: minimum quorum check added to Autopilot with minQuorum option [GH-6654]
  • agent: cache notifications work after error if the underlying RPC returns index=1 [GH-6547]
  • agent: tolerate more failure scenarios during service registration with central config enabled [GH-6472]
  • cache: remove data race in agent cache [GH-6470]
  • connect: connect CA Roots in secondary datacenters should use a SigningKeyID derived from their local intermediate [GH-6513]
  • connect: don't colon-hex-encode the AuthorityKeyId and SubjectKeyId fields in connect certs [GH-6492]
  • connect: intermediate CA certs generated with the vault provider lack URI SANs [GH-6491]
  • debug: Fix a bug in sync.WaitGroup usage. [GH-6649]
  • xds: tcp services using the discovery chain should not assume RDS during LDS [GH-6623]
  • ui: Fix a bug where switching datacenters using the datacenter menu would lead to an empty service listing [GH-6555]

1.6.1 (September 12, 2019)

IMPROVEMENTS

  • agent: Distinguish between DC not existing and not being available [GH-6399]
  • agent: Added replace-existing-checks param to service registration endpoint to replace existing checks when re-registering a service. [GH-4905]
  • auto_encrypt: verify_incoming_rpc is good enough for auto_encrypt.allow_tls [GH-6376]
  • connect: Ensure that a secondary CA's intermediate certificate will show in the various API endpoints CA Roots output [GH-6333]
  • ui: Reconcile ember-data store [GH-5745]
  • ui: Allow text selection of clickable elements and their contents without then jumping the user to the linked page [GH-5770]
  • ui: Adds the ability to frontend search instances by address (ip:port) [GH-5993]
  • ui: Add CheckID to the output panels of healthchecks [GH-6195]
  • ui: Enable blocking queries by default [GH-6194]
  • txn: don't try to decode request bodies > raft.SuggestedMaxDataSize [GH-6422]

BUG FIXES

  • network areas (Consul Enterprise): Ensure that TCP based transport for network area memberlist propgates failed nodes properly [GH-6479]
  • network areas (Consul Enterprise): make sure network areas are left as well when consul is leaving [GH-6453]
  • ui: Show the correct message when a session has been removed from a KV [GH-6167]
  • ui: Ensure KV sessions visually aren't shared between multiple KV's [GH-6166]
  • tls: make sure auto_encrypt has private key type and bits [GH-6392]

FEATURES

  • ui: Add leader icon for node listing view to call out which node is the current leader [GH-6265]

1.6.0 (August 23, 2019)

SECURITY:

  • Updated to compile with Go 1.12.8 which mitigates CVE-2019-9512 and CVE-2019-9514 for the builtin HTTP server [GH-6319]
  • Updated the google.golang.org/grpc dependency to v1.23.0 to mitigate CVE-2019-9512, CVE-2019-9514, and CVE-2019-9515 for the gRPC server. [GH-6320]

BREAKING CHANGES:

  • connect: remove deprecated managed proxies and ProxyDestination config [GH-6220]

FEATURES:

  • Connect Envoy Supports L7 Routing: Additional configuration entry types service-router, service-resolver, and service-splitter, allow for configuring Envoy sidecars to enable reliability and deployment patterns at L7 such as HTTP path-based routing, traffic shifting, and advanced failover capabilities. For more information see the L7 traffic management docs.
  • Mesh Gateways: Envoy can now be run as a gateway to route Connect traffic across datacenters using SNI headers, allowing connectivty across platforms and clouds and other complex network topologies. Read more in the mesh gateway docs.
  • Intention & CA Replication: In order to enable connecitivty for services across datacenters, Connect intentions are now replicated and the Connect CA cross-signs from the primary_datacenter. This feature was previously part of Consul Enterprise.
  • agent: add local-only parameter to operator/keyring list requests to force queries to only hit local servers. [GH-6279]
  • connect: expose an API endpoint to compile the discovery chain [GH-6248]
  • connect: generate the full SNI names for discovery targets in the compiler rather than in the xds package [GH-6340]
  • connect: introduce ExternalSNI field on service-defaults [GH-6324]
  • xds: allow http match criteria to be applied to routes on services using grpc protocols [GH-6149]

IMPROVEMENTS:

  • agent: Added tagged addressing to services similar to the already present Node tagged addressing [GH-5965]
  • agent: health checks: change long timeout behavior to use to user-configured timeout value [GH-6094]
  • api: Display allowed HTTP CIDR information nicely [GH-6029]
  • api: Update filtering language to include substring and regular expression matching on string values [GH-6190]
  • connect: added a new -bind-address cli option for envoy to create a mapping of the desired bind addresses to use instead of the default rules or tagged addresses [GH-6107]
  • connect: allow L7 routers to match on http methods [GH-6164]
  • connect: change router syntax for matching query parameters to resemble the syntax for matching paths and headers for consistency. [GH-6163]
  • connect: detect and prevent circular discovery chain references [GH-6246]
  • connect: ensure time.Duration fields retain their human readable forms in the API [GH-6348]
  • connect: reconcile how upstream configuration works with discovery chains [GH-6225]
  • connect: rework how the service resolver subset OnlyPassing flag works [GH-6173]
  • connect: simplify the compiled discovery chain data structures [GH-6242]
  • connect: validate and test more of the L7 config entries [GH-6156]
  • gossip: increase size of gossip key generated by keygen to 32 bytes and document support for AES 256 [GH-6244]
  • license (enterprise): Added license endpoint support to the API client [GH-6268]
  • xds: improve how envoy metrics are emitted [GH-6312]
  • xds: Verified integration test suite with Envoy 1.11.1 [GH-6347]

BUG FIXES:

  • acl: Fixed a bug that could prevent transition from legacy ACL mode to new ACL mode [GH-6332
  • agent: blocking central config RPCs iterations should not interfere with each other [GH-6316]
  • agent: fix an issue that could cause a panic while transferring leadership due to replication [GH-6104]
  • api: Fix a bug where the service tagged addresses were not being returned through the v1/agent/service/:service api. [GH-6299]
  • api: un-deprecate api.DecodeConfigEntry [GH-6278]
  • auto_encrypt: use server-port [GH-6287]
  • autopilot: update to also remove failed nodes from WAN gossip pool [GH-6028]
  • cli: ensure that the json form of config entries can be submitted with 'consul config write' [GH-6290]
  • cli: Fixed bindable IP detection with the connect envoy command. [GH-6238]
  • config: Ensure that all config entry writes are transparently forwarded to the primary datacneter. [GH-6327]
  • connect: allow 'envoy_cluster_json' escape hatch to continue to function [GH-6378]
  • connect: allow mesh gateways to use central config [GH-6302]
  • connect: ensure intention replication continues to work when the replication ACL token changes [GH-6288]
  • connect: ensure local dc connections do not use the gateway [GH-6085]
  • connect: fix bug in service-resolver redirects if the destination uses a default resolver [GH-6122]
  • connect: Fixed a bug that would prevent CA replication/initializing in a secondary DC from working when ACLs were enabled. [GH-6192]
  • connect : Fixed a regression that broken xds endpoint generation for prepared query upstreams. [GH-6236]
  • connect: fix failover through a mesh gateway to a remote datacenter [GH-6259]
  • connect: resolve issue where MeshGatewayConfig could be returned empty [GH-6093]
  • connect: updating a service-defaults config entry should leave an unset protocol alone [GH-6342]
  • connect: validate upstreams and prevent duplicates [GH-6224]
  • server: if inserting bootstrap config entries fails don't silence the errors [GH-6256]
  • snapshot: fix TCP half-close implementation for TLS connections [GH-6216]

KNOWN ISSUES

  • auto_encrypt: clients with auto_encrypt enabled won't be able to start because of [GH-6391]. There is a fix, but it came too late and we couldn't include it in the release. It will be part of 1.6.1 and we recommend that if you are using auto_encrypt you postpone the update.

1.5.3 (July 25, 2019)

IMPROVEMENTS:

  • raft: allow trailing logs to be configured as an escape hatch for extreme load that prevents followers catching up with leader [GH-6186]
  • raft: added raft log chunking capabilities to allow for storing larger KV entries [GH-6172]
  • agent: added configurable limit for log files to be rotated [GH-5831]
  • api: The v1/status endpoints can now be forwarded to remote datacenters [GH-6198]

BUG FIXES:

  • autopilot: update to also remove failed nodes from WAN gossip pool [GH-6028]
  • agent: avoid reverting any check updates that occur while a service is being added or the config is reloaded [GH-6144]
  • auto-encrypt: fix an issue that could cause cloud retry-join to fail when utilized with auto-encrypt by falling back to a default port [GH-6205]

1.5.2 (June 27, 2019)

FEATURE

  • tls: auto_encrypt enables automatic RPC cert provisioning for consul clients [GH-5597]

IMPROVEMENTS

  • ui: allow for customization of consul UI path [GH-5950]
  • acl: allow service deregistration with node write permission [GH-5217]
  • agent: support for maximum size for Output of checks [GH-5233]
  • agent: improve startup message when no error occurs [GH-5896]
  • agent: make sure client agent rate limits apply when hitting the client interface on a server directly [GH-5927]
  • agent: use stale requests when performing full sync [GH-5873]
  • agent: transfer leadership when establishLeadership fails [GH-5247]
  • agent: added metadata information about servers into consul service description [GH-5455]
  • connect: provide -admin-access-log-path for envoy [GH-5858]
  • connect: upgrade Envoy xDS protocol to support Envoy 1.10 [GH-5872]
  • dns: support alt domains for dns resolution [GH-5940]
  • license (enterprise): add command to reset license to builtin one
  • ui: Improve linking between sidecars and proxies and their services/service instances [GH-5944]
  • ui: Add ability to search for tokens by policy, role or service identity name [GH-5811]

BUG FIXES:

  • agent: fix several data races and bugs related to node-local alias checks [GH-5876]
  • api: update link to agent caching in comments [GH-5935]
  • connect: fix proxy address formatting for IPv6 addresses [GH-5460]
  • connect: store signingKeyId instead of authorityKeyId [GH-6005]
  • ui: fix service instance linking when multiple non-unique service id's exist on multiple nodes [GH-5933]
  • ui: Improve error messaging for ACL policies [GH-5836]
  • txn: Fixed an issue that would allow a CAS operation on a service to work when it shouldn't have. [GH-5971]

1.5.1 (May 22, 2019)

SECURITY:

  • acl: fixed an issue that if an ACL rule is used for prefix matching in a policy, keys not matching that specific prefix can be deleted by a token using that policy even with default_deny settings configured [GH-5888]

BUG FIXES:

  • agent: Fixed an issue where recreating a node using a different ID would prevent the new node from correctly joining. [GH-5485]

1.5.0 (May 08, 2019)

SECURITY:

  • connect: Envoy versions lower than 1.9.1 are vulnerable to CVE-2019-9900 and CVE-2019-9901. Both are related to HTTP request parsing and so only affect Consul Connect users if they have configured HTTP routing rules via the "escape hatch". We recommend Envoy 1.9.1 be used. Note that while we officially deprecate support for older version of Envoy in 1.5.0, we recommend using Envoy 1.9.1 with all previous versions of Consul Connect too (back to 1.3.0 where Envoy support was introduced).

BREAKING CHANGES:

  • /watch: (note this only affects downstream programs importing /watch package as a library not the watch feature in Consul) The watch package was moved from github.com/hashicorp/consul/watch to github.com/hashicorp/consul/api/watch to live in the API module. This was necessary after updating the repo to use Go modules or else various other bugs cropped up. The watch package API has not changed so projects depending on it should need to only update the import statement to get their code functioning again. [GH-5664]
  • ui: Legacy UI has been removed. Setting the CONSUL_UI_LEGACY environment variable to 1 or true will no longer revert to serving the old UI. [GH-5643]

FEATURES:

  • Connect Envoy Supports L7 Observability: We introduce features that allow configuring Envoy sidecars to emit metrics and tracing at L7 (http, http2, grpc supported). For more information see the Envoy Integration docs.
  • Centralized Configuration: Enables central configuration of some service and proxy defaults. For more information see the Configuration Entries docs
  • api: Implement data filtering for some endpoints using a new filtering language. [GH-5579]
  • snapshot agent (Consul Enterprise): Added support for saving snapshots to Azure Blob Storage.
  • acl: tokens can be created with an optional expiration time [GH-5353]
  • acl: tokens can now be assigned an optional set of service identities [GH-5390]
  • acl: tokens can now be assigned to roles [GH-5514]
  • acl: adding support for kubernetes auth provider login [GH-5600]
  • ui: Template-able Dashboard links for Service detail pages [GH-5704] [GH-5777]
  • ui: support for ACL Roles [GH-5635]

IMPROVEMENTS:

  • cli: allow to add ip addresses as Subject Alternative Names when creating certificates with consul tls cert create [GH-5602]
  • dns: Allow for hot-reload of many DNS configurations. [GH-4875]
  • agent: config is now read if json or hcl is set as the config-format or the extension is either json or hcl [GH-5723]
  • acl: Allow setting token accessor ids and secret ids during token creation. [GH-4977]
  • ui: Service Instances page redesign and further visibility of Connect Proxies [GH-5326]
  • ui: Blocking Query support / live updates for Services and Nodes, requires enabling per user via the UI Settings area [GH-5070] [GH-5267]
  • ui: Finer grained searching for the Service listing page [GH-5507]
  • ui: Add proxy icons to proxy services and instances where appropriate [GH-5463]

BUG FIXES:

  • api: fix panic in 'consul acl set-agent-token' [GH-5533]
  • api: fix issue in the transaction API where the health check definition struct wasn't being deserialized properly [GH-5553]
  • acl: memdb filter of tokens-by-policy was inverted [GH-5575]
  • acl: Fix legacy rules translation for JSON based rules. [GH-5493]
  • agent: Fixed a bug causing RPC errors when the discovery_max_stale time was exceeded. [GH-4673]
  • agent: Fix an issue with registering health checks for an agent service where the service name would be missing. [GH-5705]
  • connect: fix an issue where Envoy would fail to bootstrap if some upstreams were unavailable [GH-5499]
  • connect: fix an issue where health checks on proxies might be missed by watchers of /health/service/:service API [GH-5506]
  • connect: fix a race condition that could leave proxies with no configuration for long periods on startup [GH-5793]
  • logger: fix an issue where the log-file option was not respecting the log-level [GH-4778]
  • catalog: fix an issue where renaming nodes could cause registration instability [GH-5518]
  • network areas (Consul Enterprise): Fixed an issue that could cause a lock to be held unnecessarily causing other operations to hang.

1.4.5 (May 22, 2019)

SECURITY:

  • acl: fixed an issue that if an ACL rule is used for prefix matching in a policy, keys not matching that specific prefix can be deleted by a token using that policy even with default_deny settings configured [GH-5888]

1.4.4 (March 21, 2019)

SECURITY:

  • Fixed a problem where verify_server_hostname was not being respected and the default false was being used. This problem exists only in Consul 1.4.3. (CVE-2019-9764) [GH-5519]

FEATURES:

  • agent: enable reloading of agent-to-agent TLS configuration [GH-5419]

IMPROVEMENTS:

  • api: /health/service/:service blocking queries now only need a single goroutine regardless of number of instances in the service and watch channel which can massively reduce the number of goroutines on busy servers. [GH-5449]

BUG FIXES:

  • api: Fixed a bug where updating node information wasn't reflected in health result index. [GH-5450]
  • agent: Fixed a bug that would cause removal of all of an agents health checks when only one service was removed. [GH-5456]
  • connect: Fixed a bug where sidecar_service registered proxies might not be removed correctly due to ACLs for the service being removed first dissallowing the agent permission to delete the proxy. [GH-5482]
  • tlsutil: don't use server_name config for RPC connections. [GH-5394]

1.4.3 (March 5, 2019)

SECURITY:

  • Fixed a potential privilege escalation issue with the Consul 1.4.X ACL system when ACL token replication was enabled. (CVE-2019-8336) [GH-5423]

BUG FIXES:

  • agent: Fixed a bug that could cause invalid memberlist protocol versions to propagate throughout the cluster. [GH-3217]
  • server: Fixed a race condition during server initialization and leadership monitoring. [GH-5322]
  • agent: only enable TLS on gRPC if the HTTPS API port is enabled [GH-5287]
  • agent: Fixed default log file permissions. [GH-5346]
  • api: Fixed bug where /connect/intentions endpoint didn't return X-Consul-Index [GH-5355]
  • agent: Ensure that reaped servers are removed from RPC routing. [GH-5317]
  • acl: Fix potential race condition when listing or retrieving ACL tokens. [GH-5412]
  • agent: Fixed race condition that could turn up while registering services on the local agent. [GH-4998]

FEATURES:

  • prepared queries: Enable ServiceMeta filtering for prepared queries. [GH-5291]
  • dns: Enabled caching of RPC responses within the DNS server. [GH-5300]

IMPROVEMENTS:

  • agent: Check ACLs more often for xDS stream endpoints. [GH-5237]
  • connect: Sidecar services now inherit tags and service metadata of the parent service by default. [GH-5291]
  • connect: Envoy proxies can now have cluster-specific config overrides via new "escape hatches": [GH-5308]
  • agent: Added opt-in ACL token persistence for tokens set with the agent/token/* endpoints: [GH-5328]
  • agent: Default to requiring protocol version 1.2 for TLS connections. The docs previously said this was going to be the default in 0.8+ but it had been left at 1.0 until now. [GH-5340]

1.4.2 (January 28, 2019)

BUG FIXES:

  • api: Fixed backwards compatibility in the Consul Go API client. [GH-5270]
  • dns: Fixed a bug that would cause node meta TXT records to always be generated even if they were not used in the responses. [GH-5271]

1.4.1 (January 23, 2019)

Note: Consul 1.4.1 can break compatibility with older versions of the Consul Go API client. At this time, we recommend that you not upgrade to 1.4.1 if you use the Go API client or other applications that utilize it such as Nomad. Read more: [GH-5270]

FEATURES:

  • api: The transaction API now supports catalog operations for interacting with nodes, services and checks. See the transacton API page for more information. [GH-4869]

SECURITY:

  • Fixed an issue that caused verify_server_hostname to not implicitly configure verify_outgoing to true. The documentation stated this was implicit. The previous implementation had a bug that resulted in this being partially incorrect and resulted in plaintext communication in agent-to-agent RPC when verify_outgoing was not explicitly set. (CVE-2018-19653) [GH-5069]

IMPROVEMENTS:

  • agent: Improve blocking queries for services that do not exist. [GH-4810]
  • api: Added new /v1/agent/health/service/name/<service name> and /v1/agent/health/service/id/<service id> endpoints to allow querying a services status from the agent itself and avoid querying a Consul server. [GH-2488]
  • api: Added a new allow_write_http_from configuration to set which CIDR network ranges can send non GET/HEAD/OPTIONS HTTP requests. Requests originating from other addresses will be denied. [GH-4712]
  • cli: Added a new cli command: consul tls with subcommands ca create and cert create to help bootstrapping a secure agent TLS setup. This includes a new guide for creating certificates.
  • connect: clients are smarter about when they regenerate leaf certificates to improve performance and reliability [GH-5091]
  • gossip: CPU performance improvements to memberlist gossip on very large clusters [GH-5189]
  • connect: Added support for prepared query upstream proxy destination type watching. [GH-4969
  • connect: (Consul Enterprise) Now forwards any intention API calls from secondary datacenters to the primary instead of erroring when intention replication is enabled.
  • connect: Now controls rate of Certificate Signing Requests during a CA rotation so the servers aren't overwhelmed. [GH-5228]

BUG FIXES:

  • acl: Fixed a concurrent policy resolution issue that would fail to resolve policies for a token [GH-5219]
  • acl: Fixed a few racey edge cases regarding policy resolution where the RPC request could error out due to the token used for the request being deleted or modified after the token was read but before policy resolution. [GH-5246]
  • acl: Fixed a bug that would cause legacy ACL tokens of type management to not get full privileges when they also had rules set on them. [GH-5261]
  • agent: Prevent health check status flapping during check re-registration. [GH-4904]
  • agent: Consul 1.2.3 added DNS weights but this caused an issue with agent Anti-Entropy that didn't set the same default and so performed a re-sync every 2 minutes despite no changes. [GH-5096]
  • agent: Fix an anti-entropy state syncing issue where an invalid token being used for registration of 1 service could cause a failure to register a different service with a valid token. [GH-3676]
  • agent: (Consul Enterprise) Snapshot agent now uses S3 API for unversioned objects to workaround an issue when a bucket has versioning enabled.
  • agent: Fixed a bug where agent cache could return an error older than the last non-error value stored. This mostly affected Connect bootstrapping in integration environments but lead to some very hard to track down "impossible" issues [GH-4480]
  • agent: snapshot verification now works regardless of spacing in meta.json [GH-5193]
  • agent: Fixed a bug where disable_host_node_id = false was not working properly [GH-4914]
  • agent: Fixed issue where DNS weights added in 1.2.3 caused unnecessary Anti-Entropy syncs due to implicit vs explicit default weights being considered "different". [GH-5126]
  • api: Fixed an issue where service discovery requests that use both ?cached and multiple repeated tag filters might incorrectly see the cached result for a different query [GH-4987]
  • api: Fixed an issue causing blocking query wait times to not be used when retrieving leaf certificates. [GH-4462]
  • cli: display messages from serf in cli [GH-5236]
  • connect: Fixed an issue where a blank CA config could be written to a snapshot when Connect was disabled. [GH-4954]
  • connect: Fixed a bug with the create and modify indices of leaf certificates not being incremented properly. [GH-4463]
  • connect: Fixed an issue where certificates could leak and remain in client memory forever [GH-5091]
  • connect: (Consul Enterprise) When requesting to sign intermediates the primary dc is now used
  • connect: added tls config for vault connect ca provider [GH-5125]
  • connect: Fix a panic on 32 bit systems for unaligned 64 bit atomic operations. [GH-5128]
  • debug: Fixed an issue causing the debug archive to not be gzipped. [GH-5141]
  • dns: Fix an issue causing infinite recursion for some DNS queries when a nodes address had bee misconfigured [GH-4907]
  • watch: Fix a data race during setting up a watch plan. [GH-4357]
  • ui: Correctly encode/decode URLs within the KV areas. Also encode/decode slashes in URLS related to service names [GH5206]

1.4.0 (November 14, 2018)

FEATURES:

  • New ACL System: The ACL system has been redesigned while allowing for in-place upgrades that will automatically migrate to the new system while retaining compatibility for existing ACL tokens for clusters where ACLs are enabled. This new system introduces a number of improvements to tokens including accessor IDs and a new policy model. It also includes a new CLI for ACL interactions and a completely redesigned UI experience to manage ACLs and policies. WAN federated clusters will need to add the additional replication token configuration in order to ensure WAN ACL replication in the new system. [GH-4791]

    • ACL CLI.
    • New ACL HTTP APIs.
    • Splitting ACL Tokens into Tokens and Policies with rules being defined on policies and tokens being linked to policies.
    • ACL Tokens have a public accessor ID now in addition to the secret ID that they used to have.
    • Setting a replication token is now required but it only needs "read" permissions on ACLs.
    • Update to the rules language to allow for exact-matching rules in addition to prefix matching rules
    • Added DC local tokens.
    • Auto-Transitioning from legacy mode to normal mode as the cluster's servers get upgraded.
    • ACL UI updates to support new functionality.

  • Multi-datacenter Connect: (Consul Enterprise) Consul Connect now supports multi-datacenter connections and replicates intentions. This allows WAN federated DCs to provide connections from source and destination proxies in any DC.

  • New command consul debug which gathers information about the cluster to help resolve incidents and debug issues faster. [GH-4754]

IMPROVEMENTS:

  • dns: Implement prefix lookups for DNS TTL. [GH-4605]
  • ui: Add JSON and YAML linting to the KV code editor. [GH-4814]
  • connect: Fix comment DYNAMIC_DNS to LOGICAL_DNS. [GH-4799]
  • terraform: fix formatting of consul.tf. [GH-4580]

BUG FIXES:

  • snapshot: Fixed a bug where node ID and datacenter weren't being included in or restored from the snapshots. [GH-4872]
  • api: Fixed migration issue where changes to allow multiple tags in 1.3.0 would cause broken results during a migration from earlier versions [GH-4944]

1.3.1 (November 13, 2018)

BUG FIXES:

  • api: Fix issue introduced in 1.3.0 where catalog queries with tag filters change behaviour during upgrades from 1.2.x or earlier. (Back-ported from 1.4.0 release candidate.) [GH-4944].

1.3.0 (October 11, 2018)

FEATURES:

  • Connect Envoy Support: This release includes support for using Envoy as a Proxy with Consul Connect (Beta). Read the announcement blog post or reference documentation for more detail.
  • Sidecar Service Registration: As part of the ongoing Connect Beta we add a new, more convenient way to register sidecar proxies from within a regular service definition.
  • Deprecating Managed Proxies: The Connect Beta launched with a feature named "managed proxies". These will no longer be supported in favour of the simpler sidecar service registration. Existing functionality will not be removed until a later major release but will not be supported with fixes. See the deprecation notice for full details.
  • New command consul services register and consul services deregister for registering and deregistering services from the command line. [GH-4732]
  • api: Service discovery endpoints now support caching results in the local agent. [GH-4541]
  • dns: Added SOA configuration for DNS settings. [GH-4713]

IMPROVEMENTS:

  • ui: Improve layout of node 'cards' by restricting the grid layout to a maximum of 4 columns [GH-4761]
  • ui: Load the TextEncoder/Decoder polyfill dynamically so it's not downloaded to browsers with native support [GH-4767]
  • cli: consul connect proxy now supports a --sidecar-for option to allow simple integration with new sidecar service registrations.
  • api: /health and /catalog endpoints now support filtering by multiple tags [GH-1781]
  • agent: Only update service ModifyIndex when it's state actually changes. This makes service watches much more efficient on large clusters. [GH-4720]
  • config: Operators can now enable script checks from local config files only. [GH-4711]

BUG FIXES:

  • agent: (Consul Enterprise) Fixed an issue where the non_voting_server setting could be ignored when bootstrapping the cluster. [GH-4699]
  • cli: forward SIGTERM to child process of 'lock' and 'watch' subcommands [GH-4737]
  • connect: Fix to ensure leaf certificates for a service are not shared between clients on the same agent using different ACL tokens [GH-4736]
  • ui: Ensure service names that contain slashes are displayable [GH-4756]
  • watch: Fix issue with HTTPs only agents not executing watches properly. [GH-4727]

1.2.4 (November 27, 2018)

SECURITY:

1.2.3 (September 13, 2018)

FEATURES:

  • agent: New Cloud Auto-join provider: Kubernetes (K8S) [GH-4635]
  • http: Added support for "Authorization: Bearer" head in addition to the X-Consul-Token header. [GH-4483]
  • dns: Added a way to specify SRV weights for each service instance to allow weighted DNS load-balancing. [GH-4198]
  • dns: Include EDNS-ECS options in EDNS responses where appropriate: see RFC 7871 [GH-4647]
  • ui: Add markers/icons for external sources [GH-4640]

IMPROVEMENTS:

  • ui: Switch to fullscreen layout for lists and detail, left aligned forms [GH-4435]
  • connect: TLS certificate readiness now performs x509 certificate verification to determine whether the cert is usable. [GH-4540]
  • ui: The syntax highlighting/code editor is now on by default [GH-4651]
  • ui: Fallback to showing Node.Address if Service.Address is not set [GH-4579]
  • gossip: Improvements to Serf and memberlist improving gossip stability on very large clusters (over 35k tested) [GH-4511]

BUG FIXES:

  • agent: Avoid returning empty data on startup of a non-leader server [GH-4554]
  • agent: Fixed a panic when serf_wan port was -1 but a reconnect_timeout_wan value was set. [GH-4515]
  • agent: Fixed a problem where errors regarding DNS server creation where never shown. [GH-4578]
  • agent: Start with invalid http configuration again, even though the build-in proxy for connect won't start in that case. [GH-4655]
  • catalog: Allow renaming nodes with IDs. [GH-3974],[GH-4413],[GH-4415]
  • dns: Fixes a bug with the DNS recursor, where we would not move onto the next provided recursor if we encounter a SERVFAIL or REFUSED status. [GH-4461]
  • server: Fixed a memory leak in blocking queries against /event/list. [GH-4482]
  • server: Fixed an issue where autopilot health checking could mistakenly mark healthy servers as failed, causing a non-voting server to be promoted unnecessarily. [GH-4528]
  • snapshot: Fixed a bug where node metadata wasn't being included in or restored from the snapshots. [GH-4524]
  • connect: Fixed a bug where managed proxy instances registered for instances with different name and ID and with restrictive ACL would not be allowed. [GH-4619]
  • connect: Fixed a bug where built-in CA state was not correctly restored from a snapshot [GH-4535]
  • connect: Fixed a bug where Checks with deregister_critical_service_after would deregister the service but not remove the managed proxy [GH-4649]
  • connect: Fixed a bug that would output an error about pruning CAs every hour on the leader and might cause some CA configurations not to be pruned correctly [GH-4669]
  • raft: Update raft vendoring to pull in a fix for a potential memory leak. [GH-4539]
  • license: (Consul Enterprise) Fix an issue with the license not being reloaded from snapshots.
  • license: (Consul Enterprise) Fix an issue with encoding/decoding of the license package type from the /v1/operator/license endpoint.
  • cli: Correctly exit with error code 1 when failing to list DCs with the catalog command [GH-4583]
  • ui: Improve layout on screens of a large portrait orientation [GH-4564]
  • ui: Various browser layout bugs for various vendors/setups [GH-4608] [GH-4613] [GH-4615]

1.2.2 (July 30, 2018)

SECURITY:

  • acl: Fixed an issue where writes operations on the Keyring and Operator were being allowed with a default allow policy even when explicitly denied in the policy. [GH-4378]

FEATURES:

  • Alias Checks: Alias checks allow a service or node to alias the health status of another service or node in the cluster. [PR-4320]
  • agent: New Cloud Auto-join providers: vSphere and Packet.net. [GH-4412]
  • cli: Added -serf-wan-port, -serf-lan-port, and -server-port flags to CLI for cases where these can't be specified in config files and -hcl is too cumbersome. [GH-4353]
  • connect: The TTL of leaf (service) certificates in Connect is now configurable. [GH-4400]

IMPROVEMENTS:

  • proxy: With -register flag, heartbeat failures will only log once service registration succeeds. [GH-4314]
  • http: 1.0.3 introduced rejection of non-printable chars in HTTP URLs due to a security vulnerability. Some users who had keys written with an older version which are now dissallowed were unable to delete them. A new config option disable_http_unprintable_char_filter is added to allow those users to remove the offending keys. Leaving this new option set long term is strongly discouraged as it bypasses filtering necessary to prevent some known vulnerabilities. [GH-4442]
  • agent: Allow for advanced configuration of some gossip related parameters. [GH-4058]
  • agent: Make some Gossip tuneables configurable via the config file [GH-4444]
  • ui: Included searching on .Tags when using the freetext search field. [GH-4383]
  • ui: Service.ID's are now shown in the Service detail page and (only if it is different from the service name) the Node Detail > [Services] tab. [GH-4387]

BUG FIXES:

  • acl/connect: Fix an issue that was causing managed proxies not to work when ACLs were enabled. [GH-4441]
  • connect: Fix issue with managed proxies and watches attempting to use a client addr that is 0.0.0.0 or :: [GH-4403]
  • connect: Allow Native and Unmanaged proxy configurations via config file [GH-4443]
  • connect: Fix bug causing 100% CPU on agent when Connect is disabled but a proxy is still running [GH-4421]
  • proxy: Don't restart proxies setup in a config file when Consul restarts [GH-4407]
  • ui: Display the Service.IP address instead of the Node.IP address in the Service detail view. [GH-4410]
  • ui: Watch for trailing slash stripping 301 redirects and forward the user to the correct location. [GH-4373]
  • connect: Fixed an issue in the connect native HTTP client where it failed to resolve service names. [GH-4392]

1.2.1 (July 12, 2018)

IMPROVEMENTS:

  • acl: Prevented multiple ACL token refresh operations from occurring simultaneously. [GH-3524]
  • acl: Add async-cache down policy mode to always do ACL token refreshes in the background to reduce latency. [GH-3524]
  • proxy: Pass through HTTP client env vars to managed proxies so that they can connect back to Consul over HTTPs when not serving HTTP. [PR-4374]
  • connect: Persist intermediate CAs on leader change. [PR-4379]

BUG FIXES:

  • api: Intention APIs parse error response body for error message. [GH-4297]
  • agent: Intention read endpoint returns a 400 on invalid UUID [GH-4297]
  • agent: Service registration with "services" does not error on Connect upstream configuration. [GH-4308]
  • dns: Ensure that TXT RRs dont get put in the Answer section for A/AAAA queries. [GH-4354]
  • dns: Ensure that only 1 CNAME is returned when querying for services that have non-IP service addresses. [PR-4328]
  • api: Fixed issue where Lock and Semaphore would return earlier than their requested timeout when unable to acquire the lock. [GH-4003], [GH-3262], [GH-2399]
  • watch: Fix issue with HTTPs only agents not executing watches properly [GH-4358]
  • agent: Managed proxies that bind to 0.0.0.0 now get a health check on a reasonable IP [GH-4301]
  • server: (Consul Enterprise) Fixed an issue causing Consul to panic when network areas were used
  • license: (Consul Enterprise) Fixed an issue causing the snapshot agent to log erroneous licensing errors

1.2.0 (June 26, 2018)

FEATURES:

  • Connect Feature Beta: This version includes a major new feature for Consul named Connect. Connect enables secure service-to-service communication with automatic TLS encryption and identity-based authorization. For more details and links to demos and getting started guides, see the announcement blog post.
    • Connect must be enabled explicitly in configuration so upgrading a cluster will not affect any existing functionality until it's enabled.
    • This is a Beta feature, we don't recommend enabling this in production yet. Please see the documentation for more information.
  • dns: Enable PTR record lookups for services with IPs that have no registered node [PR-4083]
  • ui: Default to serving the new UI. Setting the CONSUL_UI_LEGACY environment variable to 1 or true will revert to serving the old UI

IMPROVEMENTS:

  • agent: A Consul user-agent string is now sent to providers when making retry-join requests [GH-4013]
  • client: Add metrics for failed RPCs PR-4220
  • agent: Add configuration entry to control including TXT records for node meta in DNS responses PR-4215
  • client: Make RPC rate limit configuration reloadable [GH-4012]

BUG FIXES:

  • agent: Fixed an issue where watches were being duplicated on reload. [GH-4179]
  • agent: Fixed an issue with Agent watches on a HTTPS only agent would fail to use TLS. [GH-4076]
  • agent: Fixed bug that would cause unnecessary and frequent logging yamux keepalives [GH-3040]
  • dns: Re-enable full DNS compression [GH-4071]

1.1.1 (November 27, 2018)

SECURITY:

1.1.0 (May 11, 2018)

FEATURES:

  • UI: The web UI has been completely redesigned and rebuilt and is in an opt-in beta period. Setting the CONSUL_UI_BETA environment variable to 1 or true will replace the existing UI with the new one. The existing UI will be deprecated and removed in a future release. [GH-4086]
  • api: Added support for Prometheus client format in metrics endpoint with ?format=prometheus (see docs) [GH-4014]
  • agent: New Cloud Auto-join provider: Joyent Triton. [GH-4108]
  • agent: (Consul Enterprise) Implemented license management with license propagation within a datacenter.

BREAKING CHANGES:

  • agent: The following previously deprecated fields and config options have been removed [GH-4097]:
    • CheckID has been removed from config file check definitions (use id instead).
    • script has been removed from config file check definitions (use args instead).
    • enableTagOverride is no longer valid in service definitions (use enable_tag_override instead).
    • The deprecated set of metric names (beginning with consul.consul.) has been removed along with the enable_deprecated_names option from the metrics configuration.

IMPROVEMENTS:

  • agent: Improve DNS performance on large clusters [GH-4036]
  • agent: start_join, start_join_wan, retry_join, retry_join_wan config params now all support go-sockaddr templates [GH-4102]
  • server: Added new configuration options raft_snapshot_interval and raft_snapshot_threshold to allow operators to configure how often servers take raft snapshots. The default values for these have been tuned for large and busy clusters with high write load. [GH-4105]

BUG FIXES:

  • agent: Only call signal.Notify once during agent startup [PR-4024]
  • agent: Add support for the new Service Meta field in agent config [GH-4045]
  • api: Add support for the new Service Meta field in API client [GH-4045]
  • agent: Updated serf library for two bug fixes - allow enough time for leave intents to propagate [GH-510] and preventing a deadlock [GH-507]
  • agent: When node-level checks (e.g. maintenance mode) were deleted, some watchers currently in between blocking calls may have missed the change in index. See [GH-3970]

1.0.8 (November 27, 2018)

SECURITY:

1.0.7 (April 13, 2018)

IMPROVEMENTS:

  • build: Bumped Go version to 1.10 [GH-3988]
  • agent: Blocking queries on service-specific health and catalog endpoints now return a per-service X-Consul-Index improving watch performance on very busy clusters. [GH-3890]. Note this may break blocking clients that relied on undocumented implementation details as noted in the upgrade docs.
  • agent: All endpoints now respond to OPTIONS requests. [GH-3885]
  • agent: List of supported TLS cipher suites updated to include newer options, [GH-3962]
  • agent: WAN federation can now be disabled by setting the serf WAN port to -1. [GH-3984]
  • agent: Added support for specifying metadata during service registration. [GH-3881]
  • agent: Added a new discover-max-stale config option to enable stale requests for service discovery endpoints. [GH-4004]
  • agent: (Consul Enterprise) Added a new option to the snapshot agent for configuring the S3 endpoint.
  • dns: Introduced a new config param to limit the number of A/AAAA records returned. [GH-3940]
  • dns: Upgrade vendored DNS library to pick up bugfixes and improvements. [GH-3978]
  • server: Updated yamux library to pick up a performance improvement. [GH-3982]
  • server: Add near=_ip support for prepared queries [GH-3798]
  • api: Add support for GZIP compression in HTTP responses. [GH-3687]
  • api: Add IgnoreCheckIDs to Prepared Query definition to allow temporarily bypassing faulty health checks [GH-3727]

BUG FIXES:

  • agent: Fixed an issue where the coordinate update endpoint was not correctly parsing the ACL token. [GH-3892]
  • agent: Fixed an issue where consul monitor couldn't be terminated until the first log line is delivered [GH-3891]
  • agent: Added warnings for when a node name isn't a valid DNS name and when the node name, a service name or service tags would exceed the allowed lengths for DNS names [GH-3854]
  • agent: Added truncation of TCP DNS responses to prevent errors for exceeding message size limits [GH-3850]
  • agent: Added -config-format flag to validate command to specify the syntax that should be used for parsing the config [GH-3996]
  • agent: HTTP Checks now report the HTTP method used instead of always reporting as a GET
  • server: Fixed an issue where the leader could miss clean up after a leadership transition. [GH-3909]

1.0.6 (February 9, 2018)

BUG FIXES:

  • agent: Fixed a panic when using the Azure provider for retry-join. [GH-3875]
  • agent: Fixed a panic when querying Consul's DNS interface over TCP. [GH-3877]

1.0.5 (February 7, 2018)

NOTE ON SKIPPED RELEASE 1.0.4:

We found [GH-3867] after cutting the 1.0.4 release and pushing the 1.0.4 release tag, so we decided to scuttle that release and push 1.0.5 instead with a fix for that issue.

SECURITY:

  • dns: Updated DNS vendor library to pick up bug fix in the DNS server where an open idle connection blocks the accept loop. [GH-3859]

FEATURES:

  • agent: Added support for gRPC health checks that probe the standard gRPC health endpoint. [GH-3073]

IMPROVEMENTS:

  • agent: (Consul Enterprise) The disable_update_check option to disable Checkpoint now defaults to true (this is only in the Enterprise version).
  • build: Bumped Go version to 1.9.3. [GH-3837]

BUG FIXES:

  • agent: (Consul Enterprise) Fixed an issue where the snapshot agent's HTTP client config was being ignored in favor of the HTTP command-line flags.
  • agent: Fixed an issue where health checks added to services with tags would cause extra periodic writes to the Consul servers, even if nothing had changed. This could cause extra churn on downstream applications like consul-template or Fabio. [GH-3845]
  • agent: Fixed several areas where reading from catalog, health, or agent HTTP endpoints could make unintended mofidications to Consul's state in a way that would cause unnecessary anti-entropy syncs back to the Consul servers. This could cause extra churn on downstream applications like consul-template or Fabio. [GH-3867]
  • agent: Fixed an issue where Serf events for failed Consul servers weren't being proactively processed by the RPC router. This would prvent Consul from proactively choosing a new server, and would instead wait for a failed RPC request before choosing a new server. This exposed clients to a failed request, when often the proactive switching would avoid that. [GH-3864]

1.0.4 (February 6, 2018)

SECURITY:

  • dns: Updated DNS vendor library to pick up bug fix in the DNS server where an open idle connection blocks the accept loop. [GH-3859]

FEATURES:

  • agent: Added support for gRPC health checks that probe the standard gRPC health endpoint. [GH-3073]

IMPROVEMENTS:

  • agent: (Consul Enterprise) The disable_update_check option to disable Checkpoint now defaults to true (this is only in the Enterprise version).
  • build: Bumped Go version to 1.9.3. [GH-3837]

BUG FIXES:

  • agent: (Consul Enterprise) Fixed an issue where the snapshot agent's HTTP client config was being ignored in favor of the HTTP command-line flags.
  • agent: Fixed an issue where health checks added to services with tags would cause extra periodic writes to the Consul servers, even if nothing had changed. This could cause extra churn on downstream applications like consul-template or Fabio. [GH-3845]
  • agent: Fixed an issue where Serf events for failed Consul servers weren't being proactively processed by the RPC router. This would prvent Consul from proactively choosing a new server, and would instead wait for a failed RPC request before choosing a new server. This exposed clients to a failed request, when often the proactive switching would avoid that. [GH-3864]

1.0.3 (January 24, 2018)

SECURITY:

  • ui: Patched handlebars JS to escape = to prevent potential XSS issues. [GH-3733]

BREAKING CHANGES:

  • agent: Updated Consul's HTTP server to ban all URLs containing non-printable characters (a bad request status will be returned for these cases). This affects some user-facing areas like key/value entry key names which are carried in URLs. [GH-3762]

FEATURES:

  • agent: Added retry-join support for Azure Virtual Machine Scale Sets. [GH-3824]

IMPROVEMENTS:

  • agent: Added agent-side telemetry around Catalog APIs to provide insight on Consul's operation from the user's perspecive. [GH-3765]
  • agent: Added the NodeID field back to the /v1/agent/self endpoint's Config block. [GH-3778]
  • api: Added missing CheckID and Name fields to API client's AgentServiceCheck structure so that IDs and names can be set when registering checks with services. [GH-3788]

BUG FIXES:

  • agent: Fixed an issue where config file symlinks were not being interpreted correctly. [GH-3753]
  • agent: Ignore malformed leftover service/check files and warn about them instead of refusing to start. [GH-1221]
  • agent: Enforce a valid port for the Serf WAN since it can't be disabled. [GH-3817]
  • agent: Stopped looging messages about zero RTTs when updating network coordinates since they are not harmful to the algorithm. Since we are still trying to find the root cause of these zero measurements, we added new metrics counters so these are still observable. [GH-3789]
  • server: Fixed a crash when POST-ing an empty body to the /v1/query endpoint. [GH-3791]
  • server: (Consul Enterprise) Fixed an issue where unhealthy servers were not replaced in a redundancy zone by autopilot (servers previously needed to be removed in order for a replacement to occur).
  • ui: Added a URI escape around key/value keys so that it's not possible to create unexpected partial key names when entering characters like ? inside a key. [GH-3760]

1.0.2 (December 15, 2017)

IMPROVEMENTS:

  • agent: Updated Serf to activate a new feature that resizes its internal message broadcast queue size based on the cluster size. This helps control the amount of memory used by the agent, but prevents spurious warnings about dropped messages in very large Consul clusters. The intent queue warnings have also been disabled since queue telemetry was already available and a simple fixed limit isn't applicable to all clusters, so it could cause a high rate of warnings about intent queue depth that were not useful or indicative of an actual issue. [GH-3705]
  • agent: Updates posener/complete library to 1.0, which allows autocomplete for flags after an equal sign, and simplifies autocomplete functions. [GH-3646]

BUG FIXES:

  • agent: Updated memberlist to pull in a fix for negative RTT measurements and their associated log messages about rejected coordinates. [GH-3704]
  • agent: Fixed an issue where node metadata specified via command line arguments overrode node metadata specified by configuration files, instead of merging as was done in versions of Consul prior to 1.0. [GH-3716]
  • agent: Fixed an issue with the /v1/session/create API where it wasn't possible to create a session without the serfHealth check. This is now possible again by including the checks key in the JSON body with an empty list. [GH-3732]
  • agent: Fixed an issue with anti-entropy syncing where checks for services with tags would cause periodic updates to the catalog, even when nothing had changed, causing the Raft index to grow slowly (~2 minutes per node per check) over time, and causing unnecessary writes and wake ups for blocking queries. [GH-3642], [GH-3259]
  • cli: Added missing support for -base64 option to consul kv get command. [GH-3736]
  • server: Fixed an issue with KV store tombstone tracking where bin tracking was being confused by monotonic time information carried in time stamps, resulting in many unnecessary bins. [GH-3670]
  • server: (Consul Enterprise) Fixed an issue with Network Segments where servers would not properly flood-join each other into all segments.
  • server: Fixed an issue where it wasn't possible to disable Autopilot's dead server cleanup behavior using configuration files. [GH-3730]
  • server: Removed the 60 second timeout when restoring snapshots, which could cause large restores to fail on slower servers. [GH-3326]
  • server: Fixed a goroutine leak during keyring operations when errors are encountered. [GH-3728]

1.0.1 (November 20, 2017)

FEATURES:

  • New Auto Join Cloud Providers: Retry join support was added for Aliyun (Alibaba Cloud), Digital Ocean, OpenStack, and Scaleway. Instance metadata can be used with these to make it easy to form Consul clusters. [GH-3634]
  • HTTP/2 Support: If TLS is enabled on a Consul agent it will automatically negotiate to use HTTP/2 for suitably configured clients accessing the client API. This allows clients to multiplex requests over the same TCP connection, such as multiple, simultaneous blocking queries. [GH-3657]

IMPROVEMENTS:

  • agent: (Consul Enterprise) Added AWS KMS support for S3 snapshots using the snapshot agent.
  • agent: Watches in the Consul agent can now be configured to invoke an HTTP endpoint instead of an executable. [GH-3305]
  • agent: Added a new -config-format command line option which can be set to hcl or json to specify the format of configuration files. This is useful for cases where the file name cannot be controlled in order to provide the required extension. [GH-3620]
  • agent: DNS recursors can now be specified as go-sockaddr templates. [GH-2932]
  • agent: Serf snapshots no longer save network coordinate information. This enables recovery from errors upon agent restart. [GH-489]
  • agent: Added defensive code to prevent out of range ping times from infecting network coordinates. Updates to the coordinate system with negative round trip times or round trip times higher than 10 seconds will log an error but will be ignored.
  • agent: The agent now warns when there are extra unparsed command line arguments and refuses to start. [GH-3397]
  • agent: Updated go-sockaddr library to get CoreOS route detection fixes and the new mask functionality. [GH-3633]
  • agent: Added a new enable_agent_tls_for_checks configuration option that allows HTTP health checks for services requiring 2-way TLS to be checked using the agent's credentials. [GH-3364]
  • agent: Made logging of health check status more uniform and moved log entries with full check output from DEBUG to TRACE level for less noise. [GH-3683]
  • build: Consul is now built with Go 1.9.2. [GH-3663]

BUG FIXES:

  • agent: Consul 1.0 shipped with an issue where Args was erroneously named ScriptArgs for health check definitions in the /v1/agent/check/register and /v1/agent/service/register APIs. Added code to accept Args so that the JSON format matches that of health checks in configuration files. The ScriptArgs form will still be supported for backwards compatibility. [GH-3587]
  • agent: Docker container checks running on Linux could get into a flapping state because the Docker agent seems to close the connection prematurely even though the body is transferred. This caused a "connection reset by peer" error which put the check into critical state. As of Consul 1.0.1 the "connection reset by peer" error is ignored for the /exec/<execID>/start command of the Docker API. [GH-3576]
  • agent: Added new form of consul.http.* metrics that were accidentally left out of Consul 1.0. [GH-3654]
  • agent: Fixed an issue with the server manager where periodic server client connection rebalancing could select a failed server. This affects agents in client mode, as well as servers talking to other servers, including over the WAN. [GH-3463]
  • agent: IPv6 addresses without port numbers and without surrounding brackets are now properly handled for joins. This affects all join types, but in particular this was discovered with AWS joins where the APIs return addresses formatted this way. [GH-3671]
  • agent: Fixed a rare startup panic of the Consul agent related to the LAN Serf instance ordering with the router manager. [GH-3680]
  • agent: Added back an exception for the snapshot_agent config key so that those configs can again live alongside Consul's configs. [GH-3678]
  • dns: Fixed an issue were components of a host name near the datacenter could be quietly ignored (eg. foo.service.dc1.extra.consul would silently ignore .extra); now an NXDOMAIN error will be returned. [GH-3200]
  • server: Fixed an issue where performing rolling updates of Consul servers could result in an outage from old servers remaining in the cluster. Consul's Autopilot would normally remove old servers when new ones come online, but it was also waiting to promote servers to voters in pairs to maintain an odd quorum size. The pairwise promotion feature was removed so that servers become voters as soon as they are stable, allowing Autopilot to remove old servers in a safer way. When upgrading from Consul 1.0, you may need to manually force-leave old servers as part of a rolling update to Consul 1.0.1. [GH-3611]
  • server: Fixed a deadlock where tombstone garbage collection for the KV store could block other KV operations, stalling writes on the leader. [GH-3700]

1.0.0 (October 16, 2017)

SECURITY:

  • ui: Fixed an XSS issue with Consul's built-in web UI where node names were not being properly escaped. [GH-3578]

BREAKING CHANGES:

  • Raft Protocol Now Defaults to 3: The -raft-protocol default has been changed from 2 to 3, enabling all Autopilot features by default. Version 3 requires Consul running 0.8.0 or newer on all servers in order to work, so if you are upgrading with older servers in a cluster then you will need to set this back to 2 in order to upgrade. See Raft Protocol Version Compatibility for more details. Also the format of peers.json used for outage recovery is different when running with the lastest Raft protocol. See Manual Recovery Using peers.json for a description of the required format. [GH-3477]

  • Config Files Require an Extension: As part of supporting the HCL format for Consul's config files, an .hcl or .json extension is required for all config files loaded by Consul, even when using the -config-file argument to specify a file directly. [GH-3480]

  • Deprecated Options Have Been Removed: All of Consul's previously deprecated command line flags and config options have been removed, so these will need to be mapped to their equivalents before upgrading. [GH-3480]

    Detailed List of Removed Options and their Equivalents
    Removed Option Equivalent
    -atlas None, Atlas is no longer supported.
    -atlas-token None, Atlas is no longer supported.
    -atlas-join None, Atlas is no longer supported.
    -atlas-endpoint None, Atlas is no longer supported.
    -dc -datacenter
    -retry-join-azure-tag-name -retry-join
    -retry-join-azure-tag-value -retry-join
    -retry-join-ec2-region -retry-join
    -retry-join-ec2-tag-key -retry-join
    -retry-join-ec2-tag-value -retry-join
    -retry-join-gce-credentials-file -retry-join
    -retry-join-gce-project-name -retry-join
    -retry-join-gce-tag-name -retry-join
    -retry-join-gce-zone-pattern -retry-join
    addresses.rpc None, the RPC server for CLI commands is no longer supported.
    advertise_addrs ports with advertise_addr and/or advertise_addr_wan
    atlas_infrastructure None, Atlas is no longer supported.
    atlas_token None, Atlas is no longer supported.
    atlas_acl_token None, Atlas is no longer supported.
    atlas_join None, Atlas is no longer supported.
    atlas_endpoint None, Atlas is no longer supported.
    dogstatsd_addr telemetry.dogstatsd_addr
    dogstatsd_tags telemetry.dogstatsd_tags
    http_api_response_headers http_config.response_headers
    ports.rpc None, the RPC server for CLI commands is no longer supported.
    recursor recursors
    retry_join_azure -retry-join
    retry_join_ec2 -retry-join
    retry_join_gce -retry-join
    statsd_addr telemetry.statsd_address
    statsite_addr telemetry.statsite_address
    statsite_prefix telemetry.metrics_prefix
    telemetry.statsite_prefix telemetry.metrics_prefix
    (service definitions) serviceid service_id
    (service definitions) dockercontainerid docker_container_id
    (service definitions) tlsskipverify tls_skip_verify
    (service definitions) deregistercriticalserviceafter deregister_critical_service_after

  • statsite_prefix Renamed to metrics_prefix: Since the statsite_prefix configuration option applied to all telemetry providers, statsite_prefix was renamed to metrics_prefix. Configuration files will need to be updated when upgrading to this version of Consul. [GH-3498]

  • advertise_addrs Removed: This configuration option was removed since it was redundant with advertise_addr and advertise_addr_wan in combination with ports and also wrongly stated that you could configure both host and port. [GH-3516]

  • Escaping Behavior Changed for go-discover Configs: The format for -retry-join and -retry-join-wan values that use go-discover Cloud auto joining has changed. Values in key=val sequences must no longer be URL encoded and can be provided as literals as long as they do not contain spaces, backslashes \ or double quotes ". If values contain these characters then use double quotes as in "some key"="some value". Special characters within a double quoted string can be escaped with a backslash \. [GH-3417]

  • HTTP Verbs are Enforced in Many HTTP APIs: Many endpoints in the HTTP API that previously took any HTTP verb now check for specific HTTP verbs and enforce them. This may break clients relying on the old behavior. [GH-3405]

    Detailed List of Updated Endpoints and Required HTTP Verbs
    Endpoint Required HTTP Verb
    /v1/acl/info GET
    /v1/acl/list GET
    /v1/acl/replication GET
    /v1/agent/check/deregister PUT
    /v1/agent/check/fail PUT
    /v1/agent/check/pass PUT
    /v1/agent/check/register PUT
    /v1/agent/check/warn PUT
    /v1/agent/checks GET
    /v1/agent/force-leave PUT
    /v1/agent/join PUT
    /v1/agent/members GET
    /v1/agent/metrics GET
    /v1/agent/self GET
    /v1/agent/service/register PUT
    /v1/agent/service/deregister PUT
    /v1/agent/services GET
    /v1/catalog/datacenters GET
    /v1/catalog/deregister PUT
    /v1/catalog/node GET
    /v1/catalog/nodes GET
    /v1/catalog/register PUT
    /v1/catalog/service GET
    /v1/catalog/services GET
    /v1/coordinate/datacenters GET
    /v1/coordinate/nodes GET
    /v1/health/checks GET
    /v1/health/node GET
    /v1/health/service GET
    /v1/health/state GET
    /v1/internal/ui/node GET
    /v1/internal/ui/nodes GET
    /v1/internal/ui/services GET
    /v1/session/info GET
    /v1/session/list GET
    /v1/session/node GET
    /v1/status/leader GET
    /v1/status/peers GET
    /v1/operator/area/:uuid/members GET
    /v1/operator/area/:uuid/join PUT

  • Unauthorized KV Requests Return 403: When ACLs are enabled, reading a key with an unauthorized token returns a 403. This previously returned a 404 response.

  • Config Section of Agent Self Endpoint has Changed: The /v1/agent/self endpoint's Config section has often been in flux as it was directly returning one of Consul's internal data structures. This configuration structure has been moved under DebugConfig, and is documents as for debugging use and subject to change, and a small set of elements of Config have been maintained and documented. See Read Configuration endpoint documentation for details. [GH-3532]

  • Deprecated configtest Command Removed: The configtest command was deprecated and has been superseded by the validate command.

  • Undocumented Flags in validate Command Removed: The validate command supported the -config-file and -config-dir command line flags but did not document them. This support has been removed since the flags are not required.

  • Metric Names Updated: Metric names no longer start with consul.consul. To help with transitioning dashboards and other metric consumers, the field enable_deprecated_names has been added to the telemetry section of the config, which will enable metrics with the old naming scheme to be sent alongside the new ones. [GH-3535]

    Detailed List of Affected Metrics by Prefix
    Prefix
    consul.consul.acl
    consul.consul.autopilot
    consul.consul.catalog
    consul.consul.fsm
    consul.consul.health
    consul.consul.http
    consul.consul.kvs
    consul.consul.leader
    consul.consul.prepared-query
    consul.consul.rpc
    consul.consul.session
    consul.consul.session_ttl
    consul.consul.txn

  • Checks Validated On Agent Startup: Consul agents now validate health check definitions in their configuration and will fail at startup if any checks are invalid. In previous versions of Consul, invalid health checks would get skipped. [GH-3559]

FEATURES:

  • Support for HCL Config Files: Consul now supports HashiCorp's HCL format for config files. This is easier to work with than JSON and supports comments. As part of this change, all config files will need to have either an .hcl or .json extension in order to specify their format. [GH-3480]
  • Support for Binding to Multiple Addresses: Consul now supports binding to multiple addresses for its HTTP, HTTPS, and DNS services. You can provide a space-separated list of addresses to -client and addresses configurations, or specify a go-sockaddr template that resolves to multiple addresses. [GH-3480]
  • Support for RFC1464 DNS TXT records: Consul DNS responses now contain the node meta data encoded according to RFC1464 as TXT records. [GH-3343]
  • Support for Running Subproccesses Directly Without a Shell: Consul agent checks and watches now support an args configuration which is a list of arguments to run for the subprocess, which runs the subprocess directly without a shell. The old script and handler configurations are now deprecated (specify a shell explicitly if you require one). A -shell=false option is also available on consul lock, consul watch, and consul exec to run the subprocesses associated with those without a shell. [GH-3509]
  • Sentinel Integration: (Consul Enterprise) Consul's ACL system integrates with Sentinel to enable code policies that apply to KV writes.

IMPROVEMENTS:

  • agent: Added support to detect public IPv4 and IPv6 addresses on AWS. [GH-3471]
  • agent: Improved /v1/operator/raft/configuration endpoint which allows Consul to avoid an extra agent RPC call for the consul operator raft list-peers command. [GH-3449]
  • agent: Improved ACL system for the KV store to support list permissions. This behavior can be opted in. For more information, see the ACL Guide. [GH-3511]
  • agent: Updates miekg/dns library to later version to pick up bug fixes and improvements. [GH-3547]
  • agent: Added automatic retries to the RPC path, and a brief RPC drain time when servers leave. These changes make Consul more robust during graceful leaves of Consul servers, such as during upgrades, and help shield applications from "no leader" errors. These are configured with new performance options. [GH-3514]
  • agent: Added a new discard_check_output agent-level configuration option that can be used to trade off write load to the Consul servers vs. visibility of health check output. This is reloadable so it can be toggled without fully restarting the agent. [GH-3562]
  • api: Updated the API client to ride out network errors when monitoring locks and semaphores. [GH-3553]
  • build: Updated Go toolchain to version 1.9.1. [GH-3537]
  • cli: consul lock and consul watch commands will forward TERM and KILL signals to their child subprocess. [GH-3509]
  • cli: Added support for autocompletion. [GH-3412]
  • server: Updated BoltDB to final version 1.3.1. [GH-3502]
  • server: Improved dead member reap algorithm to fix edge cases where servers could get left behind. [GH-3452]

BUG FIXES:

  • agent: Fixed an issue where disabling both the http and https interfaces would cause a watch-related error on agent startup, even when no watches were defined. [GH-3425]
  • agent: Added an additional step to kill health check scripts that timeout on all platforms except Windows, and added a wait so that it's not possible to run multiple instances of the same health check script at the same time. [GH-3565]
  • cli: If the consul operator raft list-peers command encounters an error it will now exit with a non-zero exit code. [GH-3513]
  • cli: CLI commands will now show help for all of their arguments. [GH-3536]
  • server: Fixed an issue where the leader server could get into a state where it was no longer performing the periodic leader loop duties and unable to serve consistent reads after a barrier timeout error. [GH-3545]

0.9.4 (November 27, 2018)

SECURITY:

0.9.3 (September 8, 2017)

FEATURES:

  • LAN Network Segments: (Consul Enterprise) Added a new Network Segments capability which allows users to configure Consul to support segmented LAN topologies with multiple, distinct gossip pools. [GH-3431]
  • WAN Join for Cloud Providers: Added WAN support for retry join for Cloud providers via go-discover, including Amazon AWS, Microsoft Azure, Google Cloud, and SoftLayer. This uses the same "provider" syntax supported for -retry-join via the -retry-join-wan configuration. [GH-3406]
  • RPC Rate Limiter: Consul agents in client mode have a new limits configuration that enables a rate limit on RPC calls the agent makes to Consul servers. [GH-3140]

IMPROVEMENTS:

  • agent: Switched to using a read lock for the agent's RPC dispatcher, which prevents RPC calls from getting serialized. [GH-3376]
  • agent: When joining a cluster, Consul now skips the unique node ID constraint for Consul members running Consul older than 0.8.5. This makes it easier to upgrade to newer versions of Consul in an existing cluster with non-unique node IDs. [GH-3070]
  • build: Upgraded Go version to 1.9. [GH-3428]
  • server: Consul servers can re-establish quorum after all of them change their IP addresses upon a restart. [GH-1580]
  • ui: Changed text area font family to monospace to make it easier to manage complex text blocks. [GH-3521]

BUG FIXES:

  • agent: Fixed an issue with consul watches not triggering when ACLs are enabled. [GH-3392]
  • agent: Updated memberlist library for a deadlock fix. [GH-3396]
  • agent: Fixed a panic when retrieving NS or SOA records on Consul clients (non-servers). This also changed the Consul server list to come from the catalog and not the agent's local state when serving these requests, so the results are consistent across a cluster. [GH-3407]
  • cli: Updated the CLI library to pull in a fix that prevents all subcommands from being shown when showing the agent's usage list; now just top-level commands are shown. [GH-3448]
  • server: Fixed an issue with Consul snapshots not saving on Windows because of errors with the fsync syscall. [GH-3409]

0.9.2 (August 9, 2017)

BUG FIXES:

  • agent: Fixed an issue where the old -retry-join-{ec2,azure,gce} command line flags were not being honored. [GH-3384]
  • server: Reverted the change that made unauthorized KV queries return 403 instead of 404 because it had a minor bug that affected the operation of Vault, and in addition to fixing the bug, we identified an additional case that needed to be covered. This restores the <= 0.9.0 behavior until we can get a complete fix. [GH-2637]

0.9.1 (August 9, 2017)

FEATURES:

  • Secure ACL Token Introduction: It's now possible to manage Consul's ACL tokens without having to place any tokens inside configuration files. This supports introduction of tokens as well as rotating. This is enabled with two new APIs:
    • A new /v1/agent/token API allows an agent's ACL tokens to be introduced without placing them into config files, and to update them without restarting the agent. See the ACL Guide for an example. This was extended to ACL replication as well, along with a new enable_acl_replication config option. [GH-3324,GH-3357]
    • A new /v1/acl/bootstrap allows a cluster's first management token to be created without using the acl_master_token configuration. See the ACL Guide for an example. [GH-3349]
  • Metrics Viewing Endpoint: A new /v1/agent/metrics API displays the current values of internally tracked metrics. [GH-3369]

IMPROVEMENTS:

  • agent: Retry Join for Amazon AWS, Microsoft Azure, Google Cloud, and (new) SoftLayer is now handled through the https://github.com/hashicorp/go-discover library. With this all -retry-join-{ec2,azure,gce}-* parameters have been deprecated in favor of a unified configuration. See -retry-join for details. [GH-3282,GH-3351]
  • agent: Reports a more detailed error message if the LAN or WAN Serf instance fails to bind to an address. [GH-3312]
  • agent: Added NS records and corrected SOA records to allow Consul's DNS interface to work properly with zone delegation. [GH-1301]
  • agent: Added support for sending metrics with labels/tags to supported backends. [GH-3369]
  • agent: Added a new prefix_filter option in the telemetry config to allow fine-grained allowing/blocking the sending of certain metrics by prefix. [GH-3369]
  • cli: Added a -child-exit-code option to consul lock so that it propagates an error code of 2 if the child process exits with an error. [GH-947]
  • docs: Added a new Geo Failover Guide showing how to use prepared queries to implement geo failover policies for services. [GH-3328]
  • docs: Added a new Consul with Containers Guide showing critical aspects of operating a Consul cluster that's run inside containers. [GH-3347]
  • server: Added a RemoveEmptyTags option to prepared query templates which will strip out any empty strings in the tags list before executing a query. This is useful when interpolating into tags in a way where the tag is optional, and where searching for an empty tag would yield no results from the query. [GH-2151]
  • server: Implemented a much faster recursive delete algorithm for the KV store. It has been benchmarked to be up to 100X faster on recursive deletes that affect millions of keys. [GH-1278, GH-3313]

BUG FIXES:

  • agent: Clean up temporary files during disk write errors when persisting services and checks. [GH-3207]
  • agent: Fixed an issue where DNS and client bind address templates were not being parsed via the go-sockaddr library. [GH-3322]
  • agent: Fixed status code on all KV store operations that fail due to an ACL issue. They now return a 403 status code, rather than a 404. [GH-2637]
  • agent: Fixed quoting issues in script health check on Windows. [GH-1875]
  • agent: Fixed an issue where consul monitor would exit on any empty log line. [GH-3253]
  • server: Updated raft library to fix issue with machine crashes causing snapshot files to not get saved to disk [GH-3362]

0.9.0 (July 20, 2017)

BREAKING CHANGES:

  • agent: Added a new enable_script_checks configuration option that defaults to false, meaning that in order to allow an agent to run health checks that execute scripts, this will need to be configured and set to true. This provides a safer out-of-the-box configuration for Consul where operators must opt-in to allow script-based health checks. [GH-3087]
  • api: Reworked context support in the API client to more closely match the Go standard library, and added context support to write requests in addition to read requests. [GH-3273, GH-2992]
  • ui: Since the UI is now bundled with the application we no longer provide a separate UI package for downloading. [GH-3292]

FEATURES:

  • agent: Added a new block_endpoints configuration option that allows blocking HTTP API endpoints by prefix. This allows operators to completely disallow access to specific endpoints on a given agent. [GH-3252]
  • cli: Added a new consul catalog command for reading datacenters, nodes, and services from the catalog. [GH-3204]
  • server: (Consul Enterprise) Added a new consul operator area update command and corresponding HTTP endpoint to allow for transitioning the TLS setting of network areas at runtime. [GH-3075]
  • server: (Consul Enterprise) Added a new UpgradeVersionTag field to the Autopilot config to allow for using the migration feature to roll out configuration or cluster changes, without having to upgrade Consul itself.

IMPROVEMENTS:

  • agent: (Consul Enterprise) Snapshot agent rotation uses S3's pagination API, enabling retaining more than a 100 snapshots.
  • agent: Removed registration of the consul service from the agent since it's already handled by the leader. This means that Consul servers no longer need to have an acl_agent_token with write access to the consul service if ACLs are enabled. [GH-3248]
  • agent: Changed /v1/acl/clone response to 403 (from 404) when trying to clone an ACL that doesn't exist. [GH-1113]
  • agent: Changed the consul exec ACL resolution logic to use the acl_agent_token if it's available. This lets operators configure an acl_agent_token with the required write privilieges to the _rexec prefix of the KV store without giving this to the acl_token, which would expose those privileges to users as well. [GH-3160]
  • agent: Updated memberlist to get latest LAN gossip tuning based on the Lifeguard paper published by Hashicorp Research. [GH-3287]
  • api: Added the ability to pass in a context as part of the QueryOptions during a request. This provides a way to cancel outstanding blocking queries. [GH-3195]
  • api: Changed signature for "done" channels on agent.Monitor() and session.RenewPeriodic methods to make them more compatible with context. [GH-3271]
  • docs: Added a complete end-to-end example of ACL bootstrapping in the ACL Guide. [GH-3248]
  • vendor: Updated golang.org/x/sys/unix to support IBM s390 platforms. [GH-3240]
  • agent: rewrote Docker health checks without using the Docker client and its dependencies. [GH-3270]

BUG FIXES:

  • agent: Fixed an issue where watch plans would take up to 10 minutes to close their connections and give up their file descriptors after reloading Consul. [GH-3018]
  • agent: (Consul Enterprise) Fixed an issue with the snapshot agent where it could get stuck trying to obtain the leader lock after an extended server outage.
  • agent: Fixed HTTP health checks to allow them to set the Host header correctly on outgoing requests. [GH-3203]
  • agent: Serf snapshots can now auto recover from disk write errors without needing a restart. [GH-1744]
  • agent: Fixed log redacting code to properly remove tokens from log lines with ACL tokens in the URL itself: /v1/acl/clone/:uuid, /v1/acl/destroy/:uuid, /v1/acl/info/:uuid. [GH-3276]
  • agent: Fixed an issue in the Docker client where Docker checks would get EOF errors trying to connect to a volume-mounted Docker socket. [GH-3254]
  • agent: Fixed a crash when using Azure auto discovery. [GH-3193]
  • agent: Added node read privileges to the acl_agent_master_token by default so it can see all nodes, which enables it to be used with operations like consul members. [GH-3113]
  • agent: Fixed an issue where enabling -disable-keyring-file would cause gossip encryption to be disabled. [GH-3243]
  • agent: Fixed a race condition where checks that are not associated with any existing services were allowed to persist. [GH-3297]
  • agent: Stop docker checks on service deregistration and on shutdown. [GH-3265, GH-3295]
  • server: Updated the Raft library to pull in a fix where servers that are very far behind in replication can get stuck in a loop trying to install snapshots. [GH-3201]
  • server: Fixed a rare but serious deadlock where the Consul leader routine could get stuck with the Raft internal leader routine while waiting for the initial barrier after a leader election. [GH-3230]
  • server: Added automatic cleanup of failed Raft snapshots. [GH-3258]
  • server: (Consul Enterprise) Fixed an issue where networks areas would not be able to be added when the server restarts if the Raft log contained a specific sequence of adds and deletes for network areas with the same peer datacenter.
  • ui: Provided a path to reset the ACL token when the current token is invalid. Previously, the UI would get stuck on the error page and it wasn't possible to get back to the settings. [GH-2370]
  • ui: Removed an extra fetch of the nodes resource when loading the UI. [GH-3245]
  • ui: Changed default ACL token type to "client" when creating ACLs. [GH-3246]
  • ui: Display a 404 error instead of a 200 when trying to load a nonexistent node. [GH-3251]

0.8.5 (June 27, 2017)

BREAKING CHANGES:

  • agent: Parse values given to ?passing for health endpoints. Previously Consul only checked for the existence of the querystring, not the value. That means using ?passing=false would actually still include passing values. Consul now parses the value given to passing as a boolean. If no value is provided, the old behavior remains. This may be a breaking change for some users, but the old experience was incorrect and caused enough confusion to warrant changing it. [GH-2212, GH-3136]
  • agent: The default value of -disable-host-node-id has been changed from false to true. This means you need to opt-in to host-based node IDs and by default Consul will generate a random node ID. A high number of users struggled to deploy newer versions of Consul with host-based IDs because of various edge cases of how the host IDs work in Docker, on specially-provisioned machines, etc. so changing this from opt-out to opt-in will ease operations for many Consul users. [GH-3171]

IMPROVEMENTS:

  • agent: Added a -disable-keyring-file option to prevent writing keyring data to disk. [GH-3145]
  • agent: Added automatic notify to systemd on Linux after LAN join is complete, which makes it easier to order services that depend on Consul being available. [GH-2121]
  • agent: The http_api_response_headers config has been moved into a new http_config struct, so the old form is still supported but is deprecated. [GH-3142]
  • dns: Added support for EDNS(0) size adjustments if set in the request frame. This allows DNS responses via UDP which are larger than the standard 512 bytes max if the requesting client can support it. [GH-1980, GH-3131]
  • server: Added a startup warning for servers when expecting to bootstrap with an even number of nodes. [GH-1282]
  • agent: (Consul Enterprise) Added support for non rotating, statically named snapshots for S3 snapshots using the snapshot agent.

BUG FIXES:

  • agent: Fixed a regression where configuring -1 for the port was no longer disabling the DNS server. [GH-3135]
  • agent: Fix consul leave shutdown race. When shutting down an agent via the consul leave command on the command line the output would be EOF instead of Graceful leave completed [GH-2880]
  • agent: Show a better error message than 'EOF' when attempting to join with the wrong gossip key. [GH-1013]
  • agent: Fixed an issue where the Method and Header features of HTTP health checks were not being applied. [GH-3178]
  • agent: Fixed an issue where internally-configured watches were not working because of an incorrect protocol error, and unified internal watch handling during reloads of the Consul agent. [GH-3177]
  • server: Fixed an issue where the leader could return stale data duing queries as it is starting up. [GH-2644]

0.8.4 (June 9, 2017)

FEATURES:

IMPROVEMENTS:

  • agent: Added a check which prevents advertising or setting a service to a zero address (0.0.0.0, [::], ::). [GH-2961]
  • agent: Allow binding to any public IPv6 address with :: [GH-2285]
  • agent: Removed SCADA-related code for Atlas and deprecated all Atlas-related configuration options. [GH-3032]
  • agent: Added support for custom check id and name when registering checks along with a service. [GH-3047]
  • agent: Updated go-sockaddr library to add support for new helper functions in bind address templates (GetPrivateIPs, GetPublicIPs), new math functions, and to pick up fixes for issues with detecting addresses on multi-homed hosts. [GH-3068]
  • agent: Watches now reset their index back to zero after an error, or if the index goes backwards, which allows watches to recover after a server restart with fresh state. [GH-2621]
  • agent: HTTP health checks now support custom method and headers. [GH-1184], [GH-2474], [GH-2657], [GH-3106]
  • agent: Increased the graceful leave timeout from 5 to 15 seconds. [GH-3121]
  • agent: Added additional logging when the agent handles signals and when it exits. [GH-3124]
  • build: Added support for linux/arm64 binaries. [GH-3042]
  • build: Consul now builds with Go 1.8.3. [GH-3074]
  • ui: Added a sticky scroll to the KV side panel so the KV edit box always stays in place. [GH-2812]

BUG FIXES:

  • agent: Added defensive code to prevent agents from infecting the network coordinates with NaN or Inf values, and added code to clean up in environments where this has happened. [GH-3023]
  • api: Added code to always read from the body of a request so that connections will always be returned to the pool. [GH-2850]
  • build: Added a vendor fix to allow compilation on Illumos. [GH-3024]
  • cli: Fixed an issue where consul exec would return a 0 exit code, even when there were nodes that didn't respond. [GH-2757]

0.8.3 (May 12, 2017)

BUG FIXES:

  • agent: Fixed an issue where NAT-configured agents with a non-routable advertise address would refuse to make RPC connections to Consul servers. This was a regression related to GH-2822 in Consul 0.8.2. [GH-3028]

0.8.2 (May 9, 2017)

BREAKING CHANGES:

  • api: HttpClient now defaults to nil in the client config and will be generated if left blank. A NewHttpClient function has been added for creating an HttpClient with a custom Transport or TLS config. [GH-2922]

IMPROVEMENTS:

  • agent: Added an error at agent startup time if both -ui and -ui-dir are configured together. [GH-2576]
  • agent: Added the datacenter of a node to the catalog, health, and query API endpoints which contain a Node structure. [GH-2713]
  • agent: Added the ca_path, tls_cipher_suites, and tls_prefer_server_cipher_suites options to give more flexibility around configuring TLS. [GH-2963]
  • agent: Reduced the timeouts for the -dev server mode so that the development server starts up almost instantly. [GH-2984]
  • agent: Added verify_incoming_rpc and verify_incoming_https options for more granular control over incoming TLS enforcement. [GH-2974]
  • agent: Use bind address as source for outgoing connections. [GH-2822]
  • api: Added the ACL replication status endpoint to the Go API client library. [GH-2947]
  • cli: Added Raft protocol version to output of operator raft list-peers command.[GH-2929]
  • ui: Added optional JSON validation when editing KV entries in the web UI. [GH-2712]
  • ui: Updated ACL guide links and made guides open in a new tab. [GH-3010]

BUG FIXES:

  • server: Fixed a panic when the tombstone garbage collector was stopped. [GH-2087]
  • server: Fixed a panic in Autopilot that could occur when a node is elected but cannot complete leader establishment and steps back down. [GH-2980]
  • server: Added a new peers.json format that allows outage recovery when using Raft protocol version 3 and higher. Previously, you'd have to set the Raft protocol version back to 2 in order to manually recover a cluster. See https://www.consul.io/docs/guides/outage.html#manual-recovery-using-peers-json for more details. [GH-3003]
  • ui: Add and update favicons [GH-2945]

0.8.1 (April 17, 2017)

IMPROVEMENTS:

  • agent: Node IDs derived from host information are now hashed to prevent things like common server hardware from generating IDs with a common prefix across nodes. [GH-2884]
  • agent: Added new -disable-host-node-id CLI flag and disable_host_node_id config option to the Consul agent to prevent it from using information from the host when generating a node ID. This will result in a random node ID, which is useful when running multiple Consul agents on the same host for testing purposes. Having this built-in eases configuring a random node ID when running in containers. [GH-2877]
  • agent: Removed useless "==> Caught signal: broken pipe" logging since that often results from problems sending telemetry or broken incoming client connections; operators don't need to be alerted to these. [GH-2768]
  • cli: Added TLS options for setting the client/CA certificates to use when communicating with Consul. These can be provided through environment variables or command line flags. [GH-2914]
  • build: Consul is now built with Go 1.8.1. [GH-2888]
  • ui: Updates Consul assets to new branding. [GH-2898]

BUG FIXES:

  • api: Added missing Raft index fields to AgentService and Node structures. [GH-2882]
  • server: Fixed an issue where flood joins would not work with IPv6 addresses. [GH-2878]
  • server: Fixed an issue where electing a 0.8.x leader during an upgrade would cause a panic in older servers. [GH-2889]
  • server: Fixed an issue where tracking of leadership changes could become incorrect when changes occurred very rapidly. This could manifest as a panic in Autopilot, but could have caused other issues with multiple leader management routines running simultaneously. [GH-2896]
  • server: Fixed a panic when checking ACLs on a session that doesn't exist. [GH-2624]

0.8.0 (April 5, 2017)

BREAKING CHANGES:

  • Command-Line Interface RPC Deprecation: The RPC client interface has been removed. All CLI commands that used RPC and the -rpc-addr flag to communicate with Consul have been converted to use the HTTP API and the appropriate flags for it, and the rpc field has been removed from the port and address binding configs. You will need to remove these fields from your config files and update any scripts that passed a custom -rpc-addr to the following commands: force-leave, info, join, keyring, leave, members, monitor, reload

  • Version 8 ACLs Are Now Opt-Out: The acl_enforce_version_8 configuration now defaults to true to enable full version 8 ACL support by default. If you are upgrading an existing cluster with ACLs enabled, you will need to set this to false during the upgrade on both Consul agents and Consul servers. Version 8 ACLs were also changed so that acl_datacenter must be set on agents in order to enable the agent-side enforcement of ACLs. This makes for a smoother experience in clusters where ACLs aren't enabled at all, but where the agents would have to wait to contact a Consul server before learning that. [GH-2844]

  • Remote Exec Is Now Opt-In: The default for disable_remote_exec was changed to "true", so now operators need to opt-in to having agents support running commands remotely via consul exec. [GH-2854]

  • Raft Protocol Compatibility: When upgrading to Consul 0.8.0 from a version lower than 0.7.0, users will need to set the -raft-protocol option to 1 in order to maintain backwards compatibility with the old servers during the upgrade. See Upgrading Specific Versions guide for more details.

FEATURES:

  • Autopilot: A set of features has been added to allow for automatic operator-friendly management of Consul servers. For more information about Autopilot, see the Autopilot Guide.
    • Dead Server Cleanup: Dead servers will periodically be cleaned up and removed from the Raft peer set, to prevent them from interfering with the quorum size and leader elections.
    • Server Health Checking: An internal health check has been added to track the stability of servers. The thresholds of this health check are tunable as part of the Autopilot configuration and the status can be viewed through the /v1/operator/autopilot/health HTTP endpoint.
    • New Server Stabilization: When a new server is added to the cluster, there will be a waiting period where it must be healthy and stable for a certain amount of time before being promoted to a full, voting member. This threshold can be configured using the new server_stabilization_time setting.
    • Advanced Redundancy: (Consul Enterprise) A new -non-voting-server option flag has been added for Consul servers to configure a server that does not participate in the Raft quorum. This can be used to add read scalability to a cluster in cases where a high volume of reads to servers are needed, but non-voting servers can be lost without causing an outage. There's also a new redundancy_zone_tag configuration that allows Autopilot to manage separating servers into zones for redundancy. Only one server in each zone can be a voting member at one time. This helps when Consul servers are managed with automatic replacement with a system like a resource scheduler or auto-scaling group. Extra non-voting servers in each zone will be available as hot standbys (that help with read-scaling) that can be quickly promoted into service when the voting server in a zone fails.
    • Upgrade Orchestration: (Consul Enterprise) Autopilot will automatically orchestrate an upgrade strategy for Consul servers where it will initially add newer versions of Consul servers as non-voters, wait for a full set of newer versioned servers to be added, and then gradually swap into service as voters and swap out older versioned servers to non-voters. This allows operators to safely bring up new servers, wait for the upgrade to be complete, and then terminate the old servers.
  • Network Areas: (Consul Enterprise) A new capability has been added which allows operators to define network areas that join together two Consul datacenters. Unlike Consul's WAN feature, network areas use just the server RPC port for communication, and pairwise relationships can be made between arbitrary datacenters, so not all servers need to be fully connected. This allows for complex topologies among Consul datacenters like hub/spoke and more general trees. See the Network Areas Guide for more details.
  • WAN Soft Fail: Request routing between servers in the WAN is now more robust by treating Serf failures as advisory but not final. This means that if there are issues between some subset of the servers in the WAN, Consul will still be able to route RPC requests as long as RPCs are actually still working. Prior to WAN Soft Fail, any datacenters having connectivity problems on the WAN would mean that all DCs might potentially stop sending RPCs to those datacenters. [GH-2801]
  • WAN Join Flooding: A new routine was added that looks for Consul servers in the LAN and makes sure that they are joined into the WAN as well. This catches up up newly-added servers onto the WAN as soon as they join the LAN, keeping them in sync automatically. [GH-2801]
  • Validate command: To provide consistency across our products, the configtest command has been deprecated and replaced with the validate command (to match Nomad and Terraform). The configtest command will be removed in Consul 0.9. [GH-2732]

IMPROVEMENTS:

  • agent: Fixed a missing case where gossip would stop flowing to dead nodes for a short while. [GH-2722]
  • agent: Changed agent to seed Go's random number generator. [GH-2722]
  • agent: Serf snapshots no longer have the executable bit set on the file. [GH-2722]
  • agent: Consul is now built with Go 1.8. [GH-2752]
  • agent: Updated aws-sdk-go version (used for EC2 auto join) for Go 1.8 compatibility. [GH-2755]
  • agent: User-supplied node IDs are now normalized to lower-case. [GH-2798]
  • agent: Added checks to enforce uniqueness of agent node IDs at cluster join time and when registering with the catalog. [GH-2832]
  • cli: Standardized handling of CLI options for connecting to the Consul agent. This makes sure that the same set of flags and environment variables works in all CLI commands (see https://www.consul.io/docs/commands/index.html#environment-variables). [GH-2717]
  • cli: Updated go-cleanhttp library for better HTTP connection handling between CLI commands and the Consul agent (tunes reuse settings). [GH-2735]
  • cli: The operator raft subcommand has had its two modes split into the list-peers and remove-peer subcommands. The old flags for these will continue to work for backwards compatibility, but will be removed in Consul 0.9.
  • cli: Added an -id flag to the operator raft remove-peer command to allow removing a peer by ID. [GH-2847]
  • dns: Allows the .service tag to be optional in RFC 2782 lookups. [GH-2690]
  • server: Changed the internal EnsureRegistration RPC endpoint to prevent registering checks that aren't associated with the top-level node being registered. [GH-2846]

BUG FIXES:

  • agent: Fixed an issue with consul watch not working when http was listening on a unix socket. [GH-2385]
  • agent: Fixed an issue where checks and services could not sync deregister operations back to the catalog when version 8 ACL support is enabled. [GH-2818]
  • agent: Fixed an issue where agents could use the ACL token registered with a service when registering checks for the same service that were registered with a different ACL token. [GH-2829]
  • cli: Fixed consul kv commands not reading the CONSUL_HTTP_TOKEN environment variable. [GH-2566]
  • cli: Fixed an issue where prefixing an address with a protocol (such as 'http://' or 'https://') in -http-addr or CONSUL_HTTP_ADDR would give an error.
  • cli: Fixed an issue where error messages would get printed to stdout instead of stderr. [GH-2548]
  • server: Fixed an issue with version 8 ACLs where servers couldn't deregister nodes from the catalog during reconciliation. [GH-2792] This fix was generalized and applied to registering nodes as well. [GH-2826]
  • server: Fixed an issue where servers could temporarily roll back changes to a node's metadata or tagged addresses when making updates to the node's health checks. [GH-2826]
  • server: Fixed an issue where the service name consul was not subject to service ACL policies with version 8 ACLs enabled. [GH-2816]

0.7.5 (February 15, 2017)

BUG FIXES:

  • server: Fixed a rare but serious issue where Consul servers could panic when performing a large delete operation followed by a specific sequence of other updates to related parts of the state store (affects KV, sessions, prepared queries, and the catalog). [GH-2724]

0.7.4 (February 6, 2017)

IMPROVEMENTS:

  • agent: Integrated gopsutil library to use built in host UUID as node ID, if available, instead of a randomly generated UUID. This makes it easier for other applications on the same host to generate the same node ID without coordinating with Consul. [GH-2697]
  • agent: Added a configuration option, tls_min_version, for setting the minimum allowed TLS version used for the HTTP API and RPC. [GH-2699]
  • agent: Added a relay-factor option to keyring operations to allow nodes to relay their response through N randomly-chosen other nodes in the cluster. [GH-2704]
  • build: Consul is now built with Go 1.7.5. [GH-2682]
  • dns: Add ability to lookup Consul agents by either their Node ID or Node Name through the node interface (e.g. DNS (node-id|node-name).node.consul). [GH-2702]

BUG FIXES:

  • dns: Fixed an issue where SRV lookups for services on a node registered with non-IP addresses were missing the CNAME record in the additional section of the response. [GH-2695]

0.7.3 (January 26, 2017)

FEATURES:

  • KV Import/Export CLI: consul kv export and consul kv import can be used to move parts of the KV tree between disconnected consul clusters, using JSON as the intermediate representation. [GH-2633]
  • Node Metadata: Support for assigning user-defined metadata key/value pairs to nodes has been added. This can be viewed when looking up node info, and can be used to filter the results of various catalog and health endpoints. For more information, see the Catalog, Health, and Prepared Query endpoint documentation, as well as the Node Meta section of the agent configuration. [GH-2654]
  • Node Identifiers: Consul agents can now be configured with a unique identifier, or they will generate one at startup that will persist across agent restarts. This identifier is designed to represent a node across all time, even if the name or address of the node changes. Identifiers are currently only exposed in node-related endpoints, but they will be used in future versions of Consul to help manage Consul servers and the Raft quorum in a more robust manner, as the quorum is currently tracked via addresses, which can change. [GH-2661]
  • Improved Blocking Queries: Consul's blocking query implementation was improved to provide a much more fine-grained mechanism for detecting changes. For example, in previous versions of Consul blocking to wait on a change to a specific service would result in a wake up if any service changed. Now, wake ups are scoped to the specific service being watched, if possible. This support has been added to all endpoints that support blocking queries, nothing new is required to take advantage of this feature. [GH-2671]
  • GCE auto-discovery: New -retry-join-gce configuration options added to allow bootstrapping by automatically discovering Google Cloud instances with a given tag at startup. [GH-2570]

IMPROVEMENTS:

  • build: Consul is now built with Go 1.7.4. [GH-2676]
  • cli: consul kv get now has a -base64 flag to base 64 encode the value. [GH-2631]
  • cli: consul kv put now has a -base64 flag for setting values which are base 64 encoded. [GH-2632]
  • ui: Added a notice that JS is required when viewing the web UI with JS disabled. [GH-2636]

BUG FIXES:

  • agent: Redacted the AWS access key and secret key ID from the /v1/agent/self output so they are not disclosed. [GH-2677]
  • agent: Fixed a rare startup panic due to a Raft/Serf race condition. [GH-1899]
  • cli: Fixed a panic when an empty quoted argument was given to consul kv put. [GH-2635]
  • tests: Fixed a race condition with check mock's map usage. [GH-2578]

0.7.2 (December 19, 2016)

FEATURES:

  • Keyring API: A new /v1/operator/keyring HTTP endpoint was added that allows for performing operations such as list, install, use, and remove on the encryption keys in the gossip keyring. See the Keyring Endpoint for more details. [GH-2509]
  • Monitor API: A new /v1/agent/monitor HTTP endpoint was added to allow for viewing streaming log output from the agent, similar to the consul monitor command. See the Monitor Endpoint for more details. [GH-2511]
  • Reload API: A new /v1/agent/reload HTTP endpoint was added for triggering a reload of the agent's configuration. See the Reload Endpoint for more details. [GH-2516]
  • Leave API: A new /v1/agent/leave HTTP endpoint was added for causing an agent to gracefully shutdown and leave the cluster (previously, only force-leave was present in the HTTP API). See the Leave Endpoint for more details. [GH-2516]
  • Bind Address Templates (beta): Consul agents now allow go-sockaddr/template syntax to be used for any bind address configuration (advertise_addr, bind_addr, client_addr, and others). This allows for easy creation of immutable images for Consul that can fetch their own address based on an interface name, network CIDR, address family from an actual RFC number, and many other possible schemes. This feature is in beta and we may tweak the template syntax before final release, but we encourage the community to try this and provide feedback. [GH-2563]
  • Complete ACL Coverage (beta): Consul 0.8 will feature complete ACL coverage for all of Consul. To ease the transition to the new policies, a beta version of complete ACL support was added to help with testing and migration to the new features. Please see the ACLs Internals Guide for more details. [GH-2594, GH-2592, GH-2590]

IMPROVEMENTS:

  • agent: Defaults to ?pretty JSON for HTTP API requests when in -dev mode. [GH-2518]
  • agent: Updated Circonus metrics library and added new Circonus configration options for Consul for customizing check display name and tags. [GH-2555]
  • agent: Added a checksum to UDP gossip messages to guard against packet corruption. [GH-2574]
  • agent: Check whether a snapshot needs to be taken more often (every 5 seconds instead of 2 minutes) to keep the raft file smaller and to avoid doing huge truncations when writing lots of entries very quickly. [GH-2591]
  • agent: Allow gossiping to suspected/recently dead nodes. [GH-2593]
  • agent: Changed the gossip suspicion timeout to grow smoothly as the number of nodes grows. [GH-2593]
  • agent: Added a deprecation notice for Atlas features to the CLI and docs. [GH-2597]
  • agent: Give a better error message when the given data-dir is not a directory. [GH-2529]

BUG FIXES:

  • agent: Fixed a panic when SIGPIPE signal was received. [GH-2404]
  • api: Added missing Raft index fields to CatalogService structure. [GH-2366]
  • api: Added missing notes field to AgentServiceCheck structure. [GH-2336]
  • api: Changed type of AgentServiceCheck.TLSSkipVerify from string to bool. [GH-2530]
  • api: Added new HealthChecks.AggregatedStatus() method that makes it easy get an overall health status from a list of checks. [GH-2544]
  • api: Changed type of KVTxnOp.Verb from string to KVOp. [GH-2531]
  • cli: Fixed an issue with the consul kv put command where a negative value would be interpreted as an argument to read from standard input. [GH-2526]
  • ui: Fixed an issue where extra commas would be shown around service tags. [GH-2340]
  • ui: Customized Bootstrap config to avoid missing font file references. [GH-2485]
  • ui: Removed "Deregister" button as removing nodes from the catalog isn't a common operation and leads to lots of user confusion. [GH-2541]

0.7.1 (November 10, 2016)

BREAKING CHANGES:

  • Child process reaping support has been removed, along with the reap configuration option. Reaping is also done via dumb-init in the Consul Docker image, so removing it from Consul itself simplifies the code and eases future maintainence for Consul. If you are running Consul as PID 1 in a container you will need to arrange for a wrapper process to reap child processes. [GH-1988]
  • The default for max_stale has been increased to a near-indefinite threshold (10 years) to allow DNS queries to continue to be served in the event of a long outage with no leader. A new telemetry counter has also been added at consul.dns.stale_queries to track when agents serve DNS queries that are over a certain staleness (>5 seconds). [GH-2481]
  • The api package's PreparedQuery.Delete() method now takes WriteOptions instead of QueryOptions. [GH-2417]

FEATURES:

  • Key/Value Store Command Line Interface: New consul kv commands were added for easy access to all basic key/value store operations. [GH-2360]
  • Snapshot/Restore: A new /v1/snapshot HTTP endpoint and corresponding set of consul snapshot commands were added for easy point-in-time snapshots for disaster recovery. Snapshots include all state managed by Consul's Raft consensus protocol, including Key/Value Entries, Service Catalog, Prepared Queries, Sessions, and ACLs. Snapshots can be restored on the fly into a completely fresh cluster. [GH-2396]
  • AWS auto-discovery: New -retry-join-ec2 configuration options added to allow bootstrapping by automatically discovering AWS instances with a given tag key/value at startup. [GH-2459]

IMPROVEMENTS:

  • api: All session options can now be set when using api.Lock(). [GH-2372]
  • agent: Added the ability to bind Serf WAN and LAN to different interfaces than the general bind address. [GH-2007]
  • agent: Added a new tls_skip_verify configuration option for HTTP checks. [GH-1984]
  • build: Consul is now built with Go 1.7.3. [GH-2281]

BUG FIXES:

  • agent: Fixed a Go race issue with log buffering at startup. [GH-2262]
  • agent: Fixed a panic during anti-entropy sync for services and checks. [GH-2125]
  • agent: Fixed an issue on Windows where "wsarecv" errors were logged when CLI commands accessed the RPC interface. [GH-2356]
  • agent: Syslog initialization will now retry on errors for up to 60 seconds to avoid a race condition at system startup. [GH-1610]
  • agent: Fixed a panic when both -dev and -bootstrap-expect flags were provided. [GH-2464]
  • agent: Added a retry with backoff when a session fails to invalidate after expiring. [GH-2435]
  • agent: Fixed an issue where Consul would fail to start because of leftover malformed check/service state files. [GH-1221]
  • agent: Fixed agent crashes on macOS Sierra by upgrading Go. [GH-2407, GH-2281]
  • agent: Log a warning instead of success when attempting to deregister a nonexistent service. [GH-2492]
  • api: Trim leading slashes from keys/prefixes when querying KV endpoints to avoid a bug with redirects in Go 1.7 (golang/go#4800). [GH-2403]
  • dns: Fixed external services that pointed to consul addresses (CNAME records) not resolving to A-records. [GH-1228]
  • dns: Fixed an issue with SRV lookups where the service address was different from the node's. [GH-832]
  • dns: Fixed an issue where truncated records from a recursor query were improperly reported as errors. [GH-2384]
  • server: Fixed the port numbers in the sample JSON inside peers.info. [GH-2391]
  • server: Squashes ACL datacenter name to lower case and checks for proper formatting at startup. [GH-2059, GH-1778, GH-2478]
  • ui: Fixed an XSS issue with the display of sessions and ACLs in the web UI. [GH-2456]

0.7.0 (September 14, 2016)

BREAKING CHANGES:

  • The default behavior of leave_on_terminate and skip_leave_on_interrupt are now dependent on whether or not the agent is acting as a server or client. When Consul is started as a server the defaults for these are false and true, respectively, which means that you have to explicitly configure a server to leave the cluster. When Consul is started as a client the defaults are the opposite, which means by default, clients will leave the cluster if shutdown or interrupted. [GH-1909] [GH-2320]
  • The allow_stale configuration for DNS queries to the Consul agent now defaults to true, allowing for better utilization of available Consul servers and higher throughput at the expense of weaker consistency. This is almost always an acceptable tradeoff for DNS queries, but this can be reconfigured to use the old default behavior if desired. [GH-2315]
  • Output from HTTP checks is truncated to 4k when stored on the servers, similar to script check output. [GH-1952]
  • Consul's Go API client will now send ACL tokens using HTTP headers instead of query parameters, requiring Consul 0.6.0 or later. [GH-2233]
  • Removed support for protocol version 1, so Consul 0.7 is no longer compatible with Consul versions prior to 0.3. [GH-2259]
  • The Raft peers information in consul info has changed format and includes information about the suffrage of a server, which will be used in future versions of Consul. [GH-2222]
  • New translate_wan_addrs behavior from [GH-2118] translates addresses in HTTP responses and could break clients that are expecting local addresses. A new X-Consul-Translate-Addresses header was added to allow clients to detect if translation is enabled for HTTP responses, and a "lan" tag was added to TaggedAddresses for clients that need the local address regardless of translation. [GH-2280]
  • The behavior of the peers.json file is different in this version of Consul. This file won't normally be present and is used only during outage recovery. Be sure to read the updated Outage Recovery Guide for details. [GH-2222]
  • Consul's default Raft timing is now set to work more reliably on lower-performance servers, which allows small clusters to use lower cost compute at the expense of reduced performance for failed leader detection and leader elections. You will need to configure Consul to get the same performance as before. See the new Server Performance guide for more details. [GH-2303]

FEATURES:

  • Transactional Key/Value API: A new /v1/txn API was added that allows for atomic updates to and fetches from multiple entries in the key/value store inside of an atomic transaction. This includes conditional updates based on obtaining locks, and all other key/value store operations. See the Key/Value Store Endpoint for more details. [GH-2028]
  • Native ACL Replication: Added a built-in full replication capability for ACLs. Non-ACL datacenters can now replicate the complete ACL set locally to their state store and fall back to that if there's an outage. Additionally, this provides a good way to make a backup ACL datacenter, or to migrate the ACL datacenter to a different one. See the ACL Internals Guide for more details. [GH-2237]
  • Server Connection Rebalancing: Consul agents will now periodically reconnect to available Consul servers in order to redistribute their RPC query load. Consul clients will, by default, attempt to establish a new connection every 120s to 180s unless the size of the cluster is sufficiently large. The rate at which agents begin to query new servers is proportional to the size of the Consul cluster (servers should never receive more than 64 new connections per second per Consul server as a result of rebalancing). Clusters in stable environments who use allow_stale should see a more even distribution of query load across all of their Consul servers. [GH-1743]
  • Raft Updates and Consul Operator Interface: This version of Consul upgrades to "stage one" of the v2 HashiCorp Raft library. This version offers improved handling of cluster membership changes and recovery after a loss of quorum. This version also provides a foundation for new features that will appear in future Consul versions once the remainder of the v2 library is complete. [GH-2222]
    Consul's default Raft timing is now set to work more reliably on lower-performance servers, which allows small clusters to use lower cost compute at the expense of reduced performance for failed leader detection and leader elections. You will need to configure Consul to get the same performance as before. See the new Server Performance guide for more details. [GH-2303]
    Servers will now abort bootstrapping if they detect an existing cluster with configured Raft peers. This will help prevent safe but spurious leader elections when introducing new nodes with bootstrap_expect enabled into an existing cluster. [GH-2319]
    Added new consul operator command, HTTP endpoint, and associated ACL to allow Consul operators to view and update the Raft configuration. This allows a stale server to be removed from the Raft peers without requiring downtime and peers.json recovery file use. See the new Consul Operator Command and the Consul Operator Endpoint for details, as well as the updated Outage Recovery Guide. [GH-2312]
  • Serf Lifeguard Updates: Implemented a new set of feedback controls for the gossip layer that help prevent degraded nodes that can't meet the soft real-time requirements from erroneously causing serfHealth flapping in other, healthy nodes. This feature tunes itself automatically and requires no configuration. [GH-2101]
  • Prepared Query Near Parameter: Prepared queries support baking in a new Near sorting parameter. This allows results to be sorted by network round trip time based on a static node, or based on the round trip time from the Consul agent where the request originated. This can be used to find a co-located service instance is one is available, with a transparent fallback to the next best alternate instance otherwise. [GH-2137]
  • Automatic Service Deregistration: Added a new deregister_critical_service_after timeout field for health checks which will cause the service associated with that check to get deregistered if the check is critical for longer than the timeout. This is useful for cleanup of health checks registered natively by applications, or in other situations where services may not always be cleanly shutdown. [GH-679]
  • WAN Address Translation Everywhere: Extended the translate_wan_addrs config option to also translate node addresses in HTTP responses, making it easy to use this feature from non-DNS clients. [GH-2118]
  • RPC Retries: Consul will now retry RPC calls that result in "no leader" errors for up to 5 seconds. This allows agents to ride out leader elections with a delayed response vs. an error. [GH-2175]
  • Circonus Telemetry Support: Added support for Circonus as a telemetry destination. [GH-2193]

IMPROVEMENTS:

  • agent: Reap time for failed nodes is now configurable via new reconnect_timeout and reconnect_timeout_wan config options (use with caution). [GH-1935]
  • agent: Joins based on a DNS lookup will use TCP and attempt to join with the full list of returned addresses. [GH-2101]
  • agent: Consul will now refuse to start with a helpful message if the same UNIX socket is used for more than one listening endpoint. [GH-1910]
  • agent: Removed an obsolete warning message when Consul starts on Windows. [GH-1920]
  • agent: Defaults bind address to 127.0.0.1 when running in -dev mode. [GH-1878]
  • agent: Added version information to the log when Consul starts up. [GH-1404]
  • agent: Added timing metrics for HTTP requests in the form of consul.http.<verb>.<path>. [GH-2256]
  • build: Updated all vendored dependencies. [GH-2258]
  • build: Consul releases are now built with Go 1.6.3. [GH-2260]
  • checks: Script checks now support an optional timeout parameter. [GH-1762]
  • checks: HTTP health checks limit saved output to 4K to avoid performance issues. [GH-1952]
  • cli: Added a -stale mode for watchers to allow them to pull data from any Consul server, not just the leader. [GH-2045] [GH-917]
  • dns: Consul agents can now limit the number of UDP answers returned via the DNS interface. The default number of UDP answers is 3, however by adjusting the dns_config.udp_answer_limit configuration parameter, it is now possible to limit the results down to 1. This tunable provides environments where RFC3484 section 6, rule 9 is enforced with an important workaround in order to preserve the desired behavior of randomized DNS results. Most modern environments will not need to adjust this setting as this RFC was made obsolete by RFC 6724. See the agent options documentation for additional details for when this should be used. [GH-1712]
  • dns: Consul now compresses all DNS responses by default. This prevents issues when recursing records that were originally compressed, where Consul would sometimes generate an invalid, uncompressed response that was too large. [GH-2266]
  • dns: Added a new recursor_timeout configuration option to set the timeout for Consul's internal DNS client that's used for recursing queries to upstream DNS servers. [GH-2321]
  • dns: Added a new -dns-port command line option so this can be set without a config file. [GH-2263]
  • ui: Added a new network tomography visualization to the UI. [GH-2046]

BUG FIXES:

  • agent: Fixed an issue where a health check's output never updates if the check status doesn't change after the Consul agent starts. [GH-1934]
  • agent: External services can now be registered with ACL tokens. [GH-1738]
  • agent: Fixed an issue where large events affecting many nodes could cause infinite intent rebroadcasts, leading to many log messages about intent queue overflows. [GH-1062]
  • agent: Gossip encryption keys are now validated before being made persistent in the keyring, avoiding delayed feedback at runtime. [GH-1299]
  • dns: Fixed an issue where DNS requests for SRV records could be incorrectly trimmed, resulting in an ADDITIONAL section that was out of sync with the ANSWER. [GH-1931]
  • dns: Fixed two issues where DNS requests for SRV records on a prepared query that failed over would report the wrong domain and fail to translate addresses. [GH-2218] [GH-2220]
  • server: Fixed a deadlock related to sorting the list of available datacenters by round trip time. [GH-2130]
  • server: Fixed an issue with the state store's immutable radix tree that would prevent it from using cached modified objects during transactions, leading to extra copies and increased memory / GC pressure. [GH-2106]
  • server: Upgraded Bolt DB to v1.2.1 to fix an issue on Windows where Consul would sometimes fail to start due to open user-mapped sections. [GH-2203]

OTHER CHANGES:

  • build: Switched from Godep to govendor. [GH-2252]

0.6.4 (March 16, 2016)

BACKWARDS INCOMPATIBILITIES:

  • Added a new query ACL type to manage prepared query names, and stopped capturing ACL tokens by default when prepared queries are created. This won't affect existing queries and how they are executed, but this will affect how they are managed. Now management of prepared queries can be delegated within an organization. If you use prepared queries, you'll need to read the Consul 0.6.4 upgrade instructions before upgrading to this version of Consul. [GH-1748]
  • Consul's Go API client now pools connections by default, and requires you to manually opt-out of this behavior. Previously, idle connections were supported and their lifetime was managed by a finalizer, but this wasn't reliable in certain situations. If you reuse an API client object during the lifetime of your application, then there's nothing to do. If you have short-lived API client objects, you may need to configure them using the new api.DefaultNonPooledConfig() method to avoid leaking idle connections. [GH-1825]
  • Consul's Go API client's agent.UpdateTTL() function was updated in a way that will only work with Consul 0.6.4 and later. The agent.PassTTL(), agent.WarnTTL(), and agent.FailTTL() functions were not affected and will continue work with older versions of Consul. [GH-1794]

FEATURES:

  • Added new template prepared queries which allow you to define a prefix (possibly even an empty prefix) to apply prepared query features like datacenter failover to multiple services with a single query definition. This makes it easy to apply a common policy to multiple services without having to manage many prepared queries. See Prepared Query Templates for more details. [GH-1764]
  • Added a new ability to translate address lookups when doing queries of nodes in remote datacenters via DNS using a new translate_wan_addrs configuration option. This allows the node to be reached within its own datacenter using its local address, and reached from other datacenters using its WAN address, which is useful in hybrid setups with mixed networks. [GH-1698]

IMPROVEMENTS:

  • Added a new disable_hostname configuration option to control whether Consul's runtime telemetry gets prepended with the host name. All of the telemetry configuration has also been moved to a telemetry nested structure, but the old format is currently still supported. [GH-1284]
  • Consul's Go dependencies are now vendored using Godep. [GH-1714]
  • Added support for EnableTagOverride for the catalog in the Go API client. [GH-1726]
  • Consul now ships built from Go 1.6. [GH-1735]
  • Added a new /v1/agent/check/update/<check id> API for updating TTL checks which makes it easier to send large check output as part of a PUT body and not a query parameter. [GH-1785].
  • Added a default set of Accept headers for HTTP checks. [GH-1819]
  • Added support for RHEL7/Systemd in Terraform example. [GH-1629]

BUG FIXES:

  • Updated the internal web UI (-ui option) to latest released build, fixing an ACL-related issue and the broken settings icon. [GH-1619]
  • Fixed an issue where blocking KV reads could miss updates and return stale data when another key whose name is a prefix of the watched key was updated. [GH-1632]
  • Fixed the redirect from / to /ui when the internal web UI (-ui option) is enabled. [GH-1713]
  • Updated memberlist to pull in a fix for leaking goroutines when performing TCP fallback pings. This affected users with frequent UDP connectivity problems. [GH-1802]
  • Added a fix to trim UDP DNS responses so they don't exceed 512 bytes. [GH-1813]
  • Updated go-dockerclient to fix Docker health checks with Docker 1.10. [GH-1706]
  • Removed fixed height display of nodes and services in UI, leading to broken displays when a node has a lot of services. [GH-2055]

0.6.3 (January 15, 2016)

BUG FIXES:

  • Fixed an issue when running Consul as PID 1 in a Docker container where it could consume CPU and show spurious failures for health checks, watch handlers, and consul exec commands [GH-1592]

0.6.2 (January 13, 2016)

SECURITY:

This is a security-only release; other than the version number and building against Go 1.5.3, there are no changes from 0.6.1.

0.6.1 (January 6, 2016)

BACKWARDS INCOMPATIBILITIES:

  • The new -monitor-retry option to consul lock defaults to 3. This will cause the lock monitor to retry up to 3 times, waiting 1s between each attempt if it gets a 500 error from the Consul servers. For the vast majority of use cases this is desirable to prevent the lock from being given up during a brief period of Consul unavailability. If you want to get the previous default behavior you will need to set the -monitor-retry=0 option.

IMPROVEMENTS:

  • Consul is now built with Go 1.5.2
  • Added source IP address and port information to RPC-related log error messages and HTTP access logs [GH-1513] [GH-1448]
  • API clients configured for insecure SSL now use an HTTP transport that's set up the same way as the Go default transport [GH-1526]
  • Added new per-host telemetry on DNS requests [GH-1537]
  • Added support for reaping child processes which is useful when running Consul as PID 1 in Docker containers [GH-1539]
  • Added new -ui command line and ui config option that enables a built-in Consul web UI, making deployment much simpler [GH-1543]
  • Added new -dev command line option that creates a completely in-memory standalone Consul server for development
  • Added a Solaris build, now that dependencies have been updated to support it [GH-1568]
  • Added new -try option to consul lock to allow it to timeout with an error if it doesn't acquire the lock [GH-1567]
  • Added a new -monitor-retry option to consul lock to help ride out brief periods of Consul unavailabily without causing the lock to be given up [GH-1567]

BUG FIXES:

  • Fixed broken settings icon in web UI [GH-1469]
  • Fixed a web UI bug where the supplied token wasn't being passed into the internal endpoint, breaking some pages when multiple datacenters were present [GH-1071]

0.6.0 (December 3, 2015)

BACKWARDS INCOMPATIBILITIES:

  • A KV lock acquisition operation will now allow the lock holder to update the key's contents without giving up the lock by doing another PUT with ?acquire=<session> and providing the same session that is holding the lock. Previously, this operation would fail.

FEATURES:

  • Service ACLs now apply to service discovery [GH-1024]
  • Added event ACLs to guard firing user events [GH-1046]
  • Added keyring ACLs for gossip encryption keyring operations [GH-1090]
  • Added a new TCP check type that does a connect as a check [GH-1130]
  • Added new "tag override" feature that lets catalog updates to a service's tags flow down to agents [GH-1187]
  • Ported in-memory database from LMDB to an immutable radix tree to improve read throughput, reduce garbage collection pressure, and make Consul 100% pure Go [GH-1291]
  • Added support for sending telemetry to DogStatsD [GH-1293]
  • Added new network tomography subsystem that estimates the network round trip times between nodes and exposes that in raw APIs, as well as in existing APIs (find the service node nearest node X); also includes a new consul rtt command to query interactively [GH-1331]
  • Consul now builds under Go 1.5.1 by default [GH-1345]
  • Added built-in support for running health checks inside Docker containers [GH-1343]
  • Added prepared queries which support service health queries with rich features such as filters for multiple tags and failover to remote datacenters based on network coordinates; these are available via HTTP as well as the DNS interface [GH-1389]

BUG FIXES:

  • Fixed expired certificates in unit tests [GH-979]
  • Allow services with / characters in the UI [GH-988]
  • Added SOA/NXDOMAIN records to negative DNS responses per RFC2308 [GH-995] [GH-1142] [GH-1195] [GH-1217]
  • Token hiding in HTTP logs bug fixed [GH-1020]
  • RFC6598 addresses are accepted as private IPs [GH-1050]
  • Fixed reverse DNS lookups to recursor [GH-1137]
  • Removes the trailing / added by the consul lock command [GH-1145]
  • Fixed bad lock handler execution during shutdown [GH-1080] [GH-1158] [GH-1214]
  • Added missing support for AAAA queries for nodes [GH-1222]
  • Tokens passed from the CLI or API work for maint mode [GH-1230]
  • Fixed service deregister/reregister flaps that could happen during consul reload [GH-1235]
  • Fixed the Go API client to properly distinguish between expired sessions and sessions that don't exist [GH-1041]
  • Fixed the KV section of the UI to work on Safari [GH-1321]
  • Cleaned up JavaScript for built-in UI with bug fixes [GH-1338]

IMPROVEMENTS:

  • Added sorting of consul members command output [GH-969]
  • Updated AWS templates for RHEL6, CentOS6 [GH-992] [GH-1002]
  • Advertised gossip/rpc addresses can now be configured [GH-1004]
  • Failed lock acquisition handling now responds based on type of failure [GH-1006]
  • Agents now remember check state across restarts [GH-1009]
  • Always run ACL tests by default in API tests [GH-1030]
  • Consul now refuses to start if there are multiple private IPs [GH-1099]
  • Improved efficiency of servers managing incoming connections from agents [GH-1170]
  • Added logging of the DNS client addresses in error messages [GH-1166]
  • Added -http-port option to change the HTTP API port number [GH-1167]
  • Atlas integration options are reload-able via SIGHUP [GH-1199]
  • Atlas endpoint is a configurable option and CLI arg [GH-1201]
  • Added -pass-stdin option to consul lock command [GH-1200]
  • Enables the /v1/internal/ui/* endpoints, even if -ui-dir isn't set [GH-1215]
  • Added HTTP method to Consul's log output for better debugging [GH-1270]
  • Lock holders can ?acquire=<session> a key again with the same session that holds the lock to update a key's contents without releasing the lock [GH-1291]
  • Improved an O(n^2) algorithm in the agent's catalog sync code [GH-1296]
  • Switched to net-rpc-msgpackrpc to reduce RPC overhead [GH-1307]
  • Removed all uses of the http package's default client and transport in Consul to avoid conflicts with other packages [GH-1310] [GH-1327]
  • Added new X-Consul-Token HTTP header option to avoid passing tokens in the query string [GH-1318]
  • Increased session TTL max to 24 hours (use with caution, see note added to the Session HTTP endpoint documentation) [GH-1412]
  • Added support to the API client for retrying lock monitoring when Consul is unavailable, helping prevent false indications of lost locks (eg. apps like Vault can avoid failing over when a Consul leader election occurs) [GH-1457]
  • Added reap of receive buffer space for idle streams in the connection pool [GH-1452]

MISC:

  • Lots of docs fixes
  • Lots of Vagrantfile cleanup
  • Data migrator utility removed to eliminate cgo dependency [GH-1309]

UPGRADE NOTES:

  • Consul will refuse to start if the data directory contains an "mdb" folder. This folder was used in versions of Consul up to 0.5.1. Consul version 0.5.2 included a baked-in utility to automatically upgrade the data format, but this has been removed in Consul 0.6 to eliminate the dependency on cgo.
  • New service read, event firing, and keyring ACLs may require special steps to perform during an upgrade if ACLs are enabled and set to deny by default.
  • Consul will refuse to start if there are multiple private IPs available, so if this is the case you will need to configure Consul's advertise or bind addresses before upgrading.

See https://www.consul.io/docs/upgrade-specific.html for detailed upgrade instructions.

0.5.2 (May 18, 2015)

FEATURES:

  • Include datacenter in the members output
  • HTTP Health Check sets user agent "Consul Health Check" [GH-951]

BUG FIXES:

  • Fixed memory leak caused by blocking query [GH-939]

MISC:

  • Remove unused constant [GH-941]

0.5.1 (May 13, 2015)

FEATURES:

  • Ability to configure minimum session TTL. [GH-821]
  • Ability to set the initial state of a health check when registering [GH-859]
  • New configtest sub-command to verify config validity [GH-904]
  • ACL enforcement is prefix based for service names [GH-905]
  • ACLs support upsert for simpler restore and external generation [GH-909]
  • ACL tokens can be provided per-service during registration [GH-891]
  • Support for distinct LAN and WAN advertise addresses [GH-816]
  • Migrating Raft log from LMDB to BoltDB [GH-857]
  • session_ttl_min is now configurable to reduce the minimum TTL [GH-821]
  • Adding verify_server_hostname to protect against server forging [GH-927]

BUG FIXES:

  • Datacenter is lowercased, fixes DNS lookups [GH-761]
  • Deregister all checks when service is deregistered [GH-918]
  • Fixing issues with updates of persisted services [GH-910]
  • Chained CNAME resolution fixes [GH-862]
  • Tokens are filtered out of log messages [GH-860]
  • Fixing anti-entropy issue if servers rollback Raft log [GH-850]
  • Datacenter name is case insensitive for DNS lookups
  • Queries for invalid datacenters do not leak sockets [GH-807]

IMPROVEMENTS:

  • HTTP health checks more reliable, avoid KeepAlives [GH-824]
  • Improved protection against a passive cluster merge
  • SIGTERM is properly handled for graceful shutdown [GH-827]
  • Better staggering of deferred updates to checks [GH-884]
  • Configurable stats prefix [GH-902]
  • Raft uses BoltDB as the backend store. [GH-857]
  • API RenewPeriodic more resilient to transient errors [GH-912]

0.5.0 (February 19, 2015)

FEATURES:

  • Key rotation support for gossip layer. This allows the encrypt key to be changed globally. See "keyring" command. [GH-336]
  • Options to join the WAN pool on start (start_join_wan, retry_join_wan) [GH-477]
  • Optional HTTPS interface [GH-478]
  • Ephemeral keys via "delete" session behavior. This allows keys to be deleted when a session is invalidated instead of having the lock released. Adds new "Behavior" field to Session which is configurable. [GH-487]
  • Reverse DNS lookups via PTR for IPv4 and IPv6 [GH-475]
  • API added checks and services are persisted. This means services and checks will survive a crash or restart. [GH-497]
  • ACLs can now protect service registration. Users in blacklist mode should allow registrations before upgrading to prevent a service disruption. [GH-506] [GH-465]
  • Sessions support a heartbeat failure detector via use of TTLs. This adds a new "TTL" field to Sessions and a /v1/session/renew endpoint. Heartbeats act like a failure detector (health check), but are managed by the servers. [GH-524] [GH-172]
  • Support for service specific IP addresses. This allows the service to advertise an address that is different from the agent. [GH-229] [GH-570]
  • Support KV Delete with Check-And-Set [GH-589]
  • Merge armon/consul-api into api as official Go client.
  • Support for distributed locks and semaphores in API client [GH-594] [GH-600]
  • Support for native HTTP health checks [GH-592]
  • Support for node and service maintenance modes [GH-606]
  • Added new "consul maint" command to easily toggle maintenance modes [GH-625]
  • Added new "consul lock" command for simple highly-available deployments. This lets Consul manage the leader election and easily handle N+1 deployments without the applications being Consul aware. [GH-619]
  • Multiple checks can be associated with a service [GH-591] [GH-230]

BUG FIXES:

  • Fixed X-Consul-Index calculation for KV ListKeys
  • Fixed errors under extremely high read parallelism
  • Fixed issue causing event watches to not fire reliably [GH-479]
  • Fixed non-monotonic X-Consul-Index with key deletion [GH-577] [GH-195]
  • Fixed use of default instead of custom TLD in some DNS responses [GH-582]
  • Fixed memory leaks in API client when an error response is returned [GH-608]
  • Fixed issues with graceful leave in single-node bootstrap cluster [GH-621]
  • Fixed issue preventing node reaping [GH-371]
  • Fixed gossip stability at very large scale
  • Fixed string of rpc error: rpc error: ... no known leader. [GH-611]
  • Fixed panic in exec during cancellation
  • Fixed health check state reset caused by SIGHUP [GH-693]
  • Fixed bug in UI when multiple datacenters exist.

IMPROVEMENTS:

  • Support "consul exec" in foreign datacenter [GH-584]
  • Improved K/V blocking query performance [GH-578]
  • CLI respects CONSUL_RPC_ADDR environment variable to load parameter [GH-542]
  • Added support for multiple DNS recursors [GH-448]
  • Added support for defining multiple services per configuration file [GH-433]
  • Added support for defining multiple checks per configuration file [GH-433]
  • Allow mixing of service and check definitions in a configuration file [GH-433]
  • Allow notes for checks in service definition file [GH-449]
  • Random stagger for agent checks to prevent thundering herd [GH-546]
  • More useful metrics are sent to statsd/statsite
  • Added configuration to set custom HTTP headers (CORS) [GH-558]
  • Reject invalid configurations to simplify validation [GH-576]
  • Guard against accidental cluster mixing [GH-580] [GH-260]
  • Added option to filter DNS results on warning [GH-595]
  • Improve write throughput with raft log caching [GH-604]
  • Added ability to bind RPC and HTTP listeners to UNIX sockets [GH-587] [GH-612]
  • K/V HTTP endpoint returns 400 on conflicting flags [GH-634] [GH-432]

MISC:

  • UI confirms before deleting key sub-tree [GH-520]
  • More useful output in "consul version" [GH-480]
  • Many documentation improvements
  • Reduce log messages when quorum member is logs [GH-566]

UPGRADE NOTES:

  • If acl_default_policy is "deny", ensure tokens are updated to enable service registration to avoid a service disruption. The new ACL policy can be submitted with 0.4 before upgrading to 0.5 where it will be enforced.

  • Servers running 0.5.X cannot be mixed with older servers. (Any client version is fine). There is a 15 minute upgrade window where mixed versions are allowed before older servers will panic due to an unsupported internal command. This is due to the new KV tombstones which are internal to servers.

0.4.1 (October 20, 2014)

FEATURES:

  • Adding flags for -retry-join to attempt a join with configurable retry behavior. [GH-395]

BUG FIXES:

  • Fixed ACL token in UI
  • Fixed ACL reloading in UI [GH-323]
  • Fixed long session names in UI [GH-353]
  • Fixed exit code from remote exec [GH-346]
  • Fixing only a single watch being run by an agent [GH-337]
  • Fixing potential race in connection multiplexing
  • Fixing issue with Session ID and ACL ID generation. [GH-391]
  • Fixing multiple headers for /v1/event/list endpoint [GH-361]
  • Fixing graceful leave of leader causing invalid Raft peers [GH-360]
  • Fixing bug with closing TLS connection on error
  • Fixing issue with node reaping [GH-371]
  • Fixing aggressive deadlock time [GH-389]
  • Fixing syslog filter level [GH-272]
  • Serf snapshot compaction works on Windows [GH-332]
  • Raft snapshots work on Windows [GH-265]
  • Consul service entry clean by clients now possible
  • Fixing improper deserialization

IMPROVEMENTS:

  • Use "critical" health state instead of "unknown" [GH-341]
  • Consul service can be targeted for exec [GH-344]
  • Provide debug logging for session invalidation [GH-390]
  • Added "Deregister" button to UI [GH-364]
  • Added enable_truncate DNS configuration flag [GH-376]
  • Reduce mmap() size on 32bit systems [GH-265]
  • Temporary state is cleaned after an abort [GH-338] [GH-178]

MISC:

  • Health state "unknown" being deprecated

0.4.0 (September 5, 2014)

FEATURES:

  • Fine-grained ACL system to restrict access to KV store. Clients use tokens which can be restricted to (read, write, deny) permissions using longest-prefix matches.

  • Watch mechanisms added to invoke a handler when data changes in consul. Used with the consul watch command, or by specifying watches in an agent configuration.

  • Event system added to support custom user events. Events are fired using the consul event command. They are handled using a standard watch.

  • Remote execution using consul exec. This allows for command execution on remote instances mediated through Consul.

  • RFC-2782 style DNS lookups supported

  • UI improvements, including support for ACLs.

IMPROVEMENTS:

  • DNS case-insensitivity [GH-189]
  • Support for HTTP ?pretty parameter to pretty format JSON output.
  • Use $SHELL when invoking handlers. [GH-237]
  • Agent takes the -encrypt CLI Flag [GH-245]
  • New statsd_add config for Statsd support. [GH-247]
  • New addresses config for providing an override to client_addr for DNS, HTTP, or RPC endpoints. [GH-301] [GH-253]
  • Support Checkpoint for security bulletins and update announcements.

BUG FIXES:

  • Fixed race condition in -bootstrap-expect [GH-254]
  • Require PUT to /v1/session/destroy [GH-285]
  • Fixed registration race condition [GH-300] [GH-279]

UPGRADE NOTES:

  • ACL support should not be enabled until all server nodes are running Consul 0.4. Mixed server versions with ACL support enabled may result in panics.

0.3.1 (July 21, 2014)

FEATURES:

  • Improved bootstrapping process, thanks to @robxu9

BUG FIXES:

  • Fixed issue with service re-registration [GH-216]
  • Fixed handling of -rejoin flag
  • Restored 0.2 TLS behavior, thanks to @nelhage [GH-233]
  • Fix the statsite flags, thanks to @nelhage [GH-243]
  • Fixed filters on critical / non-passing checks [GH-241]
  • Fixed initial log compaction crash [GH-297]

IMPROVEMENTS:

  • UI Improvements
  • Improved handling of Serf snapshot data
  • Increase reliability of failure detector
  • More useful logging messages

0.3.0 (June 13, 2014)

FEATURES:

  • Better, faster, cleaner UI [GH-194] [GH-196]
  • Sessions, which act as a binding layer between nodes, checks and KV data. [GH-162]
  • Key locking. KV data integrates with sessions to enable distributed locking. [GH-162]
  • DNS lookups can do stale reads and TTLs. [GH-200]
  • Added new /v1/agent/self endpoint [GH-173]
  • reload command can be used to trigger configuration reload from the CLI [GH-142]

IMPROVEMENTS:

  • members has a much cleaner output format [GH-143]
  • info includes build version information
  • Sorted results for datacneter list [GH-198]
  • Switch multiplexing to yamux
  • Allow multiple CA certs in ca_file [GH-174]
  • Enable logging to syslog. [GH-105]
  • Allow raw key value lookup [GH-150]
  • Log encryption enabled [GH-151]
  • Support -rejoin to rejoin a cluster after a previous leave. [GH-110]
  • Support the "any" wildcard for v1/health/state/ [GH-152]
  • Defer sync of health check output [GH-157]
  • Provide output for serfHealth check [GH-176]
  • Datacenter name is validated [GH-169]
  • Configurable syslog facilities [GH-170]
  • Pipelining replication of writes
  • Raft group commits
  • Increased stability of leader terms
  • Prevent previously left nodes from causing re-elections

BUG FIXES:

  • Fixed memory leak in in-memory stats system
  • Fixing race between RPC and Raft init [GH-160]
  • Server-local RPC is avoids network [GH-148]
  • Fixing builds for older OSX [GH-147]

MISC:

  • Fixed missing prefixes on some log messages
  • Removed the -role filter of members command
  • Lots of docs fixes

0.2.1 (May 20, 2014)

IMPROVEMENTS:

  • Improved the URL formatting for the key/value editor in the Web UI. Importantly, the editor now allows editing keys with dashes in the name. [GH-119]
  • The web UI now has cancel and delete folder actions in the key/value editor. [GH-124], [GH-122]
  • Add flag to agent to write pid to a file. [GH-106]
  • Time out commands if Raft exceeds command enqueue timeout
  • Adding support for the -advertise CLI flag. [GH-156]
  • Fixing potential name conflicts on the WAN gossip ring [GH-158]
  • /v1/catalog/services returns an empty slice instead of null. [GH-145]
  • members command returns exit code 2 if no results. [GH-116]

BUG FIXES:

  • Renaming "separator" to "separator". This is the correct spelling, but both spellings are respected for backwards compatibility. [GH-101]
  • Private IP is properly found on Windows clients.
  • Windows agents won't show "failed to decode" errors on every RPC request.
  • Fixed memory leak with RPC clients. [GH-149]
  • Serf name conflict resolution disabled. [GH-97]
  • Raft deadlock possibility fixed. [GH-141]

MISC:

  • Updating to latest version of LMDB
  • Reduced the limit of KV entries to 512KB. [GH-123].
  • Warn if any Raft log exceeds 1MB
  • Lots of docs fixes

0.2.0 (May 1, 2014)

FEATURES:

  • Adding Web UI for Consul. This is enabled by providing the -ui-dir flag with the path to the web directory. The UI is visited at the standard HTTP address (Defaults to http://127.0.0.1:8500/). There is a demo available here.
  • Adding new read consistency modes. ?consistent can be used for strongly consistent reads without caveats. ?stale can be used for stale reads to allow for higher throughput and read scalability. [GH-68]
  • /v1/health/service/ endpoint can take an optional ?passing flag to filter to only nodes with passing results. [GH-57]
  • The KV endpoint supports listing keys with the ?keys query parameter, and limited up to a separator using ?separator=.

IMPROVEMENTS:

  • Health check output goes into separate Output field instead of overriding Notes. [GH-59]
  • Adding a minimum check interval to prevent checks with extremely low intervals fork bombing. [GH-64]
  • Raft peer set cleared on leave. [GH-69]
  • Case insensitive parsing checks. [GH-78]
  • Increase limit of DB size and Raft log on 64bit systems. [GH-81]
  • Output of health checks limited to 4K. [GH-83]
  • More warnings if GOMAXPROCS == 1 [GH-87]
  • Added runtime information to consul info

BUG FIXES:

  • Fixed 404 on /v1/agent/service/deregister and /v1/agent/check/deregister. [GH-95]
  • Fixed JSON parsing for /v1/agent/check/register [GH-60]
  • DNS parser can handler period in a tag name. [GH-39]
  • "application/json" content-type is sent on HTTP requests. [GH-45]
  • Work around for LMDB delete issue. [GH-85]
  • Fixed tag gossip propagation for rapid restart. [GH-86]

MISC:

  • More conservative timing values for Raft
  • Provide a warning if attempting to commit a very large Raft entry
  • Improved timeliness of registration when server is in bootstrap mode. [GH-72]

0.1.0 (April 17, 2014)

  • Initial release