Connect external services to Consul service mesh with terminating gateways.
Learn how to run service discovery and a service mesh with Consul
Getting Started
Consul is a networking tool that provides a fully featured service-mesh control plane, service discovery, configuration, and segmentation. Here, learn how to perform common Consul operations locally.
Getting Started with Consul Service Mesh
Learn how to setup a development environment for testing and troubleshooting Consul service mesh on Kubernetes before going into production.
Understand Consul Service Mesh
7 minConsul can be deployed as a service mesh control plane that provides service-to-service connection authorization and encryption using mutual TLS. In this guide you will learn how to configure Consul as your Kubernetes service mesh to encrypt and control traffic between services.
Deploy Consul Service Mesh on Kubernetes
6 minConsul can be deployed as a service mesh control plane that provides service-to-service connection authorization and encryption using mutual TLS. In this guide you will learn how to configure Consul as your Kubernetes service mesh to encrypt and control traffic between services.
Secure Applications with Consul Service Mesh
6 minConsul can be deployed as a service mesh control plane that provides service-to-service connection authorization and encryption using mutual TLS. In this guide you will learn how to deploy applications on Kubernetes using Consul service mesh to encrypt and control traffic between services.
Enforce a Zero-trust Network with Consul Service Mesh
6 minConsul provides you a simplified approach to network security. In this guide you will learn how to define intentions to introduce a zero-trust network security approact in your Kubernetes cluster.
Observe Network Traffic with Consul Service Mesh
8 minConsul can be deployed as a service mesh control plane that provides service-to-service connection authorization and encryption using mutual TLS. In this guide you will get an overview of observability and L7 traffic management features for Consul service mesh.
Run Consul on Kubernetes
In this track, you will review production best practices for all Kubernetes installation types, and learn cloud-specific configurations for deploying Consul on Google Kubernetes Engine and Azure Kubernetes Service. Finally, you will practice registering, securing, and observing services deployed with Kubernetes.
Consul on Minikube via Helm
8 minDeploy Consul locally on Minikube using the official Helm chart, and learn how to access Consul. Finally, configure Connect for services in your Kubernetes cluster.
Deploy Consul on Azure Kubernetes Service (AKS)
30 minDeploy Consul on AKS with the official Helm chart and deploy two services into Consul's service mesh.
Deploy Consul on Google Kubernetes Engine (GKE)
30 minDeploy Consul on GKE with the official Helm chart and learn how to manage your datacenter with the Consul UI, CLI, and API.
Deploy Consul on Amazon Elastic Kubernetes Service (EKS)
30 minDeploy Consul on Amazon EKS with the official Helm chart and learn how to manage your datacenter with the Consul UI, CLI, and API.
Consul and Kubernetes Reference Architecture
15 minThis document provides recommended practices and a reference architecture.
HashiCorp Consul Service on Azure
In this track, you will get a preview of the new HashiCorp managed Consul Service (HCS) available on Azure in public beta. You will review steps to create a new HCS datacenter on Azure and how to use VMs or Azure Kubernetes Service (AKS) as Consul clients.
Deploy HashiCorp Consul Service on Azure
15 minHashiCorp Consul Service (HCS) on Azure enables Microsoft Azure users to natively provision HashiCorp-managed Consul servers in any supported Azure region directly through the Azure Marketplace.
Discover HashiCorp Consul Service on Azure Configuration
10 minLearn how to retrieve HashiCorp Consul Service (HCS) on Azure data including server connection information, Consul client configuration, and Consul certificates. The data you retrieve in this guide will enable you to add Consul clients to HCS on Azure.
Connect VM-based Applications to HashiCorp Consul Service on Azure
15 minConnect an Azure VM with a configured Consul client to your managed HashiCorp Consul Service (HCS) on Azure.
Connect an Azure Kubernetes Service (AKS) cluster to HashiCorp Consul Service on Azure
15 minConnect Consul clients deployed in Azure Kubernetes Service (AKS) with HashiCorp Consul Service (HCS) on Azure.
Setup a Secure Development Environment
Learn how to setup a development environment for testing and troubleshooting Consul before going into production.
Product Certification Exam Prep
Review guide for the HashiCorp Certified: Consul Associate exam.
Understand Consul Service Mesh
7 minConsul can be deployed as a service mesh control plane that provides service-to-service connection authorization and encryption using mutual TLS. In this guide you will learn how to configure Consul as your Kubernetes service mesh to encrypt and control traffic between services.
Deploy Consul Service Mesh on Kubernetes
6 minConsul can be deployed as a service mesh control plane that provides service-to-service connection authorization and encryption using mutual TLS. In this guide you will learn how to configure Consul as your Kubernetes service mesh to encrypt and control traffic between services.
Secure Applications with Consul Service Mesh
6 minConsul can be deployed as a service mesh control plane that provides service-to-service connection authorization and encryption using mutual TLS. In this guide you will learn how to deploy applications on Kubernetes using Consul service mesh to encrypt and control traffic between services.
Enforce a Zero-trust Network with Consul Service Mesh
6 minConsul provides you a simplified approach to network security. In this guide you will learn how to define intentions to introduce a zero-trust network security approact in your Kubernetes cluster.
Observe Network Traffic with Consul Service Mesh
8 minConsul can be deployed as a service mesh control plane that provides service-to-service connection authorization and encryption using mutual TLS. In this guide you will get an overview of observability and L7 traffic management features for Consul service mesh.
Consul on Minikube via Helm
8 minDeploy Consul locally on Minikube using the official Helm chart, and learn how to access Consul. Finally, configure Connect for services in your Kubernetes cluster.
Deploy Consul on Azure Kubernetes Service (AKS)
30 minDeploy Consul on AKS with the official Helm chart and deploy two services into Consul's service mesh.
Deploy Consul on Google Kubernetes Engine (GKE)
30 minDeploy Consul on GKE with the official Helm chart and learn how to manage your datacenter with the Consul UI, CLI, and API.
Deploy Consul on Amazon Elastic Kubernetes Service (EKS)
30 minDeploy Consul on Amazon EKS with the official Helm chart and learn how to manage your datacenter with the Consul UI, CLI, and API.
Consul and Kubernetes Reference Architecture
15 minThis document provides recommended practices and a reference architecture.
Deploy HashiCorp Consul Service on Azure
15 minHashiCorp Consul Service (HCS) on Azure enables Microsoft Azure users to natively provision HashiCorp-managed Consul servers in any supported Azure region directly through the Azure Marketplace.
Discover HashiCorp Consul Service on Azure Configuration
10 minLearn how to retrieve HashiCorp Consul Service (HCS) on Azure data including server connection information, Consul client configuration, and Consul certificates. The data you retrieve in this guide will enable you to add Consul clients to HCS on Azure.
Connect VM-based Applications to HashiCorp Consul Service on Azure
15 minConnect an Azure VM with a configured Consul client to your managed HashiCorp Consul Service (HCS) on Azure.
Connect an Azure Kubernetes Service (AKS) cluster to HashiCorp Consul Service on Azure
15 minConnect Consul clients deployed in Azure Kubernetes Service (AKS) with HashiCorp Consul Service (HCS) on Azure.
Operations and Development Tracks
Consul Release Highlights
Learn about Consul 1.8 features including mesh, terminating, and ingress gateways.
Day 1: Deploy Your First Datacenter
Learn to deploy your first production-ready datacenter. If you are responsible for setting up and maintaining a healthy datacenter, this path will help you do so successfully.
Introduction
5 minDeploy your first production-ready datacenter with Consul.
Consul Reference Architecture
8 minThis document provides recommended practices and a reference architecture for HashiCorp Consul production deployments.
Deployment Guide
8 minIn this guide you will deploy your first three-server Consul cluster in accordance with the Reference Architecture.
Datacenter Backups
10 minConsul provide the snapshot tool for backing up and restoring data. In this guide you will learn how to accomplish both.
Run Consul as a Service on Windows
10 minLearn how to run Consul as a service on Windows servers.
Day 1: Security and Network Operations
Continue securing and configuring your first production-ready datacenter. This path includes a series of guides for securing the cluster and setting up networking.
Introduction
5 minNow that you have deployed your first Consul datacenter, secure it.
Gossip Encryption
10 minLearn how to secure gossip communication between Consul agents for a single datacenter.
Secure Agent Communication with TLS Encryption
12 minLearn how to secure RPC and consensus communication by creating and deploying certificates to Consul agents.
Secure Consul with ACLs
16 minThis guide walks though securing your production Consul datacenter with ACLs.
Manage ACL Policies
13 minIn this guide, you'll learn how to discover the minimum privileges required to complete operations within your Consul datacenter and how to manage access using the operator-only implementation method.
Maintenance and Monitoring Operations
This path includes a series of guides for advanced operations that may need to be performed after the initial setup including advanced networking, security, outage recovery, monitoring, and troubleshooting.
Consul Cluster Monitoring and Metrics
12 minAfter setting up your first datacenter, it is an ideal time to make sure your datacenter is healthy and establish a baseline. This guide will discuss Consul health and server health metrics.
Monitor Consul with Telegraf
12 minIn this guide, you will use Telegraf to visualize Consul metrics.
ACL Replication for Multiple Datacenters
15 minConfigure tokens, policies, and roles to work across multiple datacenters.
Add & Remove Servers
12 minThere are several methods for adding or removing servers from the Consul cluster. Learn the best practices for each method.
Autopilot
8 minThis guide covers how to configure and use Autopilot features, which helps with Raft cluster monitoring, introduces stable servers, and cleans up dead servers.
Secure Your Datacenters with Agent Authentication
This track includes a series of guides for advanced security operations that may need to be performed after the initial setup including ACL replication and TLS configuration.
Migrate Legacy ACL Tokens
15 minThis guide includes strategies and command examples to migrate legacy ACL tokens after an upgrading from an older version of Consul with the legacy ACL system to Consul 1.4+.
Secure Agent Communication with Existing Certificate Authority
35 minLearn how to secure RPC, consensus, and HTTP communication by creating and deploying certificates to Consul agents using OpenSSL as the CA.
Update Agents to Communicate with TLS
15 minLearn how to secure RPC and consensus communication by creating and deploying certificates to Consul agents on an existing datacdenter.
Service Discovery and Consul DNS
Learn more about Service Discovery.
Geo Failover with Prepared Queries
12 minThis guide describes how to use Consul's prepared query capability, which automates geo failover policies for services in the case that one of multiple connected datacenters is unavailable.
External Services
17 minIt's rare to have all of your services running on nodes that you control. Learn how to register and health check services with Consul, even when they are running on nodes without a co-located Consul agent.
Register External Services using Terraform
20 minRegister external services with Consul using the Terraform Consul provider.
Use Health Checks With Consul
15 minThis guide describes how to use Consul's health checks capability, which 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.
Service Mesh and Consul Connect
Consul service mesh secures service-to-service communication with authorization and encryption. Learn how to allow or restrict east-west traffic using Connect.
Secure Service Communication with Consul Service Mesh and Envoy
12 minGain hands-on experience with Consul service mesh using internal proxies or Envoy as sidecar proxies.
Connect in Production
12 minThis guide describes best practices for running Consul Connect in production.
Traffic Splitting for Service Deployments
15 minIn this guide you will split layer-7 traffic, using Envoy proxies configured by Consul, to roll out a new version of a service. You can use this method for zero-downtime, blue-green, and canary deployments.
Connect Services Across Datacenters with Mesh Gateways
30 minIn this guide you will connect two services across datacenters using Consul Connect, intention replication, WAN gossip federation, and mesh gateways.
Understand Terminating Gateways
beta12 minTerminating gateways are egress proxies that provide connectivity to external destinations by terminating Consul Connect mTLS connections, enforcing Consul intentions, and forwarding requests to appropriate destination services.
Service Configuration and Consul KV
Learn more about Service Configuration and Consul KV.
Consul Template
12 minThis guide demonstrates how to programmatically render configuration files from a variety of locations including Consul KV.
Application Leader Election with Sessions
10 minThis guide describes how to build client-side leader elections for service instances, using Consul.
Distributed Semaphores with Sessions
12 minThis guide demonstrates how to implement a distributed semaphore using the Consul KV store.
[Enterprise] Segment Your Datacenter with Namespaces
Learn how to use Namespaces to more easily share datacenter access for multiple teams.
Load Balancer Integrations
Learn how Consul integrates with popular load balancing technologies such as Nginx, HAProxy, and F5.
Load Balancing with F5 and Consul
12 minIn this guide you will use Consul to configure F5 BIG-IP nodes and server pools based on changes in Consul service discovery.
Load Balancing with NGINX Plus' Service Discovery Integration
12 minLearn how to automatically configure NGINX Plus' load balancer with service discovery data, via a native integration with Consul.
Load Balancing with NGINX and Consul Template
12 minIn this guide, you will use Consul template to update NGINX load balancer configurations based on changes in Consul service discovery.
Load Balancing with HAProxy Service Discovery Integration
15 minThis guide describes how to use HAProxy's native integration to automatically configure the load balancer with service discovery data from Consul.
Cloud and Platform Integrations
Learn how Consul service discovery integrates with cloud providers and technologies.
Discover Services External to Pivotal Application Service
14 minThis introductory guide describes how to use Consul DNS with Pivotal Application Service to discover external services.
Consul-AWS
12 minThis guide describes how to use Consul-AWS to sync the services in an AWS Cloud Map namespace to a Consul datacenter or vice versa.
Monitor Consul with AppDynamics CNS
25 minIn this guide, you will learn how to use the HashiCorp's Consul Monitoring Extension for AppDynamics CNS to collect Consul telemetry data and node information.
Introduction
5 minDeploy your first production-ready datacenter with Consul.
Consul Reference Architecture
8 minThis document provides recommended practices and a reference architecture for HashiCorp Consul production deployments.
Deployment Guide
8 minIn this guide you will deploy your first three-server Consul cluster in accordance with the Reference Architecture.
Datacenter Backups
10 minConsul provide the snapshot tool for backing up and restoring data. In this guide you will learn how to accomplish both.
Run Consul as a Service on Windows
10 minLearn how to run Consul as a service on Windows servers.
Introduction
5 minNow that you have deployed your first Consul datacenter, secure it.
Gossip Encryption
10 minLearn how to secure gossip communication between Consul agents for a single datacenter.
Secure Agent Communication with TLS Encryption
12 minLearn how to secure RPC and consensus communication by creating and deploying certificates to Consul agents.
Secure Consul with ACLs
16 minThis guide walks though securing your production Consul datacenter with ACLs.
Manage ACL Policies
13 minIn this guide, you'll learn how to discover the minimum privileges required to complete operations within your Consul datacenter and how to manage access using the operator-only implementation method.
Consul Cluster Monitoring and Metrics
12 minAfter setting up your first datacenter, it is an ideal time to make sure your datacenter is healthy and establish a baseline. This guide will discuss Consul health and server health metrics.
Monitor Consul with Telegraf
12 minIn this guide, you will use Telegraf to visualize Consul metrics.
ACL Replication for Multiple Datacenters
15 minConfigure tokens, policies, and roles to work across multiple datacenters.
Add & Remove Servers
12 minThere are several methods for adding or removing servers from the Consul cluster. Learn the best practices for each method.
Autopilot
8 minThis guide covers how to configure and use Autopilot features, which helps with Raft cluster monitoring, introduces stable servers, and cleans up dead servers.
Migrate Legacy ACL Tokens
15 minThis guide includes strategies and command examples to migrate legacy ACL tokens after an upgrading from an older version of Consul with the legacy ACL system to Consul 1.4+.
Secure Agent Communication with Existing Certificate Authority
35 minLearn how to secure RPC, consensus, and HTTP communication by creating and deploying certificates to Consul agents using OpenSSL as the CA.
Update Agents to Communicate with TLS
15 minLearn how to secure RPC and consensus communication by creating and deploying certificates to Consul agents on an existing datacdenter.
Geo Failover with Prepared Queries
12 minThis guide describes how to use Consul's prepared query capability, which automates geo failover policies for services in the case that one of multiple connected datacenters is unavailable.
External Services
17 minIt's rare to have all of your services running on nodes that you control. Learn how to register and health check services with Consul, even when they are running on nodes without a co-located Consul agent.
Register External Services using Terraform
20 minRegister external services with Consul using the Terraform Consul provider.
Use Health Checks With Consul
15 minThis guide describes how to use Consul's health checks capability, which 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.
Secure Service Communication with Consul Service Mesh and Envoy
12 minGain hands-on experience with Consul service mesh using internal proxies or Envoy as sidecar proxies.
Connect in Production
12 minThis guide describes best practices for running Consul Connect in production.
Traffic Splitting for Service Deployments
15 minIn this guide you will split layer-7 traffic, using Envoy proxies configured by Consul, to roll out a new version of a service. You can use this method for zero-downtime, blue-green, and canary deployments.
Connect Services Across Datacenters with Mesh Gateways
30 minIn this guide you will connect two services across datacenters using Consul Connect, intention replication, WAN gossip federation, and mesh gateways.
Understand Terminating Gateways
beta12 minTerminating gateways are egress proxies that provide connectivity to external destinations by terminating Consul Connect mTLS connections, enforcing Consul intentions, and forwarding requests to appropriate destination services.
Consul Template
12 minThis guide demonstrates how to programmatically render configuration files from a variety of locations including Consul KV.
Application Leader Election with Sessions
10 minThis guide describes how to build client-side leader elections for service instances, using Consul.
Distributed Semaphores with Sessions
12 minThis guide demonstrates how to implement a distributed semaphore using the Consul KV store.
Load Balancing with F5 and Consul
12 minIn this guide you will use Consul to configure F5 BIG-IP nodes and server pools based on changes in Consul service discovery.
Load Balancing with NGINX Plus' Service Discovery Integration
12 minLearn how to automatically configure NGINX Plus' load balancer with service discovery data, via a native integration with Consul.
Load Balancing with NGINX and Consul Template
12 minIn this guide, you will use Consul template to update NGINX load balancer configurations based on changes in Consul service discovery.
Load Balancing with HAProxy Service Discovery Integration
15 minThis guide describes how to use HAProxy's native integration to automatically configure the load balancer with service discovery data from Consul.
Discover Services External to Pivotal Application Service
14 minThis introductory guide describes how to use Consul DNS with Pivotal Application Service to discover external services.
Consul-AWS
12 minThis guide describes how to use Consul-AWS to sync the services in an AWS Cloud Map namespace to a Consul datacenter or vice versa.
Monitor Consul with AppDynamics CNS
25 minIn this guide, you will learn how to use the HashiCorp's Consul Monitoring Extension for AppDynamics CNS to collect Consul telemetry data and node information.
Looking for specific Consul information? The Consul documentation provides reference material and in-depth details on: