Node.js アプリケーションのコンテナー化

もくじ

前提条件

  • Docker Desktop の最新版をインストールしていること。
  • git クライアント が利用可能であること。 本節の利用例ではコマンドラインベースの git クライアントを用いていきますが、別のクライアントを用いてもかまいません。

概要

本節では Node.js アプリケーションをコンテナー化して実行する手順を示していきます。

サンプルアプリケーションの入手

本ガイドにおいて利用するサンプルアプリケーションをクローンします。 端末画面を開いて、作業を行うディレクトリに移動します。 そして以下のコマンドを実行してリポジトリをクローンします。

$ git clone https://github.com/docker/docker-nodejs-sample

Docker アセットの初期化

アプリケーションの入手はできました。 次はアプリケーションのコンテナー化に必要となる Docker アセットを生成します。 Docker Desktop にはビルトインの Docker Init 機能があるので、効率的に作業を進められます。 あるいは手動でアセットを生成することもできます。

端末画面内の docker-nodejs-sample ディレクトリにおいて docker init コマンドを実行します。 docker init はデフォルトの設定をいくつか行いますが、アプリケーション内容についていくつか質問が行われるので、それに答えます。 以下の利用例において docker init の質問への答えを示しているので、これを参考に同様の入力を行ってください。

$ docker init
Welcome to the Docker Init CLI!

This utility will walk you through creating the following files with sensible defaults for your project:
  - .dockerignore
  - Dockerfile
  - compose.yaml
  - README.Docker.md

Let's get started!

? What application platform does your project use? Node
? What version of Node do you want to use? 18.0.0
? Which package manager do you want to use? npm
? What command do you want to use to start the app: node src/index.js
? What port does your server listen on? 3000

Docker Desktop をインストールしていない場合やアセットを手動で生成したい場合は、以下に示すファイルをプロジェクトディレクトリ内に生成します。

Dockerfile という名前のファイルを生成して、内容を以下のようにします。

Dockerfile
# syntax=docker/dockerfile:1

# 本ファイル全体にコメントをつけてわかりやすくしています。
# もっと情報が必要な場合は https://docs.docker.com/go/dockerfile-reference/
# にある Dockerfile リファレンスガイドを参照してください。

# このテンプレートをより良いものにするお手伝いをしていただけますか？
# フィードバックがあれば以下にお伝えください。: https://forms.gle/ybq9Krt8jtBL3iCk7

ARG NODE_VERSION=18.0.0

FROM node:${NODE_VERSION}-alpine

# デフォルトで node の本番環境を利用します。
ENV NODE_ENV production


WORKDIR /usr/src/app

# Docker キャッシュ機能を最大限活用するために依存パッケージを個別のステップで
# ダウンロードします。キャッシュマウントを /root/.npm にしてこれ以降のビルドを
# 高速化します。package.json と package-lock.json をバインドマウントすることで
# これらがこのレイヤーにコピーされないようにしています。
RUN --mount=type=bind,source=package.json,target=package.json \
    --mount=type=bind,source=package-lock.json,target=package-lock.json \
    --mount=type=cache,target=/root/.npm \
    npm ci --omit=dev

# 非rootユーザーとしてアプリケーションを実行します。
USER node

# 残りのソースファイルをイメージにコピーします。
COPY . .

# アプリケーションが利用するポートを開放します。
EXPOSE 3000

# アプリケーションを実行します。
CMD node src/index.js

compose.yaml という名前のファイルを生成して、内容を以下のようにします。

compose.yaml
# Comments are provided throughout this file to help you get started.
# If you need more help, visit the Docker Compose reference guide at
# https://docs.docker.com/go/compose-spec-reference/

# Here the instructions define your application as a service called "server".
# This service is built from the Dockerfile in the current directory.
# You can add other services your application may depend on here, such as a
# database or a cache. For examples, see the Awesome Compose repository:
# https://github.com/docker/awesome-compose
services:
  server:
    build:
      context: .
    environment:
      NODE_ENV: production
    ports:
      - 3000:3000
# The commented out section below is an example of how to define a PostgreSQL
# database that your application can use. `depends_on` tells Docker Compose to
# start the database before your application. The `db-data` volume persists the
# database data between container restarts. The `db-password` secret is used
# to set the database password. You must create `db/password.txt` and add
# a password of your choosing to it before running `docker-compose up`.
#     depends_on:
#       db:
#         condition: service_healthy
#   db:
#     image: postgres
#     restart: always
#     user: postgres
#     secrets:
#       - db-password
#     volumes:
#       - db-data:/var/lib/postgresql/data
#     environment:
#       - POSTGRES_DB=example
#       - POSTGRES_PASSWORD_FILE=/run/secrets/db-password
#     expose:
#       - 5432
#     healthcheck:
#       test: [ "CMD", "pg_isready" ]
#       interval: 10s
#       timeout: 5s
#       retries: 5
# volumes:
#   db-data:
# secrets:
#   db-password:
#     file: db/password.txt

.dockerignore という名前のファイルを生成して、内容を以下のようにします。

.dockerignore
# Include any files or directories that you don't want to be copied to your
# container here (e.g., local build artifacts, temporary files, etc.).
#
# For more help, visit the .dockerignore file reference guide at
# https://docs.docker.com/go/build-context-dockerignore/

**/.classpath
**/.dockerignore
**/.env
**/.git
**/.gitignore
**/.project
**/.settings
**/.toolstarget
**/.vs
**/.vscode
**/.next
**/.cache
**/*.*proj.user
**/*.dbmdl
**/*.jfm
**/charts
**/docker-compose*
**/compose.y*ml
**/Dockerfile*
**/node_modules
**/npm-debug.log
**/obj
**/secrets.dev.yaml
**/values.dev.yaml
**/build
**/dist
LICENSE
README.md

上により docker-nodejs-sample ディレクトリ内は、最低でも以下の構成となるはずです。

├── docker-nodejs-sample/
│ ├── spec/
│ ├── src/
│ ├── .dockerignore
│ ├── .gitignore
│ ├── compose.yaml
│ ├── Dockerfile
│ ├── package-lock.json
│ ├── package.json
│ └── README.md

各ファイルについての詳細は以下を参照してください。

アプリケーションの実行

端末画面内の docker-nodejs-sample ディレクトリから以下のコマンドを実行します。

$ docker compose up --build

ブラウザーを開いて http://localhost:3000 にアクセスし、アプリケーションを確認します。 シンプルな todo アプリケーションが表示されたはずです。

端末画面から ctrl+c を押下してアプリケーションを停止します。

バックグラウンドでのアプリケーション実行

アプリケーションは端末から切り離して実行することができます。 それには -d オプションをつけます。 端末画面内の docker-nodejs-sample ディレクトリから以下のコマンドを実行します。

$ docker compose up --build -d

ブラウザーを開いて http://localhost:3000 にアクセスし、アプリケーションを確認します。

シンプルな todo アプリケーションが表示されたはずです。

端末画面から以下のコマンドを実行してアプリケーションを停止します。

$ docker compose down

Compose コマンドの詳細は Compose CLI リファレンス を参照してください。

まとめ

本節では Docker を使って Node.js アプリケーションをコンテナー化して実行する方法について学びました。

関連情報

次のステップ

次の節では、コンテナーを使ってアプリケーションの開発を行う方法を学びます。

コンテナーを利用した Node.js 開発 »