Goal
- NestJs Project를 Docker Image로 만들기.
Image Variants
Docker 공식 홈페이지에서는 아래와 같은 3가지의 변형 이미지를 소개하고 있다.
-
node:<version> -
node:<version>-slim -
node:<version>-alpine
node:<version>
NodeJs의 실제 이미지이다. NodeJs의 이미지 중 어떠한 것을 선택해야 할 지 불확실하다면 해당 이미지를 사용하라고 이야기 하고 있다.
주로 해당 변형 이미지는 배포 혹은 base Image로 사용된다.
간혹 뒤에 buster나 stretch가 붙는 경우가 존재하는데 이러한 경우는 Debian계열 이미지를 베이스로 배포되었다는 것을 나타낸다. (즉 현재 이미지가 어떠한 릴리즈를 기반으로 배포되었는지를 알 수 있는 척도가 된다.)
node:<version>-slim
slim이 붙은 이미지는 실행하기 위한 최소한의 패키지만을 포함하고 있다. 기본이미지(node:<version>)에 포함된 공통 패키지는 포함하고 있지 않습니다.
배포 환경에 용량제한이 심한 경우가 아니라면 기본이미지(node:<version>) 사용을 추천한다고 한다.
node:<version>-alpine
node:<version>-alpine는 유명한 Alpine Linux 프로젝트를 기반으로 한다. alpine 리눅스는 대부분의 배포 기반 이미지 보다 작으며(~5MB), 따라서 일반적으로 작은 이미즈를 만들 수 있다.
참고로 glibc와 friends를 사용하는 대신 musl libc를 사용한다는 점으로 libc를 필요로 하는 소프트웨어에서 이슈가 발생할 수 있다.
dockerfile, dockerignore
프로젝트를 docker 이미지로 만들기 위해서는 dockerfile 및 dockerignore를 작성해야 한다. (vs-code를 사용하고 있다면 Docker Extension을 설치하면 도움을 받을 수 있다. Docker Extension)
현재 글에서 dockerfile, dockerignore에 대해서는 깊게 설명하지 않을 것이다. 이전에 작성한 글을 참고하기를 바란다. ( TIL- Dockerfile 작성법 )
이미지 만들기
NestJs프로젝트는 기본적으로 빌드를 하게 되면 dist라는 디렉토리로 build 된 결과물이 포함되게 된다. (Monorepo는 main.js라는 파일이 하나만 생길 것이고 그렇지 않은 경우 컴파일 한 결과들이 모두 포함되게 된다.)
로컬에서 개발을 하다보면 프로젝트 루트에 dist가 존재하게 될 텐데 이미지를 빌드할 때 개발할 때 build된 결과물이 포함되면 안될 것이다.
이럴 때 작성하는 것이 dockerignore이다.
dockerignore 작성
dockerignore에 기존 개발에 존재하던 dist, node_module를 제외하기 위해 아래와 같이 작성해준다. .gitignore와 작성하는 방법은 동일하다.
node_module
dist이렇게 되면 이미지를 빌드할 때 COPY명령어를 사용하게 되는데 이 때 dockerignore에 포함 되어 있는 것들은 복사하지 않는다.
dockerfile 작성
dockerfile을 작성할 때 2단계로 나눠서 작성을 하였다. Step을 2개로 나눈 이유는 빌드할 때는 기본이미지를 이용하여 빌드를 하고, 빌드 결과물을 Step 2로 가져와서 Step 2에서는 가벼운 이미지를 이용하여 docker 이미지를 생성하기 위해서이다.
작성한 dockerfile은 아래와 같다.
# STEP 1
# 1
FROM node:16 AS builder
# 2
WORKDIR /app
# 3
COPY . .
# 4
RUN yarn
# 5
RUN yarn build
# STEP 2
#6
FROM node:16-alpine
#7
WORKDIR /app
#8
ENV NODE_ENV production
#9
COPY --from=builder /app ./
#10
CMD ["yarn","start:prod"]Step 1 (빌드 하는 단계)
-
NestJs프로젝트를 빌드할 때 사용할docker이미지를 정의한다. 현재 기본 이미지를 이용하였다. -
명령이 실행될 디렉토리를
/app으로 지정. -
현재
dockerfile이 위치한 곳에 있는 모든 소스들을/app으로 복사한다. 이 때dockerignore에 정의한 것은 복사되지 않는다. -
현재 프로젝트가 의존하고 있는 의존성들을 가져온다.
-
package.json에 정의 된build스크립트를 실행한다.
Step 2 (이미지 경량화 및 Server 실행)
-
기본이미지 보다 작은
alpine이미지를 이용하여 이미지의 용량을 줄인다. -
명령이 실행될 디렉토리를
/app으로 지정. -
NODE_ENV환경변수를production으로 정의한다. -
Step 1에서 빌드 된 결과물을 복사해온다.
-
서버 실행
이미지 빌드하기 및 실행하기
dockerfile 작성이 완료되었으면 해당 파일을 통해 이미지를 만들 수 있다.
docker image build
docker build -t <도커 이미지 이름> <docker file 경로>
//ex (프로젝트 루트)
docker build -t hello-nestjs .docker container start
docker run <도커 이미지 이름> ...(추가적인 option)Reference
