This module is community maintained and the Lightbend subscription doesn’t cover support for this module. It is also marked as may change. That means that the API, configuration or semantics can change without warning or deprecation period.

Consul currently ignores all fields apart from service name. This is expected to change.

If you are using Consul to do the service discovery this would allow you to base your Cluster on Consul services.

Project Info

Project Info: Akka Discovery Consul
JDK versions
Adopt OpenJDK 8 with Hotspot
Adopt OpenJDK 11 with Hotspot
Scala versions2.11.12, 2.12.10, 2.13.0
Readiness level
Since 0.15.0, 2018-07-02
Home page
API documentation
Release notesGitHub releases
IssuesGitHub issues
libraryDependencies += "com.lightbend.akka.discovery" %% "akka-discovery-consul" % "1.0.7"
dependencies {
  compile group: 'com.lightbend.akka.discovery', name: 'akka-discovery-consul_2.12', version: '1.0.7'

akka-discovery-consul can be used with Akka 2.5.27 or 2.6.5 or later. You have to override the following Akka dependencies by defining them explicitly in your build and define the Akka version to the one that you are using. Latest patch version of Akka is recommended and a later version than 2.6.5 can be used.

val AkkaVersion = "2.6.5"
libraryDependencies ++= Seq(
  "com.typesafe.akka" %% "akka-cluster" % AkkaVersion,
  "com.typesafe.akka" %% "akka-discovery" % AkkaVersion
versions += [
  AkkaVersion: "2.6.5",
  ScalaBinary: "2.12"
dependencies {
  compile group: 'com.typesafe.akka', name: "akka-cluster_${versions.ScalaBinary}", version: versions.AkkaVersion,
  compile group: 'com.typesafe.akka', name: "akka-discovery_${versions.ScalaBinary}", version: versions.AkkaVersion

In your application conf add:

akka.discovery {
  method = akka-consul
  akka-consul {

    #How to connect to Consul to fetch services data
    consul-host = ""
    consul-port = 8500

    # Prefix for consul tag with the name of the actor system / application name,
    # services with this tag present will be found by the discovery mechanism
    # i.e. `system:test` will be found in cluster if the cluster system is named `test`
    application-name-tag-prefix = "system:"

    # Prefix for tag containing port number where akka management is set up so that
    # the seed nodes can be found, an example value for the tag would be `akka-management-port:19999`
    application-akka-management-port-tag-prefix = "akka-management-port:"


  • Since tags in Consul services are simple strings, prefixes are necessary to ensure that proper values are read.

  • If Akka management port tag is not found on service in Consul the implementation defaults to catalog service port.

Found an error in this documentation? The source code for this page can be found here. Please feel free to edit and contribute a pull request.