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,708 Commits 445 Branches 179 Tags 481 MiB
Go 65.8%
MDX 16.4%
SCSS 9.4%
JavaScript 4.1%
Handlebars 1.8%
Other 2.4%
Go to file
Ryan Uber 8455077e5d api: add harnessing for tests 
This is necessary as consul-api's tests require a real consul instance
to be running. We can't directly import an agent to fire up an instance,
due to the way this would create an import cycle. These tests instead
will start a consul instance using the binary in $PATH (if it exists).
 		2015-01-06 15:52:06 -08:00
acl typofixes - https://github.com/vlajos/misspell_fixer 2014-12-04 23:25:06 +00:00
api api: add harnessing for tests 2015-01-06 15:52:06 -08:00
bench Cutting v0.4.1 2014-10-17 11:00:59 -07:00
command api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
consul consul: Minor cleanup 2014-12-12 22:17:41 -08:00
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 Make the 'consul version' to return value that is from 'git describe --tags' 2014-11-18 22:15:58 +00: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 agent: fix test cases 2014-11-19 16:36:18 -08:00
tlsutil Moved TLS Config stuff to tlsutil package 2014-11-18 11:03:36 -05:00
ui ui: confirm dialog only when deleting key directories #521 2014-12-06 12:00:51 -08:00
watch api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
website Merge pull request #543 from lyrixx/patch-2 2014-12-16 21:59:30 -08:00
.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 Vagrant updates 2014-12-04 21:24:05 -08: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.