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
5,340 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
James Phillips e4eb5960fe Merge pull request #2844 from hashicorp/agent-acl-default 
Disables agent-level enforcement on Consul agents unless acl_datacenter is set.
 		2017-03-29 13:01:35 -07:00
acl Adds support to the ACL package for agent policies. 2016-12-14 07:07:41 -08:00
api Use new APIs 2017-03-23 18:48:13 -04:00
bench Gets benchmarks running again and does a rough pass for 0.7.1. 2016-11-29 13:02:26 -08:00
command Disables agent-level enforcement on Consul agents unless acl_datacenter is set. 2017-03-29 12:24:42 -07:00
consul Use the new raft api function for leaving if applicable 2017-03-27 12:31:38 -07:00
contrib Merge pull request #1863 from mssola/bash-completion 2016-07-05 12:52:58 -07:00
demo/vagrant-cluster Install latest version by default 2017-03-01 13:19:59 -05:00
lib Adds missing unit tests and cleans up some router bugs. 2017-03-16 16:42:19 -07:00
logger Fix vet issues 2017-03-23 20:29:31 -04:00
scripts Fixes up some stale BUILD_TAGS references in the scripts. 2017-03-23 22:52:39 -07:00
snapshot Adjusts location of archive test fixtures. 2016-11-03 21:42:50 -07:00
terraform Removes an obsolete environment variable from the example upstart script. 2017-02-01 16:56:53 -08:00
test Add utility types to enable checking for unset flags 2017-02-07 20:14:41 -05:00
testutil Cleans up a stray mark and fixes unit tests. 2017-03-27 01:28:54 -07:00
tlsutil Add TLSMinVersion to config options 2017-02-01 16:20:33 -05:00
types Removes remoteConsuls in favor of the new router. 2017-03-16 16:42:19 -07:00
ui UI: add notification for disabled JavaScript 2017-01-05 09:10:58 -05:00
vendor Add pkg/errors 2017-03-23 18:41:20 -04:00
version Puts tree back in dev mode. 2017-03-27 18:44:22 -07:00
watch Moves stale code to same spot and adds it everywhere that supports it. 2016-08-10 15:49:51 -07:00
website Disables agent-level enforcement on Consul agents unless acl_datacenter is set. 2017-03-29 12:24:42 -07:00
.gitignore Use gox for building 2015-10-22 14:16:01 -04:00
.travis.yml Modernize makefile a bit 2017-03-23 20:29:32 -04:00
CHANGELOG.md Update CHANGELOG.md 2017-03-28 12:02:19 -07:00
GNUmakefile Modernize makefile a bit 2017-03-23 20:29:32 -04:00
ISSUE_TEMPLATE.md Revise issue template to include a hint to use a gist 2016-04-28 22:27:25 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
README.md Bumps Go version to 1.8. 2017-02-16 13:21:28 -08:00
commands.go Merge pull request #2771 from hashicorp/f-autopilot 2017-02-28 15:04:16 -08:00
main.go Update website docs for validate command 2017-02-10 19:38:38 -05: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

README.md

Consul Build Status Join the chat at https://gitter.im/hashicorp-consul/Lobby

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, FreeBSD, Solaris, and Windows.

Quick Start

An extensive quick start is viewable on the Consul website:

https://www.consul.io/intro/getting-started/install.html

Documentation

Full, comprehensive documentation is viewable on the Consul website:

https://www.consul.io/docs

Developing Consul

If you wish to work on Consul itself, you'll first need Go installed (version 1.8+ 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:

$ 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.8+ 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.

Vendoring

Consul currently uses govendor for vendoring.