[Docker] Docker compose 개념, 문법, 예제

Docker Compose 란?

• 응집력 있는 애플리케이션으로 함께 작동하는 여러 컨테이너를 실행하려는 로컬 개발 및 테스트 환경을 위해 설계된 도구
• docker compose yaml코드는 여러 개의 docker run 실행과 유사하며 네트워크, 볼륨 등을 한번에 생성할 수 있다.
• docker compose로 생성된 컨테이너들은 독립된 네트워크로 구성되므로 컨테이너  간 통신이 쉽다.
• Docker file 작성 -> docker-compose.yml 작성 -> docker compose up
• 장점
  • 서로 다른 OS환경이라도 동일한 환경구성이 가능하다. 
  • 동일한 환경을 사용하기 때문에 개발환경에 이슈가 발생해도 팀간 소통이 쉽다.
  • 복잡한 환경도 YAML 코드로 스크립트화 할 수 있기 때문에 자동화가 가능하다.
  • docker compose CLI를 이용하여 쉽게 "멀티 컨테이너 애플리케이션"을 관리할 수 있다.
• 단점
  • 동시에 다수의 컨테이너 서비스를 수행하는 경우 자원 활용률이 순간 높아질 수 있다.

 

 

Docker compose 와 Kubernetes의 차이

 

 

Docker compose 특징

• docker compose는 여러 번의 docker cli를 실행하지 않고, 한번에 관련 애플리케이션들을 YAML파일로 구성하여 내부 환경 구성과 속성을 실행할 수 있다.
• 설정 값을 캐싱하기 때문에 재시작 시 변경이 없다면 캐싱된 정보를 그대로 사용하여 빠른 서비스 실행을 보장할 수 있다. 
• YAML 코드에 포함된 애플리케이션들은 동일 네트워크에 포함되기 때문에 복잡한 연결 구성 없이도 쉽게 API 통신이 가능하다. 

 

 

자주 쓰는 Docker compose 문법

build

mydiary-front: 
	build: 
		context: ./my-diary-front 	#Dockerfile 위치 (동일 경로면 생략 가능)
		dockerfile: Dockerfile 		#제공하는 Dockerfile 이름

container_name

• 생략 시 자동으로 부여, "디렉토리명_서비스명_n"
• docker run의 --name 옵션과 동일

 

ports

• 서비스 내부 포트와 외부 호스트 포트를 지정하여 바인드. 외부 노출 포트 지정
• docker run의 -p 옵션과 동일

 

networks

• 최상위 레벨의 networks에 정의된 네트워크 이름을 작성
• docker run의 --net(--network) 옵션과 동일

 

volumes

• 서비스 내부 디렉토리와 호스트 디렉토리를 연결하여 데이터 지속성 설정.
• docker run의 -v

 

environment

• 서비스 내부 환경 변수 설정
• 환경 변수가 많은 경우, 파일 (.env)로 만들어 지정 (env_file: ./envfile.env)

 

command

• 서비스가 구동 이후 실행할 명령어 작성
• docker run의 마지막에 작성되는 명령어

 

restart

• 서비스 재시작 옵션 지정
• docker run의 --restart 옵션과 동일

 

depends_on

• 서비스 간의 종속성을 의미.
• 먼저 실행해야 하는 서비스를 지정하여 순서 지정

 

deploy.replicas

• 해당 서비스의 복제 컨테이너 수 지정
• replica를 사용할 땐 컨테이너 이름을 지정하면 안 된다. (유일해야 하기 때문)

 

 

 

예시1 Docker compose file [Nodejs+ Spring + MySQL + Nginx] 

 

docker-compose.yml

version: '3.8'

services:
 mydiary-db:
  image: mysql:5.7-debian
  container_name: rolling-db
  environment:
   MYSQL_ROOT_PASSWORD: pass123
   MYSQL_DATABASE: paperdb
   MYSQL_ROOT_HOST: '%'
   MYSQL_USER: user
   MYSQL_PASSWORD: user
  ports:
   - '3306:3306'
  networks:
   - mydiary-net
  restart: always
  command:
   - --character-set-server=utf8
   - --collation-server=utf8_general_ci

 mydiary-back:
  build:
   context: ./my-diary-back
   dockerfile: Dockerfile
  deploy:
   replicas: 3
  restart: always
  depends_on:
   - mydiary-db
  ports:
   - '8081-8083:8080'
  environment:
   SPRING_DATASOURCE_URL: jdbc:mysql://rolling-db:3306/paperdb?serverTimezone=Asia/Seoul
   SPRING_DATASOURCE_USERNAME: user
   SPRING_DATASOURCE_PASSWORD: user
  networks:
   - mydiary-net

 mydiary-front:
  build:
   context: ./my-diary-front
   dockerfile: Dockerfile
  deploy:
   replicas: 3
  restart: always
  depends_on:
   - mydiary-back
  ports:
   - '3000-3002:3000'
  networks:
   - mydiary-net

 proxy-be:
  image: nginx:1.21.5-alpine
  container_name: rolling-server-lb
  restart: always
  depends_on:
   - mydiary-back
  ports:
   - '8080:80'
  volumes:
   - ${PWD}/proxy/nginx-be.conf:/etc/nginx/nginx.conf
  networks:
   - mydiary-net

 proxy-fe:
  image: nginx:1.21.5-alpine
  container_name: rolling-front-lb
  restart: always
  ports:
   - '80:80'
  volumes:
   - ${PWD}/proxy/nginx-fe.conf:/etc/nginx/nginx.conf
  networks:
   - mydiary-net

networks:
 mydiary-net:
  driver: bridge
  ipam:
   driver: default
   config:
   - subnet: 172.20.0.0/24
     ip_range: 172.20.0.0/24
     gateway: 172.20.0.1

 

Nginx backend conf

• 위에서 설정한 백엔드 컨테이너 service name인  "mydiray-back" 을 사용해야 한다.
• 프론트에서 트래픽을 전달받을 때 mydiary-back에다 하나씩 전달할 수 있기 때. 

events { worker_connections 1024; }
http{
    upstream mydiary-back { # upstream의 이름을 rolling-server로 설정
    server mydiary-back:8081;
    server mydiary-back:8082;
    server mydiary-back:8083;
    }
    server {
            listen *:8080 default_server; # 클라이언트가 요청하는 포트 번호
    location / {
            proxy_pass http://mydiary-back; # 설정한 upstream으로 요청 보내기
            }
    }
}

 

Nginx front conf

events { worker_connections 1024; }
http {
    upstream front-servers {
        server mydiary-front:3000;
        server mydiary-front:3001;
        server mydiary-front:3002;
    }
    server {
        listen 80 default_server;
        location / {
            proxy_pass http://front-servers;
        }
    }
}

 

 

 

 

예시2 Docker compose file [Spring+ MariaDB + Redis] 

MariaDB

• /database/Dockerfile

FROM mariadb:10

ENV TZ=Asia/Seoul

• /database/config/mariadb.cnf

[client]
default-character-set=utf8mb4

[mysql]
default-character-set=utf8mb4

[mysqld]
character-set-server=utf8mb4
collation-server=utf8mb4_unicode_ci
skip-character-set-client-handshake

[mysqldump]
default-character-set=utf8mb4

 

Redis

• /redis/Dockerfile

FROM redis:6

ENV TZ=Asia/Seoul

 

Spring

• ./Dockerfile

FROM openjdk:11
ARG JAR_FILE=build/libs/app.jar
COPY ${JAR_FILE} ./app.jar
ENV TZ=Asia/Seoul
ENTRYPOINT ["java", "-jar", "./app.jar"]

 

docker-compose.yml

• ./docker-compose.yml

version: "3.8"                                          # 파일 규격 버전
services:                                               # 이 항목 밑에 실행하려는 컨테이너들을 정의
  pharmacy-recommendation-redis:                        # 서비스명
    container_name: pharmacy-recommendation-redis       # 컨테이너 명
    build:
      dockerfile: Dockerfile
      context: ./redis
    image: dgjinsu/pharmacy-recommendation-redis
    ports:
      - "6380:6379"
  pharmacy-recommendation-database:
    container_name: pharmacy-recommendation-database
    build:
      dockerfile: Dockerfile
      context: ./database
    image: dgjinsu/pharmacy-recommendation-database
    environment:
      - MARIADB_DATABASE=pharmacy-recommendation
      - MARIADB_ROOT_PASSWORD=${SPRING_DATASOURCE_PASSWORD}
    volumes:
      - ./database/config:/etc/mysql/conf.d
      - ./database/init:/docker-entrypoint-initdb.d
    ports:
      - "3307:3306"      # 접근 포트 설정 (컨테이너 외부:컨테이너 내부)
  pharmacy-recommendation-app:
    container_name: pharmacy-recommendation-app
    build: .
    depends_on:          # DB, REDIS 컨테이너가 실행된 다음 WEB을 실행시킨다.
      - pharmacy-recommendation-database
      - pharmacy-recommendation-redis
    image: dgjinsu/pharmacy-recommendation-app
    environment:
      - SPRING_DATASOURCE_USERNAME=${SPRING_DATASOURCE_USERNAME}
      - SPRING_DATASOURCE_PASSWORD=${SPRING_DATASOURCE_PASSWORD}
      - SPRING_PROFILES_ACTIVE=${SPRING_PROFILES_ACTIVE}
      - KAKAO_REST_API_KEY=${KAKAO_REST_API_KEY}
    ports:
      - "80:8080"
    restart: always # depends on은 실행 순서만 컨트롤 할뿐,
      # 컨테이너 안의 서비스가 실행가능한 상태인지까지는 확인 하지 않기 때문에
    # DB 또는 Redis가 아직 실행가능한 상태가 아니여서 실패하는 경우 재시작 하도록 설정