[Docker] docker-compose에서 links와 depends_on의 차이점

💡 본 문서는 'docker-compose에서 links와 depends_on의 차이점'에 대해 정리해놓은 글입니다.
Docker 컨테이너는 시스템에서 격리된 프로세스로 실행됩니다. 이때 Docker에서 지원하는 프로세스간 통신하기 위한 방법인 links와 depends_on에 대해 정리하였으니 참고하시기 바랍니다.

1. docker-compose에서 links와 depends_on의 차이점

1.1 docker-compose: depends_on

depends_on 은 서비스가 시작되고 중지되어야 하는 순서를 설정하는 Docker Compose 키워드입니다.

예를 들어 웹 앱 이미지로 구축할 웹 애플리케이션이 Postgres 컨테이너 이후에 시작되기를 원한다고 가정합니다. docker-compose.yml 파일 을 살펴보겠습니다 .

services:
  db:
    image: postgres:latest
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
    ports:
      - 5432:5432
  web-app:
    image: web-app:latest
    ports:
      - 8080:8080
    depends_on:
      - db

Docker는 이미지를 가져오고 지정된 종속성에 따라 컨테이너를 실행합니다. 따라서 이 경우 Postgres 컨테이너가 대기열에서 가장 먼저 실행됩니다.

그러나 depends_on 은 종속성이 준비될 때까지 명시적으로 기다리지 않기 때문에 제한이 있습니다.

웹 애플리케이션이 시작할 때 일부 마이그레이션 스크립트를 실행해야 한다고 상상해 봅시다. 데이터베이스가 연결을 허용하지 않으면 Postgres 서비스가 올바르게 시작되었지만 스크립트를 실행할 수 없습니다.

그러나 특정 도구나 자체 관리 스크립팅을 사용하여 시작 또는 종료 순서를 제어하면 이를 피할 수 있습니다 .

1.2 docker-compose: links

links 는 Docker가 네트워크를 통해 컨테이너를 연결하도록 지시합니다. 컨테이너를 연결할 때 Docker는 환경 변수를 만들고 컨테이너를 알려진 호스트 목록에 추가하여 서로를 검색할 수 있도록 합니다.

Postgres 컨테이너를 실행하는 간단한 Docker 예제를 확인하고 이를 웹 애플리케이션에 연결합니다.

먼저 Postgres 컨테이너를 실행해 보겠습니다.

$ docker run -d --name db -p 5342:5342 postgres:latest

그런 다음 웹 애플리케이션에 연결합니다.

$ docker run -d -p 8080:8080 --name web-app --link db

예제를 Docker Compose로 변환해 보겠습니다.

services:
  db:
    image: postgres:latest
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
    ports:
      - 5432:5432
  web-app:
    images: web-app:latest
    ports:
      - 8080:8080
    links:
      - db

1.3 docker-compose: network

아직 사용 중인 Docker links 를 찾을 수 있으나, Docker Compose는 버전 2부터 docker network 도입으로 인해 더 이상 사용되지 않습니다.

이러한 방식으로 애플리케이션을 복잡한 네트워킹(예: overlay network)과 연결할 수 있으며, 일반적으로 네트워크를 지정하지 않을 때 bridge network를 기본값으로 사용할 수 있습니다.

 데이터베이스에 대한 볼륨 및 환경 변수를 추가하면서 links를 제거 하고 network로 교체해 보겠습니다.

services:
  db:
    image: postgres:latest
    restart: always
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
    ports:
      - 5432:5432
    volumes: 
      - db:/var/lib/postgresql/data
    networks:
      - mynet

  web-app:
    image:web-app:latest
    depends_on:
      - db
    networks:
      - mynet
    ports:
      - 8080:8080
    environment:
      DB_HOST: db
      DB_PORT: 5432
      DB_USER: postgres
      DB_PASSWORD: postgres
      DB_NAME: postgres

networks:
  mynet:
    driver: bridge

volumes:
  db:
    driver: local

2. 결론: links 와 depends_on 의 차이점

종속성 표현이 포함되지만 Docker links 와 depends_on 은 다른 의미를 갖습니다.

• depends_on: Docker에게 컨테이너 실행 순서(서비스가 시작되고 중지되어야 하는 순서)를 알려줍니다.
• links 또는 networks: 네트워크를 통해 컨테이너에 대한 연결을 설정합니다.

참고

[Blog] Difference Between links and depends_on in Docker Compose: https://www.baeldung.com/ops/docker-compose-links-depends-on