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.
1769 Commits
1702 Branches
457 Tags
697 MiB
 
 
 
 
 
 
Tree: 4192925086
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4192925086'
${ noResults }
Armon Dadgar 4192925086
Merge pull request #580 from hashicorp/f-merge 		10 years ago
acl typofixes - https://github.com/vlajos/misspell_fixer 10 years ago
bench
…
command Merge pull request #576 from hashicorp/f-verify-config 10 years ago
consul consul: Adding merge delegate to prevent mixing clusters 10 years ago
demo/vagrant-cluster
…
deps deps: add 0.4.1 deps file, rename 0-4.1 to match naming convention 10 years ago
scripts Minor deployment fixes 10 years ago
terraform typofixes - https://github.com/vlajos/misspell_fixer 10 years ago
test
…
testutil agent: fix test cases 10 years ago
tlsutil Moved TLS Config stuff to tlsutil package 10 years ago
ui Merge pull request #558 from ceh/http-api-response-headers 10 years ago
watch
…
website Merge pull request #558 from ceh/http-api-response-headers 10 years ago
.gitignore
…
.travis.yml
…
CHANGELOG.md typofixes - https://github.com/vlajos/misspell_fixer 10 years ago
LICENSE
…
Makefile Separate cover target for tests 10 years ago
README.md
…
Vagrantfile Minor deployment fixes 10 years ago
build.bat Make modulename param so build.bat can be generalized and used for any go project 10 years ago
commands.go Only override version pre-release if blank 10 years ago
main.go
…
main_test.go
…
version.go Make the 'consul version' to return value that is from 'git describe --tags' 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.2+ 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.