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
Paul Banks 257ad520f2
Merge pull request #3928 from hashicorp/service-token-docs
Notes on ACL token storage and permissions
2018-03-02 16:28:56 +00:00
acl Cleans up some drift between the OSS and Enterprise trees. 2017-10-11 15:53:07 -07:00
agent Merge pull request #3899 from pierresouchay/fix_blocking_queries_index 2018-03-02 16:24:43 +00:00
api fix typo 2018-02-18 23:13:57 -08:00
bench Gets benchmarks running again and does a rough pass for 0.7.1. 2016-11-29 13:02:26 -08:00
command Fixes #3891: agent monitor no longer unresponsive before logs stream. 2018-02-19 21:53:10 +00:00
demo [demo/vagrant-cluster] upgrade from jessie to stretch 2018-02-13 20:01:36 +01:00
ipaddr New config parser, HCL support, multiple bind addrs (#3480) 2017-09-25 11:40:42 -07:00
lib remove golint warnings 2018-01-28 22:40:13 +04:00
logger golint: Untangle if blocks with return in else 2017-04-25 09:26:13 -07:00
scripts Bumps Go version back down to 1.9.3. 2018-02-08 19:42:53 -08:00
sentinel Renames stubs to be more consistent. 2017-11-29 18:36:52 -08:00
snapshot Removes timeout when restoring snapshots. 2017-12-13 14:10:54 -08:00
terraform consul upgraded to 1.0.0 in terraform scripts (#3588) 2017-10-18 10:08:25 -07:00
test Adds enable_agent_tls_for_checks configuration option which allows (#3661) 2017-11-07 18:22:09 -08:00
testrpc agent: move agent/consul/structs to agent/structs 2017-08-09 14:32:12 +02:00
testutil Bumps the standard retry up. 2018-02-07 18:03:39 -08:00
tlsutil Removes stale TLS config clone() in favor of new supported method. 2018-01-10 15:24:26 -08:00
types Removes remoteConsuls in favor of the new router. 2017-03-16 16:42:19 -07:00
ui Fixes erroneous closed <p> tag 2018-01-16 11:29:55 +00:00
vendor remove old pkgs and put deps of missing packages in vendor.json 2018-02-23 17:08:24 -05:00
version Puts the tree back into dev mode 2018-02-09 10:25:58 -08:00
watch watch: make sure invoke channels timeout evenutally 2017-10-24 20:35:36 +02:00
website Merge pull request #3928 from hashicorp/service-token-docs 2018-03-02 16:28:56 +00:00
.gitignore build: add changelogfmt target to format [GH-xxxx] references to links 2017-10-04 21:14:16 +02:00
.travis.yml Revert "Change .travis.yml, set parallel to 1 to pass tests" 2018-02-22 14:16:24 +01:00
CHANGELOG.md Update CHANGELOG.md 2018-03-02 16:27:48 +00:00
GNUmakefile Merge pull request #3903 from hashicorp/build-fixes 2018-02-23 13:12:45 +00:00
INTERNALS.md Adds a basic INTERNALS.md guide with some pointers into the code. 2018-02-08 17:05:36 -08:00
ISSUE_TEMPLATE.md Reorders the issue template. 2018-01-11 18:16:51 -08:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
README.md Adds a link to Consul Enterprise in the README. 2018-01-23 12:32:54 -08:00
Vagrantfile Adds a basic Linux Vagrant setup, stolen from Nomad. 2017-10-06 08:10:12 -07:00
main.go Adds a registry mechanism for CLI commands. 2017-11-29 18:36:52 -08: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. A commercial version called Consul Enterprise is also available.

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. The test suite may fail if over-parallelized, so if you are seeing stochastic failures try GOTEST_FLAGS="-p 2 -parallel 2" 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 and vendorfmt for formatting vendor.json to a more merge-friendly "one line per package" format.