Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
 
 
 
 
 
 
Go to file
hc-github-team-consul-core cc29508740
Backport of Docs/cluster peering 1.15 updates into release/1.14.x (#16397)
* backport of commit e878d2d3e4

* backport of commit 5a378f5794

* backport of commit 1f7e812d85

* Docs/cluster peering 1.15 updates (#16291)

* initial commit

* initial commit

* Overview updates

* Overview page improvements

* More Overview improvements

* improvements

* Small fixes/updates

* Updates

* Overview updates

* Nav data

* More nav updates

* Fix

* updates

* Updates + tip test

* Directory test

* refining

* Create restructure w/ k8s

* Single usage page

* Technical Specification

* k8s pages

* typo

* L7 traffic management

* Manage connections

* k8s page fix

* Create page tab corrections

* link to k8s

* intentions

* corrections

* Add-on intention descriptions

* adjustments

* Missing </CodeTabs>

* Diagram improvements

* Final diagram update

* Apply suggestions from code review

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
Co-authored-by: David Yu <dyu@hashicorp.com>

* diagram name fix

* Fixes

* Updates to index.mdx

* Tech specs page corrections

* Tech specs page rename

* update link to tech specs

* K8s - new pages + tech specs

* k8s - manage peering connections

* k8s L7 traffic management

* Separated establish connection pages

* Directory fixes

* Usage clean up

* k8s docs edits

* Updated nav data

* CodeBlock Component fix

* filename

* CodeBlockConfig removal

* Redirects

* Update k8s filenames

* Reshuffle k8s tech specs for clarity, fmt yaml files

* Update general cluster peering docs, reorder CLI > API > UI, cross link to kubernetes

* Fix config rendering in k8s usage docs, cross link to general usage from k8s docs

* fix legacy link

* update k8s docs

* fix nested list rendering

* redirect fix

* page error

---------

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
Co-authored-by: David Yu <dyu@hashicorp.com>
Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>

---------

Co-authored-by: boruszak <jeffrey.boruszak@hashicorp.com>
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
Co-authored-by: David Yu <dyu@hashicorp.com>
Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
2023-02-23 12:52:26 -06:00
.changelog backport of commit a0598b81a3 (#16362) 2023-02-22 16:52:41 +00:00
.circleci Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
.github Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
.release Enable ironbank integration (#14931) 2022-10-11 10:27:06 -04:00
acl Backport of Fixup authz for data imported from peers into release/1.14.x (#15355) 2022-11-14 13:36:51 -05:00
agent backport of commit 817d85df12 (#16343) 2023-02-21 20:10:52 +00:00
api fix: revert go mod compat for sdk,api to 1.19 (#16323) (#16327) 2023-02-18 15:12:36 -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 Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
command Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
connect Backport of connect: Add support for ConsulResolver to specifies a filter expression into release/1.14.x (#15800) 2022-12-19 18:23:39 +00:00
contributing Move contributing to docs 2021-08-30 16:17:09 -04:00
docs fix: missing UDP field in checkType (#14885) 2022-10-05 15:57:21 -04:00
grafana add readme outlining how to edit and publish 2021-01-12 14:47:11 -08:00
internal Backport of [OSS] Add boilerplate for proto files implementing BlockableQuery into release/1.14.x (#15558) 2022-11-25 15:47:34 -05:00
ipaddr Ensure Consul is IPv6 compliant (#5468) 2019-06-04 10:02:38 -04:00
lib Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
logging Backport of Update go version to 1.19 into release/1.14.x (#15139) 2022-10-24 16:12:42 -04:00
proto Backport of Bring back parameter ServerExternalAddresses in GenerateToken endpoint into release/1.14.x (#15296) 2022-11-08 15:31:17 -06:00
proto-public Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
sdk fix: revert go mod compat for sdk,api to 1.19 (#16323) (#16327) 2023-02-18 15:12:36 -05: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 backport of commit a0598b81a3 (#16362) 2023-02-22 16:52:41 +00:00
testrpc feat(cli): add initial peering cli commands 2022-09-01 17:20:13 -04:00
tlsutil Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05: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 Backport of ui: Add ServerExternalAddresses to peer token create form into release/1.14.x (#15620) 2022-11-30 18:59:52 +00:00
version Apply 1.14.4 changelog and prep for next release 2023-01-27 15:35:15 -06:00
website Backport of Docs/cluster peering 1.15 updates into release/1.14.x (#16397) 2023-02-23 12:52:26 -06:00
.dockerignore Update the scripting 2018-06-14 21:42:47 -04:00
.gitignore chore: ignore vscode files 2022-07-25 12:31:58 -04:00
.golangci.yml Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
CHANGELOG.md Apply 1.14.4 changelog and prep for next release 2023-01-27 15:35:15 -06:00
Dockerfile backport of commit a0598b81a3 (#16362) 2023-02-22 16:52:41 +00:00
GNUmakefile Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
LICENSE backport of commit 2db4256734 (#15314) 2022-11-09 13:24:44 -05:00
NOTICE.md add copyright notice file 2018-07-09 10:58:26 -07:00
README.md Fixed broken links referring to tutorials running as local agent (#14954) 2022-10-11 13:01:29 -07:00
Vagrantfile Adds a basic Linux Vagrant setup, stolen from Nomad. 2017-10-06 08:10:12 -07:00
fixup_acl_move.sh Fixup script 2 2022-04-05 14:52:43 -07:00
go.mod Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
go.sum Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05:00
main.go Manual Backport of [OSS] security: update go to 1.20.1 into release/1.14.x (#16321) 2023-02-17 18:11:45 -05: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.