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.
An extensive quick start is viewable on the Consul website:
Full, comprehensive documentation is viewable on the Consul website:
Next, clone this repository into
then just type
make. In a few moments, you'll have a working
$ make ... $ bin/consul ...
make will also place a copy of the binary in the first part of your $GOPATH
You can run tests by typing
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
Consul currently uses Godep for vendoring. These steps can be used to update dependencies in a controlled way.
Start by running a clean golang container:
docker run -i -t -v `pwd`:/go/src/github.com/hashicorp/consul golang sh
After that, you'll get a shell inside the container:
go get github.com/tools/godepto install Godep.
cd /go/src/github.com/hashicorp/consulto change to the Consul repo. Note that we mounted that as a volume above into the
godep restoreto update the container with the current state of dependencies based on what's vendored.
- Update dependencies as needed.
godep saveand look at the results carefully before committing.