[강문구] sprint8 #227

Kangmoongu · 2025-07-08T05:40:49Z

요구사항

애플리케이션 컨테이너화

Dockerfile 작성

Amazon Corretto 17 이미지를 베이스 이미지로 사용하세요.
작업 디렉토리를 설정하세요. (/app)
프로젝트 파일을 컨테이너로 복사하세요. 단, 불필요한 파일은 .dockerignore를 활용해 제외하세요.
Gradle Wrapper를 사용하여 애플리케이션을 빌드하세요.
80 포트를 노출하도록 설정하세요.
프로젝트 정보를 환경 변수로 설정하세요.
- 실행할 jar 파일의 이름을 추론하는데 활용됩니다.
- PROJECT_NAME: discodeit
- PROJECT_VERSION: 1.2-M8
JVM 옵션을 환경 변수로 설정하세요.
- JVM_OPTS: 기본값은 빈 문자열로 정의
애플리케이션 실행 명령어를 설정하세요. 이때 환경변수로 정의한 프로젝트 정보를 활용하세요.

이미지 빌드 및 실행 테스트

Docker 이미지를 빌드하고 태그(local)를 지정하세요.
빌드된 이미지를 활용해서 컨테이너를 실행하고 애플리케이션을 테스트하세요.
- prod 프로필로 실행하세요.
- 데이터베이스는 로컬 환경에서 구동 중인 PostgreSQL 서버를 활용하세요.
- 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 버킷 구성

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.s3
- 클래스명: AWSS3Test
- Properties 클래스를 활용해서 .env에 정의한 AWS 정보를 로드하세요.
- 작업 별 테스트 메소드를 작성하세요.
  - 업로드
  - 다운로드
  - PresignedUrl 생성

AWS S3를 활용한 BinaryContentStroage 고도화

앞서 작성한 테스트 메소드를 참고해 S3BinaryContentStorage를 구현하세요.
- 클래스 다이어그램
discodeit.storage.type 값이 s3인 경우에만 Bean으로 등록되어야 합니다.
S3BinaryContentStorageTest를 함께 작성하면서 구현하세요.

BinaryContentStorage 설정을 유연하게 제어할 수 있도록 application.yaml을 수정하세요.

-  type: local
-  root-path: .discodeit/storage
+  type: ${STORAGE_TYPE:local}  # local | s3 (기본값: local)
+  local:
+    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분)

AWS 관련 정보는 형상관리하면 안되므로 .env 파일에 작성된 값을 임포트하는 방식으로 설정하세요.
Docker Compose에서도 위 설정을 주입할 수 있도록 수정하세요.

download 메소드는 PresignedUrl을 활용해 리다이렉트하는 방식으로 구현하세요.

AWS를 활용한 배포 (AWS RDS, ECR, ECS)

AWS RDS 구성

AWS RDS PostgreSQL 인스턴스를 생성하세요.

항목	값	비고
데이터베이스 생성 방식	표준 생성
엔진 옵션 > 엔진 유형	PostgreSQL
엔진 옵션 > 엔진 버전	17.2-R2	기본값
템플릿	프리 티어	과금 주의
설정 > DB 인스턴스 식별자	discodeit-db
설정 > 자격증명설정 > 사용자 이름	postgres	기본값
설정 > 자격증명설정 > 자격 관리	자체 관리	기본값
설정 > 자격증명설정 > 마스터 암호	임의의 값	따로 메모해두세요
인스턴스 구성 > 인스턴스 클래스	db.t4g.micro	기본값
연결 > 퍼블릭 액세스	아니오	과금 주의
연결 > 추가구성 > 포트	5432	기본값
모니터링 > 보존기간	7일 (프리티어)	과금 주의
모니터링 > 추가 모니터링 설정	모두 체크 해제	기본값, 과금 주의
추가 구성 > 백업	체크 해제	과금 주의

이외 설정은 기본값을 유지하세요.
과금이 발생할 수 있으니 다음 항목은 한번 더 확인해주세요.
- 템플릿: 프리티어
- 퍼블릭 액세스: 아니오
- 모니터링 > 보존기간: 7일
- 모니터링 > 추가 모니터링 설정: 모두 체크 해제
- 추가 구성 > 백업: 비활성화
- SSH 터널링을 통해 개발 환경에서 접근할 수 있도록 EC2를 구성하세요.
  - EC2 인스턴스를 생성하세요.

항목	값	비고
이름 및 태그	rds-ssh
인스턴스 유형	t2.micro	기본값, 과금 주의
키 페어	새 키 페어 생성	.pem 파일 저장 위치를 기억하세요
네트워크 설정 > 방화벽(보안그룹)	기존 보안 그룹 선택

   * 이외 설정은 기본값을 유지하세요.

보안 그룹에서 인바운드 규칙을 편집하세요.
- 유형: SSH
- 소스: 내 IP
  - 작업 환경의 네트워크(와이파이 등)가 달라지면 계속 수정해주어야 할 수 있습니다.
- DataGrip을 통해 연결 후 데이터베이스와 사용자, 테이블을 초기화하세요.
  - 데이터 소스 추가 시 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 실행 후 앞서 생성한 discodeit IAM 사용자 정보를 입력하세요.
- 엑세스 키
- 시크릿 키
- region: ap-northeast-2
- output format: json
discodeit IAM 사용자가 ECR에 접근할 수 있도록 다음 권한을 부여하세요.
- AmazonElasticContainerRegistryPublicFullAccess
- Docker 클라이언트를 배포할 레지스트리에 대해 인증합니다.
  - 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-M8
- 멀티플랫폼: linux/amd64,linux/arm64
AWS 콘솔에서 푸시된 이미지를 확인하세요.

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 콘솔에서 클러스터를 생성하세요.

항목	값	비고
클러스터 구성 > 클러스터 이름	discodeit-cluster
인프라 > AWS Fargate(서버리스)	체크해제	과금 주의
인프라 > Amazon EC2 인스턴스	체크
인프라 > EC2 인스턴스 유형	t2.micro	과금 주의
인프라 > 원하는 용량	최소 0, 최대 1	과금 주의
인프라 > SSH 키 페어	새 키 페어 생성 후 지정

이외 설정은 기본값을 유지하세요.
태스크를 정의하세요.

항목	값	비고
태스크 정의 구성 > 태스크 정의 패밀리	discodeit-task
인프라 요구 사항 > 시작 유형	AWS Fargate: 체크 해제, Amazon EC2 인스턴스: 체크
인프라 요구 사항 > 네트워크 모드	bridge
인프라 요구 사항 > 태스크 크기	CPU: 0.25 vCPU, 메모리: 0.5 GB
컨테이너-1 > 컨테이너 세부 정보	이름: discodeit-app, 이미지 URI: 이전에 배포한 이미지
컨테이너-1 > 포트 매핑	호스트 포트: 80, 컨테이너 포트: 80
컨테이너-1 > 리소스 할당 제한 - 조건부	CPU: 0.25 vCPU, 메모리 하드 제한: 0.5 GB, 소프트: 0.25 GB
컨테이너-1 > 환경 변수 - 선택 사항 > 파일에서 추가	이전에 S3에 업로드한 discodeit.env 파일 지정

이외 설정은 기본값을 유지하세요.
태스크 생성 후 태스크 실행 역할에 S3 관련 권한을 추가하세요.
- 환경 변수 파일을 읽기위해 필요합니다.
discodeit 클러스터 상세 화면에서 서비스를 생성하세요.

항목	값	비고
배포 구성 > 태스크 정의 패밀리	discodeit-task
배포 구성 > 서비스 이름	discodeit-service
배포 구성 > 원하는 태스크	1	기본값
배포 구성 > 상태 검사 유예 기간	30초

이외 설정은 기본값을 유지하세요.
태스크의 EC2 보안 그룹의 인바운드 규칙을 설정하여 어디서든 접근할 수 있도록 하세요.
- EC2 보안 그룹에서 인바운드 규칙을 편집하세요.
- 규칙 유형으로 HTTP를 선택하세요.
- 소스로 Anywhere-IPv4를 선택하여 모든 IP를 허용하세요.
태스크 실행이 완료되면 해당 EC2의 퍼블릭 IP에 접속해보세요.

심화 요구사항

이미지 최적화하기

멀티 스테이지(빌드, 런타임) 빌드를 활용해 이미지의 크기를 줄여보세요.
- 태그명: local-slim
- 이전에 빌드한 이미지(1.2-M8 또는 local)와 크기를 비교해보세요.
이미지 레이어 캐시를 고려해 Dockerfile을 수정해보세요.

GitHub Actions를 활용한 CI/CD 파이프라인 구축

리뷰를 위해 PR에 포함해야할 정보

.env 파일 (AWS 키는 제외)

# ===========================================
# PostgreSQL Database Configuration
# ===========================================
POSTGRES_DB=discodeit
POSTGRES_USER=discodeit_user
POSTGRES_PASSWORD=discodeit1234
POSTGRES_PORT=5432

# ===========================================
# Spring Boot Application Configuration
# ===========================================
SPRING_PROFILES_ACTIVE=dev
SERVER_PORT=8080
APP_PORT=8081

# ===========================================
# Logging Configuration
# ===========================================
LOG_LEVEL=INFO

# ===========================================
# JVM Configuration
# ===========================================
JVM_OPTS=-Xmx1g -Xms512m -XX:+UseContainerSupport -XX:MaxRAMPercentage=70.0

# ===========================================
# AWS
# ===========================================
AWS_S3_REGION=ap-northeast-2
AWS_S3_BUCKET=discodeit-binary-content-storage-kmg
AWS_S3_PRESIGNED_URL_EXPIRATION=600

# ===========================================
# Storage Configuration
# ===========================================
STORAGE_TYPE=s3
STORAGE_LOCAL_ROOT_PATH=./discodeit/storage

RDS
- AWS 콘솔 인스턴스 상세 페이지 스크린샷 이미지
- SSH 터널링을 통해 연결한 DataGrip 스크린샷 이미지
  - 생성한 테이블 목록이 보이도록 캡처해주세요.
ECR
- 푸시된 이미지가 보이는 AWS 콘솔 페이지 스크린샷 이미지
ECS
- 실행 중인 태스크 구성정보가 표시된 AWS 콘솔 페이지 스크린샷 이미지
- 배포된 EC2 엔드포인트
- 3.35.218.40
VPC
- 보안 그룹의 인바운드 규칙을 확인할 수 있는 AWS 콘솔 페이지 스크린샷 이미지
IAM
- 사용자의 권한 정책이 표시된 AWS 콘솔 페이지 스크린샷 이미지

멘토에게

셀프 코드 리뷰를 통해 질문 이어가겠습니다.

Kangmoongu added 20 commits June 18, 2025 16:28

fix: sprint-7 BaseCode 반영

a27a6c7

feat: logging 구현

d4f77f9

feat: 커스텀 예외처리 구현 및 Schema.sql 수정

ddef170

feat: Validation 구현

89da012

feat: Validation 의존성 추가

f142dbc

feat: 기본 Actuator 엔트포인트 설정 및 Actuator info를 위한 애플리케이션 정보를 추가

f3aabd5

feat: Service 레이어 단위 테스트 구현 및 userService 버그 수정

0d49b95

feat: Controller, Service, Repository 단위 테스트 구현

4e9ef03

feat: 통합테스트 구현

4b1392a

feat: 심화요구사항 MDC를 통한 로깅 고도화 구현

ef6c64d

feat: SpringBoot Admin 의존성을 추가하여 Admin 관리와 대시보드 구현

e428ef3

feat: Service Test 패키지에 대해서 60% 이상의 코드 커버리지를 달성

242ae72

feat: Sprint8 BaseCode 반영

9424642

feat: Sprint8 Basecode 반영

5358c92

feat: Dockerfile 작성

1e0c303

feat: docker-compose.yml 작성 및 docker 실행

deae7a3

feat: BinaryContentStorage 고도화 (AWS S3) 구현

f26cff8

feat: 배포 환경에서 컨테이너 실행 간 사용할 환경 변수정의 및 .gitignore추가

f48a257

fix: AWS S3 초기화 로직 오류수정

37ad85e

feat: 심화 요구사항 구현(이미지 최적화, GitHub Actions를 활용한 CI/CD 파이프라인 구축)

03f7444

Kangmoongu added the 매운맛🔥 뒤는 없습니다. 그냥 필터 없이 말해주세요. 책임은 제가 집니다. label Jul 8, 2025

Kangmoongu changed the base branch from main to 강문구 July 8, 2025 06:35

Kangmoongu requested a review from dongjoon1251 July 8, 2025 07:21

Kangmoongu added 7 commits July 8, 2025 16:28

fix: test.yml 수정

04b76d5

fix: deploy.yml 공백수정

7a1faa2

fix: 버그수정

346d5f7

fix: deploy.yml 오류 수정

9ff2c70

fix: deploy.yml 오류 수정

604993d

fix: deploy.yml 오류 수정

318f355

fix: findByUserId_ExistingUserId_ReturnsUserStatus() 수정

aec4ea6

Kangmoongu added 3 commits July 8, 2025 18:38

fix: test.yml에서 AWSS3Test는 사용하지 않는것으로 설정

d6c2ed3

fix: 단위테스트만 테스트 수행하도록 변경

eed3a68

fix: 통합테스트와 S3테스트는 제외

4dbc64b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[강문구] sprint8 #227

[강문구] sprint8 #227

Uh oh!

Kangmoongu commented Jul 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

[강문구] sprint8 #227

Are you sure you want to change the base?

[강문구] sprint8 #227

Uh oh!

Conversation

Kangmoongu commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

요구사항

애플리케이션 컨테이너화

Dockerfile 작성

이미지 빌드 및 실행 테스트

Docker Compose 구성

BinaryContentStorage 고도화 (AWS S3)

AWS S3 버킷 구성

AWS S3 접근을 위한 IAM 구성

AWS S3 테스트

AWS S3를 활용한 BinaryContentStroage 고도화

AWS를 활용한 배포 (AWS RDS, ECR, ECS)

AWS RDS 구성

AWS ECR 구성

AWS ECS 구성

심화 요구사항

이미지 최적화하기

GitHub Actions를 활용한 CI/CD 파이프라인 구축

리뷰를 위해 PR에 포함해야할 정보

멘토에게

Uh oh!

Uh oh!

Kangmoongu commented Jul 8, 2025 •

edited

Loading