Skip to content

Latest commit

 

History

History
293 lines (192 loc) · 7.93 KB

dockerfile_pattern.md

File metadata and controls

293 lines (192 loc) · 7.93 KB

Dockerfile 작성 패턴

Dockerfile 문법을 설명하는 자료는 많지만, Dockfile을 쉽게 작성하는 방법은 찾기 어렵습니다.

Dockerfile을 작성하려면

  • Dockerfile 문법
  • Linux 명령, 파일 시스템, 유저, 패키지 라이브러리
  • 설치하고자하는 애플리케이션

에 대한 지식들이 필요합니다.

도커 파일 작성에는 패턴이 있습니다.

제가 주로 ROS를 다루는 이유로 Ubuntu 기준으로 작성합니다.

시험용 Ubuntu

Dockerfile을 수정 및 빌드해가며 오류를 찾아내기도 하지만 오히려 시간이 걸리는 경우가 있습니다. 컨테이너의 셸에서 설치해가며 관련 패키지 의존성을 확인하면 더 쉽게 푸는 경우도 있습니다.

다음과 같이 짧은 Dockerfile로 우분투 이미지를 만들고 실행합니다.

FROM ubuntu:20.04

ENTRYPOINT ["/bin/bash"]

그리고 빌드하고:

$ docker build . -t myubuntu

실행합니다:

$ docker run -it myubuntu

컨테이너가 올라오며 컨테이너의 bash로 들어가게 되고 리눅스 명령을 사용할 수 있게 됩니다.

여기에서 의존성을 설치하며 테스트 할 수 있습니다. 확정이 되면 변경 사항을 Dockerfile에 기록 하고, 컨테이너 셸에서 Ctrl+C를 눌러서 컨테이너를 종료하고 다시 컨테이너를 시작합니다.

FROM ubuntu:20.04

<<< 변경 사항은 이 사이에 추가 될 것입니다.

ENTRYPOINT ["/bin/bash"]

변경사항을 다시 build하고 run하여 Dockerfile을 완성해 갑니다.

마지막으로 설치가 완료되면 ENTRYPOINT가 애플리케이션을 가리키도록 하면 bash가 시작되지 않고 해당 애플리케이션이 실행 될 것입니다.

Dockerfile 패턴

Dockerfile 작성 패턴은 몇개 부분으로 나눌 수 있습니다.

  • 베이스 이미지
  • 작업 디렉토리
  • 사용자 계정
  • 패키지 라이브러리 설치
  • 소스코드 다운로드 및 빌드
  • 네트워크 구성
  • 진입점 명령 선언

베이스 이미지

만들려는 컨테이너 이미지의 기반이 되는 이미지를 지정합니다.

이 예제는 Ubuntu 20.04로 합니다:

FROM ubuntu:20.04

사용자 계정

WORKDIR은 컨테이너 이미지 내의 현재 디렉토리를 지정합니다. 디렉토리가 없으면 빌드 시스템이 컨테이너 이미지의 디렉토리를 새로 만듭니다.

다음은 root 계정으로 전환합니다.

USER root

이것은 리눅스 명령:

$ su -

와 동일합니다. 하지만,

보안 문제로 root 계정으로 애플리케이션을 설치하는 것은 권장 되지 않으며, 많은 경우 애플리케이션 소스코드들이 root계정으로 빌드 및 설치가 되지 않습니다. 그래서 사용자 계정을 만들어야 합니다.

다음은 appuser라는 사용자 계정과 홈 디렉토리를 생성하는 패턴입니다. 어느 컨테이너 이미지의 경우 USERNAME 환경변수가 이미 정의된 경우가 있습니다. 여기서는 USER_NAME이라는 변수로 합니다:

ARG USER_NAME=appuser
ARG USER_ID=1000
ARG GROUP_ID=1000
RUN groupadd ${USER_NAME} --gid ${USER_ID}\
    && useradd -l -m ${USER_NAME} -u ${USER_ID} -g ${USER_ID} -s /bin/bash

사용자 계정이 만들어지면 사용자 계정으로 전환이 가능 합니다:

USER $USER_NAME

데비안 패키지 설치

데비안 패키지를 설치하는 경우 대화 모드가 되어 Dockerfile 빌드가 중단되는 경우가 있습니다. 이를 방지하고 설치하는 패턴입니다. 데비안 패키지는 root 권한이 필요하므로 root 계정으로 설치 합니다:

ARG DEBIAN_FRONTEND=noninteractive

데비안 패키지를 설치 합니다:

USER root

ARG DEBIAN_FRONTEND=noninteractive

RUN apt update --no-install-recommends \
    && apt upgrade --no-install-recommends -y \
    && apt-get install --no-install-recommends -y \
    build-essential \
    git \
    ca-certificates \
    lsb-release \
    sudo \
    tzdata \
    bash-completion \    
    .... \
    python3 \
    python3-pip \
    python3-setuptools \
    python3-wheel

USER root로 하였는데 root 권한 -sudo 명령이 필요한 경우 USER root를 통해 root 계정으로 전환한 후에 해당 작업을 합니다.

파이썬 패키지 설치

파이썬 패키지를 설치합니다. 이전에 root 계정으로 전환 되었으면 반복할 필요는 없습니다.

USER root

RUN pip3 install numpy

일반 사용자 계정에 sudo 권한 부여

보안 문제로 root 계정으로 애플리케이션을 설치하는 것은 권장 되지 않으며, 경우에 따라 빌드 및 설치가 되지 않습니다. 그래서, 일반 사용자 계정으로 설치하고 sudo 권한을 부여하는 패턴 입니다. 유저에게 sudo 권한을 부여하려면 sudo 데비안 패키지가 사전에 설치되어 있어야 합니다:

RUN apt install --no-install-recommends -y sudo

USER root

ENV USER=${USER_NAME}
RUN echo "$USER_NAME ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/${USER_NAME}
RUN chmod 0440 /etc/sudoers.d/${USER_NAME}

디렉토리를 일반 유저 소유로 변경

USER root

RUN chown -R ${USER_NAME}:${USER_NAME} /app

일반 사용자 계정으로 전환

USER ${USER_NAME}

애플리케이션 디렉토리를 만들고 사용자 계정 권한 부여

사용자 계정으로 컨테이너에 app디렉토리를 만들고 사용자 계정 권한을 부여 합니다.

USER ${USER_NAME}

RUN sudo mkdir -p /app && sudo chmod -R 777 /app

작업 디렉토리

WORKDIR은 컨테이너안에서 작업할 디렉토리를 지정합니다. 디렉토리가 없으면 빌드시스템이 디렉토리를 새로 만듭니다.

이 아래는 컨테이너의 /app 디렉토리로 변경 합니다.

WORKDIR /app

작업 디렉토리는 언제라도 변경 할 수 있습니다. 예컨데:

WORKDIR /app/scripts

/app/script스크립트 폴더를 생성하거나 이동하여 작업을 합니다.

파일 복사

호스트에서 컨테이너 이미지로 파일을 복사가 필요한 경우도 있습니다.

WORKDIR /app

COPY <srcfile> <destfile>

소스코드 클론 및 서브 모듈 설치

어느 경우 소스 저장소에서 파일을 클론합니다:

WORKDIR /app

RUN git config --global http.postBuffer 1048576000
RUN git clone https://github.com/clone/these .
RUN git checkout v1.2.3 -b mine/v1.2.3
RUN git submodule update --init --recursive

소스코드 빌드

소스코드 빌드는 애플리케이션마다 다르므로 다루지 않겠습니다. 다만, 일반 유저로 빌드해야 합니다:

USER ${USER_NAME}

...  빌드

데비안 임시 파일 삭제

# Cleanup
RUN sudo apt-get clean \
    && sudo rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

네트워크 리슨 포트 노출

EXPOSE xxxxx
EXPOSE yyyyy

환경 변수 및 진입점 스크립트 생성

환경 변수 및 진입 스크립트를 작성합니다.

RUN echo "if [ -d \"\$HOME/.local/bin\" ] ; then\nPATH=\"\$HOME/.local/bin:\$PATH\"\nfi" >> ~/app_entrypoint.sh

RUN export APP_ENTRYPOINT="/home/${USER_NAME}/app_entrypoint.sh" \
    && echo "#!/bin/bash" > $APP_ENTRYPOINT \
    && echo "set -e" >> $APP_ENTRYPOINT \
    && echo "source /home/${USER_NAME}/.app_env" >> $APP_ENTRYPOINT \
    && echo 'exec "$@"' >> $APP_ENTRYPOINT \
    && chmod +x $APP_ENTRYPOINT \
    && sudo mv $APP_ENTRYPOINT /app_entrypoint.sh

진입점 명령 선언

컨테이너 시작시 실행할 스크립트와 명령을 지정합니다:

ENV CCACHE_MAXSIZE=1G
ENTRYPOINT ["/app_entrypoint.sh"]
CMD ["bash"]

참조