Dockerコンテナに未インストールのコマンドを実行する : docker debug コマンド
TL;DR
-
slimなどの軽量イメージは、必要最低限のコマンドしかインストールされていない - そのため、動作確認やデバッグのためのコマンド（例：
ping）が使用できない - そんな時は、
docker debugコマンドを使うと、コンテナに未インストールのコマンドを実行できる
注意事項
docker debugコマンドはDocker Desktopの有料プラン(Pro/Team/Business) でしか利用できません。
背景
Dockerイメージを作成する際のベストプラクティスとして、「必要最小限の要素のみを含める」というものがあります。
「イメージサイズを小さくすることによるダウンロード時間の短縮」や「脆弱性が入り込むリスクを低減する」といったものが主な理由です。
一方で、動作確認をするときに、普段使用しているコマンドが使用できず、不便さを感じることも多々あります。
複数コンテナを使用したシステムで、「疎通ができているか確認しよう」と気軽にpingをしてエラーが発生すると辛いものがありますよね。
そんな時は、docker debugコマンドを使うと、コンテナに未インストールのコマンドを実行できます。
docker debug コマンド
使用例
まずは docker debugがない場合を見てみましょう。
ここでは、軽量イメージとしてhello-worldを使用します。
hello-worldコンテナを起動して、シェルに接続してみます。
❯ docker run -it hello-world sh
docker: Error response from daemon: failed to create task for container: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: error during container init: exec: "sh": executable file not found in $PATH: unknown
Run 'docker run --help' for more information
はい、そもそもshがインストールされていないので、エラーになります。
次に、docker debugコマンドを使って、hello-worldコンテナにアクセスしてみます。
やり方は簡単で、 docker debug {image_name} というコマンドを実行するだけです。
（起動中のコンテナにアクセスする場合は、docker debug {container_name} というコマンドを実行します）
❯ docker debug hello-world
▄
▄ ▄ ▄ ▀▄▀
▄ ▄ ▄ ▄ ▄▇▀ █▀▄ █▀█ █▀▀ █▄▀ █▀▀ █▀█
▀████████▀ █▄▀ █▄█ █▄▄ █ █ ██▄ █▀▄
▀█████▀ DEBUG
Builtin commands:
- install [tool1] [tool2] ... Add Nix packages from: https://search.nixos.org/packages
- uninstall [tool1] [tool2] ... Uninstall NixOS package(s).
- entrypoint Print/lint/run the entrypoint.
- builtins Show builtin commands.
Checks:
✓ distro: unknown/scratch
✓ entrypoint linter: no errors (run 'entrypoint' for details)
Note: This is a sandbox shell. All changes will not affect the actual image.
Version: 0.0.41
root@ec153840d1e6 / [hello-world:latest]
Dockerのロゴが表示され、デバッグ用のサンドボックスシェルが起動しました。
この後は、通常のシェルと同様にコマンドを実行できます。
docker > pwd
/
root@ec153840d1e6 / [hello-world:latest]
docker > ls
dev etc hello nix proc sys
root@ec153840d1e6 / [hello-world:latest]
docker > ping google.com
PING google.com (142.251.42.142) 56(84) bytes of data.
64 bytes from nrt12s45-in-f14.1e100.net (142.251.42.142): icmp_seq=1 ttl=62 time=26.9 ms
64 bytes from nrt12s45-in-f14.1e100.net (142.251.42.142): icmp_seq=2 ttl=62 time=33.5 ms
...
root@ec153840d1e6 / [hello-world:latest]
追加のコマンドをインストールする
docker debugを使うと、コンテナに未インストールのコマンドを実行できます。
しかしながら、すべてのコマンドが事前に準備されている訳ではありません。
例として、nslookupはインストールされていないため、エラーになります。
docker > nslookup google.com
zsh: command not found: nslookup
このような場合は、installコマンドを使って、デバッグ環境にコマンドをインストールします。
使用したいコマンドが入っているパッケージを https://search.nixos.org/packages で検索し、installコマンドでインストールします。
今回使用したいnslookupはbindパッケージに含まれているようでしたのでこちらを指定します。
docker > install bind
Tip: You can install any package available at: https://search.nixos.org/packages.
installing 'bind-9.18.28'
building '/nix/store/d1cpn3yjl14aib5p82ig6wkk4plxjb8j-user-environment.drv'...
root@ec153840d1e6 / [hello-world:latest]
docker > nslookup google.com
Server: 192.168.65.7
Address: 192.168.65.7#53
Non-authoritative answer:
Name: google.com
Address: 172.217.175.14
Name: google.com
Address: 2404:6800:4004:825::200e
無事にnslookupコマンドが使えるようになりました。
Reference
公式ドキュメント
参考書籍
Docker Deep Diveという書籍が、Dockerの全体像を理解するのに役立ちます。
Zero to Dockerとタイトルにあるように、まだDockerを使ったことがない人にも優しく、なおかつDockerの内部的な仕組みについても詳しく書かれています。
Dockerをより良く使いたい人、またその中身についても興味がある人にはおすすめです。
Discussion