Docker コンテナで Ansible のテストベッド環境を用意する

何をするか

ansible-playbook を使って何らかの Linux 環境のセットアップを自動化するとき、Playbook のテスト用に使い捨ての Docker コンテナ（テストベッド環境）があると便利です。

Ansible には、Playbook 実行後の冪等性を保つという性質がありますが、一度 Playbook を実行してしまうと元の状態に戻すことはできません。 一方通行の冪等性はあっても、可逆性はないということですね。 Playbook を試行錯誤して作っている段階では、何度も ansible-playbook を実行することになるので、本当にその Playbook がまっさらな状態の OS に対して適用できるのか不安になってきます（冪等性があるので理論的には動作するはずですが）。 異なるディストリビューションに対して実行できるのか試したくなることもあります。

ここでは、Ansible のテストベッド環境として Docker コンテナを作成し、各種 Ansible コマンド (ansible / ansible-playbook) で制御してみます。

テストベッド用のコンテナを起動する

Ansible は一般的にはマネージドノードに SSH 接続して Playbook を実行しますが、実は Docker コンテナに直接接続することもできます。 つまり、テストベッド用の Docker コンテナには、sshd (OpenSSH) などのサービスをわざわざインストールする必要はありません。

ただし、Ansible マネージドノードの要件として、Python3 だけはインストールしておく必要があります。 次の Dockerfile では、Ubuntu を親イメージとして、Python3 だけ追加しています。

FROM ubuntu:22.04

# Python3 のインストール
RUN apt update && apt install --no-install-recommends -y python3

Dockerfile をビルドして、testbed イメージを作成します。

$ docker image build . -t testbed

このイメージを使って、コンテナを起動します。 ここでは、コンテナ名も testbed にしています。

$ docker container run --rm -td --name testbed testbed bash

コンテナがすぐに終了してしまわないように、-t (--tty) オプションを付けて bash に仮想端末を割り当て、さらにバックグラウンド起動 (-d) しています（参考: Docker コンテナをバックグラウンド実行する）。

次のようにして、testbed コンテナが立ち上がっていることを確認します。

$ docker container ls
CONTAINER ID  IMAGE    COMMAND  CREATED        STATUS        PORTS  NAMES
20cc261f5352  testbed  "bash"   3 seconds ago  Up 2 seconds         testbed

Ansible のインベントリファイルを作成する

操作対象とする Docker コンテナの名前（ここでは testbed のみ）を列挙したインベントリファイルを作成します。 ansible_connection=docker オプションを指定することで、接続先が Docker コンテナであることを Ansible に知らせます。 この指定がないと、Ansible は SSH 接続しようとしてしまいます。

testbed ansible_connection=docker

all:
  hosts:
    testbed:
      ansible_connection: docker

Ansible コマンドを実行する

インベントリファイルができたので、Ansible コマンドを実行して testbed コンテナを制御してみます。

ansible コマンドの実行

まずは、ansible コマンドで単独のモジュール (ping) を実行してみます。

$ ansible -i hosts.ini all -m ping
testbed | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python3"
    },
    "changed": false,
    "ping": "pong"
}

うまく制御できました！

ansible-playbook コマンドの実行

次に、ansible-playbook を実行してみます。 テスト用に次のような簡単な Playbook を作成します。 Ansible 組み込みの user モジュールを使って、ansible というユーザーを作成する Playbook です。

- hosts: all
  tasks:
  - name: Create ansible user
    ansible.builtin.user:
      name: ansible
      shell: /bin/bash

Playbook を実行します。

$ ansible-playbook -i hosts.ini main.yml

PLAY [all] **************************...

TASK [Gathering Facts] **************...
ok: [testbed]

TASK [Create ansible user] **********...
changed: [testbed]

PLAY RECAP **************************...
testbed  : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0

こちらもうまくいきました！

コンテナの状態を見てみる

最後に、testbed コンテナ上で bash を起動して、どんな状態になっているかを確認しておきます。 ちゃんと ansible ユーザーが作成されていれば成功です。

$ docker container exec -it testbed bash
root@f7c7a2d8f325:/# ls /home
ansible

次のようにコンテナを作り直せば、再びまっさらな状態からやり直すことができます。 コンテナ起動時に --rm オプションを指定しておいたので、コンテナは停止と同時に削除されます。

# コンテナの停止＆削除
$ docker container stop testbed
testbed

# コンテナの再生成＆起動
$ docker container run --rm -td --name testbed testbed bash
fc17f036b0a5c2dafbaa7e55d936fb6a052cbe0fd05465c25c0e680baebf2316

関連記事

• Docker で Ansible の実行環境用のコンテナを作成する
• Ansible の SSH 接続で使用するユーザーと秘密鍵を指定する
• Ansible 関連用語
• Docker コンテナで Nginx サーバーを立ち上げる
• Ansible モジュールのヘルプを表示する (ansible-doc)
• Ansible で Hello World
• Ansible の ansible.cfg ファイルの検索順序