[Docker] ENTRYPOINT와 CMD의 관계

ENTRYPOINT와 CMD의 관계

Dockerfile에서 자주 사용되는 ENTRYPOINT와 CMD 명령어의 관계와 사용법에 대해 자세히 알아보겠습니다. 이 두 명령어는 컨테이너가 시작될 때 실행될 명령어를 정의하는 데 사용되지만, 그 동작 방식과 목적에 차이가 있습니다. 또한, shell 형식과 exec 형식에 대한 이해도 중요합니다. 이 글에서는 이러한 개념들을 명확하게 이해하고 효과적으로 활용할 수 있도록 도와드리겠습니다.

---

Shell 형식과 Exec 형식

Dockerfile에서 명령어를 작성할 때 shell 형식과 exec 형식 두 가지 방식이 있습니다. 이 두 형식은 명령어를 실행하는 방식에 차이가 있으며, 이를 이해하는 것이 중요합니다.

Shell 형식

Shell 형식은 터미널에서 직접 명령어를 입력하는 것과 유사하게 작성하는 방식입니다. 단일 문자열로 명령어를 작성하며, 쉘을 통해 실행됩니다.

RUN npm ci \
    && npm run build

 

특징

• 쉘 프로세스를 통해 실행됩니다.
• 환경 변수 치환 및 쉘 기능(예: 파이프, 리디렉션)을 사용할 수 있습니다.
• 쉘을 통해 명령어가 실행되므로 PID 1로 쉘이 실행됩니다.

Exec 형식

Exec 형식은 JSON 배열 형태로 명령어와 그 인자를 명확하게 구분하여 작성하는 방식입니다. 쉘을 사용하지 않고 직접 명령어를 실행합니다.

ENTRYPOINT ["npm", "run", "start"]

 

특징

• 쉘을 사용하지 않고 직접 실행되므로 쉘 프로세싱이 일어나지 않습니다.
• PID 1로 지정된 명령어가 실행됩니다.
• 환경 변수 치환이 자동으로 이루어지지 않습니다.

주의사항: Exec 형식으로 작성할 때는 작은따옴표(')가 아닌 반드시 큰 따옴표(")를 사용해야 합니다.

---

RUN vs CMD vs ENTRYPOINT

Dockerfile에서 RUN, CMD, ENTRYPOINT는 모두 명령어를 실행하는 데 사용되지만, 그 시점과 목적이 다릅니다.

RUN 명령어

• 용도: 이미지를 빌드할 때 실행할 명령어를 정의합니다.
• 시점: docker build 과정 중에 실행됩니다.
• 예시: RUN npm ci \ && npm run build
• 특징:
  • 이미지 레이어를 생성하며, 빌드 시점에 필요한 파일을 설치하거나 설정할 때 사용합니다.
  • 컨테이너 실행 시에는 영향을 미치지 않습니다.

CMD 명령어

• 용도: 컨테이너가 시작될 때 기본적으로 실행할 명령어를 정의합니다.
• 시점: docker run 시점에 실행됩니다.
• 예시: CMD ["echo", "Welcome to kakao."]
• 특징:
  • 컨테이너 실행 시 기본 명령어를 설정하며, docker run 명령어에서 명령어를 덮어쓸 수 있습니다.
  • 단일 명령어 또는 배열 형식으로 작성할 수 있습니다.

ENTRYPOINT 명령어

• 용도: 컨테이너가 시작될 때 반드시 실행해야 하는 명령어를 정의합니다.
• 시점: docker run 시점에 실행됩니다.
• 예시: ENTRYPOINT ["npm", "run", "start"]
• 특징:
  • CMD와 유사하지만, ENTRYPOINT는 덮어쓸 수 없고 항상 실행됩니다.
  • Exec 형식으로 작성하는 것이 일반적입니다.

---

CMD vs ENTRYPOINT

CMD와 ENTRYPOINT는 컨테이너가 시작될 때 실행할 명령어를 정의하는 데 사용되지만, 그 동작 방식에 차이가 있습니다.

CMD

• 유연성: docker run 명령어에서 명령어를 덮어쓸 수 있습니다.
• 용도: 기본 명령어 또는 인자를 설정할 때 사용됩니다.
• 예시

  docker container run myimage echo "Learn to love learning."
  # 출력: Learn to love learning.
  

• CMD ["echo", "Welcome to Codeit."]

ENTRYPOINT

• 고정성: docker run 명령어에서 덮어쓸 수 없으며, 항상 실행됩니다.
• 용도: 컨테이너의 주된 기능을 실행할 때 사용됩니다.
• 예시

  docker container run myimage
  # 항상 'npm run start'가 실행됩니다.
  

• ENTRYPOINT ["npm", "run", "start"]

함께 사용하기

CMD와 ENTRYPOINT를 함께 사용하면, CMD는 ENTRYPOINT의 인자로 작동하게 됩니다.

FROM ubuntu
CMD ["Kakao"]
ENTRYPOINT ["echo", "Welcome To "]

docker container run myimage Seoul
# 출력: Welcome To Seoul

docker container run myimage Busan
# 출력: Welcome To Busan

• 장점: ENTRYPOINT는 고정된 명령어를 실행하면서, CMD를 통해 유연하게 인자를 전달할 수 있습니다.
• 주의사항: ENTRYPOINT와 CMD의 조합을 이해하고 적절히 사용해야 합니다.

---

CMD의 또 다른 기능

CMD는 ENTRYPOINT와 함께 사용할 때 추가적인 기능을 제공합니다. CMD는 ENTRYPOINT에서 실행할 명령어의 파라미터 역할을 합니다.

예시

FROM ubuntu
CMD ["Kakao"]
ENTRYPOINT ["echo", "Welcome To "]

docker container run myimage Seoul
# 출력: Welcome To Seoul

docker container run myimage Busan
# 출력: Welcome To Busan

• 동작 방식:
  • ENTRYPOINT는 항상 실행되며, CMD는 그 인자로 전달됩니다.
  • docker run 명령어에서 CMD를 재정의하면, ENTRYPOINT의 인자로 새로운 값을 전달할 수 있습니다.

Tip: CMD를 사용하여 기본 인자를 설정하고, 필요에 따라 덮어쓸 수 있도록 설계하면 유연한 Docker 이미지를 만들 수 있습니다.

---

ENV와 ARG 사용 시 유의사항

Dockerfile에서 ENV와 ARG는 변수를 선언하고 사용하는 데 중요한 역할을 합니다. 그러나 이 두 명령어는 사용 목적과 범위가 다르므로 올바르게 이해하고 사용하는 것이 중요합니다.

ENV와 ARG 비교

특징	ENV	ARG
용도	컨테이너 실행 시 환경 변수 설정	이미지 빌드 시 변수 설정
시점	컨테이너 실행 시	이미지 빌드 시
재정의 가능성	docker run -e 옵션으로 재정의 가능	docker build --build-arg 옵션으로 재정의 가능
생명주기	이미지 빌드 시점부터 컨테이너 실행 후까지	이미지 빌드 시점 동안만 유효
기본값 설정	반드시 기본값을 초기화해야 함	기본값을 지정하지 않아도 됨

사용 예시

ENV

ENV PORT=3000

• 용도: 애플리케이션이 실행될 때 필요한 환경 변수를 설정할 때 사용됩니다.
• 재정의: docker run -e PORT=4000과 같이 실행 시점에 재정의할 수 있습니다.

ARG

ARG NODE_VERSION=20.15.1

• 용도: 이미지 빌드 시 특정 버전의 Node.js를 설치할 때 사용됩니다.
• 재정의: docker build --build-arg NODE_VERSION=14.17.0 .과 같이 빌드 시점에 재정의할 수 있습니다.

변수 참조 팁

Dockerfile에서 변수를 참조할 때는 ${VARIABLE} 형식을 사용하는 것이 좋습니다. 이는 변수와 문자열을 명확하게 구분할 수 있게 해주며, 변수 값이 없을 때 기본값을 설정하는 데 유용합니다.

예시

ENV VARIABLE=Hello
RUN echo "$VARIABLE_World"       # 출력: My name is ${VARIABLE}
RUN echo "${VARIABLE}_World"     # 출력: Hello_World

FROM ubuntu
ENV MY_NAME=Ryan
ENTRYPOINT ["echo", "My name is ${MY_NAME}"]
# 출력: My name is Ryan

# 잘못된 예시
ENTRYPOINT ["echo", "My name is $MY_NAME"]
# 출력: My name is ${MY_NAME}

 

장점

• 변수와 문자열이 명확하게 구분됩니다.
• 조건부 값을 설정할 수 있습니다.

조건부 변수 설정

ENV GREETING=${NAME:-Hi}

• 설명: NAME 변수가 설정되어 있으면 그 값을 사용하고, 그렇지 않으면 Hi를 사용합니다.

FROM ubuntu
ENV GREETING=${NAME:-Hi}
CMD ["echo", "${GREETING}, Welcome!"]

docker container run myimage
# 출력: Hi, Welcome!

docker container run -e NAME=Kakao myimage
# 출력: Kakao, Welcome!

 

---

Dockerfile 작성 팁

Dockerfile을 작성할 때는 ENTRYPOINT와 CMD의 올바른 사용법을 숙지하는 것이 중요합니다.

다음은 Dockerfile 작성 시 유용한 팁입니다.

1. ENTRYPOINT는 Exec 형식으로 작성

ENTRYPOINT는 고정된 명령어를 실행할 때 사용하므로, Exec 형식(["executable", "param1", "param2"])으로 작성하는 것이 좋습니다. 이는 쉘 프로세싱을 피하고, 컨테이너의 PID 1로 지정된 프로세스가 SIGTERM 시그널을 직접 받을 수 있게 해줍니다.

ENTRYPOINT ["npm", "run", "start"]

2. CMD는 기본 인자를 설정할 때 사용

CMD는 ENTRYPOINT의 인자를 설정하거나, 기본 명령어를 설정할 때 사용됩니다. Exec 형식으로 작성하여 일관성을 유지합니다.

CMD ["--help"]

3. RUN은 빌드 시점의 설정에 사용

RUN 명령어는 이미지 빌드 시 필요한 패키지 설치나 설정 작업에 사용됩니다.

RUN apt-get update && apt-get install -y curl

4. ENV와 ARG의 적절한 사용

• ENV: 컨테이너 실행 시 필요한 환경 변수를 설정할 때 사용합니다.
• ARG: 이미지 빌드 시 필요한 변수를 설정할 때 사용합니다.

---

참고 자료

• Dockerfile 공식 문서: https://docs.docker.com/engine/reference/builder/
• Docker Compose 공식 문서: https://docs.docker.com/compose/
• Docker Volume CLI Reference: Docker Volume Commands
• Docker Networking Best Practices: Networking Best Practices
• Docker Bind Mounts vs Volumes: Bind Mounts vs Volumes
• Docker ENV vs ARG: ENV vs ARG