Skip to content

Conversation

devlee1011
Copy link
Collaborator

@devlee1011 devlee1011 commented Sep 1, 2025

기본 요구사항

애플리케이션 컨테이너화

Dockerfile 작성

  • Amazon Corretto 17 이미지를 베이스 이미지로 사용하세요.
  • 작업 디렉토리를 설정하세요. (/app)
  • 프로젝트 파일을 컨테이너로 복사하세요. 단, 불필요한 파일은 .dockerignore를 활용해 제외하세요.
  • Gradle Wrapper를 사용하여 애플리케이션을 빌드하세요.
  • 80 포트를 노출하도록 설정하세요.
  • 프로젝트 정보를 환경 변수로 설정하세요.
  • JVM 옵션을 환경 변수로 설정하세요.
  • 애플리케이션 실행 명령어를 설정하세요. 이때 환경변수로 정의한 프로젝트 정보를 활용하세요.

이미지 빌드 및 실행 테스트

  • Docker 이미지를 빌드하고 태그(local)를 지정하세요.
  • 빌드된 이미지를 활용해서 컨테이너를 실행하고 애플리케이션을 테스트하세요.
    • prod 프로필로 실행하세요.
    • 데이터베이스는 로컬 환경에서 구동 중인 PostgreSQL 서버를 활용하세요.
    • http://localhost:8081로 접속 가능하도록 포트를 매핑하세요.
    • 애플리케이션 서비스를 로컬 Dockerfile에서 빌드하도록 구성하세요.
    • 애플리케이션 볼륨을 구성하여 컨테이너가 재시작되어도 BinaryContentStorage 데이터가 유지되도록 하세요.
    • PostgreSQL 볼륨을 구성하여 컨테이너가 재시작되어도 데이터가 유지되도록 하세요.
    • PostgreSQL 서비스 실행 후 schema.sql이 자동으로 실행되도록 구성하세요.
    • 서비스 간 의존성을 설정하세요(depends_on).
    • 필요한 포트 매핑을 구성하세요.
    • Docker Compose를 사용하여 서비스를 시작하고 테스트하세요.

BinaryContentStorage 고도화 (AWS S3)

AWS S3 버킷 구성

  • AWS S3 버킷을 생성하세요.
  • 버킷 이름을 discodeit-binary-content-storage-(사용자 이니셜) 형식으로 지정하세요.
  • 퍼블릭 액세스 차단 설정을 활성화하세요(모든 퍼블릭 액세스 차단).
  • 버전 관리는 비활성화 상태로 두세요.

AWS S3 접근을 위한 IAM 구성

  • S3 버킷에 접근하기 위한 IAM 사용자(discodeit)를 생성하세요.
  • AmazonS3FullAccess 권한을 할당하고, 사용자 생성을 완료하세요.
  • 생성된 사용자에 엑세스 키를 생성하세요.
  • 발급받은 키를 포함해서 AWS 관련 정보는 .env 파일에 추가합니다.

AWS S3 테스트

  • AWS S3 SDK 의존성을 추가하세요.
  • S3 API를 간단하게 테스트하세요.
    • 패키지명: com.sprint.mission.discodeit.stoarge.s3
    • 클래스명: AWSS3Test
      • Properties 클래스를 활용해서 .env에 정의한 AWS 정보를 로드하세요.
      • 작업 별 테스트 메소드를 작성하세요.
      • 업로드
      • 다운로드
      • PresignedUrl 생성

**AWS S3를 활용한 BinaryContentStorage 고도화`

  • 앞서 작성한 테스트 메소드를 참고해 S3BinaryContentStorage를 구현하세요.
  • discodeit.storage.type 값이 s3인 경우에만 Bean으로 등록되어야 합니다.
  • S3BinaryContentStorageTest를 함께 작성하면서 구현하세요.
  • BinaryContentStorage 설정을 유연하게 제어할 수 있도록 application.yaml을 수정하세요.
      • AWS 관련 정보는 형상관리하면 안되므로 .env 파일에 작성된 값을 임포트하는 방식으로 설정하세요.
      • Docker Compose에서도 위 설정을 주입할 수 있도록 수정하세요.
  • download 메소드는 PresignedUrl을 활용해 리다이렉트하는 방식으로 구현하세요.

Docker Compose 구성

  • 애플리케이션과 PostgreSQL 서비스를 포함하세요.
  • 각 서비스에 필요한 모든 환경 변수를 설정하세요.

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

AWS RDS 구성

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

  • 과금이 발생할 수 있으니 다음 항목은 한번 더 확인해주세요.

      • 템플릿: 프리티어
      • 퍼블릭 액세스: 아니오
      • 모니터링 > 보존기간: 7일
      • 모니터링 > 추가 모니터링 설정: 모두 체크 해제
      • 추가 구성 > 백업: 비활성화
  • SSH 터널링을 통해 개발 환경에서 접근할 수 있도록 EC2를 구성하세요.

      • EC2 인스턴스를 생성하세요.
      • 보안 그룹에서 인바운드 규칙을 편집하세요.
      • DataGrip을 통해 연결 후 데이터베이스와 사용자, 테이블을 초기화하세요.
      • 데이터 소스 추가 시 SSH/SSL > Use SSH tunnel 설정을 활성화하세요. 이때 이전에 다운로드한 .pem 파일을 활용하세요.
      • 연결이 성공하면 데이터베이스와 사용자, 테이블을 초기화하세요.
      • 구성이 완료되면 rds-ssh 인스턴스는 완전히 삭제하여 과금에 유의하세요.

AWS ECR 구성

  • 이미지를 배포할 퍼블릭 레포지토리(discodeit)를 생성하세요.

  • AWS CLI를 설치하세요.

  • aws configure 실행 후 앞서 생성한 discodeit IAM 사용자 정보를 입력하세요.

  • discodeit IAM 사용자가 ECR에 접근할 수 있도록 다음 권한을 부여하세요.

    • AmazonElasticContainerRegistryPublicFullAccess
  • Docker 클라이언트를 배포할 레지스트리에 대해 인증합니다.

  • 멀티플랫폼을 지원하도록 애플리케이션 이미지를 빌드하고, 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 클러스터 상세 화면에서 서비스를 생성하세요.
  • 태스크의 EC2 보안 그룹의 인바운드 규칙을 설정하여 어디서든 접근할 수 있도록 하세요.
      • EC2 보안 그룹에서 인바운드 규칙을 편집하세요.
      • 규칙 유형으로 HTTP를 선택하세요.
      • 소스로 Anywhere-IPv4를 선택하여 모든 IP를 허용하세요.
  • 태스크 실행이 완료되면 해당 EC2의 퍼블릭 IP에 접속해보세요.

심화 요구사항

이미지 최적화하기

  • 멀티 스테이지(빌드, 런타임) 빌드를 활용해 이미지의 크기를 줄여보세요.
  • 이미지 레이어 캐시를 고려해 Dockerfile을 수정해보세요.

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

  • CI(지속적 통합)를 위한 워크플로우를 설정하세요.
    • .github/workflows/test.yml 파일을 생성하세요.
    • main 브랜치에 PR이 생성되면 실행되도록 설정하세요.
    • 테스트가 실행하는 Job을 정의하세요.
    • CodeCov를 통해 테스트 커버리지 뱃지를 README에 추가해보세요.

  • CD(지속적 배포)를 위한 워크플로우를 설정하세요.
    • .github/workflows/deploy.yml 파일을 생성하세요.
    • release 브랜치에 코드가 푸시되면 실행되도록 설정하세요.
    • AWS 정보 설정
      • GitHub 레포지토리 설정을 통해 시크릿을 추가하세요.
        • AWS_ACCESS_KEY: IAM 사용자의 액세스 키
        • AWS_SECRET_KEY: IAM 사용자의 시크릿 키
    • GitHub 레포지토리 설정을 통해 변수를 추가하세요.
    • Docker 이미지 빌드 및 푸시
      • Docker 이미지를 빌드하고 푸시하는 Job을 정의하세요.
      • AWS CLI를 설정하는 Step을 추가하세요.
      • ECR 로그인 Step을 추가하세요.
      • Docker 이미지 빌드 및 푸시하는 과정을 Step으로 추가하세요
      • 이미지 태그는 latest와 GitHub 커밋 해시를 사용하도록 설정하세요
    • ECS 서비스 업데이트
      • ECS 서비스를 업데이트하는 Job을 정의하세요.
      • AWS CLI를 설정하는 Step을 추가하세요.
      • 태스크 정의를 업데이트하는 Step을 추가하세요.
      • 프리티어 리소스를 고려해 AWS CLI를 사용해 기존에 구동 중인 서비스를 중단하는 Step을 추가하세요.
      • 새로 등록한 태스크 정의를 사용하도록 ECS 서비스를 업데이트하는 Step을 추가하세요.
    • AWS 콘솔을 통해 새로 등록된 태스크 정의로 배포되었는지 확인하세요.

주요 변경사항

스크린샷

image

멘토에게

  • CI/CD 코드는 작성 하였는데, 테스트가 실패하였습니다. (환경 변수를 CI로 주입하는 데 문제가 있습니다)

하드 코딩된 dev 프로필의 데이터소스 정보 수정
gitignore에 .env 추가
설정 프로필 prod로 변경
compose 설정 파일에 volume 추가
schema 파일 위치 루트 폴더로 변경
JpaClockConfig 클래스 추가
각 Instant 타임 정보를 사용하는 Request 클래스의 JsonFormat의 timezone을 Asia/Seoul로 변경
Dockerfile, docker-compose에 타임존 설정 추가
application 디폴트 설정 파일에 타임존 설정 추가
AWS S3 관련 의존성 추가
AWSS3Test 서비스 클래스 생성 (S3 테스트용) - 업로드, 다운로드, 프리사인드 URL 생성 기능
설정 파일(application.yaml)에 AWS  S3 관련 환경변수 설정 값 추가
docker-compose 설정 파일에 AWS S3 환경 변수 추가
BasicBinaryContentService에 S3를 사용해 파일을 생성,저장하는 로직 추가
BinaryContentController에 AWS S3용 create, donwolad API 메서드 추가
AWS S3 의존성 추가, Spring Boot 버전 변경(3.4.0 -> 3.5.5)
S3BinaryContentStorage 구현, S3Config 로직 내장(S3Client, S3Presigner 생성 로직)
S3Config, AWSS3Test 제거
AWSS3Test 클래스 재생성, 외부 연동 테스트 코드 추가
application-prod 설정 파일의 ddl-auto를 validate로 변경
shcema.sql 오타 수정
.env 환경 변수 파일과 값이 겹치는 것에 의한 배포 오류 해결을 위함
Windows 환경에서 CRLF 개행으로 인한 docker buildx 실패 오류 해결
.gitattributes로 CRLF를 기본 LF로 변경
Dockerfile의 dos2unix 설치, 줄바꿈 변환 파트 제거
환경변수가 인식되지 않는 오류 수정
.gitignore에 CI/CD 워크플로우 폴더(.github) 대상 제외
테스트 코드에 환경 변수 주입용도 코드 추가
다시 env 주입 로직으로 변경하고 gradle에서 test 환경에서 주입받도록 하는 코드 추가
GitHub Actions - Secrets에서 주입받도록 변경
AwsProperties 클래스 삭제 (로컬 env 주입 로직 삭제)
@value를 통해 CI로 주입받은 환경변수 값을 application.yml로부터 직접 주입
CI 주입 방식 변경, 빌드 전에 주입
설정 파일을 통한 주입에서 System.getenve()로 변경
AWS 환경변수 받아오는 로직 변경 (Props -> System.getenv())
on:
pull_request:
branches:
- "main"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test 브랜치는 main말고 다른걸로 잡는게 좋을것 같아요!

import java.util.TimeZone;

@Configuration
public class JpaClockConfig {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

오 이런 컨피그 만들어두는 것 매우 좋습니다.

}

@GetMapping("{binaryContentId}/get")
public ResponseEntity<?> get(@PathVariable("binaryContentId") UUID binaryContentId) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

메서드 명이나 api url 명이 get인게 어색합니다. 다운로드라는 의미가 드러나도록하는게 좋을것 같아요!

file.getBytes()
);
} catch (IOException e) {
throw new RuntimeException(e);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이런 익셉션도 커스텀하게 처리하시면 좋을것 같습니다.

}

@Override
public BinaryContentDto find(UUID binaryContentId) {
Copy link
Collaborator

@spring-kang spring-kang Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Transactional(readOnly=true)추가하시면 좋을것 같아요

}

@Override
public List<BinaryContentDto> findAllByIdIn(List<UUID> binaryContentIds) {
Copy link
Collaborator

@spring-kang spring-kang Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Transactional(readOnly=true)추가하시면 좋을것 같아요

}

@Override
public ReadStatusDto find(UUID readStatusId) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Transactional(readOnly=true)추가하시면 좋을것 같아요

}

@Override
public List<ReadStatusDto> findAllByUserId(UUID userId) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Transactional(readOnly=true)추가하시면 좋을것 같아요

}

@Override
public UserDto find(UUID userId) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Transactional(readOnly=true)추가하시면 좋을것 같아요

}

@Override
public List<UserDto> findAll() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Transactional(readOnly=true)추가하시면 좋을것 같아요

}

@Override
public UserStatusDto find(UUID userStatusId) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Transactional(readOnly=true)추가하시면 좋을것 같아요

}

@Override
public List<UserStatusDto> findAll() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Transactional(readOnly=true)추가하시면 좋을것 같아요

import java.util.UUID;

@Component
public class AWSS3Test {
Copy link
Collaborator

@spring-kang spring-kang Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

클래스명을 Test로 끝나지 않게 만들어주시면 좋을것 같아요!

@spring-kang
Copy link
Collaborator

컨플리트가 나는 부분이 있습니다. 확인 부탁드립니다.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants