dockerがDockerfileをビルドするときにRUNnpmインストール命令をキャッシュする方法


86

現在、アプリケーション用のノードバックエンドを開発しています。それをドッキングするとき(docker build .)、最も長いフェーズはRUN npm installです。このRUN npm install命令は、サーバーコードが少し変更されるたびに実行されるため、ビルド時間が長くなり、生産性が低下します。

アプリケーションコードが存在する場所でnpminstallを実行し、ADD命令を使用してnode_modulesをコンテナーに追加すると、この問題が解決することがわかりましたが、ベストプラクティスにはほど遠いです。それは、それをドッキングするという考え全体を壊し、コンテナの重量を大幅に増加させます。

他の解決策はありますか?

回答:


125

さて、Dockerファイルを書くときの効率に関するこの素晴らしい記事を見つけました。

これは、RUN npm install命令を実行する前にアプリケーションコードを追加する不正なDockerファイルの例です。

FROM ubuntu

RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list
RUN apt-get update
RUN apt-get -y install python-software-properties git build-essential
RUN add-apt-repository -y ppa:chris-lea/node.js
RUN apt-get update
RUN apt-get -y install nodejs

WORKDIR /opt/app

COPY . /opt/app
RUN npm install
EXPOSE 3001

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

アプリケーションのコピーを2つのCOPY命令(1つはpackage.jsonファイル用、もう1つは残りのファイル用)に分割し、実際のコードを追加する前にnpm install命令を実行することにより、コードを変更してもRUN npminstallはトリガーされません。命令では、p​​ackage.jsonの変更のみがトリガーされます。より良い練習用Dockerファイル:

FROM ubuntu
MAINTAINER David Weinstein <david@bitjudo.com>

# install our dependencies and nodejs
RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list
RUN apt-get update
RUN apt-get -y install python-software-properties git build-essential
RUN add-apt-repository -y ppa:chris-lea/node.js
RUN apt-get update
RUN apt-get -y install nodejs

# use changes to package.json to force Docker not to use the cache
# when we change our application's nodejs dependencies:
COPY package.json /tmp/package.json
RUN cd /tmp && npm install
RUN mkdir -p /opt/app && cp -a /tmp/node_modules /opt/app/

# From here we load our application's code in, therefore the previous docker
# "layer" thats been cached will be used if possible
WORKDIR /opt/app
COPY . /opt/app

EXPOSE 3000

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

これは、package.jsonファイルが追加された場所であり、その依存関係をインストールして、アプリが存在するコンテナーWORKDIRにコピーします。

ADD package.json /tmp/package.json
RUN cd /tmp && npm install
RUN mkdir -p /opt/app && cp -a /tmp/node_modules /opt/app/

すべてのDockerビルドでnpmインストールフェーズを回避するには、これらの行をコピーして、^ / opt / app ^をアプリがコンテナー内にある場所に変更します。


2
それはうまくいきます。しかし、いくつかのポイント。、afaikADDを支持することはお勧めしませんCOPYCOPYさらに効果的です。IMO、最後の2つの段落は重複しているため、必要ありません。また、アプリの観点からWORKDIRは、設定されている限り、ファイルシステムのどこにアプリが存在するかは問題ではありません。
eljefedelrodeodeljefe 2016年

2
さらに良いのは、を含むすべてのapt-getコマンドを1つのRUNに結合することapt-get cleanです。また、。/ node_modulesを.dockerignoreに追加して、作業ディレクトリがビルドされたコンテナにコピーされないようにし、ビルドのビルドコンテキストコピーステップを高速化します。
対称2016

1
同じアプローチですがpackage.json、最終的な静止位置に追加するだけでも問題なく機能します(cp / mvを削除します)。
J.フリッツバーンズ

27
わかりません。なぜ一時ディレクトリにインストールしてからアプリディレクトリに移動するのですか?なぜアプリディレクトリにインストールしないのですか?ここで何が欠けていますか?
joniba 2017年

1
これはおそらく死んでいますが、将来の読者のために言及したいと思いました。@jonibaこれを行う理由の1つは、ローカルホストファイルシステムのnode_modulesに干渉することなく、composeで一時フォルダーを永続ボリュームとしてマウントすることです。ダウンロードされた再package.jsonの変更が場合、すなわち私は、コンテナ内でローカルだけでなく、私のアプリを実行して、まだ私のnode_modulesを持っていない常に能力を維持することができます
dancypants

41

奇妙な!多段階ビルドについては誰も言及していません。

# ---- Base Node ----
FROM alpine:3.5 AS base
# install node
RUN apk add --no-cache nodejs-current tini
# set working directory
WORKDIR /root/chat
# Set tini as entrypoint
ENTRYPOINT ["/sbin/tini", "--"]
# copy project file
COPY package.json .

#
# ---- Dependencies ----
FROM base AS dependencies
# install node packages
RUN npm set progress=false && npm config set depth 0
RUN npm install --only=production 
# copy production node_modules aside
RUN cp -R node_modules prod_node_modules
# install ALL node_modules, including 'devDependencies'
RUN npm install

#
# ---- Test ----
# run linters, setup and tests
FROM dependencies AS test
COPY . .
RUN  npm run lint && npm run setup && npm run test

#
# ---- Release ----
FROM base AS release
# copy production node_modules
COPY --from=dependencies /root/chat/prod_node_modules ./node_modules
# copy app sources
COPY . .
# expose port and define CMD
EXPOSE 5000
CMD npm run start

ここに素晴らしいチュートリアル:https//codefresh.io/docker-tutorial/node_docker_multistage/


2
持って何次第ですCOPY後に声明をENTRYPOINT
リンデ

Dockerfileを編集するたびに依存関係を再インストールせずにDockerfileをテストする場合にも、優れた利点があります
XavierBrassoud20年

31

最も簡単なアプローチは、Dockerのコピーセマンティクスを活用することであることがわかりました。

COPY命令は、新しいファイルまたはディレクトリをからコピーし、パスのコンテナのファイルシステムに追加します。

これは、最初にpackage.jsonファイルを明示的にコピーしてから、npm installキャッシュできるステップを実行すると、残りのソースディレクトリをコピーできることを意味します。package.jsonファイルが変更された場合、それは新しくなり、将来のビルドのためにnpminstallキャッシュを再実行します。

Dockerfileの末尾のスニペットは次のようになります。

# install node modules
WORKDIR  /usr/app
COPY     package.json /usr/app/package.json
RUN      npm install

# install application
COPY     . /usr/app

7
代わりにcd /usr/appを使用できます/使用する必要がありますWORKDIR /usr/app
ウラジミールヴカナック

1
@VladimirVukanac:+1:WORKDIRの使用について; 私はそれを考慮に入れるために上記の答えを更新しました。
J.フリッツ・バーンズ

1
@ user557657 WORKDIRは、コマンドが実行される将来のイメージ内のディレクトリを設定します。したがって、この場合、/usr/appイメージ内からnpm installを実行/usr/app/node_modulesし、npminstallからインストールされた依存関係を使用してを作成します。
J.フリッツバーンズ

1
@ J.FritzBarnesどうもありがとう。残りのファイルと一緒にファイルを再度COPY . /usr/appコピーしませんか?package.json/usr/app
user5576 5719

1
Dockerはnpm installpackage.json変更があった場合にコマンドを再実行せず、RUNコマンドの結果をキャッシュし、同じRUNコマンドが同じ結果を生成すると想定します。キャッシュを無効にするにはdocker build、-no-cacheフラグを指定して実行するか、何らかの方法でRUNコマンドを変更する必要があります。
MikhailZhuravlev19年

3

すでにご存知かもしれませんが、同じフォルダーに.dockerignoreファイルを含めることができます。

node_modules
npm-debug.log

Dockerハブにプッシュするときに画像が肥大化しないようにするため


1

tmpフォルダーを使用する必要はありません。package.jsonをコンテナーのアプリケーションフォルダーにコピーし、インストール作業を行って、後ですべてのファイルをコピーするだけです。

COPY app/package.json /opt/app/package.json
RUN cd /opt/app && npm install
COPY app /opt/app

コンテナディレクトリ/ opt / appでnpminstallを実行してから、すべてのファイルをローカルマシンから/ opt / appにコピーしていますか?
user5576 5719
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.