Spring Cloud Consul

2.2.0 M3

Spring Cloud Consul provides Consul integrations for Spring Boot apps through autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few simple annotations you can quickly enable and configure the common patterns inside your application and build large distributed systems with Hashicorp’s Consul. The patterns provided include Service Discovery, Distributed Configuration and Control Bus.


Spring Cloud Consul features:

  • Service Discovery: instances can be registered with the Consul agent and clients can discover the instances using Spring-managed beans

  • Supports Ribbon, the client side load-balancer via Spring Cloud Netflix

  • Supports Spring Cloud LoadBalancer - a client side load-balancer provided by the Spring Cloud project

  • Supports Zuul, a dynamic router and filter via Spring Cloud Netflix

  • Distributed Configuration: using the Consul Key/Value store

  • Control Bus: Distributed control events using Consul Events

Quick Start

As long as Spring Cloud Consul and the Consul API are on the classpath any Spring Boot application with @EnableDiscoveryClient will try to contact a Consul agent on localhost:8500 (the default values of spring.cloud.consul.host and spring.cloud.consul.port respectively):

public class Application {

  public String home() {
    return "Hello World";

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);


A local Consul agent must be running. See the Consul agent documentation on how to run an agent.

Quick start

Bootstrap your application with Spring Initializr.


Each Spring project has its own; it explains in great details how you can use project features and what you can achieve with them.
2.2.0 M3 PRE CURRENT Reference Doc. API Doc.
2.2.0 SNAPSHOT CURRENT Reference Doc. API Doc.
2.1.4 SNAPSHOT CURRENT Reference Doc. API Doc.
2.1.3 CURRENT GA Reference Doc. API Doc.
2.0.4 SNAPSHOT Reference Doc. API Doc.
2.0.3 GA Reference Doc. API Doc.
1.3.7 SNAPSHOT Reference Doc. API Doc.
1.3.6 GA Reference Doc. API Doc.
1.2.3 GA Reference Doc. API Doc.

A few examples to try out: