Windows 上の Dockerfile
Docker エンジンには、コンテナー イメージの作成を自動化するツールが含まれています。 docker commit コマンドを使用して手動でコンテナー イメージを作成することもできますが、イメージの自動作成プロセスを使用すると、次のような多くの利点があります。
- コンテナー イメージをコードとして保存。
- メンテナンスやアップグレードの目的による、コンテナー イメージの迅速かつ正確な再作成。
- コンテナー イメージと開発サイクル間の継続的な統合。
この自動処理を行う Docker コンポーネントは、Dockerfile であり、docker build コマンドです。
Dockerfile は新しいコンテナー イメージを作成するために必要な命令を含むテキスト ファイルです。 たとえば、ベースとして使用する既存のイメージの指定、イメージの作成プロセス時に実行されるコマンド、コンテナー イメージの新しいインスタンスが展開されるときに実行されるコマンドなどの命令が含まれます。
Docker ビルドは、Dockerfile を使用し、イメージ作成プロセスをトリガーする Docker エンジン コマンドです。
このトピックでは、Windows コンテナーで Dockerfiles を使用する方法、基本構文を解釈する方法、および最も一般的な Dockerfiles 命令について説明します。
このドキュメントでは、コンテナー イメージとコンテナー イメージ レイヤーの概念について説明します。 イメージとイメージレイヤーの詳細については、「コンテナーの基本イメージ」を参照してください。
Dockerfile について詳しくは、Dockerfile リファレンスをご覧ください。
基本構文
ごく基本的なフォームでは、Dockerfile はとても単純です。 次の例では、IIS を含み、’hello world’ サイトを含む新しいイメージを作成します。 この例に含まれるコマンド (# で示されます) については、各手順で説明します。 この記事の以降のセクションでは、Dockerfile 構文規則と、Dockerfile 命令について詳しく説明します。
注意
Dockerfile は、拡張子は付けずに作成する必要があります。 Windows でこれを行うには、好みのエディターでファイルを作成し、"Dockerfile" という名前を使用してそのファイルを保存します (引用符も含めます)。
# Sample Dockerfile
# Indicates that the windowsservercore image will be used as the base image.
FROM mcr.microsoft.com/windows/servercore:ltsc2019
# Metadata indicating an image maintainer.
LABEL maintainer="jshelton@contoso.com"
# Uses dism.exe to install the IIS role.
RUN dism.exe /online /enable-feature /all /featurename:iis-webserver /NoRestart
# Creates an HTML file and adds content to this file.
RUN echo "Hello World - Dockerfile" > c:\inetpub\wwwroot\index.html
# Sets a command or process that will run each time a container is run from the new image.
CMD [ "cmd" ]
Windows 用の Dockerfiles のその他の例については、Dockerfiles for Windows レポジトリを参照してください。
Instructions
Dockerfile 命令は、Docker エンジンに対して、コンテナー イメージを作成するために必要な手順を示します。 これら命令は、順番に、1 つずつ実行されます。 次の例は、Dockerfiles で最もよく使用される命令です。 Dockerfile 命令の完全な一覧については、Dockerfile リファレンスを参照してください。
FROM
FROM 命令では、新しいイメージ作成プロセス中に使用されるコンテナー イメージを設定します。 たとえば、命令 FROM mcr.microsoft.com/windows/servercore を使用すると、結果のイメージは Windows Server Core ベース OS イメージから派生し、依存します。 指定したイメージが、Docker ビルド プロセスが実行されているシステムに存在しない場合、Docker エンジンは、パブリックまたはプライベートのイメージ レジストリからイメージのダウンロードを試行します。
FROM 命令の形式は次のようになります。
FROM <image>
FROM コマンド構文の例を以下に示します。
Microsoft Container Registry (MCR) から ltsc2019 バージョンの Windows Server Core をダウンロードするには:
FROM mcr.microsoft.com/windows/servercore:ltsc2019
詳細については、「FROM リファレンス」を参照してください。
実行
RUN 命令は、コマンドを実行し、新しいコンテナー イメージにキャプチャするように指定します。 これらのコマンドには、ソフトウェアのインストール、ファイルとディレクトリの作成、環境構成の作成などの項目が含まれます。
RUN 命令は次のようになります。
# exec form
RUN ["<executable>", "<param 1>", "<param 2>"]
# shell form
RUN <command>
exec とシェル形式間の違いは、RUN 命令の実行方法です。 exec フォームを使用すると、指定したプログラムが明示的に実行されます。
exec 形式の例を以下に示します。
FROM mcr.microsoft.com/windows/servercore:ltsc2019
RUN ["powershell", "New-Item", "c:/test"]
結果のイメージは、powershell New-Item c:/test コマンドを実行します。
docker history doc-exe-method
IMAGE CREATED CREATED BY SIZE COMMENT
b3452b13e472 2 minutes ago powershell New-Item c:/test 30.76 MB
対照的に、次の例では、同じ操作をシェル フォームで実行しています。
FROM mcr.microsoft.com/windows/servercore:ltsc2019
RUN powershell New-Item c:\test
結果のイメージには、cmd /S /C powershell New-Item c:\test の実行命令があります。
docker history doc-shell-method
IMAGE CREATED CREATED BY SIZE COMMENT
062a543374fc 19 seconds ago cmd /S /C powershell New-Item c:\test 30.76 MB
Windows での実行の使用に関する考慮事項
Windows では、exec 形式で RUN 命令を使用する場合、バックスラッシュをエスケープする必要があります。
RUN ["powershell", "New-Item", "c:\\test"]
ターゲット プログラムが Windows インストーラーの場合は、/x:<directory> フラグを使用してセットアップを抽出してから、実際の (サイレント) インストール手順を実行する必要があります。 また、コマンドが終了するまで待ってから、他の操作を実行する必要があります。 そうしないと、このプロセスは何もインストールせずに途中で終了してしまいます。 詳細については、次の例を参照してください。
Windows での RUN の使用例
この例では、Dockerfile が DISM を使用してコンテナー イメージに IIS をインストールします。
RUN dism.exe /online /enable-feature /all /featurename:iis-webserver /NoRestart
この例では、Visual Studio 再頒布可能パッケージをインストールします。 Start-Process と -Wait パラメーターを使用を使用してインストーラーを実行します。 これにより、Dockerfile の次の命令に進む前に、インストールを確実に完了することができます。
RUN powershell.exe -Command Start-Process c:\vcredist_x86.exe -ArgumentList '/quiet' -Wait
RUN 命令の詳細については、RUN リファレンスを参照してください。
COPY
COPY 命令は、ファイルとディレクトリを、コンテナーのファイルシステムにコピーします。 ファイルとディレクトリは、Dockerfile の相対パスで示す必要があります。
COPY 命令の形式は次のようになります。
COPY <source> <destination>
送信元または送信先のいずれかに空白が含まれる場合は、次の例で示されるように、パスを角かっこと二重引用符で囲みます。
COPY ["<source>", "<destination>"]
Windows での COPY の使用に関する考慮事項
Windows では、変換先形式でスラッシュを使用する必要があります。 たとえば、これらは有効な COPY 命令です。
COPY test1.txt /temp/
COPY test1.txt c:/temp/
一方、バックスラッシュ付きの次の形式は機能しません。
COPY test1.txt c:\temp\
COPY を Windows で使用する例
この例では、ソース ディレクトリのコンテンツを、コンテナー イメージの sqllite というディレクトリに追加します。
COPY source /sqlite/
この例では、config から始まるすべてのファイルを、コンテナー イメージの c:\temp ディレクトリに追加します。
COPY config* c:/temp/
COPY 命令の詳細については、COPY リファレンスをご覧ください。
ADD
ADD 命令は COPY 命令に似ていますが、さらに多くの機能があります。 ADD 命令は、ホストのファイルがコンテナー イメージにコピーされるだけでなく、リモートの場所にあるファイルを URL の仕様に対してコピーします。
ADD 命令の形式は次のようになります。
ADD <source> <destination>
送信元または送信先のいずれかに空白が含まれる場合は、パスを角かっこと二重引用符で囲みます。
ADD ["<source>", "<destination>"]
Windows での ADD 実行に関する考慮事項
Windows では、変換先形式でスラッシュを使用する必要があります。 たとえば、これらは有効な ADD 命令です。
ADD test1.txt /temp/
ADD test1.txt c:/temp/
一方、バックスラッシュ付きの次の形式は機能しません。
ADD test1.txt c:\temp\
さらに、Linux の ADD 動作では、コンピューター上の圧縮されたパッケージを展開できます。 この機能は、Windows ではこの機能を使用できません。
Windows での ADD の使用例
この例では、ソース ディレクトリのコンテンツを、コンテナー イメージの sqllite というディレクトリに追加します。
ADD source /sqlite/
この例では、「config」から始まるすべてのファイルを、コンテナー イメージの c:\temp ディレクトリに追加します。
ADD config* c:/temp/
この例では、Windows 用 Python を、コンテナー イメージの c:\temp ディレクトリにダウンロードします。
ADD https://www.python.org/ftp/python/3.5.1/python-3.5.1.exe /temp/python-3.5.1.exe
ADD 命令の詳細については、ADD リファレンスを参照してください。
WORKDIR
WORKDIR 命令では、RUN、CMD、コンテナー イメージのインスタンスを実行する作業ディレクトリなど、他の Dockerfile 命令の作業ディレクトリを設定します。
WORKDIR 命令の形式は次のようになります。
WORKDIR <path to working directory>
Windows で WORKDIR を使用する場合の考慮事項
Windows では、作業ディレクトリにバックスラッシュが含まれる場合、エスケープする必要があります。
WORKDIR c:\\windows
使用例
WORKDIR c:\\Apache24\\bin
WORKDIR 命令の詳細については、WORKDIR リファレンスを参照してください。
CMD
CMD 命令では、コンテナー イメージのインスタンスを展開するときに実行する既定のコマンドを設定します。 たとえば、コンテナーが NGINX Web サーバーをホストする場合、CMD には、nginx.exe などコマンドを使用して、Web サーバーを起動する命令を含めることができます。 Dockerfile に複数の CMD 命令を指定すると、最後の命令のみが評価されます。
CMD 命令の形式は次のようになります。
# exec form
CMD ["<executable", "<param>"]
# shell form
CMD <command>
Windows での CMD の使用に関する考慮事項
Windows では、CMD 命令に指定されたファイル パスにはフォワード スラッシュを使用し、バックスラッシュをエスケープする (\\) 必要があります。 この例は有効な CMD 命令です。
# exec form
CMD ["c:\\Apache24\\bin\\httpd.exe", "-w"]
# shell form
CMD c:\\Apache24\\bin\\httpd.exe -w
ただし、適切なスラッシュのない次の形式は機能しません。
CMD c:\Apache24\bin\httpd.exe -w
CMD 命令について詳しくは、CMD リファレンスをご覧ください。
エスケープ文字
多くの場合、Dockerfile の命令は複数の行にまたがる必要があります。 これを行うには、エスケープ文字を使用することができます。 既定の Dockerfile のエスケープ文字はバックスラッシュ \ です。 ただし、バックスラッシュは Windows のファイルパスの区切り文字でもあるため、複数の行にまたがるようにこれ使用すると、問題が発生する可能性があります。 これを回避するには、パーサー ディレクティブを使用して、既定のエスケープ文字を変更することもできます。 パーサー ディレクティブについて詳しくは、パーサー ディレクティブを参照してください。
次の例は、既定のエスケープ文字を使用した複数の行にまたがる単一の RUN 命令を示しています。
FROM mcr.microsoft.com/windows/servercore:ltsc2019
RUN powershell.exe -Command \
$ErrorActionPreference = 'Stop'; \
wget https://www.python.org/ftp/python/3.5.1/python-3.5.1.exe -OutFile c:\python-3.5.1.exe ; \
Start-Process c:\python-3.5.1.exe -ArgumentList '/quiet InstallAllUsers=1 PrependPath=1' -Wait ; \
Remove-Item c:\python-3.5.1.exe -Force
エスケープ文字を変更するには、エスケープ パーサー ディレクティブを Dockerfile の最初の行に配置します。 これは、次の例で確認できます。
注意
エスケープ文字として使用できる値は次の 2 つの値のみです。 \ と `。
# escape=`
FROM mcr.microsoft.com/windows/servercore:ltsc2019
RUN powershell.exe -Command `
$ErrorActionPreference = 'Stop'; `
wget https://www.python.org/ftp/python/3.5.1/python-3.5.1.exe -OutFile c:\python-3.5.1.exe ; `
Start-Process c:\python-3.5.1.exe -ArgumentList '/quiet InstallAllUsers=1 PrependPath=1' -Wait ; `
Remove-Item c:\python-3.5.1.exe -Force
エスケープ パーサー ディレクティブについて詳しくは、エスケープ パーサー ディレクティブを参照してください。
Dockerfile の PowerShell
PowerShell コマンドレット
PowerShell コマンドレットは、Dockerfile で RUN 操作を使用して実行できます。
FROM mcr.microsoft.com/windows/servercore:ltsc2019
RUN powershell -command Expand-Archive -Path c:\apache.zip -DestinationPath c:\
REST 呼び出し
PowerShell の Invoke-WebRequest コマンドレットは、Web サービスから情報やファイルを収集するときに便利です。 たとえば、Python を含むイメージをビルドする場合は、次の例に示すように、$ProgressPreference を SilentlyContinue に設定すると、ダウンロードが高速になります。
FROM mcr.microsoft.com/windows/servercore:ltsc2019
RUN powershell.exe -Command \
$ErrorActionPreference = 'Stop'; \
$ProgressPreference = 'SilentlyContinue'; \
Invoke-WebRequest https://www.python.org/ftp/python/3.5.1/python-3.5.1.exe -OutFile c:\python-3.5.1.exe ; \
Start-Process c:\python-3.5.1.exe -ArgumentList '/quiet InstallAllUsers=1 PrependPath=1' -Wait ; \
Remove-Item c:\python-3.5.1.exe -Force
注意
Invoke-WebRequest は、Nano Server でも機能します。
イメージの作成プロセス中にファイルをダウンロードするために PowerShell を使用するもう 1 つのオプションは、.NET WebClient ライブラリを使用することです。 この方法で、ダウンロードのパフォーマンスが向上します。 次の例では、WebClient ライブラリを使用して、Python ソフトウェアをダウンロードしています。
FROM mcr.microsoft.com/windows/servercore:ltsc2019
RUN powershell.exe -Command \
$ErrorActionPreference = 'Stop'; \
(New-Object System.Net.WebClient).DownloadFile('https://www.python.org/ftp/python/3.5.1/python-3.5.1.exe','c:\python-3.5.1.exe') ; \
Start-Process c:\python-3.5.1.exe -ArgumentList '/quiet InstallAllUsers=1 PrependPath=1' -Wait ; \
Remove-Item c:\python-3.5.1.exe -Force
注意
Nano Server は、現在 WebClient をサポートしていません。
Powershell スクリプト
場合によっては、イメージの作成プロセス中に使用されるコンテナーにスクリプトをコピーしてから、コンテナー内からそのスクリプトを実行する方法が便利なことがあります。
注意
この方法では、イメージ レイヤー キャッシュが制限され、Dockerfile の読みやすさが低下します。
この例では、ADD 命令を使用して、ビルド コンピューターからコンテナーにスクリプトをコピーします。 このスクリプトは、RUN 命令を使用して実行されます。
FROM mcr.microsoft.com/windows/servercore:ltsc2019
ADD script.ps1 /windows/temp/script.ps1
RUN powershell.exe -executionpolicy bypass c:\windows\temp\script.ps1
Docker のビルド
Dockerfile が作成され、ディスクに保存されると、docker build を実行して新しいイメージを作成できます。 docker build コマンドには、いくつかの省略可能なパラメーターと、Dockerfile のパスを指定できます。 すべてのビルド オプションの一覧を含め、Docker のビルドの詳細については、ビルドのレファレンスをご覧ください。
docker build コマンドの形式は次のようになります。
docker build [OPTIONS] PATH
たとえば、次のコマンドでは、’iis’ というイメージが作成されます。
docker build -t iis .
ビルド プロセスが開始されると、出力に状態が示され、任意のスローされたエラーが返されます。
C:\> docker build -t iis .
Sending build context to Docker daemon 2.048 kB
Step 1 : FROM mcr.microsoft.com/windows/servercore:ltsc2019
---> 6801d964fda5
Step 2 : RUN dism /online /enable-feature /all /featurename:iis-webserver /NoRestart
---> Running in ae8759fb47db
Deployment Image Servicing and Management tool
Version: 10.0.10586.0
Image Version: 10.0.10586.0
Enabling feature(s)
The operation completed successfully.
---> 4cd675d35444
Removing intermediate container ae8759fb47db
Step 3 : RUN echo "Hello World - Dockerfile" > c:\inetpub\wwwroot\index.html
---> Running in 9a26b8bcaa3a
---> e2aafdfbe392
Removing intermediate container 9a26b8bcaa3a
Successfully built e2aafdfbe392
結果は、新しいコンテナー イメージになります。この例では、’iis’ というイメージです。
docker images
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
iis latest e2aafdfbe392 About a minute ago 207.8 MB
windowsservercore latest 6801d964fda5 4 months ago 0 B