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
Christopher "Chief" Najewicz 0b710b4a7a Update docs for retry_join cloud discovery to include snippet around (#3577)
using HTTP_PROXY, HTTPS_PROXY and NO_PROXY env vars when needed
2017-10-17 16:05:44 -07:00
acl Cleans up some drift between the OSS and Enterprise trees. 2017-10-11 15:53:07 -07:00
agent Replace time.Now().Sub(x) with time.Since(x) 2017-10-17 20:38:24 +02:00
api Replace time.Now().Sub(x) with time.Since(x) 2017-10-17 20:38:24 +02:00
bench Gets benchmarks running again and does a rough pass for 0.7.1. 2016-11-29 13:02:26 -08:00
command commands: get HTTP API flags for usage automatically 2017-10-18 00:08:45 +02:00
contrib Merge pull request #1863 from mssola/bash-completion 2016-07-05 12:52:58 -07:00
demo/vagrant-cluster Install latest version by default 2017-03-01 13:19:59 -05:00
ipaddr New config parser, HCL support, multiple bind addrs (#3480) 2017-09-25 11:40:42 -07:00
lib Makes RPC handling more robust when rolling servers. (#3561) 2017-10-10 15:19:50 -07:00
logger golint: Untangle if blocks with return in else 2017-04-25 09:26:13 -07:00
scripts Adds a basic Linux Vagrant setup, stolen from Nomad. 2017-10-06 08:10:12 -07:00
sentinel Introduce Code Policy validation via sentinel, with a noop implementation 2017-09-25 13:44:55 -05:00
snapshot test: add helper for ioutil.TempDir/TempFile 2017-05-12 22:12:47 +02:00
terraform Fix a typo in output. 2017-09-05 09:14:21 -07:00
test Makes porter take over if an existing instance died. 2017-09-26 16:25:18 -07:00
testrpc agent: move agent/consul/structs to agent/structs 2017-08-09 14:32:12 +02:00
testutil agent: consolidate handling of 405 Method Not Allowed (#3405) 2017-09-25 23:11:19 -07:00
tlsutil Add a path for transitioning to TLS on an existing cluster (#3001) 2017-05-10 14:25:48 -07:00
types Removes remoteConsuls in favor of the new router. 2017-03-16 16:42:19 -07:00
ui Fixes an XSS issue with unescaped node names. (#3578) 2017-10-16 09:12:36 -07:00
vendor revert monkey patch for mitchellh/cli 2017-10-18 00:08:45 +02:00
version Puts the tree in 1.0.1 dev mode. 2017-10-16 10:28:06 -07:00
watch Use new DeletePrefixMethod for implementing KVSDeleteTree operation. This makes deletes on sub trees larger than one million nodes about 100 times faster. Added unit tests. 2017-07-25 17:21:18 -05:00
website Update docs for retry_join cloud discovery to include snippet around (#3577) 2017-10-17 16:05:44 -07:00
.gitignore build: add changelogfmt target to format [GH-xxxx] references to links 2017-10-04 21:14:16 +02:00
.travis.yml Removes Go 1.8.x. 2017-09-07 09:20:52 -07:00
CHANGELOG.md Puts the tree in 1.0 final release mode. 2017-10-16 09:16:52 -07:00
GNUmakefile build: add changelogfmt target to format [GH-xxxx] references to links 2017-10-04 21:14:16 +02:00
ISSUE_TEMPLATE.md Revise issue template to include a hint to use a gist 2016-04-28 22:27:25 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
README.md Upgrades Go version to 1.9. 2017-08-29 15:32:34 -07:00
Vagrantfile Adds a basic Linux Vagrant setup, stolen from Nomad. 2017-10-06 08:10:12 -07:00
main.go Autocomplete support 2017-10-06 15:05:45 -05:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00

README.md

Consul Build Status Join the chat at https://gitter.im/hashicorp-consul/Lobby

Consul is a tool for service discovery and configuration. Consul is distributed, highly available, and extremely scalable.

Consul provides several key features:

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

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

Consul runs on Linux, Mac OS X, FreeBSD, Solaris, and Windows.

Quick Start

An extensive quick start is viewable on the Consul website:

https://www.consul.io/intro/getting-started/install.html

Documentation

Full, comprehensive documentation is viewable on the Consul website:

https://www.consul.io/docs

Developing Consul

If you wish to work on Consul itself, you'll first need Go installed (version 1.9+ is required). Make sure you have Go properly installed, including setting up your GOPATH.

Next, clone this repository into $GOPATH/src/github.com/hashicorp/consul and then just type make. In a few moments, you'll have a working consul executable:

$ make
...
$ bin/consul
...

Note: make will build all os/architecture combinations. Set the environment variable CONSUL_DEV=1 to build it just for your local machine's os/architecture, or use make dev.

Note: make will also place a copy of the binary in the first part of your $GOPATH.

You can run tests by typing make test.

If you make any changes to the code, run make format in order to automatically format the code according to Go standards.

Vendoring

Consul currently uses govendor for vendoring.