Playbook＠Ansible

はじめに

本サイトにつきまして、以下をご認識のほど宜しくお願いいたします。

• https://hiroki-it.github.io/tech-notebook/

01. playbookファイル

playbookファイルとは

サーバーのセットアップ処理を設定する。

処理をrolesディレクトリに切り分けても良い。

切り分ける場合、rolesディレクトリを作業ディレクトリとし、相対パスでファイルを指定することになる。

＊実装例＊

appサーバー、dbサーバー、webサーバーをセットアップする。

各コンポーネントはrolesディレクトリに切り分けている。

# roleファイル
# appサーバー
- hosts: app
  become: yes
  force_handlers: "true"
  # rolesディレクトリ以下に処理を切り分ける。上から順にrolesを実行する。
  roles:
    - shared
    - app

# dbサーバー
- hosts: db
  become: yes
  force_handlers: "true"
  roles:
    - shared
    - db

# webサーバー
- hosts: web
  become: yes
  force_handlers: "true"
  roles:
    - shared
    - web

repository/
├── playbook.yml
├── roles/
│   ├── shared/
│   │   └── tasks/
│   │       └── main.yml
│   │
│   ├── app/
│   │   └── tasks/
│   │       └── main.yml
│   │
│   ├── db/
│   │   └── tasks/
│   │       └── main.yml
│   │
│   └── web/
│       └── tasks/
│           └── main.yml
│

• https://zenn.dev/y_mrok/books/ansible-no-tsukaikata/viewer/chapter8#%E3%83%97%E3%83%AC%E3%82%A4%E3%83%96%E3%83%83%E3%82%AF%E3%81%A8%E3%81%AF

01-02. playbookファイルの切り分け

rolesディレクトリ

▼ rolesディレクトリとは

特定の機能に関するタスクが設定されたファイルを配置する。

playbook.ymlファイルを切り分けるために使用する。

• https://ansible-workbook.readthedocs.io/ja/latest/role/role.html

▼ handlersディレクトリ

taskファイルの後続処理が設定されたhandlerファイルを配置する。

taskファイルのnotifyオプションで指定できる。

# handlerファイル
- name: Restart php-fpm
  service:
    name: php-fpm
    state: restarted

# taskファイル
- name: Upload www.conf
  ansible.builtin.template:
    src: php-fpm/www.conf.j2
    dest: /etc/php-fpm.d/www.conf
  notify:
    # handlerの名前を指定する。
    - restart_php-fpm

▼ taskディレクトリ

playbookファイルから切り分けたセットアップ処理が設定されたtaskファイルを配置する。

＊実装例＊

PHP製のアプリケーションが稼働するappサーバーをセットアップする。

# taskファイル
- name: Install software-properties-common
  ansible.builtin.apt:
    name: software-properties-common
    state: present

- name: Install packages
  ansible.builtin.apt:
  pkg:
    - php
    - php-fpm
    - php-pdo
  state: present
  notify:
    - restart_php-fpm

- name: Upload php.ini
  ansible.builtin.template:
    src: php.ini.j2
    dest: /etc/php.ini
  notify:
    - restart_php-fpm

- name: Upload www.conf
  ansible.builtin.template:
    src: php-fpm/www.conf.j2
    dest: /etc/php-fpm.d/www.conf
  notify:
    - restart_php-fpm

- name: Setup composer
  ansible.builtin.shell: |

    # Composerのセットアップ処理

    ...

▼ templateディレクトリ

アップロードファイルの鋳型となるj2ファイルを配置する。

鋳型に変数を出力できる。

＊実装例＊

php.iniファイルの鋳型として、php.ini.j2ファイルを配置する。

; Start a new pool named 'www'.
; the variable $pool can we used in any directive and will be replaced by the
; pool name ('www' here)
[www]

...

group_varsディレクトリ

▼ group_varsディレクトリとは

複数の管理対象ノードで使用する変数に関するファイルやディレクトリを配置する。

inventoriesディレクトリと同じ階層に配置し、加えてinventoryファイルで設定したグループ名やホスト名と同じ名前にする必要がある。

自動的に読み込まれ、playbookファイルやinventoryファイルで出力できる。

• https://qiita.com/WisteriaWave/items/0e5dda7ddc13b22188c7#215-%E3%82%B0%E3%83%AB%E3%83%BC%E3%83%97%E5%A4%89%E6%95%B0%E3%83%9B%E3%82%B9%E3%83%88%E5%A4%89%E6%95%B0%E3%81%AE%E5%A4%96%E5%87%BA%E3%81%97

▼ group_varファイル

複数の管理対象ノードで使用する変数を設定する。

# group_varファイル
env: prd
domain: example.com
ip_addresses:
  - 192.168.0.1
  - 192.168.0.2
  - 192.168.0.3
ports:
  - 22/tcp
  - 80/tcp
  - 443/tcp

ポート番号のリストをplaybookファイルで出力する

• https://bftnagoya.hateblo.jp/entry/2021/03/12/101207

---
- name: Add port
  firewalld:
    port: "{{ item }}"
    permanent: yes
    state: enabled
    zone: public
  with_items:
    - "{{ ports }}"

- name: Restart firewalld
  systemd:
    name: firewalld
    state: reloaded

host_varsディレクトリ

▼ host_varsディレクトリとは

特定の管理対象ノードで使用する変数に関するファイルを配置する。

▼ host_varファイル

特定の管理対象ノードで使用する変数を設定する。

inventoriesディレクトリ

▼ inventoriesディレクトリとは

管理対象ノードの情報を設定する。

Ansibleの実行時に、-iオプションでディレクトリを指定する。

• https://tekunabe.hatenablog.jp/entry/2019/02/23/ansible_inventory_merge

$ ansible-playbook <playbookファイル> -i <inventoriesディレクトリ>

▼ inventoryファイル

管理対象ノードを設定する。

複数の拡張子 (ini形式、yml形式、json形式) で定義でき、ansible-inventoryコマンドでini形式から他の形式に変換できる。

ただし、ini形式の場合は拡張子をつけない方が良い。実行環境 (本番/ステージング) 別にファイルを切り分けると良い。

また、サーバーを冗長化している場合は、これも別々に定義しておく。

プロビジョニングの実行対象はロードバランサーから一時的に切り離すようにすることにより、プロビジョニングに伴ってインシデントが起こっても、ユーザーへの影響を防げる。

• https://docs.ansible.com/ansible/2.9/user_guide/intro_inventory.html#inventoryformat
• https://zenn.dev/y_mrok/books/ansible-no-tsukaikata/viewer/chapter5
• https://tekunabe.hatenablog.jp/entry/2017/11/08/ansible_inventory_ini

＊実装例＊

もしyml形式の場合は以下の通りとなる。

# inventoryファイル
# テスト環境
- all:
    hosts:
      app:
        # 管理対象ノードのIPアドレス
        ansible_host: 127.0.0.1
        # 管理対象ノードにログインするためのユーザー名
        ansible_user: vagrant
        # 管理対象ノードにログインするためのパスワード
        ansible_password: vagrant
      web:
        ansible_host: 127.0.0.1
        ansible_user: vagrant
        ansible_password: vagrant
      db:
        ansible_host: 127.0.0.1
        ansible_user: vagrant
        ansible_password: vagrant

# inventoryファイル
# 本番環境
- all:
    children:
      # 冗長化サーバーa
      server_a:
        hosts:
          # appサーバー
          app:
            # 管理対象ノードのIPアドレス
            ansible_host: 192.168.100.101
            # 管理対象ノードにログインするためのユーザー名
            ansible_user: ubuntu
            # 管理対象ノードにログインするためのパスワード
            ansible_password: ubuntu
            # 管理対象ノードへのSSH公開鍵認証に使用する秘密鍵
            ansible_ssh_private_key_file: /etc/ansible/ssh_keys/prd-foo.pem
          # webサーバー
          web:
            ansible_host: 192.168.100.10
            ansible_user: ubuntu
            ansible_password: ubuntu
            ansible_ssh_private_key_file: /etc/ansible/ssh_keys/prd-foo.pem
      # 冗長化サーバーc
      server_c:
        hosts:
          # appサーバー
          app:
            ansible_host: 192.168.100.102
            ansible_user: ubuntu
            ansible_password: ubuntu
            ansible_ssh_private_key_file: /etc/ansible/ssh_keys/prd-foo.pem
          # webサーバー
          web:
            ansible_host: 192.168.100.11
            ansible_user: ubuntu
            ansible_password: ubuntu
            ansible_ssh_private_key_file: /etc/ansible/ssh_keys/prd-foo.pem

＊実装例＊

もしini形式の場合は以下の通りとなる。

# inventoryファイル
# テスト環境

# -------------------
# 冗長化サーバーa
# -------------------

# appサーバー
[server_a.hosts.app]
# 管理対象ノードのIPアドレス
ansible_host=192.168.100.101
# 管理対象ノードにログインするためのユーザー名
ansible_user=ubuntu
# 管理対象ノードにログインするためのパスワード
ansible_password=ubuntu
# 管理対象ノードへのSSH公開鍵認証に使用する秘密鍵
ansible_ssh_private_key_file=/etc/ansible/ssh_keys/prd-foo.pem

# webサーバー
[server_a.hosts.web]
ansible_host=192.168.100.10
ansible_user=ubuntu
ansible_password=ubuntu
ansible_ssh_private_key_file=/etc/ansible/ssh_keys/prd-foo.pem

# -------------------
# 冗長化サーバーc
# -------------------

# appサーバー
[server_c.hosts.app]
ansible_host=192.168.100.102
ansible_user=ubuntu
ansible_password=ubuntu
ansible_ssh_private_key_file=/etc/ansible/ssh_keys/prd-foo.pem

# webサーバー
[server_c.hosts.web]
ansible_host=192.168.100.11
ansible_user=ubuntu
ansible_password=ubuntu
ansible_ssh_private_key_file=/etc/ansible/ssh_keys/prd-foo.pem

# inventoryファイル
# 本番環境

# -------------------
# 冗長化サーバーa
# -------------------

# appサーバー
[server_a.hosts.app]
ansible_host=192.168.100.101
ansible_user=ubuntu
ansible_password=ubuntu
ansible_ssh_private_key_file=/etc/ansible/ssh_keys/prd-foo.pem

# webサーバー
[server_a.hosts.web]
ansible_host=192.168.100.10
ansible_user=ubuntu
ansible_password=ubuntu
ansible_ssh_private_key_file=/etc/ansible/ssh_keys/prd-foo.pem

# -------------------
# 冗長化サーバーc
# -------------------

# appサーバー
[server_c.hosts.app]
ansible_host=192.168.100.102
ansible_user=ubuntu
ansible_password=ubuntu
ansible_ssh_private_key_file=/etc/ansible/ssh_keys/prd-foo.pem

# webサーバー
[server_c.hosts.web]
ansible_host=192.168.100.11
ansible_user=ubuntu
ansible_password=ubuntu
ansible_ssh_private_key_file=/etc/ansible/ssh_keys/prd-foo.pem

02. /roles/handlersセクション

handlersセクションとは

taskセクションの後に実行するセットアップ処理を設定する。

02-02. /roles/targetsセクション

targetsセクションとは

プレイの実行先のノードを設定する。

必須である。

• https://zenn.dev/y_mrok/books/ansible-no-tsukaikata/viewer/chapter8#targets-%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3

name

▼ nameとは

プレイの名前を設定する。

- name: Setup nginx

hosts

▼ hostsとは

プレイの実行先のノードを設定する。

- hosts: all

become

▼ becomeとは

プレイをroot権限で実行するか否かを設定する。

root以外であれば、become_userキーを設定する。

- become: yes
  become_user: foo-user

gather_facts

▼ gather_factsとは

ファクト変数を収集するか否かを設定する。

- gather_facts: no

02-03. /roles/tasksセクション

tasksセクションとは

管理対象ノードで実行するセットアップ処理を手続き的に設定する。

必須である。

• https://zenn.dev/y_mrok/books/ansible-no-tsukaikata/viewer/chapter8#tasks-%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3

ansible.builtin.apt

▼ ansible.builtin.aptとは

管理対象ノードで、パッケージをaptリポジトリからインストールする。

任意のバージョンのパッケージをインストールする場合は、nameキーにそれを指定し、stateキーの値はpresentとする。

• https://docs.ansible.com/ansible/latest/collections/ansible/builtin/apt_module.html
• https://qiita.com/tkit/items/7ad3e93070e97033f604

＊実装例＊

# nginxをインストールします。
- name: Install Nginx
  ansible.builtin.apt:
    name: nginx=1.0.0
    state: present

ansible.builtin.lineinfile

▼ ansible.builtin.lineinfileとは

管理対象ノードにあるファイルを行単位で編集する。

＊実装例＊

SELinuxを無効化する。

• https://tekunabe.hatenablog.jp/entry/2019/02/24/ansible_lineinfile_intro#Playbook

＊実装例＊

# SELinuxを無効化します。
- name: Disable SELinux
  ansible.builtin.lineinfile:
    path: /etc/selinux/config
    regexp: "^SELINUX="
    line: "SELINUX=disabled"

ansible.builtin.file

▼ ansible.builtin.fileとは

管理対象ノードでファイルを操作する。

• https://tekunabe.hatenablog.jp/entry/2019/03/03/ansible_file_intro

＊実装例＊

管理対象ノードでchownコマンドを実行することにより、ファイルの所有権を設定する。

- name: Update foo-binary permission
  ansible.builtin.file:
    path: /usr/local/bin/foo-binary
    owner: root
    group: root

ansible.builtin.copy

▼ ansible.builtin.copyとは

管理対象ノードのディレクトリにファイルをコピーする。

＊実装例＊

# 設定ファイルを配置します。
- name: Copy foo.json
  ansible.builtin.copy:
    src: foo.json
    dest: /etc/foo.json
    owner: root
    group: root
    mode: 0644

ansible.builtin.get_url

▼ ansible.builtin.get_urlとは

管理対象ノードでcurlコマンドを実行する。

• https://zenn.dev/y_mrok/books/ansible-no-module-no-tsukaikata/viewer/ansible_builtin_get_url

- name: Download tool
  ansible.builtin.get_url:
    url: https://github.com/hiroki-hasegawa/foo-tool.tar.gz
    dest: .

ansible.builtin.service

▼ ansible.builtin.serviceとは

管理対象ノードでserviceコマンドの実行を設定する。

• https://docs.ansible.com/ansible/2.9/modules/service_module.html

＊実装例＊

# serviceコマンドを使用して、nginxを起動します。
- name: Start nginx service
  ansible.builtin.service:
    name: Start nginx
    state: started
    enabled: "yes"

ansible.builtin.shell

▼ ansible.builtin.shellとは

管理対象ノードでシェルを実行する。複数行に渡る場合は、『|』を使用する。

• https://docs.ansible.com/ansible/latest/collections/ansible/builtin/shell_module.html
• https://blog.ruanbekker.com/blog/2020/01/24/environment-variables-with-ansible/

＊実装例＊

- name: Echo foo
  ansible.builtin.shell: |
    echo foo

＊実装例＊

- name: fetch-config amazon-cloudwatch-agent.json
  ansible.builtin.shell: |
    /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl \
      -a fetch-config \
      -m ec2 \
      -c file:/opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.json \
      -s

ansible.builtin.systemd

▼ ansible.builtin.systemdとは

管理対象ノードでsystemctlコマンドの実行を設定する。

• https://docs.ansible.com/ansible/latest/collections/ansible/builtin/systemd_module.html

＊実装例＊

# systemdでnginxのプロセスを管理します。
- name: Start nginx systemd
  ansible.builtin.systemd:
    name: Start nginx
    state: started
    enabled: yes
    daemon_reload: yes

＊実装例＊

# systemdでcloudwatchエージェントのプロセスを管理します。
- name: Start cloudwatch-agent systemd
  ansible.builtin.systemd:
    name: amazon-cloudwatch-agent
    state: started
    enabled: yes
    daemon_reload: yes

▼ state

ユニットの最終的な状態を設定する。

設定値	説明
reloaded	最終的な状態としてdeamon_reloadするように、ユニットを再読み込みする。
restarted	最終的な状態として再起動するように、ユニットを再起動する。
started	最終的な状態として停止しているように、ユニットを起動する。
stopped	最終的な状態として停止しているさうに、ユニットを停止する。

• https://dekitakotono.blogspot.com/2019/05/systemd.html

ansible.builtin.template

▼ ansible.builtin.templateとは

テンプレート (.j2ファイル) から作成したファイルを管理対象ノードのディレクトリに配置する。

＊実装例＊

- name: Upload foo.conf
  ansible.builtin.template:
    src: foo.conf.j2
    dest: /etc/foo/foo.conf

ansible.builtin.unarchive

▼ ansible.builtin.unarchiveとは

コントロールノードまたは管理対象ノードでtarコマンドを実行することにより、圧縮ファイルを解凍する。

• https://docs.ansible.com/ansible/latest/collections/ansible/builtin/unarchive_module.html

＊実装例＊

- name: Unarchive file
  ansible.builtin.unarchive:
    src: /tmp/foo-tool.tar.gz
    dest: /usr/local/bin
    remote_src: yes # 管理対象ノード上の圧縮ファイルを指定する場合はyesとする。

ansible.builtin.user

▼ ansible.builtin.userとは

シェルのユーザーを操作する。

＊実装例＊

ユーザーを作成する。

無効なシェルを設定し、ログインできないようにしておく。

• https://docs.ansible.com/ansible/latest/collections/ansible/builtin/unarchive_module.html

- name: add user
  ansible.builtin.user:
    name: foo
    shell: /bin/false

ansible.builtin.yum

▼ ansible.builtin.yumとは

管理対象ノードで、パッケージをyumリポジトリからインストールする。

任意のバージョンのパッケージをインストールする場合は、nameキーにそれを指定し、stateキーの値はpresentとする。

• https://docs.ansible.com/ansible/latest/collections/ansible/builtin/yum_module.html
• https://qiita.com/tkit/items/7ad3e93070e97033f604

＊実装例＊

# nginxをインストールします。
- name: Install Nginx
  ansible.builtin.yum:
    name: nginx=1.0.0
    state: present

# epelリポジトリをインストールします。
- name: Install epel-release
  ansible.builtin.yum:
    name: https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
    state: present

ansible_env

▼ ansible_envとは

管理対象ノードに設定された環境変数を出力する。

gather_factsオプションを有効化する必要がある。

• https://docs.ansible.com/ansible/2.9/reference_appendices/faq.html#shell
• https://tekunabe.hatenablog.jp/entry/2019/03/09/ansible_env

＊実装例＊

管理対象ノードの環境変数のFOOを出力する。

gather_factsオプションを有効化しておく。

- gather_facts: yes

- vars:
    FOO: ansible_env.FOO

environment

▼ environmentとは

task内で出力できる環境変数を設定する。

• https://docs.ansible.com/ansible/2.9/user_guide/playbooks_environment.html

＊実装例＊

- name: Echo foo
  ansible.builtin.shell: |
    echo foo
    echo "${FOO}"
  environment:
    FOO: FOO

02-04. /roles/varsセクション

varsセクションとは

プレイで使用する設定値を変数として設定する。

設定した変数は、ansible.builtin.templateオプションを使用してj2ファイルに出力できる。

• https://blog.katsubemakito.net/ansible/ansible-1st-4
• https://ksaito11.hatenablog.com/entry/2018/10/24/232929

＊実装例＊

- name: Upload foo.conf
  ansible.builtin.template:
    src: foo.conf.j2
    dest: /etc/foo/foo.conf
  vars:
    foo: FOO
    bar: BAR

# foo.conf.j2ファイル
{{foo}}

02-05. プラグイン

lookup

▼ env

コントロールノードに設定された環境変数を出力する。

• https://docs.ansible.com/ansible/2.9/reference_appendices/faq.html#shell
• https://tekunabe.hatenablog.jp/entry/2019/03/09/ansible_env

＊実装例＊

コントロールノードの環境変数のFOOを出力する。

- name: Upload foo.conf
  ansible.builtin.template:
    src: foo.conf.j2
    dest: /etc/foo/foo.conf
  vars:
    foo: 'lookup("env", "FOO")'