Consul
Deploy Consul servers overview
This topic provides an overview of the processes involved in deploying a Consul server agent and joining it to your control plane. The specific steps vary depending on your runtime or cloud provider.
For information about how to deploy Consul client agents or dataplanes, refer to Configure Consul workloads for your dataplane.
Introduction
Consul server agents are the backbone of a Consul deployment.
The basic process to deploy the first server agent in a cluster consists of the following steps:
- Create a Consul server configuration with bootstrap mode enabled.
- Start the Consul server.
- Configure access to the Consul server with the CLI or HTTP API.
The process to deploy additional server agents in a cluster consists of the following steps:
- Update the
retry_join
stanza of the server agent configuration with the address of the bootstrapped server agent. - Start the Consul server agents using the updated configuration.
- Verify cluster members with the
consul members
command. - Remove the servers from bootstrap mode.
After you deploy it, you must secure a Consul cluster to prepare it for production environments. Refer to Secure Consul for more information about Consul's security model.
Automatic agent discovery
You can configure the retry_join
stanza so that when a Consul agent starts, it automatically joins a cluster. This ability is called cloud auto-join. Configuration requirements vary by cloud provider. For more information, refer to automatically join clusters to a cloud provider.
Guidance
Runtime-specific instructions are available to help you deploy Consul server agents.
Virtual machines (VMs)
For an overview of the process to deploy a server, refer to the Deploy Consul on VMs overview.
The following guides are also available:
Kubernetes
For an overview of our documentation related to deploying Consul servers running on Kubernetes clusters, refer to the Deploy a Consul server on Kubernetes.
Platform-specific guidance is also available:
- Deploy Consul on AKS
- Deploy Consul on EKS
- Deploy Consul on GKE
- Deploy Consul on kind
- Deploy Consul on Minikube
- Deploy Consul on OpenShift
- Deploy Consul on self-hosted Kubernetes
AWS ECS
HCP Consul Dedicated
To learn about how to deploy HCP Consul Dedicated servers, refer to Deploy servers on HCP Consul. You can access the UI workflow to deploy Dedicated clusters from the HCP portal.