June 20-22
Announcing HashiConf Europe full schedule: keynotes, sessions, labs & more
Register Now
Dismiss alert
Overview
Use Cases
Consul on Kubernetes
Control access with Consul API Gateway
Discover Services with Consul
Enforce Zero Trust Networking with Consul
Load Balancing with Consul
Manage Traffic with Consul
Multi-Platform Service Mesh with Consul
Network Infrastructure Automation with Consul
Observability with Consul
Enterprise
Tutorials
Docs
API
CLI
Community
GitHub
Download
Try HCP Consul
Documentation Menu
×
Version
v1.12.x (latest)
Mask
v1.12.x (latest)
v1.11.x
v1.10.x
v1.9.x
v1.8.x
What is Consul?
Overview
Use Cases
Overview
What is a Service Mesh?
Consul vs. Other Software
Overview
Chef, Puppet, etc.
Nagios
SkyDNS
SmartStack
Serf
Eureka
Istio
Envoy and Other Proxies
Custom Solutions
Get Started
Overview
Manual Bootstrap
Consul Agent
Glossary
Required Ports
Bootstrapping a Datacenter
Cloud Auto-join
Server Performance
Kubernetes
API
Commands (CLI)
Service Discovery
Register Services - Service Definitions
Find Services - DNS Interface
Monitor Services - Check Definitions
Service Mesh
Overview
How Service Mesh Works
Configuration
Configuration Entries
Overview
Ingress Gateway
Mesh
Exported Services
Proxy Defaults
Service Defaults
Service Intentions
Service Resolver
Service Router
Service Splitter
Terminating Gateway
Supported Proxies
Overview
Envoy
Built-in Proxy
Proxy Integration
Managed (Deprecated)
Registering Proxies
Overview
Proxy Service Registration
Sidecar Service Registration
Service-to-service permissions - Intentions
Service-to-service permissions - Intentions (Legacy Mode)
Transparent Proxy
Observability
Overview
UI Visualization
L7 Traffic Management
Overview
Discovery Chain
Connectivity Tasks
Distributed Tracing
Gateways
Overview
Mesh Gateways
WAN Federation
Enabling Service-to-service Traffic Across Datacenters
Enabling Service-to-service Traffic Across Admin Partitions
Ingress Gateways
Terminating Gateways
Nomad
Kubernetes
Native App Integration
Overview
Go Integration
Certificate Management
Overview
Built-In CA
Vault
ACM Private CA
Develop and Debug
Security
Consul API Gateway
Overview
Installation
Technical Specifications
Common Errors
Upgrades
Kubernetes
Overview
Architecture
Get Started
Installing Consul on Kubernetes
Installing Consul K8s CLI
Platform Guides
Minikube
Kind
AKS (Azure)
EKS (AWS)
GKE (Google Cloud)
Red Hat OpenShift
Self Hosted Kubernetes
Deployment Configurations
Consul Clients Outside Kubernetes
Consul Servers Outside Kubernetes
Single Consul Datacenter in Multiple Kubernetes Clusters
Consul Enterprise
Multi-Cluster Federation
Overview
Federation Between Kubernetes Clusters
Federation Between VMs and Kubernetes
Vault as Secrets Backend
Overview
Systems Integration
Data Integration
Overview
Bootstrap Token
Enterprise License
Gossip Encryption Key
Partition Token
Replication Token
Server TLS
Service Mesh Certificates
Snapshot Agent Config
WAN Federation
Compatibility Matrix
Service Mesh
Overview
Transparent Proxy
Ingress Gateways
Terminating Gateways
Ingress Controllers
Configuring a Connect CA Provider
Health Checks
Observability
Metrics
Service Sync
Custom Resource Definitions
Overview
Upgrade An Existing Cluster to CRDs
Annotations and Labels
Consul DNS
Upgrade
Upgrading Consul on Kubernetes
Upgrading Consul K8s CLI
Operations
Uninstall
Certificate Rotation
Gossip Encryption Key Rotation
Configure TLS on an Existing Cluster
Troubleshoot
Common Error Messages
FAQ
Helm Chart Configuration
Consul K8s CLI Reference
AWS ECS
Overview
Requirements
Task Resource Usage
Install with Terraform
Installation
Secure Configuration
Migrate Existing Tasks
Install Manually
Installation
Secure Configuration
ACL Controller
Architecture
Consul Enterprise
Configuration Reference
Network Infrastructure Automation
Overview
Get Started
Installation
Requirements
Configure
Run Consul-Terraform-Sync
Architecture
API
Overview
Status
Tasks
CLI
Overview
task
Configuration
Tasks
Terraform Modules
Enterprise
Overview
License
Terraform Cloud Driver
Network Drivers
Overview
Terraform
Terraform Cloud
Compatibility
Dynamic App Configuration
Consul KV
Sessions
Watches
Agent
Overview
Configuration
General
CLI Reference
Configuration Reference
Configuration Entries
Telemetry
Sentinel
RPC
Security
Overview
Access Control (ACLs)
ACL System Overview
Tokens
Policies
Roles
Rules Reference
Legacy Mode
Token Migration
ACLs in Federated Datacenters
Auth Methods
Overview
Kubernetes
JWT
OIDC
AWS IAM
Encryption
Security Models
Overview
Core
Network Infrastructure Automation
Consul Enterprise
Overview
Admin Partitions
Audit Logging
Automated Backups
Automated Upgrades
Enhanced Read Scalability
Single sign-on - OIDC
Redundancy Zones
Advanced Federation
Network Segments
Namespaces
NIA with TFE
Sentinel
License
Overview
FAQ
Architecture
Overview
Improving Consul Resilience
Anti-Entropy
Consensus Protocol
Gossip Protocol
Jepsen Testing
Network Coordinates
Integrations
Consul Integration Program
NIA Integration Program
Vault Integration
Proxy Integration
Consul Tools
Upgrade
Overview
Compatibility Promise
Specific Version Details
Upgrade Instructions
Overview
General Process
Upgrading to 1.2.4
Upgrading to 1.6.9
Upgrading to 1.8.13
Upgrading to 1.10.0
Troubleshoot
Common Error Messages
FAQ
Release Notes
Overview
Consul
v1.11.x
v1.10.x
v1.9.x
Consul API Gateway
v0.1.x
v0.2.x
Consul ECS
v0.4.x
v0.3.x
v0.2.x
Consul Terraform Sync
v0.5.x
v0.6.0-beta
Internals
Overview
ACL
Guides
Search Consul documentation
Type '/' to Search
lals
Edit this page
