서브모듈을 적용해서 민감한 정보가 담긴 파일을 숨긴다.

[nayonsoso]

어떤 기능인가요?

추가하려는 기능에 대해 간결하게 설명해주세요

이전에는 디스코드를 통해 yml 파일을 공유했었습니다.
하지만 엄밀히 말하면 디스코드를 통한 공유도 보안상 좋다고 할 수 없습니다.
따라서 private repository 를 서브모듈로 활용하는 방법을 적용해봤습니다.
이를 통해 '팀원들간의 yml 파일 동기화' 와 'yml 파일 버전 관리 가능' 을 달성할 수 있습니다.

작업 상세 내용

• 서브모듈을 위한 레포지토리 생성
• 레포지토리에 yml 파일 등록
• 서버 레포지토리에 서브모듈 추가
• yml 파일 내용 변경
• GitHub action 내용 변경

참고할만한 자료(선택)

https://celestial-sheep-6b7.notion.site/b3f5b05149544e72b15ed6f2999bf6f7

[wibaek]

가능하다면 서브모듈을 적용하면서 전체적인 yml 파일 관리 구조도 바꿀 수 있을까요?
Next.js나 Vite에서 사용되는 방식을 사용해도 좋을 것 같습니다.

구조

• production, development, test 환경에 따라 파일이 분리되어 있습니다
• 환경에 상관없이 공통적으로 공유하는 변수 파일(application, application-local)이 있습니다
• 비공개 되어야 하는 변수는 local 파일에 저장합니다

즉

• application.yml
• application-local.yml
• application-prod.yml
• application-prod-local.yml
• application-dev.yml
• application-dev-local.yml
• application-test.yml
• application-local.yml

파일을 가집니다. 여기서 -local이 붙은 파일은 비공개 되어야 하여, 서브 모듈로 관리합니다.

구현

환경을 적용하기 위하여 다음과 같이 사용합니다

spring:
  profiles:
    group:
      production:
        - classpath:secret/application-local.yml
        - prod
        - classpath:secret/application-prod-local.yml
      development:
        - classpath:secret/application-local.yml
        - dev
        - classpath:secret/application-dev-local.yml
      test:
        - classpath:secret/application-local.yml
        - test
        - classpath:secret/application-test-local.yml

~~~ 일반 공통 설정들 ~~~

또는 지나치게 파일이 많아 지는 것을 방지하기 위해 local이 아닌 값들은 application.yml에서 같이 관리 해도 될 것 같습니다.

spring:
  profiles:
    group:
      production:
        - classpath:secret/application-local.yml
        - prod
        - classpath:secret/application-prod-local.yml
      development:
        - classpath:secret/application-local.yml
        - dev
        - classpath:secret/application-dev-local.yml
      test:
        - classpath:secret/application-local.yml
        - test
        - classpath:secret/application-test-local.yml

~~~ 일반 공통 설정들(application.yml) ~~~

--- # prod
spring:
  config:
    activate:
      on-profile: prod
~~~ application-prod.yml 설정들 ~~~

--- # dev
spring:
  config:
    activate:
      on-profile: dev
~~~ application-dev.yml 설정들 ~~~

--- # test
spring:
  config:
    activate:
      on-profile: test
~~~ application-test.yml 설정들 ~~~

+ 여기에 secret 값들만 application-local.yml, application-prod-local.yml, application-dev-local.yml, application-test-local.yml로 서브모듈에서 관리해주면 됩니다.

변경 이유

현재 application.yml 구조는 제가 이전에 서버 배포를 하며 모두 비공개로 관리되던 yml을 공개 가능 파일/비밀 파일으로 제대로된 설계없이 분리해두어, 번잡해진 상태라 다시 제대로 구성이 필요하다고 생각했습니다.