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.

Config_repository
      microservice-app-DEV.properties
      microservice-app-PROD.properties

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 (https://start.spring.io) or your favourite IDE to create the application.
b. Maven Dependencies
    Include below dependencies in your pom.xml.
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
c. Java configuration
    Below is the spring boot main class with required configuration annotation @EnableConfigServer.
@SpringBootApplication
@EnableConfigServer
public class CloudConfigApplication {

    public static void main(String[] args) {
        SpringApplication.run(CloudConfigApplication.class, 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
spring:
  cloud:
    config:
      server:
        git:
          uri : https://github.com/thetechnojournals/Config-repo/
          username: ${git_user}
          password: ${git_password}
          force-pull: true

spring.security.user.name: config_user
spring.security.user.password: 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":"https://github.com/ashokprajapati999/Config-repo//microservice-app-DEV.properties","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 (https://start.spring.io) or your favourite IDE to create the application.
b. Maven Dependencies
    Include below dependencies in your pom.xml.
        <dependency>
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
c. bootstrap.yml
    A bootstrap configuration required to connect with cloud config server.
spring:
  profiles:
    active: PROD
  cloud:
    config:
      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.
    @Value("${message}")
    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

Comments

Post a Comment

Popular Posts

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 "property.name" 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 all prop…

Asynchronous REST service implementation in Spring boot

In this tutorial we will see how to create an asynchronous REST service endpoint using Spring boot application.
Asynchronous service works in a way that it will not block the client request and do the processing in separate thread. When work is complete the response returned to the client so our service will be able to handle more client requests at the same time, compare to synchronous processing model.
Let's understand how it is working in synchronous mode. In such server/client application at server side it has a pool of threads which are serving the request. If a request received by a thread then it will be blocked until it send the response back to client. In this case if processing doesn't take much time it will be able to process it quickly and accept other client requests but there could be one situation when all threads are busy and not able to accept the new client requests.

To overcome of such problems, asynchronous processing model introduced for REST services. In…

Entity to DTO conversion in Java using Jackson

It's very common to have the DTO class for a given entity in any application. When persisting data, we use entity objects and when we need to provide the data to end user/application we use DTO class. Due to this we may need to have similar properties on DTO class as we have in our Entity class and to share the data we populate DTO objects using entity objects. To do this we may need to call getter on entity and then setter on DTO for the same data which increases number of code line. Also if number of DTOs are high then we need to write lot of code to just get and set the values or vice-versa.
To overcome this problem we are going to use Jackson API and will see how to do it with minimal code only.
Maven dependency <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.9</version> </dependency> Entity class Below is our ent…

Web scraper using JSoup and Spring Boot

What is webscraping Webscraping is a technique to extract or pull the data from a website to gather required information by parsing the HTML source of their websites, such as articles from news or books site, products information from online shopping sites or course information from education sites. There are many organisations who uses web scraper to provide the best experience to their customers, for example extract the price for a smartphone from multiple online websites and show their customers the best and cheap product URL.
We will learn here how to code a web scraper by developing a simple new scraper service.
News scraper News scraper is used to extract the news articles or other related contents from a news site. Here we are going to create a web scraper application to pull the articles from news site.
Below are the operations provided by our news scraper service.
List all the authorsSearch articles by author nameSearch articles by article titleSearch articles by article desc…