consul README

The project's README from github.com/hashicorp/consul. As one markdown file: README.md.

Consul logo Consul

License: BUSL-1.1 Docker Pulls Go Report Card Coverage

Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.

Consul provides several key features:

Consul runs on Linux, macOS, FreeBSD, Solaris, and Windows and includes an optional browser based UI. A commercial version called Consul Enterprise is also available.

Please note: We take Consul's security and our users' trust very seriously. If you believe you have found a security issue in Consul, please responsibly disclose by contacting us at [email protected].

Quick Start

A few quick start guides are available on the Consul website:

Documentation

Full, comprehensive documentation is available on the Consul website: https://developer.hashicorp.com/consul/docs

Contributing

Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance. For contributions specifically to the browser based UI, please refer to the UI's README.md for guidance.

consul (hashicorp/consul)

Searching Database…

30.1K ·GitHub
What is this?Consul is a distributed, highly available, data center aware solution for connecting and configuring applications across dynamic, distributed infrastructure. It is built to be datacenter aware and can support any number of regions without complex configuration.
So is this a library I import into my code, or a service I deploy?A service you deploy. Consul runs as a distributed system on Linux, macOS, FreeBSD, Solaris and Windows, ships with an optional browser based UI, and applications talk to it over DNS and HTTP interfaces.
How do I get it running — do I need Kubernetes first?No, Kubernetes is optional. The Consul website has quick start guides for a standalone binary install, Minikube, Kind, a full Kubernetes install, and deploying HCP Consul, plus full documentation.
How do services actually find each other through it?Services register themselves with Consul, and other services discover them through a DNS or HTTP interface. External services such as SaaS providers can be registered too, so everything lives in one discovery layer.
Does it keep the traffic between my services secure?Yes. Consul Service Mesh enables secure service-to-service communication with automatic TLS encryption and identity-based authorization. Applications can use sidecar proxies, including a Transparent Proxy mode, for inbound and outbound TLS, and the API Gateway manages outside access with traffic and authorization policies.
What happens when one of my services goes down?Health Checking quickly alerts operators about issues in the cluster. Because it is integrated with service discovery, Consul stops routing traffic to unhealthy hosts and enables service level circuit breakers.
Can I use it to store my applications' configuration?Yes. Dynamic App Configuration is an HTTP API for storing indexed objects in Consul — used for configuration parameters and application metadata.
What are similar projects?istio, linkerd2, nomad, etcd, workflow, coredns, thanos, zuul
Creator
hashicorp
Size
500.8 MB
Stars
30.1K
Age
12y
Commits · 90 Days