nestJS docker image 만들기

nodejs의 도커라이징 페이지를 보면서 진행

 

nodejs에서는 server.js를 만들어서 express 프레임워크로 지정하는 작업을 하지만

nestjs에서는 main.js를 지정 하면 되기때문에 server.js 생성이 불필요

 

Dockerfile 생성

nestjs의 root 폴더에서 Dockerfile을 생성한다.

다음 Dockerfile을 열어서 내용을 넣는다.

 

가장 먼저 해야 할 것은 어떤 이미지를 사용해서 빌드할 것인지를 정의하는 것입니다.

여기서는 Docker Hub에 있는 node의 최신 LTS(장기 지원) 버전인 12을 사용할 것입니다.

FROM node:12

다음으로 이미지 안에 애플리케이션 코드를 넣기 위해 디렉터리를 생성할 것입니다.

이 디렉터리가 애플리케이션의 작업 디렉터리가 됩니다.

# 앱 디렉터리 생성
WORKDIR /dittybox/src/app

이 이미지에는 이미 Node.js와 NPM이 설치되어 있으므로 npm 바이너리로 앱의 의존성을 설치하기만 하면 됩니다.

버전 4 이하의 npm은 package-lock.json 파일을 생성하지 않을 것입니다.

# 앱 의존성 설치
# 가능한 경우(npm@5+) package.json과 package-lock.json을 모두 복사하기 위해
# 와일드카드를 사용
COPY package*.json ./

RUN npm install
# 프로덕션을 위한 코드를 빌드하는 경우
# RUN npm ci --only=production

작업 디렉터리 전체가 아닌 package.json 파일만을 복사하고 있는데, 이는 캐시된 Docker 레이어의 장점을 활용하기 위함입니다. bitJudo가 이에 대해 여기에 잘 설명해 두었습니다. 추가로, 주석에 언급된 npm ci 커맨드는 프로덕션 환경을 위한 더 빠르고, 신뢰할 수 있고, 재현 가능한 빌드를 제공합니다. 이에 대해 여기에서 자세히 알아볼 수 있습니다.

 

Docker 이미지 안에 앱의 소스코드를 넣기 위해 COPY 지시어를 사용합니다.

# 앱 소스 추가
COPY . .

앱이 8080포트에 바인딩 되어 있으므로 EXPOSE 지시어를 사용해서 docker 데몬에 매핑합니다.

EXPOSE 8080

마지막으로 런타임을 정의하는 CMD로 앱을 실행하는 중요 명령어를 정의해야 합니다.

여기서는 서버를 구동하도록 node server.js을 실행하는 기본 npm start을 사용할 것입니다.

CMD [ "node", "server.js" ]

여기서 문제! nest.js는 server.js파일이 아니다. main.js 파일이다.

그리고

Nest.JS는 기본적으로 TypeScript를 사용하여 확장자가 TS이다. 해서 COPY 이후에 RUN으로 앱을 한번 빌드를 해준다.

RUN npm run build

그러면 소스는 dist폴더에 들어 가기 때문에 dist폴더의 main을 연결한다.

CMD [ "node", "dist/main" ]

이렇게 하면 전체 파일은

FROM node:12

# 앱 디렉터리 생성
WORKDIR /dittybox/src/app

# 앱 의존성 설치
# 가능한 경우(npm@5+) package.json과 package-lock.json을 모두 복사하기 위해
# 와일드카드를 사용
COPY package*.json ./

RUN npm install
# 프로덕션을 위한 코드를 빌드하는 경우
# RUN npm ci --only=production

# 앱 소스 추가
COPY . .

RUN npm run build

EXPOSE 8080

CMD [ "node", "dist/main" ]

 

.dockerignore 파일

ockerfile과 같은 디렉터리에 .dockerignore 파일을 다음 내용으로 만드세요.

이는 Docker 이미지에 로컬 모듈과 디버깅 로그를 복사하는 것을 막아서 이미지 내에서 설치한 모듈을 덮어쓰지 않게 합니다.

node_modules
npm-debug.log

 

이미지 빌드

작성한 Dockerfile이 있는 디렉터리로 가서 Docker 이미지를 빌드하는 다음 명령어를 실행하세요. 

-t 플래그로 이미지에 태그를 추가할 수 있어 나중에 docker images 명령어로 쉽게 찾을 수 있습니다.

docker build -t dittybox/dittybox-api-app .

Docker가 당신이 빌드한 이미지를 보여줄 것입니다.

$ docker images

# 예시
REPOSITORY                      TAG        ID              CREATED
node                            12         1934b0b038d1    5 days ago
<your username>/node-web-app    latest     d64d3505b0d2    1 minute ago

 

이미지 실행

-d로 이미지를 실행하면 분리 모드로 컨테이너를 실행해서 백그라운드에서 컨테이너가 돌아가도록 합니다. 

-p 플래그는 공개 포트를 컨테이너 내의 비공개 포트로 리다이렉트합니다.

앞에서 만든 이미지를 실행하세요.

docker run -p 8080:3000 -d dittybox/dittybox-api-app

8080으로 들어오면 내부 컨테이너 3000으로 포워딩을 합니다.

이렇게 하면  localhost:8080으로 확인 하면 된다.

 

앱의 로그를 출력하세요.

# 컨테이너 아이디를 확인합니다
$ docker ps

# 앱 로그를 출력합니다
$ docker logs <container id>

# 예시
Running on http://localhost:8080

컨테이너 안에 들어가 봐야 한다면 exec 명령어를 사용할 수 있습니다.

# 컨테이너에 들어갑니다
$ docker exec -it <container id> /bin/bash

 

테스트

앱을 테스트하려면 Docker 매핑된 앱 포트를 확인합니다.

$ docker ps

# 예시
ID            IMAGE                                COMMAND    ...   PORTS
ecce33b30ebf  <your username>/node-web-app:latest  npm start  ...   49160->8080

위 예시에서 Docker가 컨테이너 내의 8080 포트를 머신의 49160 포트로 매핑했습니다.

이제 curl로 앱을 호출할 수 있습니다.(필요하다면 sudo apt-get install curl로 설치하세요.)

$ curl -i localhost:49160

HTTP/1.1 200 OK
X-Powered-By: Express
Content-Type: text/html; charset=utf-8
Content-Length: 12
ETag: W/"c-M6tWOb/Y57lesdjQuHeB1P/qTV0"
Date: Mon, 13 Nov 2017 20:53:59 GMT
Connection: keep-alive

Hello world

 

• 공식 Node.js Docker 이미지
• Node.js Docker 사용사례 문서
• 공식 Docker 문서
• Stack Overflow에 Docker 태그로 올라온 질문
• Docker 레딧