daemon.jsonでDockerエンジンのオプション指定 (/etc/docker, insecure-registries)

概要
daemon.json って何？
試した環境
insecure-registries オプションを指定してみる
Windowsの場合は？
daemon.json に設定できるキーって何があるの？
参考情報

概要

f:id:gsf_zero1:20211029114204p:plain

Dockerエンジンに対するオプションの指定の方法で、最初の頃ドキュメント読んでもよくわからなかったので、忘れないようにここにメモメモ。。。

プライベートレジストリを立てたりして、社内のクローズドな環境からしか通信しないので http 通信で済ませたい場合 Dockerエンジンのオプションに --insecure-registry を追加する必要があります。（Dockerエンジンはレジストリのアクセスをデフォルトで https しか許可してくれません。ローカルホスト以外は）

んで、ネットで情報を探すと systemd の設定ファイルとかに直接追記したり、スナップインのファイルを作ったりして指定したりしているものが多いのですが、公式ドキュメントを見ると

The recommended way is to use the platform-independent daemon.json file, which is located in /etc/docker/ on Linux by default.

Control Docker with systemd | Docker Documentation より

と記載されていて、プラットフォーム非依存な daemon.json を使えって書かれています。

daemon.json って何？

んで、この daemon.json さんは、Dockerエンジンの各種オプションを指定することができる設定ファイルという位置付けのファイルです。昔は無かったのかな多分。

ここで、dockerを始めた人で悩む人が多いと思うのですが、このファイルの場所はLinuxだと /etc/docker/daemon.json となります。。。。が、最初は「存在していません」。自分でファイルを追加する必要があります。

aptとかのパッケージ管理ソフトでインストールしている人も多いと思いますが、その場合でも「存在していません」。（インストール時にファイル置いておいてよって思います・・）

ドキュメント見ると、さも最初から存在しているような記載をしている部分があるので、「えっ、私の環境にそのファイル無いんですが・・・」って私は最初なりました。自分で勝手にファイルを追加すればオッケイです。

話を戻すと、この daemon.json さん、Dockerエンジン起動時に何のオプションも指定しなくてもデフォルトで読み込んでくれますので、ファイルを追加して設定を書いておけば、後は勝手にロードされます。

以下、自分の環境で試した結果です。

試した環境

chromebook内のLinux環境にDockerをインストールしている状態です。

$ cat /etc/os-release 
PRETTY_NAME="Debian GNU/Linux 10 (buster)"
NAME="Debian GNU/Linux"
VERSION_ID="10"
VERSION="10 (buster)"
VERSION_CODENAME=buster
ID=debian
HOME_URL="https://www.debian.org/"
SUPPORT_URL="https://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"

$ sudo docker version
Client: Docker Engine - Community
 Version:           20.10.11
 API version:       1.41
 Go version:        go1.16.9
 Git commit:        dea9396
 Built:             Thu Nov 18 00:36:10 2021
 OS/Arch:           linux/arm64
 Context:           default
 Experimental:      true

Server: Docker Engine - Community
 Engine:
  Version:          20.10.11
  API version:      1.41 (minimum version 1.12)
  Go version:       go1.16.9
  Git commit:       847da18
  Built:            Thu Nov 18 00:34:45 2021
  OS/Arch:          linux/arm64
  Experimental:     false
 containerd:
  Version:          1.4.12
  GitCommit:        7b11cfaabd73bb80907dd23182b9347b4245eb5d
 runc:
  Version:          1.0.2
  GitCommit:        v1.0.2-0-g52b36a2
 docker-init:
  Version:          0.19.0
  GitCommit:        de40ad0

insecure-registries オプションを指定してみる

insecure-registries オプションは

プライベートレジストリを構築した際、デフォルトでは docker エンジンは https 通信しか許可していないが

社内などのクローズドな環境で利用する場合は http 通信を許可したい場合などに設定するオプションです。

以下、 /etc/docker/daemon.json が存在していないものとして話を進めます。

まず、現在の状況を確認。

$ sudo docker info 2> /dev/null | tail -5
 Experimental: false
 Insecure Registries:
  127.0.0.0/8
 Live Restore Enabled: false

Insecure Registries: は、127.0.0.0/8 だけとなっています。

ここに、たとえば 192.168.1.10:5000 を追加したい場合、/etc/docker/daemon.json に設定を追加します。

$ sudo sh -c 'cat << EOF > /etc/docker/daemon.json
> {
>       "insecure-registries":[ "192.168.1.10:5000" ]
> }
> EOF
> '

追加後、デーモンを再起動します。

$ sudo systemctl restart docker

設定が読み込まれたか確認。

$ sudo docker info 2> /dev/null | tail -5
 Insecure Registries:
  192.168.1.10:5000
  127.0.0.0/8
 Live Restore Enabled: false

ちゃんと読み込まれていますね。

Windowsの場合は？

Windowsの場合、daemon.json は、C:\ProgramData\docker\config\daemon.json に作成することになります。中身は同じです。

それか、Docker Desktop for Windows を使っている場合は、GUIの設定画面からDocker Engineってメニューをクリックすると右側に daemon.json の内容が出ていますので、そこに追記してDockerエンジンを再起動してもオッケイです。

daemon.json に設定できるキーって何があるの？

以下に一覧があります。

docs.docker.com

2021-11-29時点だと、以下みたいですね。

{
  "allow-nondistributable-artifacts": [],
  "api-cors-header": "",
  "authorization-plugins": [],
  "bip": "",
  "bridge": "",
  "cgroup-parent": "",
  "cluster-advertise": "",
  "cluster-store": "",
  "cluster-store-opts": {},
  "containerd": "/run/containerd/containerd.sock",
  "containerd-namespace": "docker",
  "containerd-plugin-namespace": "docker-plugins",
  "data-root": "",
  "debug": true,
  "default-address-pools": [
    {
      "base": "172.30.0.0/16",
      "size": 24
    },
    {
      "base": "172.31.0.0/16",
      "size": 24
    }
  ],
  "default-cgroupns-mode": "private",
  "default-gateway": "",
  "default-gateway-v6": "",
  "default-runtime": "runc",
  "default-shm-size": "64M",
  "default-ulimits": {
    "nofile": {
      "Hard": 64000,
      "Name": "nofile",
      "Soft": 64000
    }
  },
  "dns": [],
  "dns-opts": [],
  "dns-search": [],
  "exec-opts": [],
  "exec-root": "",
  "experimental": false,
  "features": {},
  "fixed-cidr": "",
  "fixed-cidr-v6": "",
  "group": "",
  "hosts": [],
  "icc": false,
  "init": false,
  "init-path": "/usr/libexec/docker-init",
  "insecure-registries": [],
  "ip": "0.0.0.0",
  "ip-forward": false,
  "ip-masq": false,
  "iptables": false,
  "ip6tables": false,
  "ipv6": false,
  "labels": [],
  "live-restore": true,
  "log-driver": "json-file",
  "log-level": "",
  "log-opts": {
    "cache-disabled": "false",
    "cache-max-file": "5",
    "cache-max-size": "20m",
    "cache-compress": "true",
    "env": "os,customer",
    "labels": "somelabel",
    "max-file": "5",
    "max-size": "10m"
  },
  "max-concurrent-downloads": 3,
  "max-concurrent-uploads": 5,
  "max-download-attempts": 5,
  "mtu": 0,
  "no-new-privileges": false,
  "node-generic-resources": [
    "NVIDIA-GPU=UUID1",
    "NVIDIA-GPU=UUID2"
  ],
  "oom-score-adjust": -500,
  "pidfile": "",
  "raw-logs": false,
  "registry-mirrors": [],
  "runtimes": {
    "cc-runtime": {
      "path": "/usr/bin/cc-runtime"
    },
    "custom": {
      "path": "/usr/local/bin/my-runc-replacement",
      "runtimeArgs": [
        "--debug"
      ]
    }
  },
  "seccomp-profile": "",
  "selinux-enabled": false,
  "shutdown-timeout": 15,
  "storage-driver": "",
  "storage-opts": [],
  "swarm-default-advertise-addr": "",
  "tls": true,
  "tlscacert": "",
  "tlscert": "",
  "tlskey": "",
  "tlsverify": true,
  "userland-proxy": false,
  "userland-proxy-path": "/usr/libexec/docker-proxy",
  "userns-remap": ""
}