docker buildx history export を使用してビルド履歴をエクスポートする方法

はじめに

この実験では、Docker ビルド履歴を管理およびエクスポートするためにdocker buildx history exportコマンドを活用する方法を学びます。まず、シンプルな Docker イメージをビルドし、docker historyコマンドを使用してそのビルド履歴を確認します。

その後、特定のイメージのビルド履歴をファイルにエクスポートする方法を学びます。最後に、指定したビルダー（builder）のすべてのビルド記録をエクスポートする方法を探求し、ビルド活動の包括的な概要を把握します。このチャレンジを通じて、Docker イメージのビルドプロセスを効果的に追跡・管理するスキルを習得できます。

Skills Graph

シンプルなイメージをビルドし、その履歴を確認する

このステップでは、シンプルな Docker イメージをビルドし、その履歴を確認する方法を学びます。Docker イメージのビルドには、Dockerfileの作成が必要です。Dockerfileは、イメージを構築するためにコマンドラインで実行可能なすべてのコマンドを含むテキストファイルです。

まず、~/projectディレクトリに移動します（まだ移動していない場合）。

cd ~/project

次に、シンプルなDockerfileを作成します。~/projectディレクトリにDockerfileという名前のファイルを作成します。

nano Dockerfile

Dockerfileに以下の内容を追加します：

FROM ubuntu:latest
RUN echo "Hello, Docker!" > /app/hello.txt
CMD ["cat", "/app/hello.txt"]

このDockerfileは以下の処理を行います：

• FROM ubuntu:latest: 新しいイメージのベースイメージを指定します。Docker Hub から最新版の Ubuntu イメージを使用します。
• RUN echo "Hello, Docker!" > /app/hello.txt: イメージビルドプロセス中にコマンドを実行します。/appディレクトリを作成し、"Hello, Docker!"というテキストをhello.txtファイルに書き込みます。
• CMD ["cat", "/app/hello.txt"]: このイメージからコンテナを起動した際に実行されるデフォルトコマンドを指定します。cat /app/hello.txtコマンドを実行し、hello.txtファイルの内容を表示します。

ファイルを保存し、nano エディタを終了します（Ctrl + X、次にY、そしてEnterを押します）。

次に、docker buildコマンドを使用して Docker イメージをビルドします。イメージにmy-hello-imageという名前とlatestタグを付けます。コマンド末尾の.は、Dockerfileが現在のディレクトリにあることを示します。

docker build -t my-hello-image:latest .

ビルドプロセスを示す出力が表示され、各ステップが実行されていることがわかります。

イメージがビルドされた後、docker historyコマンドを使用してイメージの履歴を確認できます。このコマンドは、イメージを構成するレイヤーと各レイヤーを作成するために使用されたコマンドを表示します。

docker history my-hello-image:latest

出力には、各レイヤーに関する情報（レイヤーID、使用されたコマンド、作成時間、サイズなど）が表形式で表示されます。この履歴は、イメージのビルド方法を理解したり、ビルドの問題をデバッグしたりするのに役立ちます。

ビルド履歴をファイルにエクスポートする

前のステップでは、Docker イメージのビルド履歴をターミナル上で直接確認しました。このステップでは、このビルド履歴をファイルにエクスポートして後で分析したり共有したりする方法を学びます。

docker historyコマンドの出力を標準出力リダイレクト演算子>を使用してファイルに書き込むことができます。my-hello-image:latestイメージの履歴を~/projectディレクトリ内のhistory.txtというファイルにエクスポートしてみましょう。

まず、~/projectディレクトリにいることを確認します：

cd ~/project

次に、以下のコマンドを実行して履歴をエクスポートします：

docker history my-hello-image:latest > history.txt

このコマンドはdocker history my-hello-image:latestを実行し、出力を画面に表示する代わりにhistory.txtファイルに書き込みます。

catコマンドを使用してファイルの内容を表示し、ファイルが作成されビルド履歴が含まれていることを確認できます：

cat history.txt

前のステップで確認したのと同じビルド履歴情報が表示されますが、今回はhistory.txtファイルに保存されています。このファイルは簡単に共有したり、ドキュメントとして使用したりできます。

ビルド履歴をファイルにエクスポートすることは、Docker イメージのビルド方法を記録として残すのに役立つ方法です。これはデバッグ、監査、共同作業に有用です。

ビルダーの全ビルド記録をエクスポートする

前のステップでは、Docker イメージをビルドし、その履歴をエクスポートしました。Docker のデフォルトビルダーである BuildKit は、すべてのビルド操作の記録を保持しています。このステップでは、これらのビルド記録をすべてエクスポートする方法を学びます。

全ビルド記録をエクスポートするには、docker buildx buildコマンドに--metadata-fileフラグを指定します。このフラグを使用すると、ビルドメタデータ（ビルド記録を含む）を JSON 形式で指定したファイルに書き込むことができます。

まず、~/projectディレクトリにいることを確認してください：

cd ~/project

次に、再度イメージをビルドしますが、今回はビルドメタデータをbuild-records.jsonというファイルにエクスポートします。最初のステップで作成した同じDockerfileを使用します。

docker buildx build --metadata-file build-records.json -t my-hello-image:latest .

docker buildx buildコマンドは Docker Buildx プラグインの一部で、拡張されたビルド機能を提供します。--metadata-file build-records.jsonフラグは、BuildKit にビルドメタデータを指定したファイルに書き込むよう指示します。

ビルドが完了すると、~/projectディレクトリにbuild-records.jsonファイルが作成されます。このファイルには、JSON 形式でのビルドプロセスに関する詳細な情報が含まれています。

build-records.jsonファイルの内容はcatコマンドで確認できます：

cat build-records.json

出力は JSON オブジェクトで、ビルドステップに関する情報、生成されたイメージ、その他のメタデータなど、ビルドに関する様々な詳細が含まれます。この包括的な記録は、高度な分析、自動化、他のツールとの統合に役立ちます。

ビルド記録をエクスポートすることで、単なるイメージ履歴よりも詳細なビルドプロセスの情報が得られ、各ビルドステップの実行状況や関連する依存関係を把握することができます。

まとめ

この実験では、Docker イメージを構築する基本的な手順を学びました。まず、ベースイメージの指定、ビルド時のコマンド実行、コンテナのデフォルトコマンド定義など、ビルドプロセスの指示を含むDockerfileを作成しました。その後、docker buildコマンドを使用してイメージを構築し、識別しやすいようにタグ付けしました。

イメージの構築後、docker historyコマンドを使用してイメージの履歴を確認する方法を学びました。このコマンドは、イメージを構築する際に使用されたレイヤーやコマンドに関する洞察を提供します。さらに、特定のイメージのビルド履歴をdocker buildx history exportでファイルにエクスポートする方法や、現在のビルダーの全ビルド記録をエクスポートする方法を通じて、ビルドの詳細を保存・確認する手法を実践しました。