Skip to main content

Distributed configuration using spring cloud config

What is spring cloud config

Spring cloud config helps application in externalising the configuration properties in a server/client model. Which means there is a config server where all client application connects and read the properties related to their application. Properties can be accessed basis on application name and configured profile.
It supports resource based configuration using GIT repository or local file system over HTTP. Properties are managed in form of key-value pair. Though it easily integrate with spring boot application but can be used by any application in other languages also as properties can be accessed through REST URLs also.

We are going to learn below things here.

  1. GIT repository for configuration management
  2. Cloud config server
  3. Config client

GIT Repository

Here we are going to use GIT for configuration management which will be configured in config server. Setting up a GIT repository is very easy. We have to create the properties file using some naming pattern like <application_name>-<profile>.properties. Below is the structure of a GIT repository used for same purpose.


In above example "Config_repository" is our repository for configuration files where "microservice-app" is the application name and "DEV" or "PROD" is the profile name which details client application need to configure during connection to config server.
Below is the content of DEV properties file. Similarly PROD properties file will have details for production environment.
message=Welcome to Development!
world=Dev world

Cloud config server

We will create the config server using spring boot application. Below are the steps.

a. Create spring boot application
    You can either use spring initialiser ( or your favourite IDE to create the application.
b. Maven Dependencies
    Include below dependencies in your pom.xml.
c. Java configuration
    Below is the spring boot main class with required configuration annotation @EnableConfigServer.
public class CloudConfigApplication {

    public static void main(String[] args) {, args);
d. Cloud application configuration (application.yml)
    I have used YML for application configuration but properties file also can be used. Below is the content of configuration file. Here I have configured my git project for demonstration purpose.
server.port : 8888
          uri :
          username: ${git_user}
          password: ${git_password}
          force-pull: true config_user Lwre15qlw@
User name and password configured here will be required by config client to connect with it.

After starting the cloud config server, you can verify the URL in browser as given below.
Syntax: http://<host:port>/<application_name>/<profile>
Example: http://localhost:8888/microservice-app/DEV

It will show you the similar result as given below.
{"name":"microservice-app","profiles":["DEV"],"label":null,"version":"2e7c382ac0bcd2c35892960487451b333847c844","state":null,"propertySources":[{"name":"","source":{"message":"Welcome to Development!","world":"Dev world"}}]}

Cloud config client

Our config client application is created using spring boot application.

a. Create spring boot application
    You can either use spring initialiser ( or your favourite IDE to create the application.
b. Maven Dependencies
    Include below dependencies in your pom.xml.
c. bootstrap.yml
    A bootstrap configuration required to connect with cloud config server.
    active: PROD
      name: microservice-app
      uri: https://localhost:8888/
      username: config_user
      password: Lwre15qlw@
d. Properties usage
    Now our configuration is complete and we can use the properties in any of the spring managed class in the same way we do it in any regular spring application. See below example.
    private String message;
This concludes all the required components of spring cloud config server and client using GIT. Please let me know if you have any comment or suggestions.

If you are interested to know more about cloud configuration, like spring cloud bus using webhooks then please visit my another post.
config management using spring cloud bus


  1. Thank you for sharing your thoughts and knowledge on this topic.
    Microservices Online Training

  2. Thanks for sharing the valuable information. It was a great information.
    Microservices Online Training

    1. Great Article
      Cloud Computing Projects

      Networking Projects

      Final Year Projects for CSE

      JavaScript Training in Chennai

      JavaScript Training in Chennai

      The Angular Training covers a wide range of topics including Components, Angular Directives, Angular Services, Pipes, security fundamentals, Routing, and Angular programmability. The new Angular TRaining will lay the foundation you need to specialise in Single Page Application developer. Angular Training

  3. This Content is simply amazing, and helpful for students and business people. Gathered lots of information and waiting to see more updates.
    Features Of RPA
    How RPA Works

  4. This blog Contains more useful information, thanks foer this blog.
    Azure technology
    Azure system


  5. Nice informative content. Thanks for sharing the valuable information.

    RPA Training in Chennai
    RPA Training Online
    RPA Training In Bangalore

  6. Thank you for this blog. It is very useful. Share more like this.

    JAVA Training in Chennai
    JAVA Course in Chennai


Post a Comment

Popular Posts

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check. havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false. matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment. name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"} prefix - It can be use when you want to apply some prefix to

Why HashMap key should be immutable in java

HashMap is used to store the data in key, value pair where key is unique and value can be store or retrieve using the key. Any class can be a candidate for the map key if it follows below rules. 1. Overrides hashcode() and equals() method.   Map stores the data using hashcode() and equals() method from key. To store a value against a given key, map first calls key's hashcode() and then uses it to calculate the index position in backed array by applying some hashing function. For each index position it has a bucket which is a LinkedList and changed to Node from java 8. Then it will iterate through all the element and will check the equality with key by calling it's equals() method if a match is found, it will update the value with the new value otherwise it will add the new entry with given key and value. In the same way it check for the existing key when get() is called. If it finds a match for given key in the bucket with given hashcode(), it will return the value other

jaxb2-maven-plugin to generate java code from XSD schema

In this tutorial I will show how to generate the Java source code from XSD schema. I will use jaxb2-maven-plugin to generate the code using XSD file which will be declared in pom.xml to make it part of build, so when maven build is executed it will generate the java code using XSD. Class generation can be controlled in plugin configuration. Maven changes (pom.xml) Include below plugin in your pom.xml. Here we have done some configuration under configuration section as given below. schemaDirectory : This is the directory where I keep my schema (XSD file). outputDirectory : This is the java source location where I want to generate the Java files. If it is not given then by default it will be generate inside target folder. clearOutputDir : If this property is true then it will generate the classes on each build otherwise it will generate only if output directory is empty. <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jaxb2-maven-plugin</art