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.
3075 Commits
1702 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b087331c2b'
${ noResults }
Go to file
James Phillips b087331c2b
Release v0.6.0-rc1 		9 years ago
acl Fix a bunch of typos. 9 years ago
api Adds support for coordinates to client API. 9 years ago
bench Bump version references 10 years ago
command Fixes a go vet finding. 9 years ago
consul Changes batch update failure to a WARN since it's nbd. 9 years ago
contrib/zsh-completion Add new 0.5 commands 10 years ago
demo/vagrant-cluster Fix missing config-dir in getting started guide 9 years ago
deps Adding dep 10 years ago
scripts Removes netbsd and openbsd for now. 9 years ago
terraform gc duplicate platform variable 10 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 Moves the static assets into a subfolder where index.html expects them. 9 years ago
watch api: initial import from armon/consul-api 10 years ago
website Add trailing slash to avoid a redirect 9 years ago
.gitignore Use gox for building 9 years ago
.travis.yml travis-ci: use newer build infra 9 years ago
CHANGELOG.md Updates the CHANGELOG with all the 0.6.0 updates. 9 years ago
LICENSE
…
Makefile Makes the Makefile pull the tools it needs on the first run. 9 years ago
README.md Updates go version to 1.5.1, and modernizes the Vagrantfile. 9 years ago
Vagrantfile Adds zip to the Vagrant box so a make works there without any fiddling. 9 years ago
commands.go Gives RTT class a more Go-like name. 9 years ago
main.go main: do not process -v or --version after a '--' 10 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 the version for the first RC. 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:

http://www.consul.io/intro/getting-started/install.html

Documentation

Full, comprehensive documentation is viewable on the Consul website:

http://www.consul.io/docs

Developing Consul

If you wish to work on Consul itself, you'll first need Go installed (version 1.5.1+ 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.1+ 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.