Spring Cloud: Exploring Spring Cloud Config Server (Native Mode)

This is a quick tutorial on Spring Cloud Config Server. In brief, Spring cloud config allows you to have applications/micro-services configuration at a centralized place. Since we are working on spring micro-services, in production we may have hundreds of micro-services running together. Now if we want to manage configuration for hundreds of those micro-services then it would be a big pain if we do it manually. Instead, we will use Spring cloud config server to manage that configuration from a central place.

TL;DR You can download whole project by clicking following link.

Creating Config Server

Let’s set up our config server. For that, we will be creating a Maven Project. Our project structure is given below. We will be creating two files which are as follows:

  1. AsmCloudConfigNativeApplication.java – Spring boot runable file
  2. application.properties – Spring properties file
Project Structure

Adding Dependencies

Let’s add the required dependencies. Replace content in pom.xml file with the following content. Don’t forget to update the project using Maven > Update option. That will download all the necessary dependencies.

Note that we will require ‘spring-cloud-config-server‘ dependency for our server.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
		<relativePath/> <!-- lookup parent from repository -->
	<description>Demo project for Spring Boot</description>

Creating Spring Boot Application

Create file AsmCloudConfigNativeApplication.java and add the following content. This file will serve as the entry point for our application. We will be adding @EnableConfigServer annotation on this class. This will enable the config server.

package com.example.asmcloudconfignative;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

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

Adding Properties

Under resources folder create a file with name application.properties and add the following content.


For this tutorial, we are using spring cloud config native configuration method and we have configuration stored in a file on our file system. We have mentioned its path in our properties files.


If you have noticed then in this tutorial we have stored our configuration properties at a particular location on our file system. In case if you want to store those configuration properties on your classpath and ship with your application you can use the following line.


This way the configuration properties will be loaded from the config folder present on the classpath.

Common Configuration

Now navigate to your ‘C’ drive and create a folder with name ‘commonconfig’. In this folder, we will be storing our common application config file. This is the path which we have mentioned in our application.properties file.

Now create a file with name  application.properties in that folder. Please add below-given configuration in that file. It contains the URL of your Eureka server because it is common to our producer and consumer application.


We have done setting up Spring cloud config server. Now we will integrate it with our consumer and producer application. For that, we will need to include one more dependency in pom.xml and will need to do some changes in our application.properties files of both projects.

Updating Consumer Project

For consumer project we will be using application created in Spring Cloud: Creating REST Client Using Ribbon tutorial. As discussed earlier, we will be modifying that project to meet our requirements.

First, we will need to add ‘spring-cloud-starter-config‘ dependency in pom.xml. That dependency will add necessary components which will allow us to consume configurations from the config server.


Now from application.properties file, we will remove Eureka Server URL and instance-id configuration. We have moved it to our common configuration.


You can download the modified consumer project by clicking on the following link.

Updating Producer Project

For producer project, we will be using application created in Spring Cloud: Creating Student Service With Eureka. Now we will do similar changes in our producer application as well.

First we will add ‘spring-cloud-starter-config‘ dependency in pom.xml.


Then we will remove common configurations from application.properties.


You can download the modified producer project by clicking on the following link.

Eureka Server

Of-course we will need Eureka server as well. For that you can refer Setting Up Eureka Server Using Spring Cloud post which has detailed step by step explanation or you can download the following project and run it directly.

Testing it…

Now let’s start all of our applications. We will start with Eureka server first. Once Eureka server is up we will start Spring cloud config server. Then we will start producer and consumer application respectively. Once all applications are up, you can navigate to Eureka dashboard and check the status of running services.

Eureka Dashboard

If you check logs of our producer or consumer application, you should see a line similar to which highlighted below. This line states that our application has contacted spring cloud config server for retrieving configuration.

Console Output

Let’s navigate to one of our endpoints and let’s check if we can able to access our service or not. If you navigate to ‘http://localhost:11802/studentdetails/1’ endpoint you should see output something similar to shown below. If you are getting this output that means that we have configured our spring application correctly.

Endpoint Output



  1. Spring Cloud Config Server Simple Example by JavaInUse

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.