» Consul Guides

This section provides various guides for common actions. Due to the nature of Consul, some of these procedures can be complex, so our goal is to provide guidance to do them safely.

The following guides are available:

  • ACLs - This guide covers Consul's Access Control List (ACL) capability, which can be used to control access to Consul resources.

  • Adding/Removing Servers - This guide covers how to safely add and remove Consul servers from the cluster. This should be done carefully to avoid availability outages.

  • Autopilot - This guide covers Autopilot, which provides automatic operator-friendly management of Consul servers.

  • Bootstrapping - This guide covers bootstrapping a new datacenter. This covers safely adding the initial Consul servers.

  • Consul with Containers - This guide describes critical aspects of operating a Consul cluster that's run inside containers.

  • DNS Caching - Enabling TTLs for DNS query caching

  • DNS Forwarding - Forward DNS queries from Bind to Consul

  • External Services - This guide covers registering an external service. This allows using 3rd party services within the Consul framework.

  • Federation (Basic and Advanced) - Configuring Consul to support multiple datacenters.

  • Geo Failover - This guide covers using prepared queries to implement geo failover for services.

  • Leader Election - The goal of this guide is to cover how to build client-side leader election using Consul.

  • Network Segments - Configuring Consul to support partial LAN connectivity using Network Segments.

  • Outage Recovery - This guide covers recovering a cluster that has become unavailable due to server failures.

  • Semaphore - This guide covers using the KV store to implement a semaphore.

  • Sentinel - This guide covers using Sentinel for policy enforcement in Consul.

  • Server Performance - This guide covers minimum requirements for Consul servers as well as guidelines for running Consul servers in production.

  • Windows Service - This guide covers how to run Consul as a service on Windows.