Skip to content

/consul

Consul is a tool for service discovery, monitoring and configuration.
  1. Go 88.1%
  2. HTML 4.0%
  3. CSS 3.3%
  4. JavaScript 3.1%
  5. Shell 0.6%
  6. Ruby 0.4%
  7. Other 0.5%
Go HTML CSS JavaScript Shell Ruby Other
Find file
Latest commit 6e061b2 Jul 2, 2016 @slackpad slackpad committed on GitHub Merge pull request #2160 from hashicorp/f-api-pq-template 
Adds query templates to the api package
Failed to load latest commit information.
Godeps Updates go-immutable-radix to pull in caching fix. Jun 8, 2016
acl Renames "prepared_query" ACL policy to "query". Feb 24, 2016
api api: add query templates Jul 2, 2016
bench Fix Consul download link in benchmark scripts Feb 10, 2016
command Merge pull request #2137 from hashicorp/f-pq-near Jul 1, 2016
consul consul: sort source node first if at position <= 10 in PQ's Jul 1, 2016
contrib/zsh-completion Added help text for -dev option #1804 for zsh completion. Mar 28, 2016
demo/vagrant-cluster update vagrant demo Apr 27, 2016
lib Use a cryptographically secure seed May 2, 2016
scripts Enables fallback git tag check to fix Travis. Jun 3, 2016
terraform Merge pull request #2021 from MansM/patch-2 May 4, 2016
test Re-ups the snake oil certs for the unit tests. Jun 4, 2016
testutil Misc comment improvements Jun 20, 2016
tlsutil tlsutil: Testing hostname verification May 11, 2015
types Revert "Move `structs.CheckID` to a new top-level package, `types`." Jun 7, 2016
ui Updates web assets to pull in RTT viz. Jun 7, 2016
vendor Updates go-immutable-radix to pull in caching fix. Jun 9, 2016
watch Update Check API to use constants Apr 23, 2016
website small typo Jul 2, 2016
.gitignore Use gox for building Oct 22, 2015
.travis.yml Bump Go to 1.6.2 for Travis (just added) May 8, 2016
CHANGELOG.md Update CHANGELOG.md Jul 1, 2016
GNUmakefile Add `tools/cmd/cover` to GOTOOLS May 7, 2016
ISSUE_TEMPLATE.md Revise issue template to include a hint to use a gist Apr 28, 2016
LICENSE Initial commit Nov 4, 2013
README.md Update README.md May 12, 2016
commands.go Gives RTT class a more Go-like name. Oct 23, 2015
main.go Always seed math/rand on consul startup Jan 29, 2016
main_test.go Adding basic CLI infrastructure Dec 19, 2013
make.bat Removes the integration test runner, there weren't any tests using it. Oct 26, 2015
version.go Switch version back to `dev` Apr 6, 2016

README.md

Consul Build Status

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, and Windows. It is recommended to run the Consul servers only on Linux, however.

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.6+ 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.6+ 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.

Something went wrong with that request. Please try again.