Go to file
Pierre Souchay 4739b05d12 Added labels to improve new metric 2018-04-18 16:51:22 +02:00
acl Spelling (#3958) 2018-03-19 16:56:00 +00:00
agent Added labels to improve new metric 2018-04-18 16:51:22 +02:00
api Allow ignoring checks by ID when defining a PreparedQuery. Fixes #3727. 2018-04-10 14:04:16 +01:00
bench Gets benchmarks running again and does a rough pass for 0.7.1. 2016-11-29 13:02:26 -08:00
command Update make static-assets goal and run format 2018-04-13 09:57:25 -07:00
demo Enables dig in cluster demo by installing dnsutils 2018-04-13 18:01:42 +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 to 1.10 2018-03-27 17:27:51 +01: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 Spelling (#3958) 2018-03-19 16:56:00 +00: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 Spelling (#3958) 2018-03-19 16:56:00 +00:00
tlsutil 🐛 Formatting changes only; add missing trailing commas 2018-03-15 10:19:46 -07:00
types Removes remoteConsuls in favor of the new router. 2017-03-16 16:42:19 -07:00
ui Update static assets 2018-04-13 10:05:30 -07:00
vendor Add support for compression in http api 2018-04-03 22:33:13 +02:00
version Put tree back into dev mode 2018-04-13 17:17:29 -05:00
watch Add package name to log output 2018-03-21 15:56:14 +00:00
website website: fix a broken link 2018-04-13 10:33:29 -07:00
.gitattributes Initial commit 2013-11-04 14:15:27 -08:00
.gitignore build: add changelogfmt target to format [GH-xxxx] references to links 2017-10-04 21:14:16 +02:00
.travis.yml Travis evaluates ENV before cloning git repo and cding so we need to delay gathering packages until the makefile 2018-02-21 12:54:23 +00:00
CHANGELOG.md Put tree back into dev mode 2018-04-13 17:17:29 -05:00
GNUmakefile Update make static-assets goal and run format 2018-04-13 09:57:25 -07:00
INTERNALS.md Spelling (#3958) 2018-03-19 16:56:00 +00: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.