[☁️ Spring Cloud] Spring Cloud Config 개념 및 적용 방법

 

각각의 Microservice가 갖고 있는 구성정보 파일(.yml)들이 수정된다면 어플리케이션 자체를 다시 빌드하고 배포해야한다. 

 

이와 같은 번거로움을 덜어내기 위해 구성정보 파일을 외부로 분리시킨다면 개발, 테스트, 운영 환경에서까지 모든 환경 구성을 간편하게 관리할 수 있다.

 

설정을 위한 서버를 별도로 구성하고 실행 중인 어플리케이션이 서버에서 설정 정보를 파악해 갱신시키면 빌드와 배포 없이 변경사항을 반영하는 것이다 !

 

❓ Spring Cloud Config 란?

Spring Cloud Config는 분산시스템에서 서버, 클라이언트 구성에 필요한 설정정보(application.yml)를 외부에서 관리할 수 있도록 지원해주는 시스템이다. 

 

중앙화된 저장소에서 관리하기 때문에 환경설정을 일괄적으로 관리할 수 있으며 각 환경마다 DB 또는 Gateway IP 주소 등이 다를 수 있기 때문에 DEV-UAT-PROD 환경에 맞는 구성정보를 사용할 수 있도록 한다.

 

🔹 구성정보 Storage 솔루션

• Private/Public Git Repository (remote / local) ➔ 예제에서는 이 방법 사용 예정 !
• Secure Vault
• Secure File Storage

 

 

예제를 활용한 결과를 한 눈에 보자면 위와 같다.

 

원래 가지고 있었던 application.yml에서 특정한 부분을 떼어내어 별도의 공용 서버 같은 역할을 해주는 Spring Cloud Config Server를 이용해 일관되게 사용하고자 한다. 

 

예제에서는 Authentication/Authorization(JWT 방식)에서 사용되는 token.secret을 일관되게 관리하여 다른 microservices에서도  적용시킬 수 있도록 만들어 볼 것이다. 

 

 

 

Spring Cloud Config 연동하기

 

☁️ config-service 프로젝트

 

1️⃣ Dependencies 추가

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>

 

2️⃣ @EnableConfigServer 추가

👉 현재 실행하고 있는 Spring Boot 프로젝트가 Configuration Server 역할로 하게 될 것이라고 명시

@SpringBootApplication
@EnableConfigServer
public class ConfigServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigServiceApplication.class, args);
    }
}

 

3️⃣ application.yml 추가 

👉 모든 서비스에서 config 정보 관리할 수 있도록 yml 파일 작성하기 

server:
  port: 8888

spring:
  application:
    name: config-service
  cloud:
    config:
      server:
        git:
          uri: https://github.com/soogoori/spring-cloud-config
#          만약 private으로 repository 생성할 시 username, password 작성
#          username: [my_username]
#          password: [my_pwd]

 

 

ecommerce로 시작하는 yaml 파일들은 application.yml 에서 떼어낸 특정한 정보로 생각하면 된다. 

기존 application.yml에 있던 정보들은 지우고 ecommerce.yml 파일에 따로 작성했다. 

해당 파일들은 git repository에 보관했다.

 

ecommerce.yml

token:
  expiration_time: 86400000
  secret: my_token_default

gateway:
  ip: 192.168.219.105

---

☁️ user-service 프로젝트 

 

1️⃣ Dependencies 추가

 

👉 spring-boot-starter-actuator : application 상태, 모니터링 ➔ 다양한 엔드포인트로 상태값 확인 

 

/actuator/refresh 엔드포인트를 사용해 user microservice를 재부팅하지 않고 변경한 정보 반영하도록 한다.

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

 

 

2️⃣ bootstrap.yml 추가

👉 application.yml 보다 우선순위 높고, 읽어오고자 하는 configuration 정보 위치를 명시한다.

name은 configuration server가 읽어오고자 하는 구성파일 정보이다. 

spring:
  cloud:
    config:
      uri: http://127.0.0.1:8888
      name: ecommerce

 

---

💡 설정 파일 내용 변경 시 Refresh 

1. Microservice 재기동 : 가장 단순하지만 사용 X
2. Actuator Refresh : /actuator/refresh 엔드포인트 사용 ➔ 해당 예제에서는 이 방법 사용 예정 !
3. Spring Cloud Bus : 메시지 브로커와 연결해서 변경 사항들을 노드에게 전달 ➔ RabbitMQ, Kafka

우선 해당 예제에서는 2번째 방법을 사용할 예정이고, 그 후 3번째를 활용해 볼 것이다. 

 

 

 

POST /actuator/refresh 를 통해 변경된 token 정보를 갱신시켜 반영한다. 

 

 

 

Profiles 사용하여 Configuration 적용하기

 

application-name 뒤에 다양한 설정 정보 (dev, prod 등)에 해당하는 이름을 붙여 yaml 파일을 여러 개 만들고 적용시켜보자. 

application-name-<profile>.yml 로 저장할 것이다. 

 

 

☁️ user-service에서 bootstrap.yml

spring:
  cloud:
    config:
      uri: http://127.0.0.1:8888
      name: ecommerce
  profiles:
    active: dev

 

☁️ apigateway-service에서 bootstrap.yml

spring:
  cloud:
    config:
      uri: http://127.0.0.1:8888
      name: ecommerce
  profiles:
    active: prod

 

👉 위와 같이 수정한 후 로그인을 한다면 token 정보는 ecommerce-dev.yml에 명시되어 있는 my_token_dev에 대한 토큰을 사용할 것이고, health_check를 한다면 ecommerce-prod.yml에 명시되어 있는 my_token_prod에 대한 토큰을 사용할 것이다. 

 

1차적으로 AuthorizationHeaderFilter를 거칠 때 사용하는 토큰 정보가 다르기 때문에 401 Unauthorized 에러가 발생한다. 

 

 

 

 

 

참고

https://docs.spring.io/spring-cloud-config/docs/current/reference/html/ 

https://sergiomartinrubio.com/articles/centralized-configuration-with-spring-cloud-config-server/