[김현기] sprint8 #225

LZHTK · 2025-07-07T11:32:05Z

애플리케이션 컨테이너화

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를 구현하세요.
클래스 다이어그램

fxlj0hb8j-image.png

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분)

AWS 관련 정보는 형상관리하면 안되므로 .env 파일에 작성된 값을 임포트하는 방식으로 설정하세요.
Docker Compose에서도 위 설정을 주입할 수 있도록 수정하세요.
download 메소드는 PresignedUrl을 활용해 리다이렉트하는 방식으로 구현하세요.

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

AWS RDS 구성

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"

심화 요구사항

이미지 최적화하기

멀티 스테이지(빌드, 런타임) 빌드를 활용해 이미지의 크기를 줄여보세요.
- 태그명: local-slim
- 이전에 빌드한 이미지(1.2-M8 또는 local)와 크기를 비교해보세요.
이미지 레이어 캐시를 고려해 Dockerfile을 수정해보세요.
- GitHub Actions를 활용한 CI/CD 파이프라인 구축
CI(지속적 통합)를 위한 워크플로우를 설정하세요.
.github/workflows/test.yml 파일을 생성하세요.
main 브랜치에 PR이 생성되면 실행되도록 설정하세요.
테스트가 실행하는 Job을 정의하세요.
CodeCov를 통해 테스트 커버리지 뱃지를 README에 추가해보세요.

tb4cb7hos-image.png

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

.env 파일 (AWS 키는 제외)

# 데이터베이스 설정
POSTGRES_DB=discodeit
POSTGRES_USER=discodeit_user
POSTGRES_PASSWORD=discodeit1234

# 애플리케이션 데이터베이스 연결 설정
SPRING_PROFILES_ACTIVE=dev
DATABASE_URL=jdbc:postgresql://postgres:5432/discodeit
DATABASE_USERNAME=discodeit_user
DATABASE_PASSWORD=discodeit1234
SERVER_PORT=8080
HOST_PORT=8080


# 서버 설정
STORAGE_TYPE=local
STORAGE_LOCAL_ROOT_PATH=.discodeit/storage

# JVM 옵션 (빈 문자열 경고 해결)
JVM_OPTS=-Xms512m -Xmx1024m

# AWS
AWS_S3_ACCESS_KEY=...
AWS_S3_SECRET_KEY=...
AWS_S3_REGION=ap-northeast-2
AWS_S3_BUCKET=discodeit-binary-content-storage-khg
AWS_S3_PRESIGNED_URL_EXPIRATION=600
STORAGE_LOCAL_ROOT_PATH=.discodeit/storage