Go to file
Matt Keeler 42867dba4d
Update CHANGELOG.md
2018-04-12 12:13:19 -04:00
acl Spelling (#3958) 2018-03-19 16:56:00 +00:00
agent Merge pull request #4023 from hashicorp/f-near-ip 2018-04-12 12:10:48 -04:00
api Allow ignoring checks by ID when defining a PreparedQuery. Fixes #3727. 2018-04-10 14:04:16 +01:00
bench
command Address PR feedback 2018-04-02 09:23:01 -04:00
demo [demo/vagrant-cluster] upgrade from jessie to stretch 2018-02-13 20:01:36 +01:00
ipaddr
lib remove golint warnings 2018-01-28 22:40:13 +04:00
logger
scripts Bumps go version to 1.10 2018-03-27 17:27:51 +01:00
sentinel
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
testrpc
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
ui Spelling (#3958) 2018-03-19 16:56:00 +00:00
vendor Add support for compression in http api 2018-04-03 22:33:13 +02:00
version Puts the tree back into dev mode 2018-02-09 10:25:58 -08:00
watch Add package name to log output 2018-03-21 15:56:14 +00:00
website Merge pull request #4023 from hashicorp/f-near-ip 2018-04-12 12:10:48 -04:00
.gitattributes
.gitignore
.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-04-12 12:13:19 -04:00
GNUmakefile Merge pull request #3903 from hashicorp/build-fixes 2018-02-23 13:12:45 +00: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
README.md Adds a link to Consul Enterprise in the README. 2018-01-23 12:32:54 -08:00
Vagrantfile
main.go Adds a registry mechanism for CLI commands. 2017-11-29 18:36:52 -08:00
main_test.go

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.