¶ 공통
- BSN 프로젝트 개발을 위한 공통 개발환경 설정 진행 필요
¶ 1. 로컬에서 ingress 사용을 위한 hosts 파일 수정
리눅스: /etc/hosts
윈도우: C:\Windows\System32\drivers\etc\hosts
(관리자 권한으로 수정 필요)
hosts 파일 하단에 개발을 진행하는 프로젝트의 테스트 도메인 아래 내용 추가
127.0.0.1 bellsafehouse.test
¶ 2. 로컬 개발환경 설정
¶ 윈도우 환경에 프로젝트 클론
¶ 도구 - 배포
자동 업로드 활성화
로컬 또는 마운트된 폴더 추가
¶ 도구 - 배포 - 옵션...
로컬 파일이 삭제되었을 시 원격 파일 삭제 체크 (비활성화 시 로컬 파일 삭제 후 WSL 환경에서 직접 제거해야 함)
¶ ktlint 구성을 IntelliJ 에 적용
gradle ktlintApplyToIdea 실행
¶ 프로젝트 클론 후 최초 1회
-
./scripts/init-local-environment.sh
최초 1회 실행을 완료하고나면 로컬 환경을 제거하거나 추후 로컬 개발환경 배포 구조에 변경이 있지 않는 한 실행할 필요가 없음 -
./scripts/deploy-db-local.sh
마찬가지로 최초 1회 실행 완료 시 로컬 환경을 제거하거나 추후 DB 관련 변경이 있지 않는 한 실행할 필요가 없음
¶ 로컬 DB 접속 정보
TYPE: MySQL 8.0.30
IP: 127.0.0.1
PORT: 30306
ACCOUNT (관리자): root/root
ACCOUNT (앱): bellsafehouse/bellsafehouse
SCHEMA: bellsafehouse
¶ 로컬 배포 중단
./scripts/pause-local-environment.sh
로컬 환경 구성 시 도커를 종료하지 않는 이상 K8s에 의해 상태 유지를 하려고 하기 때문에 컨테이너를 종료해도 자동으로 재시작 됨
따라서 도커를 종료하지 않고 로컬 개발환경을 일시 중단하려면 위 스크립트 실행
¶ 로컬 배포 재개
./scripts/resume-local.environment.sh
위 배포 중단 스크립트 수행 시 모든 배포의 replicas 가 0으로 설정되므로 이 스크립트를 이용하여 다시 1로 변경함
¶ (필요 시) 로컬 환경 제거
로컬 환경 제거는 실수의 위험성이 있으므로 애플리케이션 환경 제거와 데이터 영구 삭제의 스크립트를 분리하였음
따라서 아에 프로젝트를 제거하려면 두개의 스크립트를 실행해야 함
./scripts/remove-local-environment.sh
위 스크립트 실행 시 모든 로컬 배포 환경을 제거함
(주의) 프로젝트 단위로 백엔드와 프론트엔드가 하나의 네임스페이스에 묶여있으므로 이 작업 수행 시 해당 프로젝트의 로컬 환경이 전부 제거됨
로컬 환경을 다시 구성하려면./scripts/init-local-environment.sh스크립트 부터 재실행 필요
¶ 제거 시 수행되는 항목
- k8s 네임스페이스 제거 (네임스페이스 내 모든 리소스가 제거됨)
- 로컬에 저장된 k8s 배포 리소스 yaml 파일 제거
¶ 제거되지 않는 항목
- DB 데이터 디렉토리용 PV
./scripts/remove-local-data.sh
위 스크립트 실행 시 로컬 PV (영구볼륨) 를 제거함
¶ 제거 시 수행되는 항목
- DB 데이터 디렉토리용 영구볼륨 제거
¶ Bell Safe House API (백엔드)
¶ 1. 프로젝트 clone
- 윈도우 WSL2 기반 IntelliJ 설정
위 문서를 참고하여 클론 수행
¶ 2. 로컬 개발환경 설정
- 공통 개발환경 설정 수행
- IntelliJ 기본 설정 수행
.gradle-cache디렉토리 우클릭 후디렉터리를 다음으로 표시->제외됨설정
¶ 실시간 로컬 백엔드 개발 환경 배포
./scripts/deploy-api-local.sh
프로젝트 루트 디렉토리를 마운트하여 배포하여 변경사항이 즉시 반영됨
¶ (필요 시) 최신 프론트엔드 환경 배포
./scripts/deploy-view-latest.sh
프론트엔드 프로젝트의 main 브랜치에 최신 이미지를 이용하여 로컬에 배포함
로컬에서 프론트엔드를 동시에 개발하고 싶을 경우, 이 배포를 이용하지 말고 프론트엔드 프로젝트 내에 포함된 로컬 개발환경 배포(./scripts/deploy-view-local.sh)를 실행하면 됨
¶ 로컬에 배포된 프론트엔드 환경을 최신으로 업데이트 하고 싶을 때
해당 k8s 리소스가 재시작되면 자동으로 최신 이미지를 pull 받아 실행함
즉시 업데이트가 필요한 상황일 경우 ./scripts/redeploy-view-latest.sh 스크립트 실행
¶ 3. (필요 시) kubernetes 리소스 정상 배포 확인
¶ ingress 리소스 정상 배포 확인
kubectl -n bell-safe-house-local get ingress
실행 결과 아래와 같이 CLASS 가 <NONE> 이 아닌, nginx 로 할당된 것으로 나오면 정상 상태
C:\Users\bell0>kubectl get -n bell-safe-house-local ingress
NAME CLASS HOSTS ADDRESS PORTS AGE
bell-safe-house-local nginx bellsafehouse.test 80 3s
¶ 주의사항
만약 hosts가 설정되지 않았다면 ingress 리소스가 정상적으로 등록되어도 등록된 host 로 접속할 수 없음
¶ deployment 정상 배포 확인
kubectl -n bell-safe-house-local get deploy -lapp=bell-safe-house-api-local -lenv=local
위 명령어 수행 후 READY 항목이 1/1 로 떠있으면 정상적으로 사용 가능한 상태
¶ Bell Safe House View (프론트엔드)
¶ 1. 프로젝트 clone
- 윈도우 WSL2 기반 WebStorm 설정
위 문서를 참고하여 프로젝트 클론 수행
¶ 2. 로컬 개발환경 설정
- 공통 개발환경 설정 수행
- WebStorm 기본 설정 수행
¶ 실시간 로컬 프론트엔드 개발 환경 배포
./scripts/deploy-view-local.sh
프로젝트 루트 디렉토리를 마운트하여 배포하여 변경사항이 즉시 반영됨
¶ (필요 시) 최신 백엔드 환경 배포
./scripts/deploy-api-latest.sh
백엔드 프로젝트의 main 브랜치에 최신 이미지를 이용하여 로컬에 배포함
로컬에서 백엔드를 동시에 개발하고 싶을 경우, 이 배포를 이용하지 말고 백엔드 프로젝트 내에 포함된 로컬 개발환경 배포(./scripts/deploy-api-local.sh)를 실행하면 됨
¶ 로컬에 배포된 백엔드 환경을 최신으로 업데이트 하고 싶을 때
해당 k8s 리소스가 재시작되면 자동으로 최신 이미지를 pull 받아 실행함
즉시 업데이트가 필요한 상황일 경우 ./scripts/redeploy-api-latest.sh 스크립트 실행