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.
2314 Commits
1700 Branches
457 Tags
682 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6f0b1a3b46'
${ noResults }
Go to file
Ryan Uber 6f0b1a3b46
agent: Add test for CNAME recursion 		10 years ago
acl typofixes - https://github.com/vlajos/misspell_fixer 10 years ago
api Read select environment variables when generating the default configuration 10 years ago
bench Cut v0.5.0 10 years ago
command agent: Add test for CNAME recursion 10 years ago
consul Merge pull request #857 from hashicorp/f-boltdb 10 years ago
contrib/zsh-completion Add new 0.5 commands 10 years ago
demo/vagrant-cluster Cut v0.5.0 10 years ago
deps Adding the dep file for 0.5.0 10 years ago
scripts Add XXX to the end of mktemp template to support more linux versions. 10 years ago
terraform Merge pull request #784 from byu/master 10 years ago
test Add some basic smoke tests for wrapTLSclient. 11 years ago
testutil testutil: Using the correct RPC struct 11 years ago
tlsutil Moved TLS Config stuff to tlsutil package 10 years ago
ui make sure button text overflow is set to ellipsis 10 years ago
watch api: initial import from armon/consul-api 10 years ago
website Website: cleanup for docs/internals/security.html. 10 years ago
.gitignore Ignore vim swap files 10 years ago
.travis.yml Only build pushes to master and PR's on travis 10 years ago
CHANGELOG.md Update CHANGELOG.md 10 years ago
LICENSE Initial commit 11 years ago
Makefile Build consul to a temp dir for API tests 10 years ago
README.md make.bat: add Makefile functionality for Windows 10 years ago
Vagrantfile Update Vagrantfile 10 years ago
commands.go Handle SIGTERM when running commands 10 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 make.bat: add Makefile functionality for Windows 10 years ago
version.go version update for dev 10 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.4+ 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.4+ 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.