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
J.C. Jones 7689a5ef2d
Document that DNS lookups can target cluster peers (#17990)
Static DNS lookups, in addition to explicitly targeting a datacenter,
can target a cluster peer. This was added in 95dc0c7b30 but didn't make the documentation.

The driving function for the change is `parseLocality` here: 0b1299c28d/agent/dns_oss.go (L25)

The biggest change in this is to adjust the standard lookup syntax to tie
`.<datacenter>` to `.dc` as required-together, and to append in the similar `.<cluster-peer>.peer` optional argument, both to A record and SRV record lookups.

Co-authored-by: David Yu <dyu@hashicorp.com>
2023-07-05 15:03:42 -07:00
.changelog [OSS] Improve Gateway Test Coverage of Catalog Health (#18011) 2023-07-05 11:30:48 -04:00
.github Revert "Add workflow to verify linux release packages (#17904)" (#17942) 2023-06-28 14:18:53 -06:00
.release Resolves issue-16844 - systemd notify by default (#16845) 2023-06-02 10:04:48 -07:00
acl server: wire up in-process Resource Service (#16978) 2023-04-18 10:03:23 +01:00
agent feat: include nodes count in operator usage endpoint and cli command (#17939) 2023-07-05 11:23:29 -04:00
api feat: include nodes count in operator usage endpoint and cli command (#17939) 2023-07-05 11:23:29 -04:00
bench
build-support Revert "Add workflow to verify linux release packages (#17904)" (#17942) 2023-06-28 14:18:53 -06:00
command [OSS] Improve Gateway Test Coverage of Catalog Health (#18011) 2023-07-05 11:30:48 -04:00
connect Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
contributing Move contributing to docs 2021-08-30 16:17:09 -04:00
docs Add documentation for remote debugging of integration tests. (#17800) 2023-06-20 15:14:15 +00:00
envoyextensions Update list of Envoy versions (#17546) 2023-06-09 02:37:49 +00:00
grafana
internal resource: enforce consistent naming of resource types (#17611) 2023-06-26 13:25:14 +01:00
ipaddr Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
lib hoststats: add package for collecting host statistics including cpu memory and disk usage (#17038) 2023-05-30 18:43:29 +00:00
logging Controller Supervision (#17016) 2023-04-25 12:52:35 +01:00
proto Expose JWKS cluster config through JWTProviderConfigEntry (#17978) 2023-07-04 09:12:06 -04:00
proto-public Fix missing BalanceOutboundConnections in v2 catalog. (#17964) 2023-06-29 16:04:21 -05:00
sdk Catalog V2 Container Based Integration Test (#17674) 2023-06-16 16:29:50 -04:00
sentinel Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
service_os Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
snapshot snapshot: some improvments to the snapshot process (#17236) 2023-05-09 15:28:52 -04:00
test [OSS] Improve Gateway Test Coverage of Catalog Health (#18011) 2023-07-05 11:30:48 -04:00
testrpc Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
tlsutil tlsutil: Fix check TLS configuration (#17481) 2023-06-28 09:24:51 -07:00
tools/internal-grpc-proxy Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
troubleshoot Various bits of cleanup detected when using Go Workspaces (#17462) 2023-06-05 16:08:39 -04:00
types Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
ui ci: remove test-integrations CircleCI workflow (#16928) 2023-04-19 16:19:29 +00:00
version [OSS] Post Consul 1.16 updates (#17606) 2023-06-07 21:46:49 +00:00
website Document that DNS lookups can target cluster peers (#17990) 2023-07-05 15:03:42 -07:00
.copywrite.hcl Remove UI brand-loader copyright headers as they do not render appropriately (#16835) 2023-03-31 11:29:19 -04:00
.dockerignore
.gitignore Various bits of cleanup detected when using Go Workspaces (#17462) 2023-06-05 16:08:39 -04:00
.golangci.yml Various bits of cleanup detected when using Go Workspaces (#17462) 2023-06-05 16:08:39 -04:00
CHANGELOG.md Add changelog entry for 1.16.0 (#17987) 2023-06-30 20:29:47 +00:00
Dockerfile Bump Alpine to 3.18 (#17719) 2023-06-14 01:02:05 +00:00
GNUmakefile Reference hashicorp/consul instead of consul for Docker image (#17914) 2023-06-27 23:17:20 +00:00
LICENSE [COMPLIANCE] Update MPL-2.0 LICENSE (#14964) 2022-11-09 12:24:14 -06:00
NOTICE.md
README.md Fixed broken links referring to tutorials running as local agent (#14954) 2022-10-11 13:01:29 -07:00
buf.work.yaml Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
fixup_acl_move.sh Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -04:00
go.mod deps: coredns v1.10.1 (#17912) 2023-06-28 07:53:43 -07:00
go.sum deps: coredns v1.10.1 (#17912) 2023-06-28 07:53:43 -07:00
main.go Copyright headers for missing files/folders (#16708) 2023-03-28 18:48:58 -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 - 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.

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