docker buildのオプション一覧｜基本から応用まで徹底解説

（最終更新月：2023年9月）

✔当記事は以下の疑問をお持ちの方に向けた内容となっています

✔当記事で紹介する内容

• docker buildオプションの基本的な概念
• docker buildオプションの正しい使い方と応用例
• 実際のdocker buildオプションの適用事例

当記事では、docker buildオプションの基本から応用まで、具体的に解説しています。

ぜひ最後までご覧ください。

Docker Buildの解説

こちらでは、Docker Buildとはそもそも何なのかを明らかにしていきます。

基本的なことになりますので、必ず目を通しておきましょう。

• Docker Buildとは？
• Docker Buildの基本的な使い方

Docker Buildとは？

Docker Buildは、DockerfileからDockerイメージを構築するプロセスです。

Dockerfileには、イメージの作成に必要な命令が記述されており、docker buildコマンドでこれを実行します。

例は以下のとおりです。

docker build -t my-image:latest .

カレントディレクトリのDockerfileからmy-image:latestというイメージを作成します。

Docker Buildの基本的な使い方

Docker Buildの基本的な使い方は、Dockerfileを作成し、その中にイメージ構築の手順を記述することから始まります。

【保存版】Dockerfileの書き方｜基本からコマンド一覧まで

「dockerfile」の基本的な使い方と作り方について学びたいですか？dockerfileは、Dockerのためのスクリプトファイルで、コンテナ化されたアプリケーションを一意に構築・管理する主要なツールです。この記事では、dockerfileの作成方法と適切なコードの書き方を、具体的なコード例とともにわかりやすく解説します。初心者にとっても、必読の内容となっています。

itc.tokyo

2023.08.12

次に、docker buildコマンドを使用してイメージを構築しましょう。

docker build -t my-app .

my-appという名前のイメージができあがります。

Docker Buildの詳細な説明

Docker Buildの詳しい使い方についても見ていきましょう。

異なるソースからのビルド方法を解説します。

• Gitリポジトリを使ったビルド方法
• tarボールやテキストファイルを利用したビルド方法

Gitリポジトリを使ったビルド方法

Docker BuildはGitリポジトリから直接ビルドすることも可能です。

docker build -t my-image-name https://github.com/username/repository.git

指定したGitリポジトリからイメージを構築します。

tarボールやテキストファイルを利用したビルド方法

tarボールやテキストファイルを使用してイメージの構築も可能。

docker build - < Dockerfile.tar.gz

tarボールに含まれるDockerfileからイメージを構築します。

Docker Buildのオプション一覧

Dockerのbuildコマンドには多くのオプションがあります。

以下は、主要なオプションの一覧表です。

オプション名	説明	例
-t, --tag	イメージに名前とタグを付けます。	docker build -t myimage:1.0 .
--build-arg	ビルド時の変数を設定します。	docker build --build-arg VAR=value .
--file, -f	Dockerfileの名前またはパスを指定します。デフォルトはDockerfileです。	docker build -f MyDockerfile .
--no-cache	キャッシュを使用せずにビルドします。	docker build --no-cache .
--pull	イメージの新しいバージョンを強制的にプルします。	docker build --pull .
--rm	ビルド後に中間コンテナを削除します（デフォルトはtrue）。	docker build --rm=false .
--squash	新しいイメージと親イメージのすべての層を1つの新しい層に統合します（実験的オプション）。	docker build --squash .
--compress	ビルドコンテキストを圧縮してDockerデーモンに送信します。	docker build --compress .
--network	ビルドプロセス中に使用するネットワークモードを指定します。	docker build --network=host .

この表は、docker buildの主要なオプションの一部を示しています。

ほかにも多くのオプションがありますので、具体的なニーズや詳細に応じて公式ドキュメントを参照することをおすすめします。

Docker Buildの実用例

こちらでは、Docker Buildの実用例についてお伝えします。

さまざまなソースから構築が可能です。

• PATHを用いた構築例
• URLを使った構築例
• パイプで構築する例

PATHを用いた構築例

ローカルのPATHを指定してビルドすることが一般的です。

docker build -t my-image /path/to/Dockerfile

指定したPATHのDockerfileからイメージを構築します。

URLを使った構築例

URLを指定してリモートからビルドすることも可能です。

docker build -t my-image https://example.com/Dockerfile

指定したURLのDockerfileからイメージを構築します。

パイプで構築する例

パイプを使用して、標準入力からDockerfileを渡せます。

cat Dockerfile | docker build -t my-image -

パイプでDockerfileを渡して、イメージを構築します。

Docker Buildの上級オプションとその使い方

こちらでは、Docker Buildの上級オプションについてお伝えします。

• .dockerignoreファイルとは？
• イメージのタグ付け(-t)
• Dockerfileの指定(-f)
• ビルドプロセスを制御するオプション

.dockerignoreファイルとは？

.dockerignoreファイルは、ビルドコンテキストから特定のファイルやディレクトリを除外するために使用されます。

以下のようなイメージに含めたくないファイルを指定しましょう。

• ログファイル
• 一時ファイル

イメージのタグ付け(-t)

-tオプションを使用して、イメージにタグを付けられます。

docker build -t my-image:latest .

こちらで作成されたイメージタグは、my-image:latestです。

Dockerfileの指定(-f)

-fオプションで、特定のDockerfileを指定できます。

docker build -f /path/to/special/Dockerfile .

指定したパスのDockerfileを使用してビルドします。

ビルドプロセスを制御するオプション

以下のオプションは、ビルドプロセスの細かい制御を可能にします。

• --cgroup-parent
• --ulimit
• --build-arg
• --security-opt

–cgroup-parent

コンテナのcgroup親を設定し、特定のcgroup内でコンテナを実行できます。

docker run --cgroup-parent=/my_custom_cgroup some_image

–ulimit

コンテナ内のユーザープロセスに対するulimit値を設定します。

ulimitは、ユーザープロセスが消費できるリソースの上限を制御するためのもの。

オープンできるファイルの最大数や、プロセスが使用できる最大メモリなどを制限できます。

docker run --ulimit nofile=1024:2048 some_image

この例では、オープンできるファイルの最大数を1024、ソフトリミットと2048、ハードリミットとして設定しています。

–build-arg

Dockerイメージのビルド時に、Dockerfile内で使用される変数の値を設定します。

ビルド時に動的な値をDockerfileに渡せるオプションです。

docker build --build-arg MY_VAR=my_value .

この例では、Dockerfile内でMY_VARという変数が使用されている場合、その値としてmy_valueが設定されます。

–security-opt

コンテナのセキュリティオプションを設定します。

AppArmor、SELinux、seccompなどのセキュリティ技術の設定をカスタマイズが可能です。

AppArmorプロファイルの設定はこちら。

docker run --security-opt apparmor=profile_name some_image

SELinuxラベルの設定です。

docker run --security-opt label=type:container_t some_image

seccompプロファイルの設定は以下のとおり。

docker run --security-opt seccomp=/path/to/seccomp/profile.json some_image

これらのオプションは、コンテナのリソース使用量、セキュリティ、ビルド設定などを細かく制御するためのものです。

適切に使用することで、コンテナの動作を最適化したり、セキュリティを強化したりできます。

ビルド時の設定とカスタマイズ

こちらでは、ビルド時の設定とカスタマイズについてお伝えします。

• コンテナのhostsファイルのエントリ追加
• ビルドステージの対象を指定するオプション
• ビルド時の出力変更
• 外部キャッシュ・ソースの指定

コンテナのhostsファイルのエントリ追加

--add-hostオプションで、ビルド中のコンテナのhostsファイルにエントリを追加できます。

docker build --add-host myhost:192.168.0.1 .

myhostという名前で指定したIPアドレスにアクセスできるようにします。

ビルドステージの対象を指定するオプション

--targetオプションで、特定のビルドステージまでのビルドを実行できます。

docker build --target build-stage .

build-stageと名付けられたステージまでのビルドを実行します。

ビルド時の出力変更

--quietオプションなどを使用して、ビルド時の出力を変更可能。

docker build --quiet .

ビルドプロセスの詳細な出力を抑制します。

外部キャッシュ・ソースの指定

--cache-fromオプションで、外部のキャッシュソースを指定できます。

docker build --cache-from=my-cache-image .

指定したイメージをキャッシュソースとして使用します。

実験的機能とオプション

こちらでは、Docker Buildの実験的機能とオプションについてお伝えします。

• スカッシュオプション(–squash)とは
• 制限事項と動作条件
• Docker実験的モードの有効化

スカッシュオプション(–squash)とは

--squashオプションは、イメージのすべてのレイヤーをひとつにまとめる機能です。

docker build --squash .

ビルドされたイメージのレイヤーをひとつにまとめます。

制限事項と動作条件

実験的機能には、特定の制限事項や動作条件があります。

一部のオプションは特定のDockerバージョンでのみ使用可能であったり、特定の設定が必要であったりします。

Docker実験的モードの有効化

Dockerの実験的機能を使用するには、Dockerの実験的モードを有効にする必要があります。

これには、Dockerの設定ファイルを編集するなどの手順が必要です。

よくあるエラーと対策

こちらでは、Docker Build時によく遭遇するエラーとその対策についてお伝えします。

• Dockerfileの文法エラー
• イメージの取得失敗
• ビルドリソースの不足

Dockerfileの文法エラー

Dockerfileの文法エラーはよく発生します。

エラーメッセージを注意深く読み、Dockerfileの該当行を確認することで、問題を解決できることが多いです。

イメージの取得失敗

基底イメージの取得失敗などもよく発生します。

以下などを確認すると良いでしょう。

• ネットワーク接続
• イメージ名のタイプミス
• プロキシ設定

ビルドリソースの不足

ビルドに必要なリソース（CPU、メモリなど）が不足するとエラーが発生します。

システムリソースの確認と適切な設定が必要です。

まとめ

当記事では、docker buildオプションについて解説してきました。

• Docker Buildは、コンテナ化されたアプリケーションの開発において中心的なプロセス
• 多岐にわたるオプションを適切に使用することで、ビルドプロセスを最適化可能
• 実験的機能を活用することで、最新の機能を試せる

Docker Buildは、コンテナ化されたアプリケーションの開発において欠かせないプロセスであり、その理解と効果的な使用が重要です。

最新の情報とベストプラクティスについては、常にアップデートされる公式リソースを参照することが重要です。