[Docker] Dockerize #1

개발환경과 배포환경의 분리, 일관된 실행 환경

---

Why Use to Docker?

도커라이즈를 적용하기에 앞서, Docker를 사용하는 근본적인 이유에 대해 알아보자.

• 격리(Isolation): 로컬(인스턴스)의 환경과 분리된 도커 환경으로 로컬 환경의 오염이나 충돌을 방지한다.
• 일관성(Consistency): 다양한 로컬(인스턴스)에서도 도커를 통해 일관된 애플리케이션을 구동할 수 있다.

Docker가 없을 때:

로컬(인스턴스) 환경과 App 구동을 위한 환경이 충돌하고 이리저리 섞인다.

• 문제점: 각 개발자의 로컬환경이 서로 달라, 일관된 환경 구성이 어렵다.
  
  • Aaron: Window OS에서 MySQL 5.7, JVM 17, 16, 12
  • Baron: Linux OS에서 MySQL 8, JVM 17, 8
  • Caron: Mac OS에서 PostgreSQL 15, JVM 17
• 이러한 차이로 인해 애플리케이션 구동을 위해 호스트 환경의 설정이 필요하며, 서로 다른 환경에서의 호환성 문제나 버전 충돌이 발생할 수 있다.

Docker가 있을 때:

Docker 이미지(컨테이너)는 App과 그 App을 실행하는 데 필요한 모든 환경(라이브러리, 설정 등)을 포함판 패키지이다.

이 패키지(이미지)를 기반으로 컨테이너를 띄우면, 앱이 구동되면서 필요한 모든 환경이 자동으로 설정된다. 이 컨테이너는 사용이 끝나면 그대로 삭제할 수 있다. 따라서 일회용품처럼 한 번 쓰고 버려도 로컬 시스템(개발자의 운영 체제나 파일)에 흔적을 남기지 않는다.

• 장점: Docker를 사용하면 각 개발자 간의 환경 차이가 해결된다.
  • Docker 컨테이너를 통해 애플리케이션과 관련된 모든 환경 설정이 일관되게 관리된다.
  • 각각의 호스트(운영체제)가 Windows, Linux, Mac OS이더라도 Docker 컨테이너 내부에서 동일한 이미지와 설정을 사용할 수 있어 개발 환경의 일관성이 보장된다.
  • 이미지에서는 "Segmentation = Consistency"로 표시하며, 컨테이너가 격리되어 환경 차이가 없고 버전 충돌 문제가 발생하지 않음을 강조한다.
  • Window OS에서는 WSL 2가 필요하다. Docker를 통해 리눅스 환경을 쉽게 구성할 수 있다.

 

Spring Boot와 Database(MySQL) 도커라이즈 & 연결

Spring 애플리케이션과 데이터베이스를 도커라이즈 하여, 실제 현업에서 배포하는 방식 그대로 ㅓ진행해 볼 예정이다.

• 일반적으로는 로컬 컴퓨터 내 사용할 DBMS(MySQL)을 설치 후, IntelliJ르 통해 개발한 자바를 DBMS와 연결하여 구동한다.
  • 현업에서는 그것과 달리 모든 것이 도커라이즈 되어 있으며, 프로파일에 따라 DB를 달리 접속한다.
• 🤟 도커라이즈를 사용하면 어디서든 구동 가능한 DBMS(MySQL) 도커이미지를 구동하고 + 자바(JAR) 도커 이미지를 구동한다.
  • 이 도커라이즈 방식으로 이번 포스팅 실습은 아래 절차대로 진행한다. 

1. Docker를 통한 Spring Boot 구동 ← Dockerfile을 활용하여 Spring Boot 도커라이즈
2. Docker를 통한 Database(MySQL) 구동 ← docker 명령어를 활용하여 Database 도커라이즈
3. Docker Compose를 통한 Spring Boot + Database(MySQL) 동시 구동 = 1번과 2번 결합

 

Spring Boot: Java 빌드(:JAR) + Docker Image 빌드(:Image)

목표: Docker로 Spring Boot 구동

 

Java 애플리케이션이 구동되는 방식

1. JAR 구동을 위한 JRE(JM) 버전 설정: 우리가 개발한 Java 애플리케이션은 특정 Java 버전을 필요로 하며, 이 버전 위에서 구동된다.
   • Docker 이미지의 베이스로 사용할 JRE/JVM 버전을 설정한다.
2. JAR 빌드: Java 소스 파일들을 컴파일하고 하나의 JAR 파일로 빌드한다.
   • 이 빌드된 JAR 파일이 실행 가능한 애플리케이션의 형태이다.
3. JAR 파일 실행: 컴파일 및 빌드 완료된 JAR 파일을 JRE 명령어를 통해 구동한다.
   • 이 경우 `java -jar application.jar` 명령어가 사용된다.

Docker 이미지 구성

• JAR을 위한 JRE(JVM) 설정: 어떤 JRE/JVM 버전을 사용할 것인지 명시
• 구동할 JAR 파일: 빌드된 JAR 파일을 Docker 이미지에 포함한다.
• 구동 명령어: JAR 파일을 구동하는 명령어를 정의한다.

Docker Image 구성의 쉬운 이해를 돕기 위한 간단한 도식

FROM amazoncorretto:17-alpine

ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar

ENTRYPOINT ["java", "-jar", "/app.jar"]

• Docker Image의 실제 구성: Dockerfile

FROM amazoncorretto:17-alpine

• JAR 구동할 JRE (JVM) 버전 설정: 베이스 이미지

ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar

• 구동할 JAR 빌드: 앞서 개발한 Java를 컴파일 및 빌드한 JAR 파일 명시

ENTRYPOINT ["java", "-jar", "/app.jar"]

• 구동: (1) JAR 구동할 JRE(JVM) 위에 + (2) 구동할 JAR 얹어 수행하기 위한 명령어

1. Spring Boot 도커라이즈 방법

1. Gradle을 통해 개발한 Java 애플리케이션 빌드 : JAR 파일

./gradlew clean build

• 위 명령어를 실행하면, `build/libs/` 디렉토리 아래에 `demo-0.0.1-SNAPSHOT.jar` 이름의 JAR 파일이 생성된다.

 

2. 앞선 JAR파일을 Dockerfile대로 도커 이미지 빌드: Docker Image

 

• Dockerfile 작성(예시 코드)

FROM amazoncorretto:17-alpine

ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar

ENTRYPOINT ["java", "-jar", "/app.jar"]

 

• Dockerfile 기반으로 Docker Image 빌드
  • 점(.)의 의미 = 현재 위치 디렉토리 내 존재하는 Dockerfile을 사용하여 도커 이미지를 빌드한다는 의미.

docker build -t spring-jpa:6th .

• 생성된 Docker Image 확인

docker images spring-jpa

• 생성된 Docker Image 정상 실행 확인

docker run -p 1000:8080 -t spring-jpa:6th

 

위 명령어가 정상적으로 Spring Boot WAS 서버가 구동된다면 로컬 컴퓨터서는 8080이 아닌, 1000 포트로 접속하게 된다.

• Docker의 포트 매핑:
  • `docker run -p 1000:8080 -t spring-jpa:6th` 명령어에서 -p 1000:8080은 호스트의 포트 1000을 컨테이너의 포트 8080에 매핑하는 설정이다.
  • 이 설정으로 인해, 호스트 컴퓨터에서는 http://localhost:1000으로 접근하며, 실제로는 Docker 컨테이너 내부에서 8080 포트로 연결된다.
• 포트 설명:
  • 컨테이너 내부 포트 (8080): 컨테이너 내에서만 접근 가능한 포트이다. Spring Boot 애플리케이션이 이 포트에서 서버를 구동하고 있다.
  • 호스트 포트 (1000): 로컬 컴퓨터에서 접근할 수 있는 포트이다. 컨테이너 내부의 8080 포트로의 접근이 이 포트를 통해 가능해진다.

 

• A 타입은 IntelliJ와 같은 개발 환경에서 애플리케이션이 바로 구동하는 경우로, 애플리케이션이 호스트의 지정된 포트에서 직접 실행된다.
• B 타입은 Docker 애플리케이션을 이미지로 빌드하고, 그 이미지를 컨테이너로 실행한 경우이다. Docker가 호스트와 포트 매핑을 통해 외부 접근을 허용하게 된다.

3. Spring 도커라이즈 시 Dockerfile 내 전달인자(ARG) 활용

앞서 사용한 Dockerfile을 보면 ARG 구문이 나오는데 이는 Dockerfile 문법 중에 자주 사용되는 것으로 필수적으로 알고 있어야 한다.

FROM amazoncorretto:17-alpine

ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar

ENTRYPOINT ["java", "-jar", "/app.jar"]

 

• 본 Dockerfile을 사용하여 Docker Image를 빌드하였을 때 아래 명령어를 사용했었다.
  • `--build-arg` 값을 설정하지 않았기 때문에, Dockerfile 내 ARG에 설정한 기본값이 들어간다.

docker build -t spring-jpa:6th .
docker run -p 1000:8080 -t spring-jpa:6th

 

• ARG를 활용한 빌드 및 수행: Docker Image 빌드 명령어 주입 시, Dockerfile 내 ARG 전달인수에 값을 전달한다.
  • 앞서 생성된 `build/libs/demo-0.0.1-SNAPSHOT.jar`의 파일이름을 `RENAMED.jar`로 변경한다.

• 아래 명령어 입력을 통해 ARG를 활용하여 빌드한다.

docker build --build-arg JAR_FILE=build/libs/RENAMED.jar -t spring-jpa:6th .
docker run -p 1000:8080 -t spring-jpa:6th

4. 미사용 도커 이미지들  삭제하기 위해 해당 이미지를 사용하고 있는 컨테이너 삭제하기

이미지를 삭제하기 위해서는 해당 이미지를 사용하고 있는 컨테이너를 먼저 삭제해야 한다.

 

1. 현재 컨테이너 상태 확인:

• 모든 컨테이너 목록(구동, 정지된 것 포함)을 확인하려면 -a 옵션을 사용한다.

docker ps -a

2. 특정 정보만 보기:

• 컨테이너 이름만 확인하려면 --format 옵션을 사용한다:

docker ps -a --format '{{.Names}}'

• `--format 옵션은 이름뿐만 아니라 알고 싶은 정보만 필터링해서 사용할 수 있다.

docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.RunningFor}}\t{{.Status}}\t{{.Names}}'

• 간단히 컨테이너 ID만 출력하고 싶다면 --quiet 또는 -q 옵션을 사용한다:

docker ps -a --quiet

3. 컨테이너 삭제:

• 확인한 컨테이너 ID 또는 NAMES를 사용하여 컨테이너를 삭제한다:

docker rm <컨테이너 ID>
docker rm <컨테이너 NAMES>

5. 미사용 Docker 이미지 삭제: docker rmi

컨테이너를 삭제했다면, 그다음엔 이미지를 삭제할 차례다. 아래 명령어를 통해 이미지가 어떤 것들이 있는지 확인한다.

docker images

• 삭제를 원하는 이미지의 IMAGE ID로 삭제한다.
  • 필자는 mysql 컨테이너 삭제 후, mysql 이미지를 삭제했다.

docker rmi <IMAGE ID>

6. Dangling 이미지 삭제

`<none>`으로 표시되는 Dangling 이미지는 사용하지 않는 리소스이므로, prune 명령어를 사용하여 정리할 수 있다.

Dangling 이미지가 발생하는 이유는 크게 두 가지 이유이다.

1. 이미지 삭제 시 컨테이너가 사용 중이어서 삭제는 못하기에 Untagged
2. 동일 이미지 태그에 대해 새로운 버전의 이미지를 생성했을 때, 기존 이미지가 Untaggedd

1. 일반적으로 우리가 의도하는 도커 이미지를 깔끔하게 삭제하는 방법:

• 해당 명령어를 통해 특정 이미지를 사용하는 컨테이너들만 한꺼번에 종료한 뒤, 이미지를 깔끔하게 지우는 아래 명령어를 사용하자.

docker rm -f $(docker ps -aq --filter ancestor=[IMAGE])
docker rmi [IMAGE]

 

2. Dangling Image: `<none>`으로 표기되어 있는 이미지 일괄 삭제 방법

• 아래 명령어를 통해 Dangling 이미지를 삭제할 수 있다.

docker image prune

• -f 옵션을 추가하여 화긴 없이 강제로 삭제할 수 있다.

docker image prune -f

• 추가로 중지된 컨테이너를 삭제하는 명령어:

docker container prune

• 사용하지 않는 모든 리소스 정리(컨테이너, 이미지, 볼륨, 네트워크):

docker system prune

---

이번 포스팅을 통해 Spring Boot 도커라이즈 하는 방법과 + Docker의 컨테이너 삭제, 이미지삭제 명령어 등을 알아보았다.

이어서 다음 포스팅에선 Docker를 통한 Database(MySQL)을 구동하는 작업을 진행할 예정이다. 

 

ℹ️ 참고

[ASAC 6기 강의자료]