[신동진] Sprint 8

[B1uffer]

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

[ x ] JVM 옵션을 환경 변수로 설정하세요.
JVM_OPTS: 기본값은 빈 문자열로 정의

[ x ] 애플리케이션 실행 명령어를 설정하세요. 이때 환경변수로 정의한 프로젝트 정보를 활용하세요.

이미지 빌드 및 실행 테스트
[ x ] Docker 이미지를 빌드하고 태그(local)를 지정하세요.
[ x ] 빌드된 이미지를 활용해서 컨테이너를 실행하고 애플리케이션을 테스트하세요.
[ x ] prod 프로필로 실행하세요.
[ x ] 데이터베이스는 로컬 환경에서 구동 중인 PostgreSQL 서버를 활용하세요.
[ x ] http://localhost:8081로 접속 가능하도록 포트를 매핑하세요.

Docker Compose 구성
개발 환경용 docker-compose.yml 파일을 작성합니다.
[ x ] 애플리케이션과 PostgreSQL 서비스를 포함하세요.
[ x ] 각 서비스에 필요한 모든 환경 변수를 설정하세요.
.env 파일을 활용하되, .env는 형상관리에서 제외하여 보안을 유지하세요.

[ x ] 애플리케이션 서비스를 로컬 Dockerfile에서 빌드하도록 구성하세요.
[ x ] 애플리케이션 볼륨을 구성하여 컨테이너가 재시작되어도 BinaryContentStorage 데이터가 유지되도록 하세요.
[ x ] PostgreSQL 볼륨을 구성하여 컨테이너가 재시작되어도 데이터가 유지되도록 하세요.
[ x ] PostgreSQL 서비스 실행 후 schema.sql이 자동으로 실행되도록 구성하세요.
[ x ] 서비스 간 의존성을 설정하세요(depends_on).
[ x ] 필요한 포트 매핑을 구성하세요.
[ ] Docker Compose를 사용하여 서비스를 시작하고 테스트하세요.
--build 플래그를 사용하여 서비스 시작 전에 이미지를 빌드하도록 합니다.

BinaryContentStorage 고도화 (AWS S3)
AWS S3 버킷 구성
[ x ] AWS S3 버킷을 생성하세요.

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

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

• 작성한 .env 파일은 리뷰를 위해 PR에 별도로 첨부해주세요. 단, 엑세스 키와 시크릿 키는 제외하세요.

AWS S3 테스트
[ x ] AWS S3 SDK 의존성을 추가하세요.

implementation 'software.amazon.awssdk:s3:2.31.7'

[ ] S3 API를 간단하게 테스트하세요.

• 패키지명: com.sprint.mission.discodeit.stoarge.s3
• 클래스명: AWSS3Test
• [ x ] Properties 클래스를 활용해서 .env에 정의한 AWS 정보를 로드하세요.
• [ x ] 작업 별 테스트 메소드를 작성하세요.
  • 업로드
  • 다운로드
  • PresignedUrl 생성

AWS S3를 활용한 BinaryContentStroage 고도화
[ x ] 앞서 작성한 테스트 메소드를 참고해 S3BinaryContentStorage를 구현하세요.

• 클래스 다이어그램

[ x ] discodeit.storage.type 값이 s3인 경우에만 Bean으로 등록되어야 합니다.
[ x ] S3BinaryContentStorageTest를 함께 작성하면서 구현하세요.
[ x ] BinaryContentStorage 설정을 유연하게 제어할 수 있도록 application.yaml을 수정하세요.

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

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

*** 테스트 관련 코드 전부 test 폴더로 옮겨야함

AWS RDS 구성

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

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

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

• [ x ] 템플릿: 프리티어
• [ x ] 퍼블릭 액세스: 아니오
• [ x ] 모니터링 > 보존기간: 7일
• [ x ] 모니터링 > 추가 모니터링 설정: 모두 체크 해제
• [ x ] 추가 구성 > 백업: 비활성화

[ x ] SSH 터널링을 통해 개발 환경에서 접근할 수 있도록 EC2를 구성하세요.

• [ x ] EC2 인스턴스를 생성하세요.

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

[ x ] 보안 그룹에서 인바운드 규칙을 편집하세요.

• 유형: SSH
• 소스: 내 IP
  • 작업 환경의 네트워크(와이파이 등)가 달라지면 계속 수정해주어야 할 수 있습니다.

[ ] DataGrip을 통해 연결 후 데이터베이스와 사용자, 테이블을 초기화하세요.

• 데이터 소스 추가 시 SSH/SSL > Use SSH tunnel 설정을 활성화하세요. 이때 이전에 다운로드한 .pem 파일을 활용하세요.

• 연결이 성공하면 데이터베이스와 사용자, 테이블을 초기화하세요.

• 구성이 완료되면 rds-ssh 인스턴스는 완전히 삭제하여 과금에 유의하세요.

AWS ECR 구성
[ ] 이미지를 배포할 퍼블릭 레포지토리(discodeit)를 생성하세요.

• 프라이빗 레포지토리는 용량 제한이 있으므로 퍼블릭 레포지토리로 생성합니다.

[ ] AWS CLI를 설치하세요.

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

• 엑세스 키
• 시크릿 키
• region: ap-northeast-2
• output format: json

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

• AmazonElasticContainerRegistryPublicFullAccess

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

• AWS 콘솔을 통해 생성한 레포지토리 페이지로 이동 후 우측 상단 푸시 명령 보기를 클릭하면 관련 명령어를 확인할 수 있습니다.

[ ] 멀티플랫폼을 지원하도록 애플리케이션 이미지를 빌드하고, discodeit 레포지토리에 push 하세요.

• 태그명: latest, 1.2-M8
• 멀티플랫폼: linux/amd64,linux/arm64

[ ] AWS 콘솔에서 푸시된 이미지를 확인하세요.

AWS ECS 구성
[ ] 배포 환경에서 컨테이너 실행 간 사용할 환경 변수를 정의하고, S3에 업로드하세요.

• discodeit.env 파일을 만들어 다음의 내용을 작성하세요.

• 이 파일을 S3에 업로드하세요.

• 이 파일은 형상관리되지 않도록 주의하세요.

[ ] AWS ECS 콘솔에서 클러스터를 생성하세요.

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

[ ] 태스크를 정의하세요.

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

  • 태스크 생성 후 태스크 실행 역할에 S3 관련 권한을 추가하세요.

    • 환경 변수 파일을 읽기위해 필요합니다.

[ ] discodeit 클러스터 상세 화면에서 서비스를 생성하세요

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

[ ] 태스크의 EC2 보안 그룹의 인바운드 규칙을 설정하여 어디서든 접근할 수 있도록 하세요.

• EC2 보안 그룹에서 인바운드 규칙을 편집하세요.
• 규칙 유형으로 HTTP를 선택하세요.
• 소스로 Anywhere-IPv4를 선택하여 모든 IP를 허용하세요.

[ ] 태스크 실행이 완료되면 해당 EC2의 퍼블릭 IP에 접속해보세요.

정리를 안하고 그냥 올려뒀습니다.

주요 변경사항

스크린샷

멘토에게

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

[joonfluence]

p3. 환경변수로 관리하기 위한 처리가 추가로 필요합니다!

@ConditionalOnProperty(name = "discodeit.storage.type", havingValue = "s3")

[joonfluence]

p2. 의존성 주입도 따로 처리 안되고 있는 것 같습니다. 동작하지 않을 듯 합니다.

[joonfluence]

전반적으로 코드 리베이스가 한번 필요할 것 같습니다.

[joonfluence]

1. 도커파일 설정 및 도커 컴포즈 설정을 잘 해주셨습니다.
2. 전반적으로 기본적인 요구사항은 만족시켜주셨지만, 실제 Infra 영역에 대한 설정이나 배포까지 진행되었는지 확인하기 어려워 점수를 많이 드리지 못했습니다. 다음번에는 직접 배포까지 해보시는 것을 권합니다.
3. 여력이 되신다면 CI/CD 파이프라인도 구성해보시는 것을 권장 드립니다. 모르는 부분이 있으면 언제든 물어봐주세요!