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
Frank Schroeder e48df7b572
test: run all tests together again
Looks like I have eliminated the troublesome tests for now.
2017-05-31 10:00:10 +02:00
acl Adds support to the ACL package for agent policies. 2016-12-14 07:07:41 -08:00
api Don't overwrite Transport's TLS config if it's been set 2017-05-24 13:45:19 -07:00
bench Gets benchmarks running again and does a rough pass for 0.7.1. 2016-11-29 13:02:26 -08:00
command test: use test name as log prefix 2017-05-31 09:54:09 +02:00
consul test: don't panic if there is no error 2017-05-31 08:59:41 +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 agent: move isAddrANY to separate package 2017-05-15 22:44:43 +02:00
lib golint: Fix existing comments 2017-04-25 09:26:13 -07:00
logger golint: Untangle if blocks with return in else 2017-04-25 09:26:13 -07:00
scripts Bumps Go version to 1.8.3. 2017-05-24 19:35:01 -07:00
snapshot test: add helper for ioutil.TempDir/TempFile 2017-05-12 22:12:47 +02:00
terraform Update install.sh for Consul 0.8.3 2017-05-12 12:52:59 -04:00
test Updates expired test certs and includes a script to generate new certs. 2017-05-12 09:28:21 +02:00
testrpc test: Drop WaitForResult from testutil and testrpc 2017-05-05 17:07:03 +02:00
testutil test: shutdown server properly 2017-05-31 00:29:22 +02: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 Merge pull request #2812 from naaaargle/master 2017-05-18 10:28:28 -04:00
vendor vendor: patch github.com/mitchellh/cli until help output is fixed 2017-05-31 00:29:29 +02:00
version Puts the tree in version 0.8.4 dev mode. 2017-05-11 18:52:37 -07:00
watch golint: No stutter 2017-04-25 09:26:13 -07:00
website Add settings for upshifting to encrypted gossip (#3079) 2017-05-30 08:51:37 -07:00
.gitignore build: cleanup .gitignore 2017-04-27 10:34:30 -07:00
.travis.yml Bumps Go version to 1.8.3. 2017-05-24 19:35:01 -07:00
CHANGELOG.md Update CHANGELOG.md 2017-05-30 08:52:51 -07:00
GNUmakefile test: run all tests together again 2017-05-31 10:00:10 +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 Bumps Go version to 1.8. 2017-02-16 13:21:28 -08:00
commands.go golint: Rename fields and structs 2017-04-25 09:26:13 -07:00
main.go Remove duplicate constants 2017-04-20 09:54:49 -07:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
make.bat Removes the integration test runner, there weren't any tests using it. 2015-10-26 11:34:01 -07: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.8+ 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 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.

Building Consul on Windows

Make sure Go 1.8+ is installed on your system and that the Go command is in your %PATH%.

For building Consul on Windows, you also need to have MinGW installed. TDM-GCC is a simple bundle installer which has all the required tools for building Consul with MinGW.

Install TDM-GCC and make sure it has been added to your %PATH%.

If all goes well, you should be able to build Consul by running make.bat from a command prompt.

See also golang/winstrap and golang/wiki/WindowsBuild for more information of how to set up a general Go build environment on Windows with MinGW.

Vendoring

Consul currently uses govendor for vendoring.