5a4543cf56
* Adds redirects for Getting Started pages * Uses correct links to resources at learn.hashicorp * Reconfigures "Learn more" links to point to learn.hashicorp * Links to learn.hashicorp on segmentation page * Adds redirect for sample config file * Fixes links to Getting Started guide on learn.hashicorp * Remove getting started guide which is now on learn.hashicorp * Corrects link to `consul/io` which should go to `consul.io` * Revert "Remove getting started guide which is now on learn.hashicorp" This reverts commit 2cebacf402f83fb936718b41ac9a27415f4e9f21 so a placeholder message can be written here while we are transitioning content to learn.hashicorp * Adding a new page for getting started to direct users to learn. * Added a note at the being of each doc to notify users about the temporary repo change. * Revert "Added a note at the being of each doc to notify users about the temporary repo change." This reverts commit 9a2a8781f9705028e4f53f758ef235e74b2b7198. From conversation at https://github.com/hashicorp/consul/pull/4878 * Removes redirect from sample web.json demo file * Removed typo
298 lines
17 KiB
Plaintext
298 lines
17 KiB
Plaintext
---
|
|
description: |-
|
|
Consul is a highly available and distributed service discovery and KV
|
|
store designed with support for the modern data center to make distributed
|
|
systems and configuration easy.
|
|
---
|
|
|
|
<div class='consul-connect'>
|
|
|
|
<section class='g-hero'>
|
|
<h1>Service discovery made easy</h1>
|
|
<p>Service registry, integrated health checks, and DNS and HTTP interfaces
|
|
enable any service to discover and be discovered by other services</p>
|
|
<div>
|
|
<a href="/downloads.html" class="g-btn download">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="22" viewBox="0 0 20 22">
|
|
<path d="M9.292 15.706a1 1 0 0 0 1.416 0l3.999-3.999a1 1 0 1 0-1.414-1.414L11 12.586V1a1 1 0 1 0-2 0v11.586l-2.293-2.293a1 1 0 1 0-1.414 1.414l3.999 3.999zM20 16v3c0 1.654-1.346 3-3 3H3c-1.654 0-3-1.346-3-3v-3a1 1 0 1 1 2 0v3c0 .551.448 1 1 1h14c.552 0 1-.449 1-1v-3a1 1 0 1 1 2 0z"/>
|
|
</svg>
|
|
Download
|
|
</a>
|
|
<a href="https://learn.hashicorp.com/consul/getting-started/services.html" class="g-btn dark-outline">Explore Docs</a>
|
|
</div>
|
|
</section>
|
|
|
|
<section class='g-section'>
|
|
<div class='g-container'>
|
|
<div class='g-timeline no-intro'>
|
|
<div>
|
|
<span class='line'></span>
|
|
<span class='line'>
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="11" height="15" viewBox="0 0 11 15">
|
|
<path fill="#CA2171" d="M0 0v15l5.499-3.751L11 7.5 5.499 3.749.002 0z"/>
|
|
</svg>
|
|
</span>
|
|
<span class='dot'></span>
|
|
<h3>The Challenge</h3>
|
|
<span class='sub-heading'>Service load balancers aren't efficient in a dynamic world.</span>
|
|
<div id='discovery-challenge-animation' class='g-animation-block'>
|
|
<%= inline_svg 'consul-connect/svgs/discovery-challenge.svg' %>
|
|
</div>
|
|
<p>Load balancers are often used to front a service tier and provide a static IP. These load balancers add cost, increase latency, introduce single points of failure, and must be updated as services scale up/down.</p>
|
|
</div>
|
|
<div>
|
|
<span class='dot'></span>
|
|
<h3>The Solution</h3>
|
|
<span class='sub-heading'>Service discovery for dynamic infrastructure.</span>
|
|
<div id='discovery-solution-animation' class='g-animation-block'>
|
|
<%= inline_svg 'consul-connect/svgs/discovery-solution.svg' %>
|
|
</div>
|
|
<p>Instead of load balancers, connectivity in dynamic infrastructure is best solved with service discovery. Service discovery uses a registry to keep a real-time list of services, their location, and their health. Services query the registry to discover the location of upstream services and then connect directly. This allows services to scale up/down and gracefully handle failure without a load balancer intermediary.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<section class='g-section border-top'>
|
|
<div class='g-container'>
|
|
<div class='intro'>
|
|
<h2>Features</h2>
|
|
</div>
|
|
<div class='g-text-asset large'>
|
|
<div>
|
|
<div>
|
|
<h3>Service Registry</h3>
|
|
<p>Consul provides a registry of all the running nodes and services, along with their current health status. This allows operators to understand the environment, and applications and automation tools to interact with dynamic infrastructure using an HTTP API.</p>
|
|
<p>
|
|
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/services.html">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<picture>
|
|
<source type="image/webp" srcset="
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_230.webp 230w,
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_690.webp 690w,
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_1290.webp 1290w" />
|
|
<source type="image/jpg" srcset="
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_230.jpg 230w,
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_690.jpg 690w,
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_1290.jpg 1290w" />
|
|
<img src='/assets/images/consul-connect/ui-health-checks/ui-health-checks_1290.jpg' alt='Service Registry'>
|
|
</picture>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<section class='g-section border-top'>
|
|
<div class='g-container'>
|
|
<div class='g-text-asset reverse'>
|
|
<div>
|
|
<div>
|
|
<h3>DNS Query Interface</h3>
|
|
<p>Consul enables service discovery using a built-in DNS server. This allows existing applications to easily integrate, as almost all applications support using DNS to resolve IP addresses. Using DNS instead of a static IP address allows services to scale up/down and route around failures easily.</p>
|
|
<p>
|
|
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/services.html#querying-services">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class='code-sample'>
|
|
<div>
|
|
<span></span>
|
|
<div class='code'><code>
|
|
$ dig <code class='keyword'>web-frontend.service.consul.</code> ANY
|
|
|
|
; <<>> DiG 9.8.3-P1 <<>> web-frontend.service.consul. ANY
|
|
;; global options: +cmd
|
|
;; Got answer:
|
|
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 29981
|
|
;; flags: qr aa rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 0, ADDITIONAL: 0
|
|
|
|
;; QUESTION SECTION:
|
|
;web-frontend.service.consul. IN ANY
|
|
|
|
;; ANSWER SECTION:
|
|
web-frontend.service.consul. 0 IN A <code class='keyword'>10.0.3.83</code>
|
|
web-frontend.service.consul. 0 IN A <code class='keyword'>10.0.1.109</code></code>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<section class='g-section border-top'>
|
|
<div class='g-container'>
|
|
<div class='g-text-asset'>
|
|
<div>
|
|
<div>
|
|
<h3>HTTP API with Edge Triggers</h3>
|
|
<p>Consul provides an HTTP API to query the service registry for nodes, services, and health check information. The API also supports blocking queries, or long-polling for any changes. This allows automation tools to react to services being registered or health status changes to change configurations or traffic routing in real time.</p>
|
|
<p>
|
|
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/services.html#http-api">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class='code-sample'>
|
|
<div>
|
|
<span></span>
|
|
<div class='code'>
|
|
<code>$ curl <code class='keyword'>http://localhost:8500/v1/health/service/web?index=11&wait=30s</code>
|
|
{
|
|
...
|
|
"Node": "10-0-1-109",
|
|
"CheckID": "service:web",
|
|
"Name": "Service 'web' check",
|
|
"Status": <code class='keyword'>"critical"</code>,
|
|
"ServiceID": "web",
|
|
"ServiceName": "web",
|
|
"CreateIndex": 10,
|
|
"ModifyIndex": 20
|
|
...
|
|
}
|
|
</code>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<section class='g-section border-top'>
|
|
<div class='g-container'>
|
|
<div class='g-text-asset reverse'>
|
|
<div>
|
|
<div>
|
|
<h3>Multi Datacenter</h3>
|
|
<p>Consul supports multiple datacenters out of the box with no complicated configuration. Look up services in other datacenters or keep the request local. Advanced features like Prepared Queries enable automatic failover to other datacenters.</p>
|
|
<p>
|
|
<a class="learn-more" href='/docs/guides/datacenters.html'>Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class='code-sample'>
|
|
<div>
|
|
<span></span>
|
|
<div class='code'>
|
|
<code>
|
|
$ curl http://localhost:8500/v1/catalog/datacenters
|
|
<code class='keyword'>[
|
|
"dc1",
|
|
"dc2"
|
|
]</code>
|
|
$ curl http://localhost:8500/v1/catalog/nodes?<code class='keyword'>dc=dc2</code>
|
|
[
|
|
{
|
|
"ID": "7081dcdf-fdc0-0432-f2e8-a357d36084e1",
|
|
"Node": "10-0-1-109",
|
|
"Address": "10.0.1.109",
|
|
"Datacenter": "<code class='keyword'>dc2</code>",
|
|
"TaggedAddresses": {
|
|
"lan": "10.0.1.109",
|
|
"wan": "10.0.1.109"
|
|
},
|
|
"CreateIndex": 112,
|
|
"ModifyIndex": 125
|
|
},
|
|
...</code>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<section class='g-section border-top'>
|
|
<div class='g-container'>
|
|
<div class='g-text-asset large'>
|
|
<div>
|
|
<div>
|
|
<h3>Health Checks</h3>
|
|
<p>Pairing service discovery with health checking prevents routing requests to unhealthy hosts and enables services to easily provide circuit breakers.</p>
|
|
<p>
|
|
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/checks.html">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<picture>
|
|
<source type="image/webp" srcset="
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_230.webp 230w,
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_690.webp 690w,
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_1290.webp 1290w" />
|
|
<source type="image/jpg" srcset="
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_230.jpg 230w,
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_690.jpg 690w,
|
|
/assets/images/consul-connect/ui-health-checks/ui-health-checks_1290.jpg 1290w" />
|
|
<img src='/assets/images/consul-connect/ui-health-checks/ui-health-checks_1290.jpg' alt='Health Checks'>
|
|
</picture>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<section class='g-section bg-dark'>
|
|
<div class='g-container'>
|
|
<div class='intro'>
|
|
<h2>Case Studies</h2>
|
|
</div>
|
|
<div class='g-carousel'>
|
|
<div class='siema'>
|
|
<a class='card' href='https://www.hashicorp.com/resources/twitch-driving-towards-a-modern-infrastructure'>
|
|
<div>
|
|
<img src='/assets/images/consul-connect/case-studies/case-study_01.jpg' alt=''>
|
|
</div>
|
|
<div class='content'>
|
|
<span class='tag video'>Video</span>
|
|
<h4>Twitch - Driving Towards a Modern Infrastructure</h4>
|
|
<p>In this talk from HashiConf 2015, Tarrant Rollins discusses how Twitch uses HashiCorp Consul to overcome legacy infrastructure and solve complex problems.</p>
|
|
<span>Watch</span>
|
|
</div>
|
|
</a>
|
|
<a class='card' href='https://www.hashicorp.com/resources/jet-com-nomad-auto-proxy-consul-template-nginx'>
|
|
<div>
|
|
<img src='/assets/images/consul-connect/case-studies/case-study_02.jpg' alt=''>
|
|
</div>
|
|
<div class='content'>
|
|
<span class='tag video'>Video</span>
|
|
<h4>Jet.com - Nomad Auto-Proxy with Consul-Template and NGINX</h4>
|
|
<p>Justen Walker explains how Jet.com uses HashiCorp Consul and Nomad to allow hundreds of developers to have self-service access, despite relying on NGINX static configs—and with a remarkably small DevOps team.</p>
|
|
<span>Watch</span>
|
|
</div>
|
|
</a>
|
|
</div>
|
|
<ul class='pagination'>
|
|
<li class='active'></li>
|
|
<li></li>
|
|
</ul>
|
|
<span class='prev'>
|
|
<svg width="18px" height="14px" viewBox="0 0 18 14" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><defs><path d="M20.9227917,11.6173214 C20.8717917,11.4953214 20.7987917,11.3843214 20.7067917,11.2923214 L14.7067917,5.29232143 C14.3167917,4.90232143 13.6837917,4.90232143 13.2927917,5.29232143 C12.9017917,5.68332143 12.9017917,6.31632143 13.2927917,6.70632143 L17.5857917,10.9993214 L3.99979167,10.9993214 C3.44779167,10.9993214 2.99979167,11.4473214 2.99979167,11.9993214 C2.99979167,12.5523214 3.44779167,12.9993214 3.99979167,12.9993214 L17.5857917,12.9993214 L13.2927917,17.2923214 C12.9017917,17.6833214 12.9017917,18.3163214 13.2927917,18.7063214 C13.4877917,18.9023214 13.7437917,18.9993214 13.9997917,18.9993214 C14.2557917,18.9993214 14.5117917,18.9023214 14.7067917,18.7063214 L20.7067917,12.7073214 C20.7987917,12.6153214 20.8717917,12.5043214 20.9227917,12.3823214 C21.0237917,12.1373214 21.0237917,11.8623214 20.9227917,11.6173214" id="path-1"></path></defs><g id="Consul" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g id="Consol.io-Service-Discovery-Op1" transform="translate(-1275.000000, -5150.000000)"><g id="Icons/Feather/arrow/arrow-right" transform="translate(1272.000000, 5145.000000)"><mask id="mask-2" fill="white"><use xlink:href="#path-1"></use></mask><use id="Mask" fill="#000000" fill-rule="evenodd" xlink:href="#path-1"></use><g id="Mixin/Fill/Black" mask="url(#mask-2)" fill="#000000" fill-rule="evenodd"><rect id="Rectangle" x="0" y="0" width="24" height="24"></rect></g></g></g></g></svg>
|
|
</span>
|
|
<span class='next'>
|
|
<svg width="18px" height="14px" viewBox="0 0 18 14" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><defs><path d="M20.9227917,11.6173214 C20.8717917,11.4953214 20.7987917,11.3843214 20.7067917,11.2923214 L14.7067917,5.29232143 C14.3167917,4.90232143 13.6837917,4.90232143 13.2927917,5.29232143 C12.9017917,5.68332143 12.9017917,6.31632143 13.2927917,6.70632143 L17.5857917,10.9993214 L3.99979167,10.9993214 C3.44779167,10.9993214 2.99979167,11.4473214 2.99979167,11.9993214 C2.99979167,12.5523214 3.44779167,12.9993214 3.99979167,12.9993214 L17.5857917,12.9993214 L13.2927917,17.2923214 C12.9017917,17.6833214 12.9017917,18.3163214 13.2927917,18.7063214 C13.4877917,18.9023214 13.7437917,18.9993214 13.9997917,18.9993214 C14.2557917,18.9993214 14.5117917,18.9023214 14.7067917,18.7063214 L20.7067917,12.7073214 C20.7987917,12.6153214 20.8717917,12.5043214 20.9227917,12.3823214 C21.0237917,12.1373214 21.0237917,11.8623214 20.9227917,11.6173214" id="path-1"></path></defs><g id="Consul" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g id="Consol.io-Service-Discovery-Op1" transform="translate(-1275.000000, -5150.000000)"><g id="Icons/Feather/arrow/arrow-right" transform="translate(1272.000000, 5145.000000)"><mask id="mask-2" fill="white"><use xlink:href="#path-1"></use></mask><use id="Mask" fill="#000000" fill-rule="evenodd" xlink:href="#path-1"></use><g id="Mixin/Fill/Black" mask="url(#mask-2)" fill="#000000" fill-rule="evenodd"><rect id="Rectangle" x="0" y="0" width="24" height="24"></rect></g></g></g></g></svg>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<section class='g-section g-cta-section'>
|
|
<div>
|
|
<h2>Ready to get started?</h2>
|
|
<a href="/downloads.html" class="g-btn white download">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="22" viewBox="0 0 20 22">
|
|
<path d="M9.292 15.706a1 1 0 0 0 1.416 0l3.999-3.999a1 1 0 1 0-1.414-1.414L11 12.586V1a1 1 0 1 0-2 0v11.586l-2.293-2.293a1 1 0 1 0-1.414 1.414l3.999 3.999zM20 16v3c0 1.654-1.346 3-3 3H3c-1.654 0-3-1.346-3-3v-3a1 1 0 1 1 2 0v3c0 .551.448 1 1 1h14c.552 0 1-.449 1-1v-3a1 1 0 1 1 2 0z"/>
|
|
</svg>
|
|
Download
|
|
</a>
|
|
<a href="https://learn.hashicorp.com/consul/getting-started/services.html" class="g-btn white-outline">Explore docs</a>
|
|
</div>
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<% content_for :scripts do %>
|
|
<script src='/assets/javascripts/consul-connect/vendor/object-fit-images.min.js' defer></script>
|
|
<script src='/assets/javascripts/consul-connect/carousel.js' defer></script>
|
|
<% end %>
|