AnsibleでDockerコンテナを管理する方法｜community.dockerコレクションでコンテナのデプロイ・停止・削除を自動化する手順

この記事のポイント

・ docker_containerモジュールでコンテナのデプロイ・停止・削除を1つのPlaybookで管理できる
・ community.dockerコレクションはansible-galaxy collection installで導入する
・ loopを使えば複数コンテナをまとめて一括起動・停止できる
・ docker_networkとdocker_volumeでネットワークとVolumeもコード管理できる

ansible --version

ansible [core 2.16.4]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/admin/.ansible/plugins/modules']
  ansible python module location = /usr/lib/python3.11/site-packages/ansible
  ansible collection location = /home/admin/.ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.11.6 (main, Nov 14 2023, 09:36:21)

ansible-galaxy collection install community.docker

Starting galaxy collection install process
Process install dependency map
Starting collection install process
Downloading https://galaxy.ansible.com/download/community-docker-3.10.4.tar.gz
Installing 'community.docker:3.10.4' to '/home/admin/.ansible/collections/...'
community.docker:3.10.4 was installed successfully

pip3 list | grep docker

docker               6.1.3

pip3 install docker

# deploy_nginx.yml
---
- name: Dockerコンテナ管理サンプル
  hosts: webservers
  become: yes
  tasks:
    - name: Nginxコンテナを起動する
      community.docker.docker_container:
        name: nginx_app
        image: nginx:1.26
        state: started
        restart_policy: always
        ports:
          - "8080:80"

# inventory.ini
[webservers]
192.168.1.101
192.168.1.102

ansible-playbook -i inventory.ini deploy_nginx.yml

PLAY [Dockerコンテナ管理サンプル] *************************************

TASK [Gathering Facts] ************************************************
ok: [192.168.1.101]
ok: [192.168.1.102]

TASK [Nginxコンテナを起動する] ***************************************
changed: [192.168.1.101]
changed: [192.168.1.102]

PLAY RECAP ************************************************************
192.168.1.101  : ok=2    changed=1    unreachable=0    failed=0
192.168.1.102  : ok=2    changed=1    unreachable=0    failed=0

TASK [Nginxコンテナを起動する] ***************************************
ok: [192.168.1.101]
ok: [192.168.1.102]

# コンテナを停止する
- name: Nginxコンテナを停止する
  community.docker.docker_container:
    name: nginx_app
    state: stopped

# コンテナを削除する（停止もあわせて行う）
- name: Nginxコンテナを削除する
  community.docker.docker_container:
    name: nginx_app
    state: absent

# multi_containers.yml
---
- name: 複数コンテナを一括管理
  hosts: appservers
  become: yes
  vars:
    app_containers:
      - { name: "api_v1", image: "myapp:1.0", port: "8001:8080" }
      - { name: "api_v2", image: "myapp:2.0", port: "8002:8080" }
      - { name: "worker_1", image: "myworker:latest", port: "8003:8080" }
  tasks:
    - name: アプリコンテナを一括起動
      community.docker.docker_container:
        name: "{{ item.name }}"
        image: "{{ item.image }}"
        state: started
        restart_policy: always
        ports:
          - "{{ item.port }}"
      loop: "{{ app_containers }}"

# group_vars/all/vault.yml（Vaultで暗号化）
db_root_password: "（Vaultで管理）"
db_user_password: "（Vaultで管理）"

# db_deploy.yml
- name: DBコンテナを起動する（環境変数設定あり）
  community.docker.docker_container:
    name: mysql_db
    image: mysql:8.0
    state: started
    restart_policy: unless-stopped
    env:
      MYSQL_ROOT_PASSWORD: "{{ db_root_password }}"
      MYSQL_DATABASE: "myapp"
      MYSQL_USER: "appuser"
      MYSQL_PASSWORD: "{{ db_user_password }}"
    ports:
      - "3306:3306"
    volumes:
      - /data/mysql:/var/lib/mysql

# network_setup.yml
---
- name: Dockerネットワーク設定
  hosts: appservers
  become: yes
  tasks:
    - name: アプリ用Dockerネットワークを作成する
      community.docker.docker_network:
        name: app_network
        driver: bridge
        state: present

    - name: フロントエンドコンテナをapp_networkに接続する
      community.docker.docker_container:
        name: nginx_frontend
        image: nginx:1.26
        state: started
        networks:
          - name: app_network

docker network ls

NETWORK ID     NAME          DRIVER    SCOPE
a3f2b1c4d5e6   app_network   bridge    local
b7c8d9e0f1a2   bridge        bridge    local
c3d4e5f6a7b8   host          host      local

# volume_and_container.yml
---
- name: VolumeとDBコンテナの管理
  hosts: dbservers
  become: yes
  tasks:
    - name: DBデータ用Volumeを作成する
      community.docker.docker_volume:
        name: mysql_data
        state: present

    - name: MySQLコンテナをVolume付きで起動する
      community.docker.docker_container:
        name: mysql_db
        image: mysql:8.0
        state: started
        volumes:
          - mysql_data:/var/lib/mysql

docker volume ls

DRIVER    VOLUME NAME
local     mysql_data

- name: Nginxコンテナを常に最新イメージで起動する
  community.docker.docker_container:
    name: nginx_app
    image: nginx:1.26
    state: started
    pull: always
    image_name_mismatch: recreate

- name: Nginxコンテナにヘルスチェックを設定する
  community.docker.docker_container:
    name: nginx_app
    image: nginx:1.26
    state: started
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost/"]
      interval: 30s
      timeout: 10s
      retries: 3

- name: docker SDKをインストールする
  ansible.builtin.pip:
    name: docker
    state: present

# dockerグループへの追加（対象サーバーで実行）
sudo usermod -aG docker ansible_user

# コンテナの実際の設定を確認する
docker inspect nginx_app