Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
 
 
 
 
 
 
Go to file
Derek Menteer 7d8764dc0e Fix xDS missing endpoint race condition.
This fixes the following race condition:
- Send update endpoints
- Send update cluster
- Recv ACK endpoints
- Recv ACK cluster

Prior to this fix, it would have resulted in the endpoints NOT existing in
Envoy. This occurred because the cluster update implicitly clears the endpoints
in Envoy, but we would never re-send the endpoint data to compensate for the
loss, because we would incorrectly ACK the invalid old endpoint hash. Since the
endpoint's hash did not actually change, they would not be resent.

The fix for this is to effectively clear out the invalid pending ACKs for child
resources whenever the parent changes. This ensures that we do not store the
child's hash as accepted when the race occurs.

An escape-hatch environment variable `XDS_PROTOCOL_LEGACY_CHILD_RESEND` was
added so that users can revert back to the old legacy behavior in the event
that this produces unknown side-effects. Visit the following thread for some
extra context on why certainty around these race conditions is difficult:
https://github.com/envoyproxy/envoy/issues/13009

This bug report and fix was mostly implemented by @ksmiley with some minor
tweaks.

Co-authored-by: Keith Smiley <ksmiley@salesforce.com>
2023-12-08 10:12:00 -06:00
.changelog Fix xDS missing endpoint race condition. 2023-12-08 10:12:00 -06:00
.github ci: fix escaping for Slack failure notifications (#19838) 2023-12-06 21:00:30 +00:00
.release OSS -> CE (community edition) changes (#18517) 2023-08-22 09:46:03 -05:00
acl [NET-6640] Adds "Policy" BindType to BindingRule (#19499) 2023-11-20 13:11:08 +00:00
agent Fix xDS missing endpoint race condition. 2023-12-08 10:12:00 -06:00
api Retry lint fixes (#19151) 2023-12-06 12:11:32 -05:00
bench Gets benchmarks running again and does a rough pass for 0.7.1. 2016-11-29 13:02:26 -08:00
build-support [NET-6650] Bump go version to 1.20.12 (#19840) 2023-12-06 13:22:00 -05:00
command NET-6784: Adding cli command to list exported services to a peer (#19821) 2023-12-07 12:55:15 +05:30
connect Retry lint fixes (#19151) 2023-12-06 12:11:32 -05:00
contributing Move contributing to docs 2021-08-30 16:17:09 -04:00
docs Add engineering docs for controllers and v2 architecture (#19671) 2023-11-17 17:55:09 -07:00
envoyextensions build: dependency updates for 1.17.0 (#19453) 2023-11-03 12:29:59 -04:00
grafana grafana: fix a query metrics from ent and add consul version (#18998) 2023-09-25 12:41:13 -04:00
internal Ensure that the default namespace always exists even prior to resource creation (#19852) 2023-12-07 13:23:06 -05:00
ipaddr [COMPLIANCE] License changes (#18443) 2023-08-11 09:12:13 -04:00
lib add DeliverLatest as common function for use by Manager and ProxyTracker Open (#19564) 2023-11-07 23:03:37 +00:00
logging unhack: fix broken `make lint` on macbooks (#19611) 2023-11-13 11:19:50 -06:00
proto [Cloud][CC-6925] Updates to pushing server state (#19682) 2023-12-04 10:25:18 -05:00
proto-public [Cloud][CC-6925] Updates to pushing server state (#19682) 2023-12-04 10:25:18 -05:00
sdk Retry lint fixes (#19151) 2023-12-06 12:11:32 -05:00
sentinel Remove old build tags (#19128) 2023-10-10 10:58:06 -04:00
service_os Remove old build tags (#19128) 2023-10-10 10:58:06 -04:00
snapshot [COMPLIANCE] License changes (#18443) 2023-08-11 09:12:13 -04:00
test Retry lint fixes (#19151) 2023-12-06 12:11:32 -05:00
test-integ Net-6730/namespace intg test (#19798) 2023-12-07 13:12:45 -05:00
testing/deployer NET-6643: upgrade test from 1.10 to 1.15 (lts) of a single cluster (#19847) 2023-12-06 19:45:37 +00:00
testrpc Retry lint fixes (#19151) 2023-12-06 12:11:32 -05:00
tlsutil [Cloud][CC-6925] Updates to pushing server state (#19682) 2023-12-04 10:25:18 -05:00
tools/internal-grpc-proxy [COMPLIANCE] License changes (#18443) 2023-08-11 09:12:13 -04:00
troubleshoot NET-3860 - [Supportability] consul troubleshoot CLI for verifying ports (#18329) 2023-12-06 11:12:15 +05:30
types [COMPLIANCE] License changes (#18443) 2023-08-11 09:12:13 -04:00
ui [NET-5688] APIGateway UI Topology Fixes (#19657) 2023-11-28 21:27:14 +00:00
version test: add test helper to detect if the current build is enterprise (#19201) 2023-11-13 10:30:07 -06:00
website NET-6784: Adding cli command to list exported services to a peer (#19821) 2023-12-07 12:55:15 +05:30
.copywrite.hcl Move ACL templated policies to hcl files (#18853) 2023-09-18 17:10:35 -04:00
.dockerignore Update the scripting 2018-06-14 21:42:47 -04:00
.gitignore add peering_commontopo tests [NET-3700] (#17951) 2023-07-18 16:41:30 -07:00
.golangci.yml dataplane: Allow getting bootstrap parameters when using V2 APIs (#18504) 2023-09-06 16:46:25 -06:00
.pre-commit-config.yaml unhack: add pre-commit guidelines (#19617) 2023-11-15 10:57:40 -06:00
CHANGELOG.md chore: update changelog for patch releases (#19855) 2023-12-07 12:43:33 -05:00
Dockerfile [COMPLIANCE] License changes (#18443) 2023-08-11 09:12:13 -04:00
Dockerfile-windows Envoy Integration Test Windows (#18007) 2023-07-21 20:26:00 +05:30
LICENSE license file updates (#19750) 2023-11-28 11:59:45 -08:00
Makefile Retry lint fixes (#19151) 2023-12-06 12:11:32 -05:00
README.md Update README.md (#19413) 2023-10-31 08:45:47 -07:00
buf.work.yaml [COMPLIANCE] License changes (#18443) 2023-08-11 09:12:13 -04:00
go.mod [Cloud][CC-6925] Updates to pushing server state (#19682) 2023-12-04 10:25:18 -05:00
go.sum [Cloud][CC-6925] Updates to pushing server state (#19682) 2023-12-04 10:25:18 -05:00
main.go [COMPLIANCE] License changes (#18443) 2023-08-11 09:12:13 -04:00

README.md

Consul logo Consul

License: BUSL-1.1 Docker Pulls Go Report Card

Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.

Consul provides several key features:

  • Multi-Datacenter - Consul is built to be datacenter aware, and can support any number of regions without complex configuration.

  • Service Mesh - Consul Service Mesh enables secure service-to-service communication with automatic TLS encryption and identity-based authorization. Applications can use sidecar proxies in a service mesh configuration to establish TLS connections for inbound and outbound connections with Transparent Proxy.

  • API Gateway - Consul API Gateway manages access to services within Consul Service Mesh, allow users to define traffic and authorization policies to services deployed within the mesh.

  • Service Discovery - Consul makes it simple for services to register themselves and to discover other services via a DNS or HTTP interface. External services such as SaaS providers can be registered as well.

  • Health Checking - Health Checking enables Consul to quickly alert operators about any issues in a cluster. The integration with service discovery prevents routing traffic to unhealthy hosts and enables service level circuit breakers.

  • Dynamic App Configuration - An HTTP API that allows users to store indexed objects within Consul, for storing configuration parameters and application metadata.

Consul runs on Linux, macOS, FreeBSD, Solaris, and Windows and includes an optional browser based UI. A commercial version called Consul Enterprise is also available.

Please note: We take Consul's security and our users' trust very seriously. If you believe you have found a security issue in Consul, please responsibly disclose by contacting us at security@hashicorp.com.

Quick Start

A few quick start guides are available on the Consul website:

Documentation

Full, comprehensive documentation is available on the Consul website: https://consul.io/docs

Contributing

Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance. For contributions specifically to the browser based UI, please refer to the UI's README.md for guidance.