Spring Cloud Config로 설정 관리 자동화하기: 개념부터 Private Git 연동까지

이번 글에서는 Spring Cloud Config는 분산 환경에서 설정 관리를 중앙 집중화하여 복잡성을 줄이고 운영 효율성을 높이는 중요한 도구입니다. 이번 글에서는 Spring Cloud Config의 개념과 이를 도입함으로써 해결할 수 있는 문제들을 살펴보고, 도입 과정과 설정 방법을 설명합니다. 또한, Private 레포지토리와 SSL 연결 설정에 대해서도 다룹니다. 이를 통해 여러 서비스의 설정을 일관되고 안전하게 관리할 수 있는 방법을 소개합니다.

1. Spring Cloud Config란?

Spring Cloud Config는 분산 시스템에서 외부 설정 정보를 중앙 서버를 통해 관리하고 제공하는 시스템입니다. Spring Cloud Config는 다음 두 가지 주요 구성 요소로 이루어져 있습니다:

• Spring Cloud Config Server (설정 서버): 외부 저장소(Git 등)를 통해 중앙에서 설정 정보를 관리하고, 이를 클라이언트 애플리케이션에 제공합니다. 설정 서버는 클라이언트 애플리케이션이 시작할 때 필요한 설정 정보를 제공하며, 클라이언트는 설정 서버에서 해당 정보를 가져와 애플리케이션에 적용합니다. 이를 통해 설정 변경 시 모든 클라이언트가 최신 설정을 사용할 수 있도록 보장합니다.
• Spring Cloud Config Client (설정 클라이언트): 설정 서버에서 설정 정보를 받아 애플리케이션에 적용합니다.

이 시스템을 사용하면 여러 서비스의 설정 파일을 중앙에서 일관되게 관리하고, 변경 사항을 쉽게 적용할 수 있습니다. 각 서비스마다 설정 파일을 따로 관리하는 번거로움을 없애주며, 모든 환경에 대한 설정 변경을 한 곳에서 제어할 수 있게 해줍니다. 이를 통해 관리의 편의성과 서비스 안정성을 높일 수 있습니다.

반응형

---

2. Spring Cloud Config의 장단점

장점

• 여러 서버의 설정 파일을 중앙 서버에서 관리할 수 있습니다. 이를 통해 설정의 일관성을 유지하고, 환경 간 설정 파일의 차이를 줄일 수 있습니다.
• 서버 재배포 없이 설정 파일의 변경사항을 반영할 수 있습니다. 이를 통해 애플리케이션의 다운타임 없이 설정을 변경하고, 운영 효율성을 극대화할 수 있습니다.
• 설정 파일에 대한 버전 관리가 가능합니다. Git과 같은 버전 관리 시스템을 사용하여 설정 파일의 변경 이력을 추적하고, 특정 시점의 설정으로 복구할 수 있습니다.

단점

• Git 서버나 설정 서버에 장애가 발생할 경우, 그 영향이 모든 서비스에 전파될 수 있습니다. 중앙 집중형 아키텍처의 특성상 단일 장애 지점(Single Point of Failure)이 발생할 수 있으므로, 고가용성을 위해 서버 이중화 또는 백업 방안이 필요합니다.
• 설정 파일의 우선순위에 주의해야 합니다. 동일한 설정이 여러 곳에 있을 경우, 나중에 읽힌 설정이 최종적으로 적용됩니다. 예를 들어, 로컬 설정 파일과 중앙 설정 서버의 설정 파일에 같은 키가 있을 경우, 중앙 설정 서버에서 읽힌 값이 우선적으로 적용됩니다. 이를 방지하기 위해서는 설정 파일의 구조를 명확히 하고, 동일한 설정을 여러 곳에 중복해서 작성하지 않도록 주의해야 합니다. 이로 인해 예상치 못한 설정 충돌이 발생할 수 있으며, 이를 방지하기 위해 설정 파일 구조를 체계적으로 관리해야 합니다.

---

3. Spring Cloud Config 구축하기

3.1 설정 파일 저장소 구축

가장 먼저 설정 파일들을 저장할 Git 레포지토리를 생성해야 합니다. 설정 파일은 {앱이름}-{프로파일}.yml 형태로 작성합니다. 예를 들어 myapp-dev.yml과 같은 형식으로 작성하여, 각 애플리케이션과 환경별로 파일을 구분합니다. 이처럼 설정 파일을 구조화하여 관리하면, 각 환경에 맞는 설정을 쉽게 찾고 업데이트할 수 있습니다.

3.2 설정 서버 구축

설정 서버를 구축하기 위해서는 spring-cloud-config-server 의존성을 추가해야 합니다. Gradle 예시는 다음과 같습니다.

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

설정 서버의 application.yml 파일에 Git 저장소와 관련된 설정을 추가합니다

server:
  port: 8888
spring:
  application:
    name: config
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-repo/spring-config-repo
          default-label: main

설정 서버는 설정 파일을 Git 저장소에서 가져와 관리하며, 설정 서버 자체의 포트는 8888로 설정되어 있습니다. 이 서버는 각 클라이언트 애플리케이션이 필요로 하는 설정 정보를 중앙에서 제공하게 됩니다.

그리고 메인 클래스에 @EnableConfigServer 어노테이션을 추가하여 설정 서버로서 기능하도록 합니다

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

@EnableConfigServer 어노테이션은 해당 애플리케이션을 Config Server로 작동하도록 설정하는 역할을 합니다. 이를 통해 중앙 서버에서 모든 설정 정보를 관리하고 제공할 수 있게 됩니다.

3.3 설정 서버 실행 및 확인

설정 서버를 실행한 후 브라우저에서 http://localhost:8888/{앱이름}/{프로파일} 형태로 접근하여 설정 파일을 제대로 읽어오는지 확인합니다. 예를 들어, http://localhost:8888/myapp/dev로 접근하면 myapp-dev.yml의 내용을 확인할 수 있습니다. 이를 통해 설정 서버가 정상적으로 동작하고 있는지, 클라이언트에 필요한 설정을 제공할 수 있는지 점검할 수 있습니다.

---

4. Private 레포지토리 SSL 연결 설정

대부분의 경우 설정 파일은 Private Git 레포지토리에 저장됩니다. 이때 Spring Cloud Config 서버가 레포지토리에 접근하기 위해 비대칭키 (SSL 인증서) 설정이 필요합니다. Private 레포지토리에 안전하게 접근하려면 SSH 키를 사용하여 인증을 설정해야 합니다.

4.1 비대칭키 생성하기

설정 서버에서 다음 명령어로 비대칭키를 생성합니다

ssh-keygen -m PEM -t ecdsa -b 256

이 명령어를 사용하면 ECDSA 방식의 비대칭키가 생성됩니다. ECDSA는 보안성이 높고, GitHub에서도 권장하는 방식입니다. 생성된 키는 설정 서버와 Git 저장소 간의 안전한 연결을 보장합니다.

4.2 공개키 등록하기

생성된 공개키를 Git 레포지토리의 deploy key에 등록합니다. 이 공개키는 GitHub 레포지토리의 Settings -> Deploy keys 메뉴에서 등록할 수 있습니다. 이를 통해 설정 서버가 해당 레포지토리에 접근할 수 있는 권한을 부여받게 됩니다.

---

4.3 설정 서버의 application.yml 수정하기

비대칭키를 사용하여 Private 레포지토리에 접근하도록 설정 서버의 application.yml 파일을 수정합니다. SSH 키를 사용하는 것은 사용자 이름과 비밀번호를 이용한 접근 방식보다 훨씬 안전합니다. SSH 키는 공개키 암호화를 사용하여 무작위 대입 공격을 방지하며, 키 파일은 보안이 강화된 방식으로 저장되기 때문에 설정 파일의 접근을 보호할 수 있습니다

spring:
  cloud:
    config:
      server:
        git:
          uri: git@github.com:your-repo/spring-config-repo.git
          privateKey: |
            -----BEGIN EC PRIVATE KEY-----
            ...
            -----END EC PRIVATE KEY-----

privateKey 항목에는 비대칭키 생성 시 생성된 개인 키를 입력합니다. 개인 키를 직접 설정 파일에 넣는 방식이기 때문에 보안에 주의해야 하며, 설정 파일 접근 권한을 제한하거나 암호화를 고려해야 합니다. 이를 통해 설정 서버는 Private 레포지토리에서 설정 파일을 안전하게 가져올 수 있습니다.

728x90

---

Spring Cloud Config를 도입하면 여러 프로젝트의 설정을 중앙에서 효율적으로 관리하고, 변경 사항을 자동으로 모든 서비스에 반영할 수 있습니다. 이를 통해 유지보수의 편의성과 운영 효율성을 높일 수 있습니다. 이는 유지보수의 편의성을 높이고, 운영 환경에서 발생할 수 있는 설정 관련 오류를 최소화합니다.

다만, Private 레포지토리와 SSL 설정 등 보안적인 부분도 신경 써야 합니다. 설정 파일이 외부에 노출되지 않도록 하고, 안전하게 관리하기 위해 적절한 접근 통제와 암호화 방식을 도입해야 합니다. 설정 파일 변경 시 자동 갱신하는 방법이나 주의 사항에 대해서는 다음 포스팅에서 다루도록 하겠습니다. 이를 통해 Spring Cloud Config를 더욱 효과적이고 안전하게 활용할 수 있는 방법을 탐구해 보겠습니다.

Spring Cloud Config는 분산 환경에서의 설정 관리 문제를 해결하고, 설정의 일관성과 가시성을 제공합니다. 이를 통해 마이크로서비스 아키텍처에서 설정을 중앙 집중적으로 관리하고, 애플리케이션 간의 설정 차이를 줄일 수 있습니다. 다음 글에서는 Spring Cloud Bus를 사용하여 설정 변경 시 모든 클라이언트에 자동으로 변경 사항을 전파하는 방법에 대해 다뤄 보겠습니다. 이를 통해 설정 관리의 자동화 수준을 한 단계 더 높여 보세요.