[Docker]Dockerize #3

Docker Compose : 두 개 이상의 도커 이미지 빌드 / 컨테이너 구동

---

Docker Compose

목적: Docker Compose를 통한 Spring Boot + Database(MySQL) 동시 구동

이번 챕터에선 Docker Compose를 사용하여 앞서 진행했던 Spring Boot 애플리케이션과 MySQL 데이터베이스를 동시에 구동하는 방법과 그 과정에 대해 알아보자. Docker Compose를 통해 여러 개의 Docker 컨테이너를 손쉽게 관리할 수 있다.

 

• DockerFile: 하나의 애플리케이션(이미지)을 정의하고 빌드할 때 사용한다.
• Docker Compose: 둘 이상의 애플리케이션(이미지)을 정의하고 함께 실행할 때 사용한다. 각 컨테이너 간의 네트워크 설정 및 환경 변수 설정을 쉽게 관리할 수 있다.

Docker Compose 파일(docker-compose.yml 작성)

`docker-compose.yml` 파일을 생성하고, Spring boot와 MySQL 컨테이너를 정의한다.

version: "3"
services:
  mysql_container_service:
    container_name: mysql_container
    hostname: mysql_host
    image: mysql:8
#   image: postgres:15
#   restart: always
    environment:
      MYSQL_ROOT_PASSWORD: "root"
      MYSQL_USER: "asac"
      MYSQL_PASSWORD: "1234"
      MYSQL_DATABASE: "example"
#     POSTGRES_USER: "asac"
#     POSTGRES_PASSWORD: "1234"
#     POSTGRES_DB: "example"
    ports:
      - 4000:3306
#     - 6000:5432

  spring_container_service:
    container_name: spring_container
    build: .
    ports:
      - 1000:8080
    environment:
      SPRING_PROFILE: develop
    depends_on:
      - mysql_container_service

 

`docker-compose.yml` 각 옵션 설명

• `services`: mysql_container_service와 spring_container_service 두 가지 서비스를 정의 → 단순 옵션 구분
• `container_name`: 생성될 컨테이너의 이름을 지정 → 명시하지 않으면 자동 생성된 것으로 사용
• `hostname`: 
  • Docker 내부 네트워크에서 mysql_host라는 호스트명으로 다른 컨테이너가 접근할 수 있도록 한다.
  • 기본적으로 Bridge 네트워크 옵션을 사용하여 Docker 엔진 내에서 여러 컨테이너가 통신할 수 있게 설정한다.
• `image`: Dockerfile을 통한 도커 이미지 생성 없이 바로 실행하고 싶은 경우, 베이스 이미지 명시가 필요하다.
• `build`: Dockerfile을 통한 도커 이미지 생성 후 실행하고 싶은 경우
• `ports`: {호스트에서 사용할(호스트에서 노출할) 포트} : {도커 내 컨테이너 간 통신 시 포트}
  • 4000:3306으로 설정하여 호스트의 4000번 포트를 컨테이너의 3306번 MySQL 포트와 연결한다.
  • 이를 통해 호스트에서 localhost:4000으로 MySQL에 접근할 수 있다.
• `environment`: 도커 이미지 생성 혹은 이미지 생성 없이 바로 컨테이너 실행 시 사용할 환경 변수
  • SPRING_PROFILE=develop 환경 변수를 설정하여 Spring Boot 애플리케이션에서 개발 모드로 실행되도록 한다.
• `deponds_on`: 어떤 컨테이너가 먼저 구동된 다음에, 해당 컨테이너가 구동되어야 하는지 순서를 명시한다.
  • mysql_container_service가 먼저 시작된 후 spring_container_service가 구동되도록 순서 지정

Docker Compose 환경 변수 설정 방법

1. Compose 파일에 직접 입력
   • docker-compose.yml 파일 내 environment 섹션에 환경 변수를 직접 입력한다.
2. 쉘 환경 변수 사용
   • export SPRING_PROFILE=develop 등과 같이 쉘에서 환경 변수를 설정하요 사용할 수 있다.
3. .env 파일 사용
   • .env 파일에 환경 변수를 정의하고 Docker Compose가 이를 자동으로 불러올 수 있다.

`docker-compose.yml` 파일이 실제로 동작하는 방식

• 로컬(호스트)과 도커 영역 두 개를 구분하여 도식화

도커 내부에 데이터베이스는 도커 엔진 내부에서 접근할때는 mysql_host:3306 ❘ 외부에서 접근할 때는 localhost:4000

 

Java 코드 변경 후 재배포

1. 새 JAR 파일 빌드

• Java 코드 변경 후 JAR 파일을 다시 빌드한다.

./gradlew clean build

 

2. Docker Compose로 컨테이너 재시작

• docker-compose up --build 옵션을 사용하여 컨테이너 이미지를 새로 빌드하고, 두 컨테이너를 동시에 실행한다

docker compose up -d --build

 

3. 개별 컨테이너 재생성

• 특정 컨테이너를 삭제 후 재생성하거나 의존성 없이 개별 컨테이너만 재구동

docker rm mysql_container
docker rm spring_container
docker compose up -d --force-recreate --build --no-deps spring_container

 

Docker Compose 주요 명령어와 옵션

• `docker-compose up -d`: 백그라운드 모드로 컨테이너 실행
  • 실행 흐름: Creating → Created → Starting → Started

$ docker-compose up -d

Container mysql_container   Creating
Container spring_container  Creating
Container mysql_container   Created
Container spring_container  Created
Container mysql_container   Starting
Container spring_container  Starting
Container mysql_container   Started
Container spring_container  Started

 

 

옵션 설명:

• `-d`: Detaced mode. 백그라운드에서 실행하여 터미널을 점유하지 않는다.
• `--build`: 이미지 캐시를 무시하고 강제로 새로 빌드
  • 도커 이미지는 여러 레이어로 구성되며, 기본적으로 캐시를 사용해 빌드 속도를 높이지만, 코드가 바뀌었을 때 캐시된 이미지가 사용될 수 있어 이 옵션을 통해 강제로 빌드한다.

Docker Image는 매 Instruction 마다 Layer로 구성되며 이 중간 과정을 Cache 해놓는다.

• `--force-recreate: 기본 컨테이너를 지우고 새로 생성하지만, 이미지를 새로 빌드하는 것은 아니다.
  • `--build`와 함께 쓰면 이미지를 새로 빌드하고 그 이미지를 사용해 컨테이너를 생성한다.
• `--no-deps`: 의존성을 가진 컨테이너를 재시작하지 않고 현재 지정된 컨테이너만 실행.
  • 예를 들어, spring_conatiner만 재구동하고 mysql_container는 재구동하지 않도록 할 때 사용한다.

컨테이너 상태 확인

• Docker Compose 상태 확인:

docker compose ps

• Docker 상태 확인:

docker ps

Docker Compose로 구동한 컨테이너 간 통신

기본적으로 Docker Compose로 실행한 컨테이너들은 같은 네트워크 내에서 자동으로 통신이 가능하지만, docker run으로 개별 실행한 컨테이너 간 통신은 별도의 네트워크 설정이 필요하다.

 

1. 네트워크 생성 후 컨테이너를 연결한다.

• `docker network create mynetwork`를 통해 `mynetwork`라는 네트워크를 생성한다.
  • 삭제는 `docker network rm mynetwork`
  • ⚠️ 삭제 시 주의사항: 네트워크에 연결된 컨테이너가 있으면 삭제되지 않으므로, 먼저 해당 네트워크에서 모든 컨테이너를 분리해야 한다.
    • 분리 명령어: `docker network disconnect mynetwork container1`

docker network create mynetwork
docker network connect mynetwork container1
docker network connect mynetwork container2

2. 컨테이너 간 핑 테스트:

docker exec -ti container1 ping container2

3. 네트워크 연결 해제(컨테이너 네트워크 분리)

docker network disconnect mynetwork container1

4. 네트워크 삭제

docker network rm mynetwork

컨테이너 네트워크 설정 방식

1. User-defined Bridge: 브릿지 네트워크를 정의해 여러 컨테이너가 동일 컨테이너 내에서 통신하도록 설정한다.

networks:
  x-network:
    driver: bridge

 

2. Hostname 방식: 각 컨테이너에 명시적으로 hostname을 설정하여 간편하게 연결이 가능하다.

version: "3"
services:
  postgres:
    container_name: postgres_host
    hostname: postgres_host
    image: postgres:15

모든 컨테이너 종료

• 테스트가 다 끝났다면 아래 명령어를 통해 Docker Compose로 띄운 모든 컨테이너를 종료해야 한다.
• Docker Compose로 구동한 모든 컨테이너를 종료하여 자원 점유를 방지해야 한다.
  • CPU와 메모리 사용량이 많이 큼.

docker compose stop

 

 

+) 컨테이너 로그 확인

• Docker logs 명령어로 컨테이너 로그 확인:

docker logs [container_name]

• 컨테이너가 제거되면 로그도 함께 삭제되기 때문에 장기 로그는 외부 서비스(Kibana 등)에 저장하는 것이 일반적이다.

---

이렇게 해서 Spring Boot와 MySQL을 Docker를 통하여 구동(Dockerize)하고, docker-compose를 사용하여 두 개를 한 번에 구동하는 방법까지 모두 알아보았다.

 

 

ℹ️ 참고

[ASAC 6기 강의자료]