[CI/CD] 실시간 채팅 애플리케이션 프로젝트 - CI/CD를 위한 Dockerfile 작성하기

📖 목차

 

 

 

---

 

지난 포스팅에서 GitHub Actions를 활용해 CI/CD 파이프라인을 구축해 보았다.

[CI/CD] 실시간 채팅 애플리케이션 프로젝트 - GitHub Actions를 통한 CI/CD 구축하기 - (2)

 

 

이번 포스팅에서는 Dockerfile을 작성하는 방법에 대해 알아보자.

 

 

 

 

 

 

 

---

 

 

 

 

 

 

 

📌  Dockerfile이란?

  Dockerfile은 Docker에서 이미지를 생성하기 위한 용도로 작성하는 스크립트(설정파일)이다. FROM, RUN, COPY 등의 명령어를 포함하며, 이 명령어들을 순서대로 실행하여 컨테이너 환경에 필요한 모든 요소를 담은 이미지를 빌드한다.

 

Dockerfile을 작성하기 전에, Dockerfile을 작성하면 어떤 장점이 있는지 확인해 보자.

1️⃣ 이미지 빌드 자동화 및 일관성 유지
Dockerfile은 이미지 빌드 과정을 순서대로 정의하는 스크립트이기 때문에 이 파일을 통해 언제든지 동일한 방식으로 이미지를 생성할 수 있다. 이는 수동으로 이미지를 생성하는 번거로움을 줄여준다.

2️⃣ 개발 환경의 표준화 및 협업 효율 증대
Dockerfile을 사용하면 모든 개발 환경과 운영 환경에서 동일한 환경을 보장하여 일관성을 유지할 수 있도록 해주며, 그에 따라 협업의 효율성을 높일 수 있다.

3️⃣ CI/CD 파이프라인 연동 및 지속적인 배포
Dockerfile은 Git과 같은 개발 도구나 CI/CD 도구와 연동하여 애플리케이션의 빌드 및 배포 과정을 자동화하는 데 필수적이다.
이를 통해 코드 변경이 있을 때마다 자동으로 이미지를 빌드하고 배포하는 지속적인 배포 시스템을 효율적으로 구축할 수 있다.

 

 

 

 

 

 

 

📌  Dockerfile 생성하기

  이제 직접 Dockerfile을 생성해 보자. 진행할 프로젝트의 루트 디렉터리에 Dockerfile을 생성한다. 

<Dockerfile 생성 경로>

 

 

 

 

 

 

 

📌  Dockerfile 작성하기

  Dockerfile을 생성했다면, 어떤 방식으로 작성할지 구성한 뒤에 작성해 보도록 하자.

기존에 진행했던 여러 프로젝트에서는 이미지 빌드 단계와 실행 단계를 따로 나누지 않고 작성했었는데, 이번 프로젝트에서는 'Build Stage' 과정과 'Run Stage' 과정을 나누어 'Multi-Stage Build' 방식으로 구성해 보았다.

 

💡 Multi-Stage Build란?
* 컨테이너 이미지를 만들면서 빌드할 때(Build)와 컨테이너 실행 시(Run)에 필요 없는 환경을 제거할 수 있도록 단계를 나누어 이미지를 만드는 방법

 

 

이렇게 멀티스테이지 빌드를 사용하게 되면 불필요한 파일이 남지 않아 최종 이미지의 용량이 작아지며 좀 더 가벼운 크기의 컨테이너를 사용할 수 있게 되고, 그에 따른 이미지 최적화가 가능하다. 또한, 보안과 배포 관점에서도 여러 장점이 있다.

 

 

 

 

 

✔️ 이제 멀티 스테이지 방식으로 Dockerfile을 작성해 보자.

# Build Stage
FROM eclipse-temurin:17-jdk AS build
WORKDIR /app

COPY . .
RUN chmod +x gradlew
RUN ./gradlew clean build -x test --no-daemon

 

• FROM eclipse-temurin:17-jdk AS build
  → OpenJDK 17이 포함된 Eclipse Temurin JDK 이미지를 기반으로 사용
  → AS build로 이름을 붙여, 빌드 전용 스테이지로 지정
• WORKDIR /app
  → 컨테이너 안에서 작업 디렉터리를 /app으로 설정
• COPY . .
  → 현재 호스트의 프로젝트 소스 코드를 컨테이너 /app에 복사
• RUN chmod +x gradlew
  → 리눅스 환경에서 실행 가능하도록 Gradle Wrapper(gradlew)에 실행 권한을 부여
• RUN ./gradlew clean build -x test --no-daemon
  → Gradle로 애플리케이션을 빌드
  → 테스트 코드를 실행하지 않고 빌드한다는 의미 + 데몬 비활성화
  → 결과적으로 /app/build/libs/ 밑에 .jar 파일이 생성됨

 

# Run Stage
FROM eclipse-temurin:17-jre
WORKDIR /app

COPY --from=build /app/build/libs/*.jar app.jar

EXPOSE 8080
ENTRYPOINT ["java", "-jar", "app.jar"]

 

• FROM eclipse-temurin:17-jdk
  → 실행 환경도 OpenJDK 17을 기반으로 함
  → 빌드에 필요한 Gradle 등은 포함하지 않아 이미지 크기 절감 가능
• WORKDIR /app
  → 실행 환경에서도 /app을 작업 디렉터리로 사용.
• COPY --from=build /app/build/libs/*.jar app.jar
  → 앞에서 만든 build stage에서 빌드된 .jar 파일을 복사
  → 컨테이너 안에 app.jar라는 이름으로 배치
• EXPOSE 8080
  → 컨테이너가 8080 포트를 외부에 노출한다고 선언
• ENTRYPOINT ["java", "-jar", "app.jar"]
  → 컨테이너가 시작될 때 실행할 명령어 지정
  → java -jar app.jar로 Spring Boot 애플리케이션이 실행됨

 

 

 

 

✔️ Build Stage와 Run Stage를 나누어 최종적으로 작성된  Dockerfile이다.

# Build Stage
FROM eclipse-temurin:17-jdk AS build
WORKDIR /app

COPY . .
RUN chmod +x gradlew
RUN ./gradlew clean build -x test --no-daemon

# Run Stage
FROM eclipse-temurin:17-jre
WORKDIR /app

COPY --from=build /app/build/libs/*.jar app.jar

EXPOSE 8080
ENTRYPOINT ["java", "-jar", "app.jar"]

<멀티 스테이지 방식으로 작성한 Dockerfile>

 

 

 

 

 

 

 

---

 

 

 

 

 

 

 

💡 그동안 Dockerfile을 작성할 때에는 이미지를 빌드하고 실행하는 내용을 나누지 않고 구성했다면,

이번실시간 채팅 애플리케이션 프로젝트에는 MSA프로젝트를 진행하면서 알게 된 멀티 스테이지 방식을 적용해 보았다.

 

단일 프로젝트이지만 팀 프로젝트를 진행할 때 시간 여유가 없어서 혼자 직접 해보지 못했던 것들을 이것저것 시도해보려고 한다.

여기까지 간단한 Dockerfile작성법에 대해 알아보았다.

 

 

 

 

 

 

 

 

 

📌  참고

[Docker] Dockerfile을 이용한 Spring Boot App 환경 구성 및 실행방법

 

[Docker] Dockerfile - Multi-stage build(멀티스테이지 빌드)