Ansibleのdocker_imageの実行時エラーについて

Question

Ansibleのdocker_imageを使用しリモートでコンテナの管理を行いたい

AnsibleでDockerと連携してコンテナの管理を行おうとしています。
その際、docker-pyを使用しイメージを取得しようとしたところでエラーが発生しました。

以下のエラーを解消するにはどうしたらよいでしょうか。

発生している問題・エラーメッセージ

TASK [PUll docker image] ************************************************************
failed: [localhost] (item=<Docker Host IP>:2376) => {"ansible_loop_var": "item", "changed": false, "item": "<Docker Host IP>:2376", "msg": "state is present but all of the following are missing: source"}

該当のソースコード

---
- name: Management Docker
  # host：ansibleサーバ
  hosts: localhost
  vars:
    docker_hosts:
            - '<Docker Host IP>:2376'
    required_docker_images: "ansible/centos7-ansible"
    tmp_dir: docker_repo

  tasks:
  ## ユーザ定義ネットワーク作成
  - name: Create docker local network
    docker_network:
      docker_host: "{{ item }}"
      name: ansible_network
    with_items: "{{ docker_hosts }}"
  ## Dockerイメージ取得
  - name: PUll docker image
    docker_image:
      docker_host: "{{ item }}"
      name: "{{ required_docker_images }}"
    with_items: "{{ docker_hosts }}"
  ## Dockerfileの準備
  - name: Get Nginx Dockerfile
    git:
      repo: https://github.com/nginxinc/docker-nginx.git
      dest: "{{ tmp_dir }}"
  ## Docker Buildの実行
  - name: Build Dockerfile
    docker_image:
      docker_host: "{{ item }}"
      path: "{{ tmp_dir}}/stable/stretch"
      name: nginxinc/docker-nginx
      tag: v1
    with_items: "{{ docker_hosts }}"
  ## Nginx用コンテナの実行
  - name: Run nginx docker container
    docker_container:
      docker_host: "{{ item }}"
      name: "nginx-1"
      image: "nginxinc/docker-nginx:v1"
      networks:
        - name: ansible_network
      purge_networks: 8080:80
      ports:
        - "8080:80"
    with_items: "{{ docker_hosts }}"
  ## Ansible用コンテナの実行
  - name: Run andible docker containar
    docker_container:
      docker_host: "{{ item }}"
      name: "ansible-1"
      image: "{{ required_docker_images }}"
      command: /bin/bash
      tty: yes
      interactive: yes
    with_items: "{{ docker_hosts }}"

試したこと

・ansible-galaxy collection install community.dockerを実行し再度プレイブックを実行
・docker_image→community.docker.docker_imageに変更し実行

どちらもうまく行きませんでした。

補足情報（環境）

OS：EC2(t2.micro)

Ansibleサーバ

$pip list | egrep "pip|awscli|ansible|docker"
ansible                      3.1.0
ansible-base                 2.10.7
awscli                       1.19.37
docker-py                    1.10.6
docker-pycreds               0.4.0
pip                          20.3.4

Docker Host

$ pip list | egrep "pip|awscli|ansible|docker"
awscli                       1.18.147
docker-py                    1.10.6
docker-pycreds               0.4.0
pip                          9.0.3

$ docker version
Client:
 Version:           19.03.13-ce
 API version:       1.40
 Go version:        go1.13.15
 Git commit:        4484c46
 Built:             Mon Oct 12 18:51:20 2020
 OS/Arch:           linux/amd64
 Experimental:      false

Server:
 Engine:
  Version:          19.03.13-ce
  API version:      1.40 (minimum version 1.12)
  Go version:       go1.13.15
  Git commit:       4484c46
  Built:            Mon Oct 12 18:51:50 2020
  OS/Arch:          linux/amd64
  Experimental:     false
 containerd:
  Version:          1.4.1
  GitCommit:        c623d1b36f09f8ef6536a057bd658b3aa8632828
 runc:
  Version:          1.0.0-rc92
  GitCommit:        ff819c7e9184c13b7c2607fe6c30ae19403a7aff
 docker-init:
  Version:          0.19.0
  GitCommit:        de40ad0

Docker　API使用のため対象行を変更

$ cat /lib/systemd/system/docker.service | grep "ExecStart=/usr/bin/dockerd -H fd://"
ExecStart=/usr/bin/dockerd -H fd:// -H tcp://0.0.0.0:2376 --containerd=/run/containerd/containerd.sock $OPTIONS $DOCKER_STORAGE_OPTIONS $DOCKER_ADD_RUNTIMES

マニュアルやエラーについて調べましたが独力では解決には至りませんでした。
お力添えのほどよろしくお願いいたします。

Answer 1

（ログインに手間取っている間に回答がありました。）
マニュアルを参考にしてください。やはり source パラメータを指定する必要があります （デフォルト値は no）

https://docs.ansible.com/ansible/latest/collections/community/docker/docker_image_module.html#ansible-collections-community-docker-docker-image-module

Comments

[masaaa1217]

URLのご提示ありがとうございます！
私の理解が及ばず申し訳ございませんが２点質問させてください。
・sourceパラメータが必要と判断した箇所はどこでしょうか。
・デフォルト値がnoはどこで判断されましたか？(force_sourceのデフォルト値？？)

[xotaki]

> ・sourceパラメータが必要と判断した箇所はどこでしょうか。
このモジュールは使ったことがないのですが、
ご提示のソースが docker_image で pull と指定していないので、パラメータが足りないと直感しました。
マニュアルの Examples を見ると大抵使いかたが書いてあります。
Parameters を見て理解を深める流れです。

> ・デフォルト値がnoはどこで判断されましたか？(force_sourceのデフォルト値？？)
ごめんなさい。別の個所を見てました。マニュアルでは青字がデフォルト値なのですが、sources にはデフォルト値は存在しませんね。

[masaaa1217]

ご回答ありがとうございます。
マニュアルの見方大変参考になりました！

Answer 2

docker_hostの設定はどのような目的でされているのでしょうか？

イメージを取得する場合は、sourceパラメータの指定が必要です。

- name: PUll docker image
  docker_image:
    name: "{{ required_docker_images }}"
    source: pull
    state: present

Comments

[masaaa1217]

ご回答ありがとうございます。
docker_hostを設定する目的としてはansibleサーバ(localhost)からdocker_host(クライアント)へリモートで設定したいという意図があり設定していました。(知識があいまいなため説明に間違いがありましたら申し訳ありません。。。)

ご回答いただいた通りに修正しましたところ正常に動作しました！
ありがとうございます。

[comefigo]

AnsibleサーバとDocker ホストは同じEC2でしょうか？

[masaaa1217]

その通りです。
VPCも同じものを使用しているため同じNW上に存在します。

[comefigo]

なるほどですね。
特にdocker_hostの設定は不要かと思います。

[masaaa1217]

そうなんですか？
例えば、
-192.168.0.1(localhost)
-192.168.0.2(docker host)←これにコンテナを入れたい
この場合はdocker_host: 192.168.0.2で設定すると解釈しておりました。(ansibleのhostsがlocalhostのため)

[comefigo]

同一EC2ホストであれば、Dockerネットワークはホストのネットワークを（デフォルト）ブリッジ接続します。
docker_xxxモジュールのdocker_hostパラメータにも書いてありますが、デフォルトはunix://var/run/docker.sockを経由してDockerクライアントがDockerサーバとやり取りします。
今回DockerクライアントはAnsibleのモジュールが担います。

[masaaa1217]

なるほどですね。
デフォルトが何を表しているのかいまいち理解できていませんでした。
comefigoさんのおかげで理解することができました。
詳しく解説していただきありがとうございます！

[comefigo]

解決されてよかったです！