README.md

Infra Structure

서버 환경

• 💻Test : develop 브런치가 반영되는 서버이다. api, admin, batch, chat 서버가 도커로 빌드되어 있다.
• 💻Production : production 브런치가 반영되는 서버이다. api, batch, chat 서버가 도커로 빌드되어 있다.
• 💻Admin : production 브런치가 반영되는 서버이다. admin 서버가 도커로 빌드되어 있다.
• 💻Jenkins : 테스트 및 프로덕션 서버를 배포하기 위한 빌드 서버이다. 프로젝트 레벨 환경 변수 추가 및 수정 시 해당 서버에 위치한 resource 파일을 수정해야 한다.

Project

Language & Framework

• Java 11
• Spring Boot 2.7.1
• JPA

Project Structure

 📂
 ┣ 📂app
 ┃ ┣ 📂admin
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂docs
 ┃ ┃ ┃ ┃ ┗ 📂asciidoc
 ┃ ┃ ┃ ┃ ┃ ┗ 📜api-doc.adoc
 ┃ ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┃ ┣ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂resources
 ┃ ┃ ┃ ┃ ┃ ┗ 📜application.yml
 ┃ ┃ ┃ ┗ 📂test
 ┃ ┃ ┣ 📜Dockerfile
 ┃ ┃ ┣ 📜Dockerfile_dev
 ┃ ┃ ┗ 📜build.gradle
 ┃ ┣ 📂api
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂docs
 ┃ ┃ ┃ ┃ ┗ 📂asciidoc
 ┃ ┃ ┃ ┃ ┃ ┗ 📜api-doc.adoc
 ┃ ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┃ ┣ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂resources
 ┃ ┃ ┃ ┗ 📂test
 ┃ ┃ ┣ 📜Dockerfile
 ┃ ┃ ┣ 📜Dockerfile_dev
 ┃ ┃ ┗ 📜build.gradle
 ┃ ┣ 📂batch
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┃ ┣ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂resources
 ┃ ┃ ┃ ┃ ┃ ┗ 📜application.yml
 ┃ ┃ ┃ ┗ 📂test
 ┃ ┃ ┣ 📜Dockerfile
 ┃ ┃ ┣ 📜Dockerfile_dev
 ┃ ┃ ┗ 📜build.gradle
 ┃ ┣ 📂chat
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┗ 📂main
 ┃ ┃ ┃ ┃ ┣ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂resources
 ┃ ┃ ┃ ┃ ┃ ┗ 📜application.yml
 ┃ ┃ ┣ 📜Dockerfile
 ┃ ┃ ┣ 📜Dockerfile_dev
 ┃ ┃ ┗ 📜build.gradle
 ┃ ┣ 📂core
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┗ 📂main
 ┃ ┃ ┃ ┃ ┣ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂resources
 ┃ ┃ ┗ 📜build.gradle
 ┣ 📂domain
 ┃ ┣ 📂src
 ┃ ┃ ┗ 📂main
 ┃ ┃ ┃ ┗ 📂java
 ┃ ┗ 📜build.gradle
 ┣ 📜.gitignore
 ┣ 📜README.md
 ┣ 📜build.gradle
 ┗ 📜settings.gradle

• 📂domain : 프로젝트 전반에 사용되는 Entity 와 Repository 가 포함된다.
• 📂app : 프로젝트의 모든 api 와 관련된 코드가 포함된다. app 모듈은 다음 5개의 sub module을 포함한다.
  • 📂api : 수정광산 애플리케이션의 RESTFul api endpoint 정의 및 관련 로직이 포함된다.
    • 📜api-doc.adoc : api 모듈과 관련된 api 문서를 작성하는 파일이다.
    • 📜build.gradle : api 모듈에 필요한 라이브러리를 선언하고 빌드와 관련된 세팅을 하는 파일이다.
    • 📜application.yml : api 모듈의 비즈니스 로직과 관련된 환경변수를 세팅하는 파일이다.
    • 📜Dockerfile : 배포 환경에서 api 모듈을 도커로 빌드할 때 사용되는 파일이다.
    • 📜Dockerfile_dev : 테스트 환경에서 api 모듈을 도커로 빌드할 때 사용되는 파일이다.
  • 📂admin : 수정광산 관리자를 위한 RESTFul api endpoint 정의 및 관련 로직이 포함된다.
    • 📜api-doc.adoc : admin 모듈과 관련된 api 문서를 작성하는 파일이다.
    • 📜build.gradle : admin 모듈에 필요한 라이브러리를 선언하고 빌드와 관련된 세팅을 하는 파일이다.
    • 📜application.yml : admin 모듈의 비즈니스 로직과 관련된 환경변수를 세팅하는 파일이다.
    • 📜Dockerfile : 배포 환경에서 admin 모듈을 도커로 빌드할 때 사용되는 파일이다.
    • 📜Dockerfile_dev : 테스트 환경에서 admin 모듈을 도커로 빌드할 때 사용되는 파일이다.
  • 📂chat : 수정광산 애플리케이션의 채팅 기능에 대한 api endpoint 정의 및 관련 로직이 포함된다. 를 작성하는 파일이다.
    • 📜build.gradle : chat 모듈과 관련된 라이브러리를 선언하고 빌드와 관련된 세팅을 하는 파일이다.
    • 📜application.yml : chat 모듈의 비즈니스 로직과 관련된 환경변수를 세팅하는 파일이다.
    • 📜Dockerfile : 배포 환경에서 admin 모듈을 도커로 빌드할 때 사용되는 파일이다.
    • 📜Dockerfile_dev : 테스트 환경에서 admin 모듈을 도커로 빌드할 때 사용되는 파일이다.
  • 📂batch : 서버가 주기적으로 자동화되어 실행하는 기능과 관련된 로직이 포함된다.
    • 📜build.gradle : batch 모듈에 필요한 라이브러리를 선언하고 세팅을 정의하는 파일이다.
    • 📜application.yml : batch 모듈의 비즈니스 로직과 관련된 환경변수를 세팅하는 파일이다.
    • 📜Dockerfile : 배포 환경에서 batch 모듈을 도커로 빌드할 때 사용되는 파일이다.
    • 📜Dockerfile_dev : 테스트 환경에서 batch 모듈을 도커로 빌드할 때 사용되는 파일이다.
  • 📂core : 여러 모듈에서 공통으로 활용하는 기능과 관련된 로직이 포함된다.
    • 📜build.gradle : core 모듈에 필요한 라이브러리를 선언하고 빌드와 관련된 세팅을 하는 파일이다.
  • 📜build.gradle : 전체 프로젝트에 적용되는 스프링 부트 버전을 설정하고 sub module 을 설정하는 파일이다.
  • 📜settings.gradle : sub module 을 선언하기 위한 파일이다.
  • 📜.gitignore : git 에 올라가지 않아야 할 파일을 정의하는 파일이다.

Deploy Rule

Check List Before a Git Push

1. api 엔드포인트 및 서비스 로직에 대한 테스트 코드를 가급적 작성한다.
2. 발행한 api 에 대한 명세를 📂수정한 모듈/src/docs/asciidoc/api-doc.adoc 에 추가한다.
3. 수정한 모듈의 테스트 코드를 전체 실행한다. 오류가 난다면 수정한다.

How to Deploy on Test Environment

1. DB 관련 수정 사항은 테스트 환경 DB에 반영한다.
2. application.yml 관련 수정 사항은 jenkins 서버 📂/var/lib/jenkins/workspace/resources/test/application.yml 을 수정한다.
3. jenkins 에서 모듈명-develop 워크스페이스를 수동 빌드한다.

How to Deploy on Prod Environment

1. DB 관련 수정 사항을 프로덕션 환경 DB에 반영한다.
2. develop 브런치를 production 브런치로 병합한다.
3. application.yml 관련 수정 사항은 jenkins 서버 📂/var/lib/jenkins/workspace/resources/application.yml 을 수정한다.
4. jenkins 에서 모듈명-production 아이템을 수동 빌드한다.