status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
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. https://www.consul.io
1,719 Commits 445 Branches 179 Tags 489 MiB
Go 62.5%
MDX 18.2%
SCSS 10.2%
JavaScript 4.4%
Handlebars 1.9%
Other 2.7%
Go to file
Seth Vargo be1b51a88d Minor deployment fixes 2015-01-02 16:28:56 -05:00
acl typofixes - https://github.com/vlajos/misspell_fixer 2014-12-04 23:25:06 +00:00
bench Cutting v0.4.1 2014-10-17 11:00:59 -07:00
command Test both ?pretty both bare and with value. 2015-01-02 09:15:41 +01:00
consul consul: Collect useful session metrics 2015-01-02 22:46:51 +05:30
demo/vagrant-cluster Install curl 2014-10-17 21:39:44 -07:00
deps deps: add 0.4.1 deps file, rename 0-4.1 to match naming convention 2014-11-15 22:40:36 -08:00
scripts Minor deployment fixes 2015-01-02 16:28:56 -05:00
terraform typofixes - https://github.com/vlajos/misspell_fixer 2014-12-04 23:25:06 +00:00
test Add some basic smoke tests for wrapTLSclient. 2014-06-29 18:11:32 -07:00
testutil testutil: Using the correct RPC struct 2014-06-10 19:12:36 -07:00
tlsutil Moved TLS Config stuff to tlsutil package 2014-11-18 11:03:36 -05:00
ui Update titles to be consistent with other sites 2014-12-30 13:18:25 -05:00
watch Fix missing arguments 2014-11-01 22:56:48 +01:00
website Merge pull request #563 from hashicorp/sethvargo/update_docs 2015-01-02 21:55:27 +05:30
.gitignore ui: ignore compiled js, dist 2014-05-01 11:22:30 -04:00
.travis.yml Adding Travis file 2014-04-19 13:40:38 -07:00
CHANGELOG.md typofixes - https://github.com/vlajos/misspell_fixer 2014-12-04 23:25:06 +00:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
Makefile Separate cover target for tests 2014-12-05 18:47:23 -08:00
README.md suggest 'go get -u ./... before running make 2014-09-02 10:49:28 -07:00
Vagrantfile Minor deployment fixes 2015-01-02 16:28:56 -05:00
build.bat Make modulename param so build.bat can be generalized and used for any go project 2014-12-13 12:11:41 -08:00
commands.go Only override version pre-release if blank 2014-11-24 11:05:11 -08:00
main.go main: Fixing app name 2014-04-11 16:23:05 -07:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
version.go Make the 'consul version' to return value that is from 'git describe --tags' 2014-11-18 22:15:58 +00:00

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.