Serverspecを仕様としたログ基盤向けAnsibleロールの設計と実装

こんにちは、AI Labの川口あいです。

前回の記事では、既存インフラのIaC化プロジェクトの第一歩として、「既存のServerspecのテストケースを仕様書として活用し、Ansibleロールを作成する」というアプローチをご紹介しました。Docker上でAnsibleの実行からServerspecによるテストまでを完結させる環境が整い、Ansible ロールによって構築した設定内容をServerspecによって検証できるようになりました。

本プロジェクトでは、前回構築した環境を用いて、ログに関する設定を集約した「ログ基盤向けのAnsibleロール」を作成しました。

本記事では、Serverspecで定義されたログ関連のテストケースを前提に、 Docker環境という制約を考慮しながら、ログ基盤向けのAnsibleロールを設計・実装した内容を紹介します。

目次

開発環境

基本的な環境は前回と同じで、以下の3つのコンテナで構成されています。

┌─────────────────────┐
│ ansible-controller  │  Ansible実行環境
│  - Python 3.11      │
│  - Ansible 2.19     │
└──────────┬──────────┘
           │
           │ SSH (ed25519)
           │
┌──────────▼──────────┐
│ almalinux-target    │  テスト対象サーバー
│  - AlmaLinux 9      │
│  - SSHd             │
└──────────▲──────────┘
           │
           │ SSH (ed25519)
           │
┌──────────┴──────────┐
│ kondate-runner      │  ServerSpec実行環境
│  - Ruby 3.3         │
│  - Kondate          │
│  - ServerSpec       │
└─────────────────────┘

また、ディレクトリ構成に関しても同様で、_template-middleware/を基にroles/に新たにロールを追加してタスクを作成していきます。

playbook/
├── docker/
│   ├── controller/    # Ansible実行環境
│   ├── target/        # 適用先サーバー(AlmaLinux)
│   └── ssh/           # SSH鍵(自動生成)
├── group_vars/        # 全環境共通の変数
├── inventories/       # 環境別のホスト定義
├── playbooks/         # 実行単位
├── roles/
│   ├── httpd/                   # 作成したロール例
│   └── _template-middleware/    # 新規ロール作成用テンプレート
└── ...

新規ロール作成時の雛形として用意されている_template-middleware/の構成は以下のようになっており、実際の処理はtasks/配下にタスクとして追加していきます。

_template-middleware/
├── defaults/
│   └── main.yml        # デフォルト変数
├── handlers/
│   └── main.yml        # ハンドラー定義(service restart など)
├── tasks/
│   └── main.yml        # 実行されるタスク本体
├── templates/
│   └── *.j2            # 設定ファイル用テンプレート
└── vars/
    └── main.yml        # ロール固有の変数

構成管理の設計と実装

今回のログ基盤向けAnsibleロールは、既存環境で運用されていた Serverspec のテストケースを仕様書として活用し、それらをすべてパスするサーバーを自動構築することを目的として作成しました。

今回活用した Serverspec テストケースの概要

ここでは、Ansible ロール作成にあたって参考にした 6つのServerspecファイルについて、その役割を簡単に紹介します。前回のプロジェクトでhttpd(Apache)のインストールおよび起動・自動起動設定はすでに完了しているものとし、ログの設定が適切に行われているかという観点に焦点を当てています。

各 Serverspec は、「Ansible による構成管理で最終的にどの状態を実現したいか」を明確にするための指標として位置づけており、ここではコードの詳細には踏み込まず、それぞれが担保している内容を概要レベルで整理します。

1. ntp_spec.rb

require 'spec_helper'

describe '[NaN]chronyがインストールされていること' do
  describe package('chrony') do
    it { should be_installed }
  end
end

describe '[os-5],[os-13] chronydが起動中で自動起動も有効であること' do
  describe service('chronyd') do
    it { should be_enabled }
    it { should be_running }
  end 
end

describe '[os-13] 上位NTPサーバーと時刻同期ができていること' do
  describe command('chronyc sources -v | grep "* " | head -c 2; echo') do
    its(:stdout) { should match /^*/ }
  end

  describe command('timedatectl show') do
    its(:stdout) { should match /NTPSynchronized=yes/ }  
  end
end

describe '[os-6] タイムゾーンがJSTになっていること' do
  describe command('date') do
    its(:stdout) { should match /JST/ }
  end

  describe command('timedatectl show') do
    its(:stdout) { should match /Timezone=Asia\/Tokyo/ }
    its(:stdout) { should match /JST/ }
  end
end

describe '[os-17] ファイルにUTC0が含まれていること' do
  describe file('/usr/share/zoneinfo/UTC') do
    its(:content) { should match /UTC0/ }
  end
end
  • chronyがインストールされていること
  • サービスが起動・自動起動設定されていること
  • タイムゾーン設定と時刻同期がされていること

-> サーバーの時刻管理が正しく行われている状態の確認

2. ssh_spec.rb

本設定は、後述する rsyslog-sftp によるログ転送を行うための前提条件として必要となります。

  • openssh-server がインストールされていること
  • sshd サービスが起動・自動起動されていること

-> sshを使った通信・連携が可能な最低限の状態を担保

3. rsyslog-systemdlog_spec.rb

  • systemd 関連ログの保存先として、専用のログファイルが作成されていること
  • ログファイルの所有者・パーミッションが適切に設定されていること
  • logrotate により、当該ログがローテーション対象として定義されていること
  • rsyslog の設定により、systemd / systemd-logind のログが専用ファイルへ出力されること

-> systemd のログを安全かつ継続的に管理できる運用基盤を担保

4. rsyslog-sftplog_spec.rb

  • sftp-server のログレベルおよび出力先が sshd の設定で明示的に定義されていること
  • sftp-server 専用のログファイルが作成され、所有者・パーミッションが適切に設定されていること
  • logrotate により、当該ログファイルがローテーション対象として管理されていること
  • rsyslog の設定により、sftp-server のログが専用ファイルへ振り分けられていること

-> sftp のファイル転送ログを取得できる状態を担保

5. httpd-logformat_spec.rb

  • Apache の全体設定において、アクセスログの出力形式が main フォーマットで定義されていること
  • 各VirtualHost においても、アクセスログの出力形式が統一して main フォーマットで設定されていること

-> ログ形式のばらつきを防ぎ、運用・分析しやすいログ出力を担保

6. httpd_logrotate_spec.rb

  • Apache のアクセスログが週次でローテーションされ約3年分保持されていること

-> Web アクセスログの長期保存要件を満たす設定を担保

Ansibleロールの作成

ここでは、Serverspecのテストケースを基に作成したAnsibleロールのうち、ntp 設定を例に紹介します。

今回は Dockerコンテナ上で検証を行っており、コンテナがホストOSのカーネルを共有する特性上、chronydを起動して時刻同期を行うことができません。そのため、Serverspec のテスト内容をそのまま適用するのではなく、実行環境を考慮した構成管理が必要となりました。

ファイル構成

ntpロールは、テンプレート(_template-middleware)を基に以下のような構成で実装しています。

roles/
└── ntp/
    ├── defaults/
    │   └── main.yml
    ├── handlers/
    │   └── main.yml
    └── tasks/
        ├── main.yml
        ├── ntp_install.yml
        └── timezone_setup.yml

処理内容ごとにタスクを分割し、tasks/main.yml を起点として各タスクを呼び出す構成としています。 また、設定値は defaults/main.yml に集約し、再利用性と可読性を高めています。

各ファイルの役割

以下に、ntp ロールで使用しているタスクを記述します。 Docker環境では chronyd を起動できないという制約を考慮した条件分岐と、設定変更時のみサービスを再起動する設計を行いました。

なお、パッケージ名やサービス名などの変数は ntp/defaults、 サービス再起動処理は ntp/handlers に定義しています。

1. main.yml

tasks/main.yml では、ntp 設定に関する処理を役割ごとに分割し、 各タスクファイルを順に呼び出しています。

---
- name: "{{ntp_package}}のインストール・時刻同期"
  ansible.builtin.include_tasks: ntp_install.yml

- name: "timezoneの設定をする"
  ansible.builtin.include_tasks: timezone_setup.yml
2. ntp_install.yml

tasks/ntp_install.yml では、以下の点を意識して実装しています。

  • chrony 設定変更時のみ chronyd を再起動
  • Docker 環境ではサービス起動・同期確認をスキップ
  • 実運用を想定し、時刻同期完了まで待機
---
- name: "{{ ntp_package }} のインストール"
  ansible.builtin.package:
    name: "{{ ntp_package }}"
    state: present
  tags:
    - ntp
    - ntp_install

- name: "chrony.conf の設定(iburst)"
  ansible.builtin.lineinfile:
    path: /etc/chrony.conf
    regexp: '^pool '
    line: "pool 2.almalinux.pool.ntp.org iburst"
    state: present
  register: config_iburst
  notify: restart_chronyd
  tags:
   - ntp
   - ntp_conf

- name: "chrony.conf の設定(makestep)"
  ansible.builtin.lineinfile:
    path: /etc/chrony.conf
    line: "makestep 1.0 3"
  register: config_makestep
  notify: restart_chronyd
  tags:
   - ntp
   - ntp_conf

- name: "{{ ntp_service }}の起動・自動起動"
  ansible.builtin.service:
    name: "{{ ntp_service }}"
    # 設定が変わっていたらrestarted、そうでなければstarted
    state: "{{ 'restarted' if (config_iburst.changed or config_makestep.changed) else 'started' }}"
    enabled: true
  when: 
    - not ansible_check_mode
    - ansible_virtualization_type != 'docker' # Dockerコンテナ内ではchronydを起動できないため実行しない方針
  tags:
    - ntp
    - ntp_starter

- name: "時刻同期が完了するまで待機"
  ansible.builtin.command: chronyc tracking
  register: sync_check
  when: 
    - not ansible_check_mode
    - ansible_virtualization_type != 'docker' # Dockerコンテナ内ではchronydを起動できないため実行しない方針
  until: "'Leap status     : Normal' in sync_check.stdout"
  retries: 30
  delay: 10
  changed_when: false
3. timezone_setup.yml

タイムゾーン設定は、tasks/timezone_setup.ymlとして独立したタスクとして切り出しています。

---
- name: "tzdataパッケージをインストール"
  ansible.builtin.package:
    name: tzdata
    state: present
  tags: 
    - ntp
    - ntp_timezone

- name: "タイムゾーンを {{ timezone }} に設定"
  community.general.timezone:
    name: "{{ timezone }}"
  tags: 
    - ntp
    - ntp_timezone

Ansibleロールの実装内容

前回の記事の開発フローのサイクルと同様に実装していきます。

作成したAnsibleロールを用いてサーバーを構築します。以下は、ntp ロール実行時のログの一部です。

...
TASK [ntp : chronydの起動・自動起動] *******************************************
skipping: [almalinux_target]

TASK [ntp : 時刻同期が完了するまで待機] ****************************************
skipping: [almalinux_target]
...

Docker環境での検証のため、chronyd の起動や時刻同期確認処理は 条件分岐によりスキップされていることが分かります。

まとめ・今後の展望

本記事では、既存の Serverspecテストケースを仕様書として活用し、ログ基盤向けの Ansibleロールを作成するまでの流れを紹介しました。

Serverspecによって「あるべき状態」を明確にした上で、Ansible による構成管理でその状態を再現し、最終的にテストが通ることをゴールとする開発フローを実践しています。

また、Docker 環境では chronyd を起動できないという制約がある中で、実行環境を考慮した条件分岐を設けることで、検証環境と実運用環境の差異を吸収できる設計としました。

今後は、Serverspecを前提とした構成管理の設計をさらに整理し、セキュリティ設定や監視関連を含めたIaC化にも取り組んでいく予定です。

​

​