Dockerを使ってNode開発環境を作る

このチュートリアルでは、Nodeアプリケーションをローカルで作成・実行する代わりに、Docker Nodeの公式イメージがベースとするDebian Linuxオペレーティングシステムのメリットを活用する方法について紹介します。ここでは、ポータブルなNode開発環境を作成し、開発者が「自分のマシンで実行しているはずなのに？」といぶかしがる問題を解決します。これは、いずれかのプラットフォームでDockerイメージを実行すると、コンテナが先読みして作成されることで発生するものです。

このチュートリアルでは、次の2つの空間を使います。

• ローカルのオペレーティングシステム：TerminalやPowerShellなどのCLIアプリケーションを使って、Dockerのローカルインストールを使用し、イメージをビルドしてコンテナとして実行します。

• コンテナのオペレーティングシステム：Dockerコマンドを使って、実行中のコンテナのベースのオペレーティングシステムにアクセスします。このコンテキストの中でコンテナのシェルを使ってコマンドを実行し、Nodeアプリケーションの作成と実行を行います。

コンテナのオペレーティングシステムは、ローカルのオペレーティングシステムとは別に実行します。コンテナ内で作成したファイルは、ローカルではアクセスできません。コンテナ内で実行しているサーバーは、ローカルのウェブブラウザでのリクエストをリッスンできません。これは、ローカル開発には理想的ではありません。この制約を解決するには、次のことを行って2つのシステム間を橋渡しします。

• コンテナのファイルシステムにローカルのフォルダをマウントする：このマウントポイントをコンテナの作業ディレクトリとして使うと、コンテナ内で作成したすべてのファイルをローカルで永続化することができます。また、ローカルで行われたプロジェクトファイルへの変更をコンテナに伝えることもできます。

• ホストにコンテナネットワークの操作を許可する：ローカルポートをコンテナポートにマッピングすると、ローカルポートへのHTTPリクエストはすべてDockerによってコンテナポートにリダイレクトされます。

このDockerベースのNode環境戦略を実際に使ってみるには、基本的なNode Expressウェブサーバーを作成します。さあ、始めてみましょう。

Nodeをインストールする負担を取り除く

シンプルな"Hello World!"というNodeアプリケーションを実行するには、一般的なチュートリアルでは次のことをやるようにと書かれています。

• Nodeをダウンロードしてインストールする
• Yarnをダウンロードしてインストールする
• Nodeの別のバージョンを使うには、Nodeをアンインストールしてから、

  nvm

  をインストールする
• NPMパッケージをグローバルにインストールする

-><-

どのオペレーティングシステムにも、上記のインストールが一筋縄ではいかないそれぞれの癖があります。しかし、NodeエコシステムへのアクセスはDockerイメージを使うことで標準化することができます。このチュートリアルでインストールが必要なのはDockerだけです。Dockerのインストールが必要な場合は、このDockerインストールドキュメントから使用しているオペレーティングシステムを選択し、次の手順に従ってください。

NPMと同様に、Dockerは数多くのDockerイメージが登録されているDocker Hubにアクセスできます。このDocker Hubから、Nodeのさまざまなバージョンをイメージとして実行することができます。これらのイメージは、ローカルプロセスとして他と重複・競合せずに実行できます。Node 8 with NPMやNode 11 with Yarnに依存するクロスプラットフォームプロジェクトを同時に作成することもできます。

プロジェクトの基礎を作成する

まず、システムのどこかに

node-docker

Node Expressサーバーを実行することを目標に、

node-docker

server.js

// server.js
const express = require("express");
const app = express();

const PORT = process.env.PORT || 8080;

app.get("/", (req, res) => {
res.send(`
    <h1>Docker + Node</h1>
    <span>A match made in the cloud</span>
`);
});

app.listen(PORT, () => {
console.log(`Server listening on port ${PORT}...`);
});

Nodeプロジェクトには

package.json

node_modules

コンテナのオペレーティングシステムにアクセスする

コンテナOSには、次のメソッドでアクセスします。

• 1つの長い

  docker run

  コマンドを使用する。

• Dockerfile

  と短い

  docker run

  コマンドを組み合わせる。

• Dockerfile

  をDocker Composeと組み合わせて使用する。

1つの

docker run

コマンドを使用する

次のコマンドを実行します。

docker run --rm -it --name node-docker \
-v $PWD:/home/app -w /home/app \
-e "PORT=3000" -p 8080:3000 \
-u node node:latest /bin/bash

コンテナシェルへのアクセスがどのように行われるかを理解するために、この

docker run

docker run --rm -it

docker run

--rm

-i

-t

-i

-t

--rm

は、ことわざの「out of sight, out of mind」のようなもので、見なければ忘れてしまいます。

-it

チームがいないと、画面には何も表示されません。

-><-

docker run --rm -it --name node-docker

--name

docker ps

docker run --rm -it --name node-docker \
-v $PWD:/home/app -w /home/app

-v

<HOST FOLDER RELATIVE PATH>:<CONTAINER FOLDER ABSOLUTE PATH>

環境変数は、MacやLinux上でコマンド

$PWD

$CD

-w

docker run --rm -it --name node-docker \
-v $PWD:/home/app -w /home/app \
-e "PORT=3000" -p 8080:3000

-e

PORT

3000

-p

8080

3000

server.js

PORT

const PORT = process.env.PORT || 8080;

docker run --rm -it --name node-docker \
-v $PWD:/home/app -w /home/app \
-e "PORT=3000" -p 8080:3000 \
-u node node:latest /bin/bash

セキュリティの保護とファイル権限の問題を回避するため、

-u

node

node:latest

/bin/bash

イメージがローカルにない場合は、Dockerがバックグラウンドで

docker pull

を発行し、Docker Hubからダウンロードします。

コマンドが実行されると、次のコンテナシェルのプロンプトが表示されます。

node@<CONTAINER ID>:/home/app$

次のメソッドに移る前に、

exit

Dockerfile

を使用する

前のセクションの

docker run

docker run --rm -it --name node-docker \
-v $PWD:/home/app -w /home/app \
-e "PORT=3000" -p 8080:3000 \
-u node node:latest /bin/bash

イメージのビルドタイムに関連するものはすべて、次のように

Dockerfile

• FROM

  は、コンテナのベースイメージ

  node:latest

  を指定します。

• WORKDIR

  は、

  -w

  を定義します。

• USER

  は、

  -u

  を定義します。

• ENV

  は、

  -e

  を定義します。

• ENTRYPOINT

  は、コンテナが実行されると

  /bin/bash

  の実行を指定します。

これにもとづき、

node-docker

Dockerfile

FROM node:latest

WORKDIR /home/app
USER node
ENV PORT 3000

EXPOSE 3000

ENTRYPOINT /bin/bash

EXPOSE 3000

docker run

Dockerfile

docker build

docker build -t node-docker .

docker build

-t

node-docker

docker images

イメージが作成されたら、次の短いコマンドを実行してサーバーを実行します。

docker run --rm -it --name node-docker \
-v $PWD:/home/app -p 8080:3000 \
node-docker

コンテナシェルのプロンプトは、次の形式で表示されます。

node@<CONTAINER ID>:/home/app$

もう一度、次のメソッドに移る前に、

exit

Docker Composeを使用する

Linuxの場合は、Docker Composeは個別にインストールします。

前のセクションの

Dockerfile

docker run

Dockerfile

FROM node:latest

WORKDIR /home/app
USER node
ENV PORT 3000

EXPOSE 3000

ENTRYPOINT /bin/bash

Command

docker run --rm -it --name node-docker \
-v $PWD:/home/app -p 8080:3000 \
node-docker

抽象化する

docker run

node-docker

docker-compose.yml

version:"3"
services:
nod_dev_env:
build: .
container_name: node-docker
ports:
- 8080:3000
volumes:
- ./:/home/app

• nod_dev_env

  は、サービスにわかりやすい名前を付けます。

• build

  は、

  Dockerfile

  へのパスを指定します。

• container_name

  は、コンテナにわかりやすい名前を付けます。

• ports

  は、ホストからコンテナへのポートマッピングを構成します。

• volumes

  は、ローカルフォルダからコンテナフォルダへのマウンティングポイントを定義します。

このサービスを開始して実行するには、次のコマンドを実行します。

docker-compose up

up

docker run

docker build

docker image
# Notice the image named <project-folder>_nod_dev_env
docker ps -a
# Notice the container named <project-folder>_nod_dev_env_<number>

up

docker-compose.yml

up

docker-compose run

nod_dev_env

まず、

up

docker-compose down

さらに、次のコマンドでサービスを実行します。

docker-compose run --rm --service-ports nod_dev_env

run

docker run -it

--service-ports

node@<CONTAINER ID>:/home/app$

何らかの理由でDocker Composeファイルに指定したポートが使用中の場合は、

--publish

-p

4000

3000

docker-compose run --rm -p 4000:3000 nod_dev_env

依存関係をインストールしてサーバーを実行する

アクティブなコンテナシェルがない場合は、上記のいずれかのメソッドを使ってアクセスします。

コンテナシェルで、Nodeプロジェクトを初期化し、次のコマンドを発行して依存関係をインストールします（

npm

を使うこともできます）。

yarn init -y
yarn add express
yarn add -D nodemon

package.json

node_modules

node-docker

nodemon

nodemon

package.json

{
// Other properties...
"scripts": {
"start": "nodemon server.js"
}
}

コンテナシェル内で、

yarn start

サーバーをテストするには、ローカルブラウザを使って

http://localhost:8080/

8080

3000

ローカルファイルのコンテンツとサーバーの接続をテストするには、

server.js

// server.js

// package and constant definitions...

app.get("/", (req, res) => {
res.send(`
    <h1>Hello From Node Running Inside Docker</h1>
`);
});

// server listening...

ブラウザのウィンドウを閉じ、新しいレスポンスを調べます。

プロジェクトを変更・拡張する

Nodeがローカルシステムにインストールされていない場合は、ローカルターミナルを使ってプロジェクトの構造とファイルのコンテンツを修正できますが、

yarn add

3000

コンテナ内のサーバーを操作したり、Nodeプロジェクトに変更を加えたい場合は、

docker exec

docker run

実行中のコンテナのIDは、簡単に取得できます。

• すでにコンテナシェルが開いている場合は、コンテナIDがシェルプロンプトに表示されています。

node@<CONTAINER ID>:/home/app$

• コンテナIDは、プログラミング的に取得することもできます。

  docker ps

  を使い、一致するコンテナの

  CONTAINER ID

  を返すように、名前でフィルタします。

docker ps -qf "name=node-docker"

-f

フラグは、

name=node-docker

の条件にもとづいてコンテナをフィルタします。

-q

(

--quiet

)は、出力の中から一致するコンテナのIDだけを表示するように制限します。実質上、docker exec

コマンドの中に

node-docker

の

CONTAINER ID`が組み込まれます。

コンテナIDを取得したら、

docker exec

• 実行中のコンテナシェルの新しいインスタンスを開きます。

docker exec -it $(docker ps -qf "name=node-docker") /bin/bash

• 内部ポート

  3000

  を使ってサーバーリクエストを出します。

docker exec -it $(docker ps -qf "name=node-docker") curl localhost:3000

• 依存関係をインストールまたは削除します。

docker exec -it $(docker ps -qf "name=node-docker") yarn add body-parser

もう一つのアクティブなコンテナシェルができたら、代わりにそこで

curl

、

yarn add

を簡単に実行できます。

まとめ... 小さなウソをばらすと

ここでは、さまざまなレベルの複雑さで分離したNode開発環境を作成する方法を紹介しました。1つの

docker run

Dockerfile

それぞれのレベルはより多くのファイル構成が必要ですが、コンテナを実行するコマンドはより短くなります。これは、構成をファイルにカプセル化することで環境がポータブルなものになり、維持しやすくなるので、価値あるトレードオフです。さらに、実行中のコンテナを操作してプロジェクトを拡張する方法も紹介しました。

IDEの場合は、構文アシスタントが使うにはNodeをローカルにインストールしなければなりません。もしくは、

vim

-><-

それでも、分離した開発環境の恩恵は受けられます。プロジェクトのセットアップ、インストール、コンテナ内で実行するランタイムの手順に制限を課すと、チーム全員が同じバージョンのLinuxでコマンドを実行するようになるので、これらの手順を標準化できます。さらに、Nodeツールで作成したキャッシュや隠れファイルはすべて、コンテナの中に閉じ込めておけるので、ローカルシステムを汚すことはありません。しかも、

yarn

JetBrainsは、デバッグアプリケーションを実行しているときに、DockerイメージをNodeやPythonのリモートインタープリタとして使用する機能の提供を始めました。将来的には、これらのツールをシステムにダウンロードしてインストールする必要がまったくなくなるかもしれません。開発者の環境を標準化し、ポータブルなものとするために、業界が何をもたらしてくれるか、これからも注目していきましょう。