2014-02-08 00:41:03 +00:00
|
|
|
---
|
|
|
|
layout: "intro"
|
|
|
|
page_title: "Introduction"
|
|
|
|
sidebar_current: "what"
|
|
|
|
---
|
|
|
|
|
2014-04-10 20:31:47 +00:00
|
|
|
# Introduction to Consul
|
2014-02-08 00:41:03 +00:00
|
|
|
|
2014-04-10 20:31:47 +00:00
|
|
|
Welcome to the intro guide to Consul! This guide is a the best place to start
|
|
|
|
with Consul. We cover what Consul is, what problems it can solve, how it compares
|
|
|
|
to existing software, and a quick start for using Consul. If you are already familiar
|
|
|
|
with the basics of Consul, the [documentation](/docs/index.html) provides more
|
2014-02-08 00:41:03 +00:00
|
|
|
of a reference for all available features.
|
|
|
|
|
2014-04-10 20:31:47 +00:00
|
|
|
## What is Consul?
|
2014-02-08 00:41:03 +00:00
|
|
|
|
2014-04-10 20:31:47 +00:00
|
|
|
Consul has multiple components, but as a whole, it is tool for managing
|
|
|
|
and coordinating infrastructure. It provides several key features:
|
2014-02-08 00:41:03 +00:00
|
|
|
|
2014-04-10 20:31:47 +00:00
|
|
|
* **Service Discovery**: Clients of Consul can _provide_ a service, such as
|
|
|
|
`api` or `mysql`, and other clients can use Consul to _discover_ providers
|
|
|
|
of a given service. Using either DNS or HTTP, applications can easily find
|
|
|
|
the services they depend upon.
|
2014-02-08 00:41:03 +00:00
|
|
|
|
2014-04-10 20:31:47 +00:00
|
|
|
* **Health Checking**: Consul clients can provide any number of health checks,
|
|
|
|
either associated with a given service ("is the webserver returning 200 OK"), or
|
|
|
|
with the local node ("is memory utilization below 90%"). This information can be
|
|
|
|
used by an operator to monitor cluster health, and it is used by the service
|
|
|
|
discovery components to route traffic away from unhealthy hosts.
|
2014-02-08 00:41:03 +00:00
|
|
|
|
2014-04-10 20:31:47 +00:00
|
|
|
* **Key/Value Store**: Applications can make use of Consul's hierarchical key/value
|
|
|
|
store for any number of purposes including dynamic configuration, feature flagging,
|
|
|
|
coordination, leader election, etc. The simple HTTP API makes dead easy to use.
|
2014-02-08 00:41:03 +00:00
|
|
|
|
2014-04-10 20:31:47 +00:00
|
|
|
* **Multi Datacenter**: Consul supports multiple datacenters out of the box. This
|
|
|
|
means users of Consul do not have to worry about building additional layers of
|
|
|
|
abstraction to grow to multiple regions.
|
2014-02-08 00:41:03 +00:00
|
|
|
|
|
|
|
See the [use cases page](/intro/use-cases.html) for a list of concrete use
|
2014-04-10 20:31:47 +00:00
|
|
|
cases built on top of the features Consul provides. See the page on
|
|
|
|
[how Consul compares to other software](/intro/vs/index.html) to see just
|
2014-02-08 00:41:03 +00:00
|
|
|
how it fits into your existing infrastructure. Or continue onwards with
|
|
|
|
the [getting started guide](/intro/getting-started/install.html) to get
|
2014-04-10 20:31:47 +00:00
|
|
|
Consul up and running and see how it works.
|