박종건 sprint8 #100
Open
박종건 sprint8 #100
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DDL 오류 수정 오타 수정 Base엔티티 패키지 이동 각 엔티티별 UUID 수동생성 -> GeneratedValue 로 변경 User 엔티티의 UserStatus 연관관계 옵션 추가 (orphenRemoval)
dev, prod 별로 이원화
- application.yaml 파일 분할 및 logback 설정 - actuator, validation 의존성 추가 - actuator info 항목 구현 완료
UUID 를 generate로 변경함에 따라, 기존 파일 저장로직 수정 (UUID Id필요). DB에 저장 후 파일 저장 하는 로직으로 변경
- 커스텀 exception 뼈대 생성 - GlobalExceptionHandler 에 유저 생성에 대한 오류처리 추가 및 ErrorMessage 생성 로직 추가 - 유저 생성시 입력값 오류 발생 처리
- 각 컨트롤러 전용 오류 추가 - 컨트롤러에서 필요한 경우 @Valid 수행 - 필요한 Dto 에 Valid 항목 추가 - GlobalException 세분화
- 서비스 관련 로그 및 커스텀 Exception 생성 및 처리
- 서비스 및 리파지토리 단위테스트 구현
- 컨트롤러 테스트 코드 구현
통합 테스트에는 2개만 테스트 함
AWS S3 테스트 가능한 클래스 생성 및 통합테스트 코드에서 테스트 구현하여 문제없음을 검증함. 도커 파일 및 compose 파일 작성 (로컬 기준) 환경설정 파일 이용하도록 수정
MDC clear 및 오류 수정
설정오류 수정
message service 테스트 코드 수정
github action 사용
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
요구사항
기본
애플리케이션 컨테이너화
Dockerfile 작성
Amazon Corretto 17 이미지를 베이스 이미지로 사용하세요.
작업 디렉토리를 설정하세요. (
/app)프로젝트 파일을 컨테이너로 복사하세요. 단, 불필요한 파일은
.dockerignore를 활용해 제외하세요.Gradle Wrapper를 사용하여 애플리케이션을 빌드하세요.
80 포트를 노출하도록 설정하세요.
프로젝트 정보를 환경 변수로 설정하세요.
실행할 jar 파일의 이름을 추론하는데 활용됩니다.
PROJECT_NAME: discodeit PROJECT_VERSION: 1.2-M8JVM 옵션을 환경 변수로 설정하세요.
JVM_OPTS: 기본값은 빈 문자열로 정의애플리케이션 실행 명령어를 설정하세요. 이때 환경변수로 정의한 프로젝트 정보를 활용하세요.
이미지 빌드 및 실행 테스트
prod프로필로 실행하세요.http://localhost:8081로 접속 가능하도록 포트를 매핑하세요.Docker Compose 구성
개발 환경용
docker-compose.yml파일을 작성합니다.애플리케이션과 PostgreSQL 서비스를 포함하세요.
각 서비스에 필요한 모든 환경 변수를 설정하세요.
.env파일을 활용하되,.env는 형상관리에서 제외하여 보안을 유지하세요.애플리케이션 서비스를 로컬
Dockerfile에서 빌드하도록 구성하세요.애플리케이션 볼륨을 구성하여 컨테이너가 재시작되어도 BinaryContentStorage 데이터가 유지되도록 하세요.
PostgreSQL 볼륨을 구성하여 컨테이너가 재시작되어도 데이터가 유지되도록 하세요.
PostgreSQL 서비스 실행 후
schema.sql이 자동으로 실행되도록 구성하세요.서비스 간 의존성을 설정하세요 (
depends_on).필요한 포트 매핑을 구성하세요.
Docker Compose를 사용하여 서비스를 시작하고 테스트하세요.
--build플래그를 사용하여 서비스 시작 전에 이미지를 빌드하도록 합니다.BinaryContentStorage 고도화 (AWS S3)
AWS S3 버킷 구성
discodeit-binary-content-storage-(사용자 이니셜)형식으로 지정하세요.AWS S3 접근을 위한 IAM 구성
S3 버킷에 접근하기 위한 IAM 사용자(
discodeit)를 생성하세요.AmazonS3FullAccess권한을 할당하고, 사용자 생성을 완료하세요.생성된 사용자에 엑세스 키를 생성하세요.
발급받은 키를 포함해서 AWS 관련 정보는
.env파일에 추가합니다.... # AWS AWS_S3_ACCESS_KEY=**엑세스_키** AWS_S3_SECRET_KEY=**시크릿_키** AWS_S3_REGION=**ap-northeast-2** AWS_S3_BUCKET=**버킷_이름**.env파일은 리뷰를 위해 PR에 별도로 첨부해주세요. 단, 엑세스 키와 시크릿 키는 제외하세요.AWS S3 테스트
AWS S3 SDK 의존성을 추가하세요.
implementation 'software.amazon.awssdk:s3:2.31.7'S3 API를 간단하게 테스트하세요.
com.sprint.mission.discodeit.stoarge.s3AWSS3TestProperties클래스를 활용해서.env에 정의한 AWS 정보를 로드하세요.AWS S3를 활용한
BinaryContentStroage고도화앞서 작성한 테스트 메소드를 참고해
S3BinaryContentStorage를 구현하세요.클래스 다이어그램
discodeit.storage.type값이s3인 경우에만 Bean으로 등록되어야 합니다.S3BinaryContentStorageTest를 함께 작성하면서 구현하세요.BinaryContentStorage설정을 유연하게 제어할 수 있도록application.yaml을 수정하세요.discodeit: storage: type: local type: ${STORAGE_TYPE:local} # local | s3 (기본값: local) local: root-path: .discodeit/storage root-path: ${STORAGE_LOCAL_ROOT_PATH:.discodeit/storage} s3: access-key: ${AWS_S3_ACCESS_KEY} secret-key: ${AWS_S3_SECRET_KEY} region: ${AWS_S3_REGION} bucket: ${AWS_S3_BUCKET} presigned-url-expiration: ${AWS_S3_PRESIGNED_URL_EXPIRATION:600} # (기본값: 10분).env파일에 작성된 값을 임포트하는 방식으로 설정하세요.download메소드는PresignedUrl을 활용해 리다이렉트하는 방식으로 구현하세요.AWS를 활용한 배포 (AWS RDS, ECR, ECS)
AWS RDS 구성
AWS RDS PostgreSQL 인스턴스를 생성하세요.
과금이 발생할 수 있으니 다음 항목은 한번 더 확인해주세요.
프리티어아니오7일모두 체크 해제비활성화SSH 터널링을 통해 개발 환경에서 접근할 수 있도록 EC2를 구성하세요.
EC2 인스턴스를 생성하세요.
보안 그룹에서 인바운드 규칙을 편집하세요.
SSH내 IPDataGrip을 통해 연결 후 데이터베이스와 사용자, 테이블을 초기화하세요.
데이터 소스 추가 시
SSH/SSL > Use SSH tunnel설정을 활성화하세요. 이때 이전에 다운로드한.pem파일을 활용하세요.연결이 성공하면 데이터베이스와 사용자, 테이블을 초기화하세요.
-- 1. 새 유저 'discodeit_user' 생성 (비밀번호는 원하는 값으로 설정) CREATE USER discodeit_user WITH PASSWORD 'discodeit1234'; -- 2. postgres 계정은 AWS RDS 환경 특성상 완전한 super user가 아니므로, discodeit_user에 대한 권한을 추가로 부여해야함. GRANT discodeit_user TO postgres; -- 3. 'discodeit' 데이터베이스 생성 (소유자는 'discodeit_user') CREATE DATABASE discodeit OWNER discodeit_user; -- 4. schema.sql 실행하여 테이블 생성구성이 완료되면
rds-ssh인스턴스는 완전히 삭제하여 과금에 유의하세요.AWS ECR 구성
이미지를 배포할 퍼블릭 레포지토리(
discodeit)를 생성하세요.AWS CLI를 설치하세요.
aws configure실행 후 앞서 생성한discodeitIAM 사용자 정보를 입력하세요.ap-northeast-2jsondiscodeitIAM 사용자가 ECR에 접근할 수 있도록 다음 권한을 부여하세요.AmazonElasticContainerRegistryPublicFullAccessDocker 클라이언트를 배포할 레지스트리에 대해 인증합니다.
AWS 콘솔을 통해 생성한 레포지토리 페이지로 이동 후 우측 상단
푸시 명령 보기를 클릭하면 관련 명령어를 확인할 수 있습니다.# 예시 aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws/...멀티플랫폼을 지원하도록 애플리케이션 이미지를 빌드하고,
discodeit레포지토리에 push 하세요.latest,1.2-M8linux/amd64,linux/arm64AWS 콘솔에서 푸시된 이미지를 확인하세요.
AWS ECS 구성
배포 환경에서 컨테이너 실행 간 사용할 환경 변수를 정의하고, S3에 업로드하세요.
discodeit.env파일을 만들어 다음의 내용을 작성하세요.# Spring Configuration SPRING_PROFILES_ACTIVE=prod # Application Configuration STORAGE_TYPE=s3 AWS_S3_ACCESS_KEY=엑세스_키 AWS_S3_SECRET_KEY=시크릿_키 AWS_S3_REGION=ap-northeast-2 AWS_S3_BUCKET=버킷_이름 AWS_S3_PRESIGNED_URL_EXPIRATION=600 # DataSource Configuration RDS_ENDPOINT=RDS_엔드포인트(포트 포함) SPRING_DATASOURCE_URL=jdbc:postgresql://${RDS_ENDPOINT}/discodeit SPRING_DATASOURCE_USERNAME=RDS_유저네임(DataGrip을 통해 생성했던 유저) SPRING_DATASOURCE_PASSWORD=RDS_비밀번호 # JVM Configuration (프리티어 고려) JVM_OPTS="-Xmx384m -Xms256m -XX:MaxMetaspaceSize=64m -XX:+UseSerialGC"이 파일을 S3에 업로드하세요.
이 파일은 형상관리되지 않도록 주의하세요.
AWS ECS 콘솔에서 클러스터를 생성하세요.
태스크를 정의하세요.
태스크 실행 역할에 S3 관련 권한을 추가하세요.discodeit클러스터 상세 화면에서 서비스를 생성하세요.태스크의 EC2 보안 그룹의 인바운드 규칙을 설정하여 어디서든 접근할 수 있도록 하세요.
HTTP를 선택하세요.Anywhere-IPv4를 선택하여 모든 IP를 허용하세요.태스크 실행이 완료되면 해당 EC2의 퍼블릭 IP에 접속해보세요.
심화
이미지 최적화하기
빌드,런타임) 빌드를 활용해 이미지의 크기를 줄여보세요.local-slim1.2-M8또는local)와 크기를 비교해보세요.GitHub Actions를 활용한 CI/CD 파이프라인 구축
CI(지속적 통합)를 위한 워크플로우를 설정하세요.
.github/workflows/test.yml파일을 생성하세요.main브랜치에 PR이 생성되면 실행되도록 설정하세요.테스트가 실행하는 Job을 정의하세요.
CodeCov를 통해 테스트 커버리지 뱃지를 README에 추가해보세요.
CD(지속적 배포)를 위한 워크플로우를 설정하세요.
.github/workflows/deploy.yml파일을 생성하세요.release브랜치에 코드가 푸시되면 실행되도록 설정하세요.AWS_ACCESS_KEY: IAM 사용자의 액세스 키AWS_SECRET_KEY: IAM 사용자의 시크릿 키AWS_REGION: AWS 리전(ap-northeast-2)ECR_REPOSITORY_URI: ECR 레포지토리 URIECS_CLUSTER: ECS 클러스터 이름(discodeit-cluster)ECS_SERVICE: ECS 서비스 이름(discodeit-service)ECS_TASK_DEFINITION: ECS 태스크 정의 이름(discodeit-task)us-east-1으로 설정해야합니다.x86_64입니다.latest와 GitHub 커밋 해시를 사용하도록 설정하세요.ECS 서비스를 업데이트하는 Job을 정의하세요.
AWS CLI를 설정하는 Step을 추가하세요.
AWS_REGION으로 설정해야합니다.태스크 정의를 업데이트하는 Step을 추가하세요.
프리티어 리소스를 고려해 AWS CLI를 사용해 기존에 구동 중인 서비스를 중단하는 Step을 추가하세요.
aws ecs update-service --desired-count옵션을 활용하세요.새로 등록한 태스크 정의를 사용하도록 ECS 서비스를 업데이트하는 Step을 추가하세요.
주요 변경사항
스크린샷
discodeit.env.txt 확장자 문제로 업로드가 안되어 txt변경했습니다.
멘토에게