be04bfed34
* Clean up handling of subprocesses and make using a shell optional * Update docs for subprocess changes * Fix tests for new subprocess behavior * More cleanup of subprocesses * Minor adjustments and cleanup for subprocess logic * Makes the watch handler reload test use the new path. * Adds check tests for new args path, and updates existing tests to use new path. * Adds support for script args in Docker checks. * Fixes the sanitize unit test. * Adds panic for unknown watch type, and reverts back to Run(). * Adds shell option back to consul lock command. * Adds shell option back to consul exec command. * Adds shell back into consul watch command. * Refactors signal forwarding and makes Windows-friendly. * Adds a clarifying comment. * Changes error wording to a warning. * Scopes signals to interrupt and kill. This avoids us trying to send SIGCHILD to the dead process. * Adds an error for shell=false for consul exec. * Adds notes about the deprecated script and handler fields. * De-nests an if statement. |
||
---|---|---|
acl | ||
agent | ||
api | ||
bench | ||
command | ||
configutil | ||
contrib | ||
demo/vagrant-cluster | ||
ipaddr | ||
lib | ||
logger | ||
scripts | ||
sentinel | ||
snapshot | ||
terraform | ||
test | ||
testrpc | ||
testutil | ||
tlsutil | ||
types | ||
ui | ||
vendor | ||
version | ||
watch | ||
website | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
CHANGELOG.md | ||
GNUmakefile | ||
ISSUE_TEMPLATE.md | ||
LICENSE | ||
README.md | ||
main.go | ||
main_test.go |
README.md
Consul
- Website: https://www.consul.io
- Chat: Gitter
- Mailing list: Google Groups
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:
Developing Consul
If you wish to work on Consul itself, you'll first need Go installed (version 1.9+ 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 build all os/architecture combinations. Set the environment variable CONSUL_DEV=1
to build it just for your local machine's os/architecture, or use make dev
.
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.
Vendoring
Consul currently uses govendor for vendoring.