[Docker] Dockerfile 정리: Docker image를 생성하자 (feat. Docker 커멘드)

💡 본 문서는 'Dockerfile'에 대해 정리해놓은 글입니다.
만들어진 Docker 이미지를 찾는 과정, Dockerfile을 작성하고 이미지를 빌드하는 과정, 이미지를 공유하는 과정 등 기초적인 도커에 대해 다룬 내용이니 참고하시기 바랍니다.

1. Dockerfile 에 대하여

1.1 Dockerfile이란?

Docker File이란 Docker Image를 만들기 위한 설정 파일입니다. 이 파일내에 작성된 인스트럭션들을 참조하여 Docker File을 작성하면, 설정된 내용대로 Docker Image를 만들어집니다.

1.2 Docker 이미지 사용하기

1.2.1 Docker 이미지 찾아보기

앞서 설명했듯이 Docker Image를 만들기 위해서 직접 Dockerfile을 작성하고 빌드하여 이미지를 생성할 수 있습니다. 하지만 보편적으로 사용하는 이미지나 특정 유명 오픈소스를 실행시키기 위한 pre-request 과정으로 수행되는 환경 구성의 경우 이미 만들어진 이미지가 있을 수 있으니 반드시 다음의 명령어로 찾아보고 Dockerfile를 작성하시기 바랍니다.

$ docker search nginx
NAME				DESCRIPTION                	STARS     OFFICIAL   AUTOMATED
nginx				Official build of Nginx.   	17430     [OK]       
linuxserver/nginx		An Nginx container…   		178                  
...

• NAME: 검색된 이미지의 이름입니다. 공식 이미지를 제외한 나머지는 '레지스트리 주소/저장소 소유자/이미지 이름' 형태입니다.
• DESCRIPTION: 이미지에 대한 설명입니다.
• STARS: 해당 이미지를 내려받는 사용자에게 받는 평가 횟수입니다.
• OFFICIAL: [OK] 표시는 해당 이미지에 포함된 애플리케이션, 미들웨어 등을 개발한 업체에서 공식적으로 제공한 이미지라는 의미입니다.
• AUTOMATED: [OK] 표시는 도커 허브에서 자체적으로 제공하는 이미지 빌드 자동화 기능을 활용해 생성한 이미지를 의미합니다.

1.2.2 Docker 이미지 내려받기

원하는 이미지가 있다면 다음의 명려어를 통해 이미지를 받을 수 있습니다.

$ docker pull nginx

search로 확인시 대부분의 이미지가 있을 것입니다. 간혹 없거나 직접 커스텀해야하는 경우 Dockerfile을 작성하여 진행하면 됩니다.

1.3 Dockerfile 작성 및 실행하기

1.3.1 Dockerfile 작성

기본으로 Dockerfile 이라는 이름을 사용합니다. Dockerfile에 대한 세부적인 작성 내용은 하단의 '2. Dockerfile 작성하기'에서 소개하겠습니다.

$ touch Dockerfile

1.3.2 Docker 이미지 생성: docker build

Dockerfile이 위치한 디렉토리에서 아래의 명령어를 실행하면, 1.0이라는 버전을 가진 docker_name이라는 새로운 도커 이미지를 생성합니다. Dockerfile이 아닌 다른 이름의 파일을 빌드시에는 추가 옵션(-f)을 줘서 지정해주어야 합니다.

$ docker build --tag docker_name:1.0 .

docker build 명령어는 도커 데몬에 빌드 컨텍스트를 전송합니다. 이때 빌드 컨텍스트란 빌드를 실행할 때 사용할 파일 집합이며, 빌드 명령을 실행하는 디렉토리와 그 하위 디렉토리에 포함된 전체 파일이다.

빌드 컨텍스트에는 COPY나 ADD에서 사용하지 않는 파일도 포함되므로 빌드 컨텍스트에는 필요한 파일만 포함해야 합니다. 부득이하게 빌드 과정에서 사용하지 않는 파일이 존재할 경우 .dockerignore 파일을 만들어 컨텍스트에서 제외할 대상을 지정하면 됩니다.

1.3.3 Docker 이미지 실행하기: docker container 띄우기

중요한 점: 명령을 입력할 때, 모든 옵션을 선언한 후에 이미지를 적어주어야 합니다. 

$ docker run -dit --name docker_name docker_name:1.0

• 위 명령은 docker_name:1.0 이미지를 docker_name이라는 이름으로 백그라운드 컨테이너를 띄워달라는 의미입니다.

추가 옵션 정리

Option	Description
-i --interactive	컨테이너의 표준 입력(stdin)을 활성화. (주로 -it 함께 사용)
-t --tty	tty(가상 터미널)을 할당. 리눅스에 키보드를 통해 표준 입력(stdin)을 전달할 수 있게한다. (주로 -it 함께 사용)
--name	컨테이너 이름을 지정.
-d --detach	컨테이너를 백그라운드로 실행.
--rm	docker run 명령어가 끝나면, 컨테이너 자동 삭제.
-p --publish	호스트와 컨테이너의 포트를 연결 (포트포워딩). -p <호스트 포트>:<컨테이너 포트> ex) -p 80:8888  - 호스트에 8888로 접속하면, 컨테이너 내부의 80포트로 자동 접속.
-v --volume	호스트와 컨테이너의 디렉토리 연결(마운트) -v <호스트 절대경로>:<컨테이너 절대경로> ex) -v /Users:/usr. - 컨테이너 /usr에 저장하는 파일은 호스트의 /Users 디렉토리에 저장.
--restart	컨테이너 종료시, 재시작 정책 설정 --restart="always" : 항상 재시작 --restart="on-failure" : 종료 스테이터스가 0이 아닐 때 재시작 * --rm 옵션과 --restart 옵션은 동시에 사용할 수 없습니다.
--privileged	컨테이너 안에서 호스트의 리눅스 커널 기능을 모두 사용

• 추가 옵션이 많거나 한번에 여러 이미지를 띄우고 싶다면, docker compose에 대해서 공부해보는 것을 추천합니다.
• docker compose에 대한 자세한 내용은 [Docker] docker compose 정리 (feat. docker-compose.yml)를 참고하시기 바랍니다.
• 추가로, privileged 설정을 안해줘서... 문제 생긴 적이 있어 관련 내용은 [Docker] Privileged Container에 대하여에 따로 정리했으니 참고하시기 바랍니다.^^

1.3.4 Docker 내부 파일 공유하기: docker cp로 로컬, 컨테이너 간 파일 공유

1) 컨테이너 안에 있는 파일을 로컬로 복사

$ docker cp tmp_container:/root/data/test.md ~/data/

2) 로컬의 파일을 컨테이너 안으로 복사

$ docker cp ~/data/test.md tmp_container:/root/data/

 

2. Dockerfile 작성하기

2.1 Dockerfile 작성하기: 주요 지시자 소개

Dockerfile 내 주요 지시자로는 아래와 같은 것들이 있습니다.

FROM	해당 도커 이미지의 바탕이 될 베이스 이미지를 지정
WORKDIR	이미지 내부에서 COPY, RUN, CMD, ENTRYPOINT의 명령이 실행될 디렉터리를 설정
COPY	호스트 머신의 파일이나 디렉터리를 도커 컨테이너 안으로 복사
ADD	기본적인 기능은 COPY와 동일하고, 압축을 푸는 등 추가기능이 더 있습니다.
VOLUME	디렉터리의 내용을 컨테이너에 저장하지 않고 호스트에 저장하도록 설정
RUN	이미지가 빌드될 때 1번만 실행되는 명령어를 정의
CMD	이미지가 컨테이너화 될 때(실행될 때)마다 실행되는 명령어를 정의
EXPOSE	이미지의 해당 포트를 외부로 개방
ENTRYPOINT	ENTRYPOINT를 입력하면 CMD에 전달된 인자들은 전부 ENTRYPOINT의 인자로 전달
LABEL	이미지를 만든 사람의 이름 등을 명시
ENV	도커 안에서 사용할 환경 변수를 지정
ARG	이미지 빌드할 때 사용할 변수를 정의

하단의 'Dockerfile 작성하기: 지시자 용례 및 자세한 설명'에서 예시를 통해 더욱 자세하게 소개하겠습니다.

2.2 Dockerfile 작성하기: 지시자 용례 및 자세한 설명

FROM

해당 도커 이미지의 바탕이 될 베이스 이미지를 지정하는 인스트럭션입니다.

FROM centos:centos8

centos는 이미지명이며, centos8는 태그명입니다.
현재 이미지를 가지고 있지 않거나 레지스트리(regestry)를 따로 지정하지 않으면, docker hub에서 이미지를 가져옵니다.

WORKDIR

Docker 이미지 내부에서 COPY, RUN, CMD, ENTRYPOINT의 명령이 실행될 디렉터리를 설정합니다.

WORKDIR /workdir

COPY

호스트 머신의 파일이나 디렉터리를 도커 컨테이너 안으로 복사하는 인스트럭션입니다.
이미지가 빌드될 때 1번만 실행되는 명령어입니다.

COPY . /workdir

현재 디렉터리에 있는 파일들을 이미지 내부 /workdir 디렉터리에 추가합니다(절대 경로를 옵션으로 주어 해당 디렉토리에 복사할 수 있습니다.).

ADD

ADD pinpoint-agent-1.8.4.tar.gz /workdir

기본적인 기능은 COPY와 동일하고, 아래의 기능이 추가로 더 있습니다.

• source가 remote URL 이면 다운받은 뒤 destination 에 복사합니다.
• source가 잘 알려진 압축파일 형식이면(tar, zip 등) 압축을 풀어줍니다.
• source가 remote URL + 압축파일 형식이면 압축을 풀지 않습니다.

아무래도 위와 같이 특수한 상황이 아니라면 COPY를 쓰는게 가독성에 좋습니다.

VOLUME

VOLUME은 디렉터리의 내용을 컨테이너에 저장하지 않고 호스트에 저장하도록 설정합니다. 

VOLUME 명령으로는 데이터 볼륨을 생성할 수 있으며, 이를 데이터 볼륨을 호스트의 특정 디렉터리와 연결하려면? (bind mount)

• docker run 명령에서 -v 옵션을 사용하거나,
  
  • ex) -v /home/sjchoi/package:/workdir
• docker-compose.yml 파일에 설정해주어야 합니다.
  • ex) volumes: /home/sjchoi/package:/workdir

RUN

도커 이미지를 실행할 컨테이너 안에서 실행할 명령어를 정의합니다.
이미지가 빌드될 때 1번만 실행되는 명령어이며, 주로 환경세팅하거나 설치할 때 사용합니다.

RUN sudo apt-get update

CMD

도커 이미지를 실행할 컨테이너 안에서 실행할 명령어를 정의합니다.
이미지가 컨테이너화 될 때(실행될 때)마다 실행되는 명령어입니다.
주의: CMD는 Dockerfile 내 하나만 작성할 수 있습니다.

작성법이 조금 특이한데, 총 3가지 작성법을 제공합니다

• CMD command param1 param2 […]
  • FROM 으로 설정한 이미지에 포함된 쉘 파일을 사용하여 명령을 실행합니다.
  • 쉘 스크립트 구문을 사용할 수 있습니다.
• CMD [“executable”, “param1”, “param2” [, …]]
  • 도커에서 권장하는 형태이며, 쉘 없이 바로 실행하면서 매개변수를 던져주는 형태입니다.
  • 쉘 스크립트 구문을 사용할 수 없습니다
    
    • CMD ["echo", "Hello, name"]
      $ Hello, name
  • 만약 쉘 스크립트를 사용하고 싶다면 쉘을 실행시키면서 인자로 전달해줘야 합니다.
    • CMD ["/bin/bash", "-c", "echo Hello, $name"]
• CMD [“param1”, “param2” [, …]]
  • ENTRYPOINT에 지정된 명령에 사용할 인자를 전달합니다.

EXPOSE

expose는 호스트OS에 포트를 공개하지 않고, 컨테이너만 포트를 공개 합니다. 호스트OS와 직접 연결되지 않고 링크 등으로 연결된 컨테이너-컨테이너간의 통신만이 필요한 경우 등에 사용 됩니다. 물론, EXPOSE로 지정되어 있다고 해서 해당 포트로 접근이 가능하거나 한 것은 아니며, 컨테이너를 실행할 때 해당 포트를 매핑(포트포워딩)시켜야 한다.

EXPOSE 3000 4000

ENTRYPOINT

CMD와 마찬가지로 컨테이너 안에서 실행될 프로세스(명령)를 지정하는 인스트럭션입니다.
ENTRYPOINT를 입력하면 CMD에 전달된 인자들은 전부 ENTRYPOINT의 인자로 전달됩니다.

이를 아래와 같이 사용해서 컨테이너의 용도를 어느정도 제한 할 수 있습니다.

FROM golang:1.10

ENTRYPOINT ["go"]
CMD [""]

해당 컨테이너에 입력하는 명령어의 경우 자동으로 go 가 입력된 상태가 됩니다.
따라서 go 이후의 명령어만 인자로 넘기면 됩니다.

$ docker container run gotest:latest version
$ go version go1.10.3 linux/amd64 # 출력

LABEL

이미지를 만든 사람의 이름 등을 적을 수 있습니다. 

LABEL email="dhslrl321@gmial.com"
LABEL name="jang"
LABEL version="1.0"
LABEL description="My Spring Application?"

• 비슷한 기능을 하는 MAINTAINER 명령어의 경우, 이제 더 이상 사용되지 않게 되었습니다(deprecated).

ENV

도커 안에서 사용할 환경 변수를 지정합니다.

ENV WORKPATH=/home/workdir

ARG

이미지 빌드할 때 사용할 변수를 정의하여 사용할 수 있습니다. 
따라서 컨테이너 생성시에 클래스패스를 바꾸는 것은 불가능합니다.

ARG classpath=.
ENV CLASSPATH=${classpath}

CMD ["java", "Main"]

외부에서 환경변수를 전달 받을수도 있다
--build-arg를 통해 인자를 전달한다

$ docker image build --build-arg classpath=/workapce/javatest -t javatest:latest .​

 

3. Dockerfile 공유하기

3.1 Dockerfile 공유하기: docker hub

이미지를 생성하면 도커 리포지토리를 이용해서 공유할 수 있습니다. 다양한 도커 리포지토리가 존재하는데 이 중 대표적인 것이 docker hub입니다. https://hub.docker.com 사이트에 가입하면 도커 허브에 이미지를 푸시해서 공유할 수 있습니다.

3.1.1 Dockerfile 추가 tag 생성하기

 생성한 이미지에 <docker hub 계정>/<리포지토리이름>:<태그> 형태를 사용하여 추가 태그를 붙입니다. 

$ docker tag docker_name:1.0 DrawingProcess/test:1.0

위의 명령어는 docker_name:1.0 이미지를 DrawingProcess 계정 test 리포지토리에 1.0 버전으로 올리겠다는 의미입니다.

3.1.2 docker hub 로그인하기

docker login 명령어를 사용해서 도커 허브에 로그인합니다.

$ docker login
Login with your Docker ID to push and pull images from Docker Hub. ...
Username: DrawingProcess
Password:
...

3.1.3 docker hub 에 이미지 push 하기

로그인에 성공했다면 docker push로 이미지를 푸시합니다.

$ docker push DrawingProcess/test:1.0

3.1.4 docker hub 에 올린 이미지 사용하기

푸시가 끝나면 도커 허브에서 이미지를 가져와 사용할 수 있습니다.

 docker run -d --rm -p 5000:5000 DrawingProcess/docker_name:1.0

3.2 Dockerfile 공유하기: Docker 이미지 압축하기

현재 띄워둔 이미지를 압축합니다.

docker save -o package.tar.gz package:latest

3.3 Dockerfile 공유하기: Docker 컨테이너 압축하기

현재 띄워둔 컨테이너 자체를 압축합니다.

docker export <container_name> > map.tar.gz

 

참고

• [Docker Official] Dockerfile reference: https://docs.docker.com/engine/reference/builder/ 
• [Docker] Dockerfile이란? : https://joont92.github.io/docker/Dockerfile/
• [Docker] Docker File을 이용하여 Docker Image만들기: https://khj93.tistory.com/entry/Docker-Docker-File-%EC%9E%91%EC%84%B1%ED%95%98%EA%B8%B0-%EB%AA%85%EB%A0%B9%EC%96%B4
• 도커 시작하기 7 : Dockerfile을 이용한 이미지 생성: https://javacan.tistory.com/entry/docker-start-7-create-image-using-dockerfile 
• [Docker] 도커파일에서 MAINTAINER는 더 이상 쓰면 안된다고? 그럼 대신 LABEL을 쓰자!: https://wonit.tistory.com/345
• 야마다 아키노리, 『도커/쿠버네티스를 활용한 컨테이너 개발 실전 입문』, 심효섭 옮김, 위키북스(2019)