Switch branches/tags
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


KumuluzEE Discovery — register service with Consul

Develop a REST KumuluzEE microservice and register it with Consul.

The objective of this sample is to show how to register a REST service with Consul using KumuluzEE Discovery extension. This tutorial will guide you through all the necessary steps. You will add KumuluzEE dependencies into pom.xml. You will use existing JAX-RS sample, described here. Required knowledge: basic familiarity with JAX-RS and basic concepts of REST and JSON; basic familiarity with Consul.


In order to run this example you will need the following:

  1. Java 8 (or newer), you can use any implementation:

    • If you have installed Java, you can check the version by typing the following in a command line:

      java -version
  2. Maven 3.2.1 (or newer):

    • If you have installed Maven, you can check the version by typing the following in a command line:

      mvn -version
  3. Git:

    • If you have installed Git, you can check the version by typing the following in a command line:

      git --version


To run this sample you will need a Consul instance. Note that such setup with only one node is not viable for production environments, but only for developing purposes. Download Consul and run it in development mode with the following command:

 $ consul agent -dev


The example uses maven to build and run the microservice.

  1. Build the sample using maven:

    $ cd discovery-samples/discovery-register
    $ mvn clean package
  2. Start local Consul instance:

  3. Run the sample:

  • Uber-jar:

    $ java -jar target/${project.build.finalName}.jar

    in Windows environemnt use the command

    java -jar target/${project.build.finalName}.jar
  • Exploded:

    $ java -cp target/classes:target/dependency/* com.kumuluz.ee.EeApplication

    in Windows environment use the command

    java -cp target/classes;target/dependency/* com.kumuluz.ee.EeApplication

The application/service can be accessed on the following URL:

The application is registered with Consul. You can discover it using one of the discover samples:

To shut down the example simply stop the processes in the foreground.


This tutorial will guide you through the steps required to register KumuluzEE microservice with Consul. We will use existing sample Customer REST service with the following resources:

We will follow these steps:

  • Import a Maven sample, mentioned above, in the IDE of your choice (Eclipse, IntelliJ, etc.)
  • Add Maven dependency to KumuluzEE Discovery extension
  • Annotate JAX-RS Application class with @RegisterService annotation
  • Build the microservice
  • Run it

Add Maven dependencies

Add the kumuluzee-discovery-consul dependency to the sample:


Add the kumuluzee-maven-plugin build plugin to package microservice as uber-jar:


or exploded:


Annotate JAX-RS Application

Add the @RegisterService annotation to JAX-RS Application class (CustomerApplication.java):

public class CustomerApplication extends Application {

Add required configuration for the service discovery

You can add configuration using any KumuluzEE configuration source.

For example, you can use config.yml file, placed in resources folder:

  name: customer-service
    name: dev
  version: 1.0.0
      port: 8081
    ttl: 20
    ping-interval: 15

Port 8081 is used because we want to run another microservice on default port, which discovers this service.

Build the microservice and run it

To build the microservice and run the example, use the commands as described in previous sections.