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
3,056 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
Diptanu Choudhury 1633cf9d1c Some changes to the docker check docs 2015-10-28 14:24:03 -07:00
acl Fix a bunch of typos. 2015-09-15 13:22:08 +01:00
api Adds support for coordinates to client API. 2015-10-23 15:23:01 -07:00
bench Bump version references 2015-05-18 14:37:27 -07:00
command Makes the version upshift code look at the correct version field. 2015-10-27 14:44:34 -07:00
consul Adds a check for the minimum version as well. 2015-10-27 15:56:36 -07:00
contrib/zsh-completion Add new 0.5 commands 2015-01-30 00:12:03 -08:00
demo/vagrant-cluster Fix missing config-dir in getting started guide 2015-07-22 13:33:15 +02:00
deps Adding dep 2015-05-18 14:05:53 -07:00
scripts Use hc-releases to upload during dist 2015-10-26 17:30:29 -04:00
terraform gc duplicate platform variable 2015-06-25 08:39:22 +02:00
test Reissues cert for the unit tests, which expired a few days ago. 2015-05-27 15:08:58 -07:00
testutil Update cleanhttp repo location 2015-10-22 14:14:22 -04:00
tlsutil tlsutil: Testing hostname verification 2015-05-11 16:05:39 -07:00
ui Merge pull request #1338 from hashicorp/js-cleaning 2015-10-26 13:24:06 -05:00
watch api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
website Some changes to the docker check docs 2015-10-28 14:24:03 -07:00
.gitignore Use gox for building 2015-10-22 14:16:01 -04:00
.travis.yml travis-ci: use newer build infra 2015-07-28 09:13:25 -07:00
CHANGELOG.md Update CHANGELOG.md 2015-10-15 15:00:41 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
Makefile Makes the Makefile pull the tools it needs on the first run. 2015-10-26 16:00:51 -07:00
README.md Updates go version to 1.5.1, and modernizes the Vagrantfile. 2015-10-26 15:59:38 -07:00
Vagrantfile Updates go version to 1.5.1, and modernizes the Vagrantfile. 2015-10-26 15:59:38 -07:00
commands.go Gives RTT class a more Go-like name. 2015-10-23 15:23:01 -07:00
main.go main: do not process -v or --version after a '--' 2015-03-11 16:33:55 -07:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
make.bat Removes the integration test runner, there weren't any tests using it. 2015-10-26 11:34:01 -07:00
version.go Preps the version for the first RC. 2015-10-26 16:03:14 -07: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.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.