📒

[Spring MSA] 02-3. Spring Cloud Config

상태

완료

수업

Spring MSA

주제

Config

연관 노트

3 more properties

참고

Spring Cloud Config

Spring Cluoud Config Server 구현

Spring Cloud Config Client 구현

GitHub 저장소에 암호화된 구성 속성 저장

Cloud Config 설정 파일 내용을 갱신하는 방법

Actuator 갱신(@RefreshScope)

Spring Cloud Bus(RabbitMQ)

설정 갱신 자동화

도커 이동

Spring Cloud Config

NOTE

Spring Cloud Config는 분산 시스템의 외부화된 설정 정보를 서버 및 클라이언트에게 제공하는 시스템입니다.

Spring Cloud Config의 주요이점은 다음과 같습니다.

모든 마이크로서비스의 구성을 한 곳에서 관리할 수 있어, 유지보수성이 올라갑니다.

애플리케이션을 재시작하지 않고도 실시간으로 구성 변경을 적용할 수 있습니다.

중요한 구성 정보를 소스코드 밖에서 안전하게 관리할 수 있습니다.

Spring Cluoud Config Server 구현

NOTE

1. 설정 서버 구성

설정 서버 구성을 위해서는 먼저 spring-cloud-starter-config와 mavenBom의 spring-cloud-dependencies 추가해주면 됩니다.

dependencies {
  implementation 'org.springframework.cloud:spring-cloud-starter-config'
}

dependencyManagement {
  imports {
    mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
  }
}
Groovy
복사
config client 추가

설정 서버의 application.yaml에는 사용해야하는 설정 정보 저장소를 설정하고, 추가적인 설정을 진행해주면 됩니다. 현재는 Git을 외부 설정 저장소로 사용하며, 이외에도 다양한 저장소가 있습니다.

server:
  port: 8888 # 일반적으로 설정서버는 8888 사용

spring:
  # 활성화할 프로필을 지정
  profiles:
    active: git  # 'git' 프로필을 활성화하여 Git 저장소를 구성 정보의 소스로 사용

  # Spring Cloud Config 관련 설정
  cloud:
    config:
      server:
        # Git 저장소 설정을 사용하여 구성 정보를 관리
        git:
          uri: "https://github.com/scofe97/back_study.git"  # 구성 파일이 저장된 Git 저장소의 URI
          default-label: main   # 기본적으로 사용할 브랜치명
          search-paths: msa/section6/config  # 구성 파일을 찾을 저장소 내의 경로
          timeout: 5            # 저장소 요청 시 타임아웃 시간 (초 단위)
          clone-on-start: true  # 서버 시작 시 저장소를 클론할지 여부
          force-pull: true      # 서버가 시작할 때마다 저장소의 최신 상태를 강제로 Pull할지 여부
YAML
복사
application.yml

마지막으로 Main클래스에 @EnableConfigServer를 붙여주면 끝납니다.

@SpringBootApplication
@EnableConfigServer // 추가!
public class ConfigserverApplication {
	// ..
}
Java
복사
ConfigserverApplication.java

2. 설정 서버 실행 및 확인

Spring Cloud Config를 사용하면 다양한 설정 파일을 읽을 수 있는데 다음의 순서대로 읽어집니다. 만약 순서대로 읽다가 동일한 값을 지니는 설정 정보가 있다면 덮어 씌워지므로 주의해야 합니다.

프로젝트의 application.yaml

설정 저장소의 application.yaml

프로젝트의 application-{profile} .yaml

설정 저장소의 application-{profile} 

spring:
  config:
    activate:
      on-profile: "prod"

build:
  version: "1.0"

cards:
  message: "Welcome to EazyBank cards related prod APIs "
  contactDetails:
    name: "Sandra Harald - Product Owner"
    email: "{cipher}40fd4a26acdbe428d773ac93852b759a3f10e136b21445547371d7c0c42f2617dbdf3a8f59e266ec2707ea96c2e9ef4d"
  onCallSupport:
    - (617) 432-2356
    - (936) 564-8721
YAML
복사
cards-prod

// # GET http://localhost:8088/cards/prod
{
    "name": "cards",
    "profiles": [
        "prod"
    ],
    "label": null,
    "version": "65213dff6d30fbff1c3c74b60d66a7dce4330a68",
    "state": null,
    "propertySources": [
        {
            "name": "https://github.com/scofe97/back_study.git/msa/section6/config/cards-prod.yml",
            "source": {
                "spring.config.activate.on-profile": "prod",
                "build.version": "1.0",
                "cards.message": "Welcome to EazyBank cards related prod APIs ",
                "cards.contactDetails.name": "Sandra Harald - Product Owner",
                "cards.contactDetails.email": "sandra@eazybank.com"
                "cards.onCallSupport[0]": "(617) 432-2356",
                "cards.onCallSupport[1]": "(936) 564-8721"
            }
        },
        {
            "name": "https://github.com/scofe97/back_study.git/msa/section6/config/cards.yml",
            "source": {
                "build.version": "3.0",
                "cards.message": "Welcome to EazyBank cards related local APIs ",
                "cards.contactDetails.name": "Dragos Lech - Developer",
                "cards.contactDetails.email": "dragos@eazybank.com",
                "cards.onCallSupport[0]": "(412) 419-3491",
                "cards.onCallSupport[1]": "(915) 382-1932"
            }
        }
    ]
}
JSON
복사
결과

Spring Cloud Config Client 구현

NOTE

1. Config 서버 의존성 추가

Config Server와 동일하게 의존성이 필요합니다.

dependencies {
  implementation 'org.springframework.cloud:spring-cloud-starter-config'
}

dependencyManagement {
  imports {
    mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
  }
}
Groovy
복사
config client 추가

application.yaml에는 Config server의 정보와 애플리케이션의 정보를 입력합니다. Config server의 URL에 optional이 붙는 이유는 통신 실패시에도 계속해서 동작할 수 있도록 하기 위함입니다.

spring:
	# 서비스 이름 등록
  application:
    name: "accounts" 
    
  # 기본 프로필 등록
  profiles:
    active: "prod"
	
	# config 서버 연결
  config:
    import: "optional:configserver:http://localhost:8071/"
YAML
복사
application.yml

•

마이크로서비스의 spring.application.name 속성을 사용하여 이름을 설정합니다.

•

설정된 이름은 서버에 저장된 파일 이름과 일치해야 합니다. 예를 들어, accounts가 서비스의 이름이라면 설정 파일은 account.yaml이 됩니다.

•

spring.config.import를 설정하여 Config 서버의 URL을 지정합니다. optional 설정을 하지 않으면 구성서버 연결 실패시 예외가 발생하게 됩니다.

GitHub 저장소에 암호화된 구성 속성 저장

NOTE

Spring Cloud Config는 구성 정보를 안전하게 관리하기 위해 암호화 및 복호화 기능을 내장하고 있습니다.

Spring Cloud Config는 구성 정보에 대한 암호화를 지원해줍니다. 가장 간단한 방식인 encrypt.key값을 설정하고 암호화/복호화 하는 과정을 진행해봅시다.

key값을 설정하고나면, /encrypt, /decrypt 엔드포인트를 기본으로 제공해줍니다.

# 암호화 키
encrypt:
  key: 'test' # 어떠한 값도 상관없음
YAML
복사
암호화 키 설정

// POST http://localhost:8071/encrypt
55b6339f4e4d29a7ed9117a77b73c14a8ff033c39b4766135a9de24eddfd563e559be8e5bc62be0238afaa6b0fdce5c9

// POST http://localhost:8071/decrypt
sandra@eazybank.com
JSON
복사

이렇게 암호화된 값을 저장할때는 cipher 접두어를 사용합니다. 이 접두어를 사용하면 구성 값을 로드할때 자동으로 값을 복호화 합니다.

# '{cipher}암호화된값'
email: '{cipher}55b6339f4e4d29a7ed9117a77b73c14a8ff033c39b4766135a9de24eddfd563e559be8e5bc62be0238afaa6b0fdce5c9'
Bash
복사
암호화된 값 저장

Cloud Config 설정 파일 내용을 갱신하는 방법

NOTE

Spring Cloud Config의 설정 파일을 변경되어도 별다른 설정을 하지 않으면, 변경사항이 바로 반영되지 않는다. 왜냐하면 설정 서버에 부하를 줄이도록 Spring Cloud Config Server에 부담을 줄이기위해서 클라이언트측에서 실행시점서 1번 읽고 로컬에 캐싱해두기 때문이다.

만약 배포 후에 값을 수정하거나 추가해야 할때마다 Config 서버를 재배포하는 것은 매우 비효율적이다. 그러므로 설정이 바뀌면 자동 갱신을 하는 방법이 3가지 있다.

Actuator 요청 (@Refresh)

Spring Cloud Bus(RabbitMq, Kafka)

Watcher를 통해 변경사항을 지속적으로 확인한다.

Actuator 갱신(@RefreshScope)

NOTE

Actuator는 애플리케이션의 상태를 모니터링하고 관리하는 여러 엔드 포인트를 제공하며, /actuator/refresh를 통해 설정값의 변경을 감지할 수 있습니다!

설정값을 변경하고 /actuator/refresh를 클라이언트에서 요청하면, 변경된 값을 감지하고 자동으로 변경해줍니다.

// Post http://localhost:8080/actuator/refresh
[
    "build.version",
    "config.client.version",
    "accounts.message"
]
JSON
복사
변경된 내용 출력

@ConfigurationProperties(prefix = "accounts")
@Getter
@Setter
public class AccountsContactInfoDto {
    private String message;

    private Map<String, String> contactDetails;

    private List<String> onCallSupport;
}
Java
복사
사용되는 변수

그런데 @ConfigurationProperties로 값을 받아오는 경우는 상관없지만, 단순 @Value로 값을 받는 경우에는 최신화되지 가 않습니다. 이 경우에는 @RefreshScope를 붙여서 해결할 수 있습니다.

Notes on Dynamic Configuration Properties

Notes on Dynamic Configuration Properties · GitHub

https://gist.github.com/dsyer/a43fe5f74427b371519af68c5c4904c7

참고글

@RefreshScope
@RestController
@RequestMapping(path="/api", produces = {MediaType.APPLICATION_JSON_VALUE})
public class AccountsController {

    private final IAccountsService iAccountsService;

    @Value("${build.version}")
    private String buildVersion;
		
		// ...   
}
Java
복사
@RefreshScope를 통해서 buildVersion값이 최신화된다.

위와 같은 방식은 무중단으로 진행이 가능하지만 결국 각 서비스가 /refresh를 호출해서 직접 설정 정보를 갱신해야하는 번거로움이 남아있습니다.

Spring Cloud Bus(RabbitMQ)

NOTE

Spring Cloud Bus는 메시지 브로커를 통해 마이크로서비스 간에 이벤트, 구성 변경 등을 전파할 수 있습니다. 이를 통해 한 서비스의 변경사항을 네트워크상의 모든 서비스에 즉각적으로 알릴 수 있습니다.

Installing RabbitMQ | RabbitMQ

<!--

https://www.rabbitmq.com/docs/download

RabbitMQ는 경량 메시지 브로커로, 스프링 클라우드 버스에 의해 사용됩니다. 이전에 사용했던 Actuator 방식은 각각의 단일 인스턴스에 대해 /refresh 요청을 보내야했지만, Cloud Bus방식은 1번의 요청으로 모든 서비스에 /refresh 요청을 보낼수 있습니다.

RabbitMQ는 단순 /refresh가 아닌 /busrefresh를 사용해야 각 서비스에 전파가 됩니다.

Config 변경 흐름도

# latest RabbitMQ 3.13
docker run -it --rm --name rabbitmq \
	-p 5672:5672 \
	-p 15672:15672 \
	rabbitmq:3.13-management
Bash
복사
RabbitMq 설치

<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
Java
복사
전체 인스턴스에 설정

spring:
  rabbitmq:
    host: "localhost"
    port: 5672
    username: "guest"
    password: "guest"
Java
복사
전체 인스턴스에 설정

/busrefresh를 보내면 204 성공요청이 발생하며, 이후 /actuator/refresh를 적용한것과 동일하게 동작합니다.

// Post http://localhost:8080/actuator/busrefresh 
JSON
복사

설정 갱신 자동화

NOTE

spring-cloud-config-monitor의존성을 추가해서 /monitor라는 API를 사용하면 변경사항이 커밋될 때마다 웹훅이 이를 감지하여 자동으로 호출하게 설정할 수 있습니다.

Hookdeck - A reliable Event Gateway for event-driven applications

Hookdeck is an Event Gateway. A platform giving engineering teams infrastructure and developer tooling to build, deploy, operate, and monitor event-driven applications.

https://hookdeck.com/

CLI Reference - Hookdeck

Use the Hookdeck CLI to receive events such as webhooks on your local server and manage your Hookdeck project

https://hookdeck.com/docs/cli

<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-config-monitor</artifactId>
</dependency>
XML
복사

•

Github 저장소에 /monitor 엔드포인트를 지정하는 웹훅을 설정합니다.

•

/monitor는 내부적으로 /busrefresh를 호출하여 변경사항을 전파합니다.

•

로컬에서 테스트할 때는 Hookdeck과 같은 서비스를 사용해서 웹훅을 사용할 수 있습니다.

도커 이동

NOTE

services:
	# RabbitMQ
  rabbit:
    image: rabbitmq:3.13-management
    hostname: rabbitmq
    ports:
      - "5672:5672"
      - "15672:15672"
    healthcheck:
      test: rabbitmq-diagnostics check_port_connectivity
      interval: 10s
      timeout: 5s
      retries: 10
      start_period: 5s
    deploy:
      resources:
        limits:
          memory: 700m
    extends:
      file: common-config.yml
      service: network-deploy-service

	# ConfigServer
  configserver:
    image: "eazybytes/configserver:s6"
    container_name: configserver-ms
    ports:
      - "8071:8071"
    depends_on:
      rabbit:
        condition: service_healthy
    healthcheck:
      test: "curl --fail --silent localhost:8071/actuator/health/readiness | grep UP || exit 1"
      interval: 10s
      timeout: 5s
      retries: 10
      start_period: 10s
    extends:
      file: common-config.yml
      service: network-base-config

	# Service 1
  accounts:
    image: "eazybytes/accounts:s6"
    container_name: accounts-ms
    ports:
      - "8080:8080"
    depends_on:
      configserver:
        condition: service_healthy
    environment:
      SPRING_APPLICATION_NAME: "accounts"
    extends:
      file: common-config.yml
      service: microservice-configserver-config

	# Service 2
  loans:
    image: "eazybytes/loans:s6"
    container_name: loans-ms
    ports:
      - "8090:8090"
    depends_on:
      configserver:
        condition: service_healthy
    environment:
      SPRING_APPLICATION_NAME: "loans"
    extends:
      file: common-config.yml
      service: microservice-configserver-config

	# Service 3
  cards:
    image: "eazybytes/cards:s6"
    container_name: cards-ms
    ports:
      - "9000:9000"
    depends_on:
      configserver:
        condition: service_healthy
    environment:
      SPRING_APPLICATION_NAME: "cards"
    extends:
      file: common-config.yml
      service: microservice-configserver-config

networks:
  eazybank:
    driver: "bridge"
YAML
복사
common-compose.yml

services:
  network-deploy-service:
    networks:
      - eazybank

  microservice-base-config:
    extends:
      service: network-deploy-service
    deploy:
      resources:
        limits:
          memory: 700m
    environment:
      SPRING_RABBITMQ_HOST: "rabbit"

  microservice-configserver-config:
    extends:
      service: microservice-base-config
    environment:
      SPRING_PROFILES_ACTIVE: default
      SPRING_CONFIG_IMPORT: configserver:http://configserver:8071/
YAML
복사
common-config.yml

Liveness Probes는 컨테이너 또는 애플리케이션이 정상 작동 중인지, 혹은 실패 상태인지를 감지하는 신호를 보냅니다.

•

컨테이너가 정상 작동 중이라면, 추가적인 조치가 필요 없습니다. 즉, 애플리케이션의 현재 상태가 좋다는 의미입니다.

•

컨테이너가 실패 상태라면, 애플리케이션을 복구하기 위한 시도가 필요하며, 보통은 애플리케이션을 재시작하는 것을 의미합니다.

Readiness Probes는 컨테이너나 애플리케이션이 네트워크 트래픽을 받을 준비가 되었는지를 판단하기 위해 사용됩니다.

•

컨테이너가 정상 작동 중이지만, 네트워크 트래픽을 처리할 준비가 안된 상태라면, Readiness Probe는 실패합니다. 이는 준비되지 않은 컨테이너로 트래픽을 보내지 않기 위함입니다.

•

준비되지 않은 컨테이너에 네트워크 트래픽을 성급하게 보내면, 로드 밸런서나 라우터가 클라이언트에게 502 오류를 반환하고 요청을 거부할 수 있습니다.