Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure. https://www.consul.io
Go to file
Dan Upton 1c2c975b0b
xDS Load Balancing (#14397)
Prior to #13244, connect proxies and gateways could only be configured by an
xDS session served by the local client agent.

In an upcoming release, it will be possible to deploy a Consul service mesh
without client agents. In this model, xDS sessions will be handled by the
servers themselves, which necessitates load-balancing to prevent a single
server from receiving a disproportionate amount of load and becoming
overwhelmed.

This introduces a simple form of load-balancing where Consul will attempt to
achieve an even spread of load (xDS sessions) between all healthy servers.
It does so by implementing a concurrent session limiter (limiter.SessionLimiter)
and adjusting the limit according to autopilot state and proxy service
registrations in the catalog.

If a server is already over capacity (i.e. the session limit is lowered),
Consul will begin draining sessions to rebalance the load. This will result
in the client receiving a `RESOURCE_EXHAUSTED` status code. It is the client's
responsibility to observe this response and reconnect to a different server.

Users of the gRPC client connection brokered by the
consul-server-connection-manager library will get this for free.

The rate at which Consul will drain sessions to rebalance load is scaled
dynamically based on the number of proxies in the catalog.
2022-09-09 15:02:01 +01:00
.changelog xDS Load Balancing (#14397) 2022-09-09 15:02:01 +01:00
.circleci Run integration tests locally using amd64 (#14365) 2022-08-29 16:13:49 -07:00
.github ci: update backport-assistant to pick merge commit (#14408) 2022-08-30 15:44:06 -04:00
.release Merge pull request #13790 from hashicorp/post-publish-website 2022-08-08 10:55:11 -05:00
acl Add ACL enforcement to peering endpoints 2022-07-25 09:34:29 -06:00
agent xDS Load Balancing (#14397) 2022-09-09 15:02:01 +01:00
api Add kv txn get-not-exists operation. 2022-09-06 10:28:59 -05:00
bench
build-support chore: add multi-arch docker build for testing 2022-08-29 12:01:31 -04:00
command Merge branch 'main' of github.com:hashicorp/consul into derekm/split-grpc-ports 2022-09-06 10:51:04 -05:00
connect Add retries and debugging to flaky test 2022-08-08 15:26:44 -04:00
contributing Move contributing to docs 2021-08-30 16:17:09 -04:00
docs peering: add config to enable/disable peering (#13867) 2022-07-22 15:20:21 -07:00
grafana
internal Extract AWS auth implementation out of Consul (#13760) 2022-07-19 16:26:44 -05:00
ipaddr
lib Extract AWS auth implementation out of Consul (#13760) 2022-07-19 16:26:44 -05:00
logging xDS Load Balancing (#14397) 2022-09-09 15:02:01 +01:00
proto Merge pull request #14285 from hashicorp/NET-638-push-server-address-updates-to-the-peer 2022-09-07 09:30:45 -04:00
proto-public Make proto-public a Go module 2022-09-06 19:30:17 +01:00
sdk Track last user of a port 2022-08-08 17:30:05 -04:00
sentinel re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
service_os re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
snapshot Vendor in rpc mono repo for net/rpc fork, go-msgpack, msgpackrpc. (#12311) 2022-02-14 09:45:45 -08:00
test Suppress "unbound variable" error. (#14424) 2022-08-31 13:06:35 -07:00
testrpc feat(cli): add initial peering cli commands 2022-09-01 17:20:13 -04:00
tlsutil Added new auto_encrypt.grpc_server_tls config option to control AutoTLS enabling of GRPC Server's TLS usage 2022-08-24 12:31:38 -04:00
tools/internal-grpc-proxy grpc: rename public/private directories to external/internal (#13721) 2022-07-13 16:33:48 +01:00
types agent: convert listener config to TLS types (#12522) 2022-03-24 15:32:25 -04:00
ui ui: update tab nav steps to use `isVisible` vs `clickable` (#14517) 2022-09-08 12:46:49 +02:00
version Sync changes from 1.13.0 release (#14104) 2022-08-10 12:21:21 -07:00
website xDS Load Balancing (#14397) 2022-09-09 15:02:01 +01:00
.dockerignore
.gitignore chore: ignore vscode files 2022-07-25 12:31:58 -04:00
.golangci.yml lint net/rpc usage (#12816) 2022-09-02 09:56:40 -07:00
CHANGELOG.md docs: add 1.13 upgrade considerations to changelog 2022-08-19 11:29:57 -07:00
Dockerfile Add version label to Docker image (#14204) 2022-08-18 14:41:34 -04:00
GNUmakefile Run integration tests locally using amd64 (#14365) 2022-08-29 16:13:49 -07:00
LICENSE
NOTICE.md
README.md Adjust README header to work in light and dark modes 2022-02-07 16:46:46 -08:00
Vagrantfile
fixup_acl_move.sh Fixup script 2 2022-04-05 14:52:43 -07:00
go.mod Make proto-public a Go module 2022-09-06 19:30:17 +01:00
go.sum Fix: upgrade pkg imdario/merg to prevent merge config panic (#14237) 2022-08-17 21:14:04 -04:00
main.go Refactor some functions for better enterprise use (#13280) 2022-05-30 09:46:55 -04:00

README.md

Consul logo Consul

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/Service Segmentation - Consul Connect 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 without being aware of Connect at all.

  • 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.

  • Key/Value Storage - A flexible key/value store enables storing dynamic configuration, feature flagging, coordination, leader election and more. The simple HTTP API makes it easy to use anywhere.

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://www.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.