github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3544 Commits
1703 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Tree: 60e54b8a07
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '60e54b8a07'
${ noResults }
James Phillips 60e54b8a07
Preps master for 0.7 development. 		9 years ago
Godeps Update go-cleanhttp 9 years ago
acl Renames "prepared_query" ACL policy to "query". 9 years ago
api Adds support for new PUT API for checks. 9 years ago
bench Fix Consul download link in benchmark scripts 9 years ago
command Correct the rtt -wan error message 9 years ago
consul one line schema change to not allow missing for sessions Table node index, Fixes #1774 9 years ago
contrib/zsh-completion Don't assume /bin/bash is installed on all OSes 9 years ago
demo/vagrant-cluster Update consul version for vagrant demo 9 years ago
lib Cull unused function and its unit test. 9 years ago
scripts Sets CGO_ENABLED to 0 in the Dockerfile. 9 years ago
terraform add asia pacific region to list for ubuntu 9 years ago
test Reissues cert for the unit tests, which expired a few days ago. 10 years ago
testutil Update cleanhttp repo location 9 years ago
tlsutil tlsutil: Testing hostname verification 10 years ago
ui Acknowledge that we're using GNU make's dialect and rename appropriate 9 years ago
vendor Metric name typo 9 years ago
watch api: initial import from armon/consul-api 10 years ago
website Fixes name of new query ACL. 9 years ago
.gitignore Use gox for building 9 years ago
.travis.yml Takes away Go tip build which is failing for odd reasons. 9 years ago
CHANGELOG.md Preps master for 0.7 development. 9 years ago
GNUmakefile Tweaks some of the default makefile targets. 9 years ago
LICENSE Initial commit 11 years ago
README.md Changes readme Go version to 1.5.3. 9 years ago
commands.go Gives RTT class a more Go-like name. 9 years ago
main.go Always seed math/rand on consul startup 9 years ago
main_test.go Adding basic CLI infrastructure 11 years ago
make.bat Removes the integration test runner, there weren't any tests using it. 9 years ago
version.go Preps master for 0.7 development. 9 years ago

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 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.5.3+ 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:

$ go get -u ./...
$ 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.5.3+ 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.