Udemy 6. Heroku.ymlを使ったDockerデプロイ #04
2021年01月22日に更新

Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)

今回達成すること

Nuxt.jsをHerokuにデプロイするために、Dockerfileとheroku.ymlを編集します。

この記事を通してNuxt.jsのデプロイに必要な知識を習得します。

作業に入る前に全体のデプロイ手順を確認しておきましょう。


  1. Nuxt.jsのDockerfileに本番用のコマンドを追記する(今回)
  2. Nuxt.js用heroku.ymlの作成(今回)
  3. Herokuアプリケーションの作成
  4. Nuxt.jsアプリをHerokuにpushする
  5. RailsにAPIドメインをセットする

※ この記事では主にNuxt.js(frontディレクトリ内)のファイルを編集します。

Nuxt.jsのDockerfileに本番用コマンドを追加する

「front」直下にあるDockerfileを、本番環境用に編集していきます。

2021年1月22日 修正

環境変数NPM_CONFIG_PRODUCTIONをDcokerfileから削除し、heroku.ymlに移動しました。

front/Dockerfile
FROM node:14.4.0-alpine

ARG WORKDIR
ARG CONTAINER_PORT
ARG API_URL

ENV HOME=/${WORKDIR} \
    LANG=C.UTF-8 \
    TZ=Asia/Tokyo \
    HOST=0.0.0.0 \
    API_URL=${API_URL}

# ENV check
RUN echo ${HOME}
RUN echo ${CONTAINER_PORT}
RUN echo ${API_URL}

WORKDIR ${HOME}

# 追加
COPY package*.json ./
RUN yarn install

COPY . ./

RUN yarn run build
# ここまで

EXPOSE ${CONTAINER_PORT}

  • COPY package*.json ./ … packageから始まる全てのファイルをワークディレクトリ 直下にコピー。

  • RUN yarn install … パッケージをインストール。package.jsonをコピーした後で実行する。

  • COPY . ./ … ファイル一式をコンテナに全てコピー。同じファイル名が存在する場合は上書きされる。

  • RUN yarn run build … (後述)

RUN yarn run buildは何をしているのか?

上記Dockerfileで記述したRUN yarn run buildは、yarn run buildを実行するようRUN命令で指定しています。

yarn run buildは、package.jsonのbuildスクリプトを実行しています。

front/package.json
"scripts": {
  "dev": "nuxt",
  "build": "nuxt build",  // ←ココ
  "start": "nuxt start",
  "generate": "nuxt generate",
  "lint": "eslint --ext .js,.vue --ignore-path .gitignore ."
},

つまりyarn run buildを実行すると、nuxt buildが実行されているのですね。

このnuxt buildは、Nuxt.jsをWebpackでビルド(構築)して、jsとcssをHeroku向けにミニファイルにしています。

これによりHerokuにもNuxt.jsアプリを表示することができるのです。

Nuxt.js用のheroku.ymlを作成する

「front」ディレクトリ直下にheroku.ymlを作成します。

まずは移動しましょう。

api $ cd ../front

heroku.ymlを作成します。

front $ touch heroku.yml

作成したファイルを開いてこのように編集します。

2021年1月22日 修正

setup.configキーを追加し、本番環境用の環境変数を追加しました。

front/heroku.yml
setup:
  config:
    NODE_ENV: production
    NPM_CONFIG_PRODUCTION: false
build:
  docker:
    web: Dockerfile
  config:
    WORKDIR: app
    API_URL: "https://<前回作成したRailsアプリの名前>.herokuapp.com"
run:
  web: yarn run start
  • build.docker, configこちらの記事で説明しています。
  • yarn run start … Nuxt.jsの本番環境での起動コマンド。

Nuxt.jsをHerokuにデプロイする場合の環境変数

Nuxt.jsをHerokuにデプロイする場合、3つの環境変数を必要とします。

  1. HOST=0.0.0.0 … (必須)Dockerfileに記述済みのため追記の必要なし。

  2. NODE_ENV=production … (必須)Node.jsに現在の環境を定義する。

    Herokuがデフォルトで設定するため、追記の必要なし。

    2021年1月22日 追記

    HerokuがデフォルトでNODE_ENV=production を設定する場合は、stackがheroku(Heroku側が用意した環境)の場合のみです。Docker環境をデプロイする場合、自分で用意する必要があります。情報が間違っており、申し訳ありません。

    参考 Docker環境では無い場合のNode.js サポート - Heroku

  3. NPM_CONFIG_PRODUCTION=false (任意)パッケージのインストールを操作するフラグ。

NPM_CONFIG_PRODUCTION=falseとは何か

このNPM_CONFIG_PRODUCTION=falseとは何なのか? 挙動について説明します。

Herokuのデフォルトの挙動

Node.jsのアプリをデプロイする場合、Herokuはpackege.jsonに書かれた全てのパッケージをインストールします。

そしてビルドを完了したのちにdevDependenciesに書かれたパッケージを削除し、デプロイを実行します。

問題点

既にインストールされている@nuxtjs/eslint-configや、後でインストールする@nuxtjs/vuetifyなど、devDependenciesに書かれたモジュールが無いよ。とエラーを吐くことがあります。

対応策

2つあります。

  1. nuxt.config.jsの設定を開発・本番で切り替えるよう書き換えたり、パッケージをdependenciesにインストールする。
  2. NPM_CONFIG_PRODUCTION=falseの環境変数を設定する。

NPM_CONFIG_PRODUCTION=falseの挙動

この環境変数がfalseの場合は、devDependenciesのパッケージを削除しません。

そのため、NPM_CONFIG_PRODUCTION=falseを設定しています。


ちなみにtrueの場合は、そもそも全てのパッケージのインストールを行わず、dependenciesだけインストールします。

参考 Heroku Node.jsのサポート - Heroku

Nuxt.jsの起動コマンド

Nuxt.jsは、環境によって起動コマンドが変わります。

  • 開発環境 … docker-compose.ymlでyarn run devを実行してNuxt.jsを起動。
  • 本番環境 … heroku.ymlでyarn run startを実行してNuxt.jsを起動。

この本番環境用のyarn run startコマンドは、実行前にnuxt buildを実行する必要があります。

そのためDockerfileにyarn run buildを追記したのです。

GitHubにpushしとく

以上で作業は終了です。

ここまでの変更をpushしておきましょう。

front $ git add -A
front $ git commit -m "edit_Dockerfile&add_heroku.yml"
front $ git push

まとめ

今回は、Dockerfileとheroku.ymlをHerokuデプロイ用に編集していきました。

コードのコピペだけではなく、意味を理解することが大切です。

これを続けていれば、いつの間にかネットの情報が自分の知識になりますよ。

次回~

次回はNuxt.jsのデプロイを完了し、インターネット上に"Hello"を返すAPIアプリケーションを表示させましょう!

▶︎ 次の記事へ。(👇にあるよ)

▷ また今後。(ブックマークしとく)

修正情報

  • 2021年1月22日

    Dockerfileとheroku.ymlを修正しました。

    Herokuデプロイの環境変数NODE_ENVについて、間違った情報があったため追記しました。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
アプリケーション仕様書
1. このカテゴリーの歩き方 #03
このカテゴリーの歩き方(まずはここをチェック)
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. ログイン前のレイアウト構築 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. ログイン前のレイアウト構築 #02
Nuxt.js ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
10. ログイン前のレイアウト構築 #03
Nuxt.js ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
10. ログイン前のレイアウト構築 #04
Nuxt.js addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
10. ログイン前のレイアウト構築 #05
Nuxt.js ウェルカムページをレスポンシブデザインに対応させよう(4/4)
10. ログイン前のレイアウト構築 #06
Nuxt.js 会員登録ページのレイアウトファイルを作成しよう(1/4)
10. ログイン前のレイアウト構築 #07
Nuxt.js 名前、メール、パスワードのコンポーネントファイルを作成しよう(2/4)
10. ログイン前のレイアウト構築 #08
Nuxt.js 親子コンポーネント間の双方向データバインディングを実装する(3/4)
10. ログイン前のレイアウト構築 #09
Nuxt.js Vuetifyのv-text-fieldを使った会員登録フォームのバリデーション設定(4/4)
10. ログイン前のレイアウト構築 #10
Nuxt.js ログインページ実装とHerokuデプロイまで(router. replaceとpushの違いとは)
11. ログイン後のレイアウト構築 #01
Nuxt.js ログイン後のツールバーを作成しよう(inject解説)
11. ログイン後のレイアウト構築 #02
Nuxt.js アカウントメニューページ・ログアウト機能を実装しよう(nuxt-child解説)
11. ログイン後のレイアウト構築 #03
Nuxt.js ログイン後のトップページにプロジェクト一覧を表示しよう
11. ログイン後のレイアウト構築 #04
Nuxt.js プロジェクトページにVuetifyのナビゲーションドロワーを追加しよう
11. ログイン後のレイアウト構築 #05
Nuxt.js paramsIDからプロジェクトを検索してVuexに保存しよう
12. サーバーサイドのログイン認証 #01
JWTとは何か?(ruby-jwtのインストール)
12. サーバーサイドのログイン認証 #02
【Rails×JWT】ログイン認証解説とJWT初期設定ファイルの作成
12. サーバーサイドのログイン認証 #03
【Rails×JWT】トークン発行とデコードを行うAuthTokenクラスの作成
12. サーバーサイドのログイン認証 #04
【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成
12. サーバーサイドのログイン認証 #05
【Rails×JWT】UserクラスからJWTを扱うTokenizableモジュールの作成
12. サーバーサイドのログイン認証 #06
【Rails×JWT】AuthTokenクラスとAuthenticatorモジュールをテストする
12. サーバーサイドのログイン認証 #07
【Rails×JWT】JWTをCookieに保存するログインコントローラーの実装
12. サーバーサイドのログイン認証 #08
【Rails×JWT】ログインコントローラーのテストとHerokuデプロイ
13. フロントエンドのログイン認証 #01
【Rails×Nuxt.js】クロスオリジン通信でのCookie共有設定
13. フロントエンドのログイン認証 #02
【Nuxt.js】Railsからのログイン成功レスポンスをVuexに保存する
13. フロントエンドのログイン認証 #03
【Nuxt.js】ローカルストレージの有効期限を暗号化する(crypto-js解説)
13. フロントエンドのログイン認証 #04
【Nuxt.js】JWT有効期限内のユーザーをログインしたままにする実装
13. フロントエンドのログイン認証 #05
【Nuxt.js】ログイン前後のリダイレクト処理をミドルウェアで実装する
13. フロントエンドのログイン認証 #06
【Nuxt.js】ログイン失敗時のトースターをグローバルイベントとして作成する
13. フロントエンドのログイン認証 #07
【Nuxt.js】エラーページを作成する
13. フロントエンドのログイン認証 #08
【Rails×Nuxt.js】デモプロジェクトの作成とHerokuデプロイ(ログイン認証完)
14. 本番環境への対応 #01
【Rails×Nuxt.js】SafariのクロスサイトCookie保存拒否に対応する
SPA開発
ブログ構築
小ネタ集