» 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 set of guides 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.

  • Agent Communication Encryption - This guide covers how to encrypt both gossip and RPC communication.

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

  • Connect in Production - This guide describes critical aspects of operating Consul Connect in Production.

  • Connect with Envoy - This guide will describe how to setup a development-mode Consul server and two Envoy proxies on a single machine using Docker.

  • Consul Cluster Monitoring & Metrics - After setting up your first datacenter, it is an ideal time to make sure your cluster is healthy and establish a baseline. This guide will cover several types of metrics in two sections: Consul health and server health.

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

  • Consul Template - This guide covers the Consul template tool, which provides a programmatic method for populating values into the file system.

  • Consul-AWS - This guide covers the Consul-AWS tool, which syncs Consul's and AWS Cloud Map's service catalog.

  • Creating Certificates - This guide describes how to setup CA and certificates to secure a Consul cluster with TLS.

  • Datacenter Backups - Consul provide the snapshot tool for backing up and restoring data. In this guide you will learn how to use both.

  • Deployment Guide - This deployment guide covers the steps required to install and configure a single HashiCorp Consul cluster as defined in the Consul Reference Architecture.

  • 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.

  • Minikube with Consul - In this guide, you'll start a local Kubernetes cluster with minikube, install Consul,and then deploy two custom services.

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

  • Monitoring Consul with Telegraf - This guide demonstrates how to setup Consul for monitoring with Telegraf.

  • 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.

  • Consul Reference Architecture - This document provides recommended practices and a reference architecture, including system requirements, datacenter design, networking, and performance optimizations for Consul production deployments.

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

  • 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.