Casual Developers Note

エンジニアやデザイナー向けの技術情報・英語学習情報・海外留学情報・海外旅行情報を提供中。世界を旅して人生を楽しもう。

現在の場所：ホーム / アーカイブdocker

By コメントを書く

初級JavascriptフルスタックエンジニアのためのReactとExpressの同時開発チュートリアル(Dockerコンテナ化してHerokuにデプロイ編)

初級JavascriptフルスタックエンジニアのためのReactとExpressの同時開発チュートリアル(Dockerコンテナ化してHerokuにデプロイ編)

最近のアプリケーションはDocker上で稼働させるのが当たり前になりつつあります。そして、HerokuのようなPaaS環境にアプリケーションをリリースすることも小規模サービスでは一般的になっています。今回は、人気のHeroku上に人気のDockerコンテナをデプロイする方法をご紹介します。

Herokuとは？

Herokuとは、AmazonのAWSやMicrosoftのAzureと言ったIaaS上にアプリケーションを簡単にデプロイすることができるPaaSです。一回デプロイしてみると、そのデプロイの簡単さに驚くばかりです。

今回は、前回の「JavascriptフルスタックエンジニアのためのReactとExpressの同時開発チュートリアル(基本的なアプリ作成と同時開発環境構築編)」に引き続き、サンプルアプリケーションをDocker化し、Herokuにデプロイしていきましょう。

環境準備

Heroku CLIのインストール

$ brew install heroku
$ heroku --version
heroku-cli/6.15.30-e7b41cd (darwin-x64) node-v9.7.1

デプロイするアプリケーション

今回は前回作成した簡単なアプリケーションを使います。なので、サンプルアプリケーションで試したい人は、前回の記事からプロジェクトを持ってきて下さい。

初級JavascriptフルスタックエンジニアのためのReactとExpressの同時開発チュートリアル(基本的なアプリ作成と同時開発環境構築編)

Herokuにデプロイする時はGitを使うので、前回のプロジェクトをひとまずコミットしましょう。

$ cd full-stack-app/
$ git init
$ git add .
$ git commit -m 'initial commit'

Herokuの登録

まずはHerokuアカウントを作ってログインしましょう。

Herokuアカウントの作成

Herokuのサイトに言ってアカウントを作成して下さい。この時にクレジットカード情報の登録を行って下さい。なぜその必要があるかと言うと、後で使うHerokuのアドオンの使用条件になっているからです。クレジットカードの登録をしただけで課金されることは無いので安心して下さい。今回は無料枠だけでやります。

ログインとキー登録

環境準備でインストールしたHeroku CLIを使ってHerokuにコマンドラインからログインします。その後、キーを生成して登録します。

$ heroku login
Enter your Heroku credentials:
Email: your@email.com
Password: ***************
Logged in as your@email.com
$ heroku keys:add
Could not find an existing SSH key at ~/.ssh/id_rsa.pub
? Would you like to generate a new one? Yes
Generating public/private rsa key pair.
...
Uploading /Users/you/.ssh/id_rsa.pub SSH key... done

Herokuにデプロイする(通常のアプリケーション編)

それではDockerで、と言いたいところですが、まずは通常のHeroku上にデプロイする方法をやってみましょう。

package.jsonにスクリプトを追加する(NPM編)

まずはpackage.jsonにHerokuにビルドしてもらうためのスクリプトを追加します。このスクリプトにより、HerokuにPushするだけでReactがビルドされます。

  "scripts": {
    ...
    "heroku-postbuild":
      "NPM_CONFIG_PRODUCTION=false npm install --prefix client && npm run build --prefix client"
  }

package.jsonにスクリプトを追加する(Yarn編)

Yarnの場合のスクリプトはこうなります。

  "scripts": {
    ...
    "heroku-postbuild":
      "NPM_CONFIG_PRODUCTION=false yarn --cwd client install && yarn --cwd client build"
  }

Mongooseの設定を変更する

「server.js」のMongooseの設定部分を以下のように書き換えます。

mongoose.connect(process.env.MONGODB_URI || 'mongodb://localhost:27018/sampledb');

すぐに分かりますが「MONGODB_URI」はHerokuが自動設定してくれるMongoDBの接続先の環境変数です。

Herokuにデプロイする

後は非常に簡単です。以下のようにコミットして、Herokuコマンドを実行するだけです。Herokuのアドオンを指定している「heroku addons:create mongolab:sandbox」では、mLabのSandbox(無料枠)にデータベースを作って自動で連携します。

$ cd full-stack-app/
$ git add .
$ git commit -m 'change to deploy to Heroku'
$ git push origin master #GitHubなどを使っている場合
$ heroku create
$ heroku addons:create mongolab:sandbox
Creating mongolab:sandbox on ⬢ xxxx-xxxx... free
Welcome to mLab.  Your new subscription is being created and will be available shortly.  Please consult the mLab Add-on Admin UI to check on its progress.
Created mongolab-xxxx-xxxx as MONGODB_URI
Use heroku addons:docs mongolab to view documentation
$ heroku config
MONGODB_URI: mongodb://heroku_xxxx:xxxx@xxxx.mlab.com:xxxx/heroku_xxxx
$ git push heroku master
$ heroku open

「heroku open」を実行してブラウザでうまく表示されない場合はログを確認しましょう。

$ heroku logs

よくあるのは環境変数の設定漏れや誤り、それに伴うデータベースとの接続失敗なので、確認してみて下さい。

アプリケーションをDockerコンテナ化する

ここからが本番です。HerokuにDockerコンテナをデプロイするためにはまずサンプルアプリケーションをDockerコンテナ上で起動するようにする必要があります。それではやっていきましょう。

必要なファイルの作成

まずはプロジェクト直下に「Dockerfile」と「docker-compose.yml」を作成します。

$ cd full-stack-app/
$ touch Dockerfile
$ touch docker-compose.yml
$ touch .dockerignore
$ touch .env

Dockerfileの作成(NPM編)

FROM node:9.7.1-alpine

RUN mkdir /app
WORKDIR /app

RUN npm install -g nodemon

COPY package.json package.json
COPY package-lock.json package-lock.json
RUN npm install && mv node_modules /node_modules

COPY . .

LABEL maintainer="You <your@email.com>"

CMD node server/server.js

Dockerfileの作成(Yarn編)

FROM node:9.7.1-alpine

RUN mkdir /app
WORKDIR /app

RUN npm install -g yarn nodemon

COPY package.json package.json
COPY yarn.lock yarn.lock
RUN yarn install && mv node_modules /node_modules

COPY . .

LABEL maintainer="You "

CMD node server/server.js

docker-compose.ymlの作成

「docker-compose.yml」は以下のようになります。

version: '3'

services:
  web:
    build: .
    ports:
      - '3001:3001'
    command: node server/server.js
    env_file:
      - .env
    depends_on:
      - 'db'
  db:
    image: mongo:latest
    ports:
      - '27018:27017'

今回はテスト用なので簡素にしてありますが、開発で使いたい場合はデータを共有したり保存したりするために「volumes」を設定すると良いでしょう。

.dockerignoreの作成

「.dockerignore」は以下のようになります。

.dockerignore
.git
node_modules
client/*
!client/build
db/

DockerコンテナにはReactをビルドしたファイルのみがあればよいのと、ローカルに保存してあるデータベースのデータも不要なので除外します。

.envの作成

ローカルでwebコンテナとdbコンテナを接続するために「MONGODB_URI」を設定します。

MONGODB_URI=mongodb://db:27017/sampledb

ローカルでビルドしてコンテナを起動する(NPM編)

$ npm run build --prefix client
$ docker-compose up -d

ローカルでビルドしてコンテナを起動する(Yarn編)

$ yarn --cwd client build
$ docker-compose up -d

以上で、サンプルアプリケーションのDocker化が完了しました。

Herokuにデプロイする(Dockerコンテナ編)

やっとここまできました。Docker化したサンプルアプリケーションをHerokuにデプロイしましょう。

環境変数の調整

「.env」ファイルの設定をコメントアウトします。「MONGODB_URI」の設定としてHerokuに設定されている環境変数を利用するためです。

# MONGODB_URI=mongodb://db:27017/sampledb

そして、Herokuの環境変数に「NODE_ENV」を設定します。

$ heroku config:set NODE_ENV=production
$ heroku config
=== xxxx-xxxx-xxxx Config Vars
MONGODB_URI: mongodb://heroku_xxxx:xxxx@xxxx.mlab.com:xxxx/heroku_xxxx
NODE_ENV:    production

これは、HerokuのNodeJS環境ではデフォルトで「NODE_ENV=production」と設定されていますが、Container Registryでは設定されていないためです。

Herokuにデプロイする(Herokuコマンド編)

それではHerokuにDockerコンテナをデプロイしましょう。「heroku container」コマンドで以下のようにするだけです。

$ cd full-stack-app/
$ npm run build --prefix client
$ heroku container:login
Login Succeeded
$ heroku container:push web
=== Building web (/Users/you/full-stack-app/Dockerfile)
Sending build context to Docker daemon   3.75MB
...
Successfully built 244a09e60313
Successfully tagged registry.heroku.com/xxxx-xxxx/web:latest
=== Pushing web (/Users/you/full-stack-app/Dockerfile)
The push refers to repository [registry.heroku.com/xxxx-xxxx-xxxx/web]
8ae4845af426: Pushed
...
$ heroku open

素晴らしい！簡単にできましたね。ローカルで自動的にDockerイメージが作成され、Herokuコンテナ環境にPushされているのが分かります。

Herokuにデプロイする(Dockerコマンド編)

Herokuコマンドを使ってやるのも良いのですが、Dockerイメージに好きな名前とバージョンを付けて自分でコントロールしたい場合は、dockerコマンドを使うと良いです。やってみましょう。

$ cd full-stack-app/
$ yarn --cwd client build
$ heroku container:login
$ docker-compose build --no-cache web
$ docker images
$ docker tag 0f4d3762ac35 registry.heroku.com/your-app-xxxxx/web:1.0.0
$ docker push registry.heroku.com/your-app-xxxxx/web:1.0.0
The push refers to repository [registry.heroku.com/your-app-xxxxx/web]
$ heroku open -a your-app-xxxxx

「your-app-xxxxx」には「heroku create」コマンド実行時にHerokuが自動で払い出したアプリ名を使用します。「heroku open」の時にブラウザに表示されるドメイン名ですね。

これで好きな名前やバージョンを付けたDockerイメージもHerokuにデプロイすることができました。

追記(container:release対応)

Container RegistryにDockerイメージをPushした後に、Releaseコマンドが必要になりました。詳しくは以下の記事を参照して下さい。

Heroku Container Registryのcontainer:push後のcontainer:releaseの対応方法

おまけ

dockerコマンドによるHerokuコンテナ環境へのログイン方法

Herokuコンテナ環境にログインするには「heroku container:login」コマンドを使ってましたが、dockerコマンドでもログインできます。

$ docker login --username=_ --password=$(heroku auth:token) registry.heroku.com
...
Login Succeeded

Herokuコンテナ環境でdocker-compose.ymlで必要なもの

今回作成した「docker-compose.yml」はローカル起動のためにPort設定やデータベース設定を記載しましたが、Herokuコンテナ環境ではPortは自動設定されますし、今回はデータベースはmLabを使用しているので設定は不要です。

そいういった贅肉を落とすと、結局以下の設定さえあればOKです。

version: '3'

services:
  web:
    build: .
    command: node server/server.js
    env_file:
      - .env

Dockerコマンドでイメージ名を後で変更しなくて良いように「image」を設定しても良いでしょう。

最後に

いかがでしたか？これでHerokuにDockerコンテナをデプロイする方法をマスターできたと思います。Herokuの独特の癖がありますが、それでもこのお手軽さは素晴らしいですね。それでは。

環境

  • PC : macOS High Sierra 10.13.3
  • heroku : heroku-cli/6.15.30-e7b41cd (darwin-x64) node-v9.7.1
  • docker : Docker version 17.12.0-ce, build c97c6d6