Serverspecを仕様とした監視向けAnsibleロールの設計と実装

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

前回の記事では、既存インフラの構成管理を前進させる取り組みとして、Serverspecを仕様としたセキュリティ設定のAnsibleロールの設計・実装についてご紹介しました。

今回のブログでは、その続きとして「監視」をセキュリティ要件として構成管理に組み込むフェーズを紹介します。セキュリティと聞くと通信制御やアクセス権限に目が向きがちですが、実際の運用では異常に気づけること(=監視が機能していること)が、インシデントの早期発見・被害最小化に直結します。

本記事では、MonitやMonitorix、さらにサーバー内部監視スクリプトといった監視系の設定を対象に、これらをどのようにAnsibleロールとして設計・実装し、Serverspecを用いて検証しているのかを、実装コードとともに紹介します。

目次

開発環境

これまでの環境と同様で以下の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       │
└─────────────────────┘

構成管理の設計と実装

今回のプロジェクトでも、既存環境で運用されていたServerspecのテストケースを仕様書として位置づけ、それらをすべてパスする状態をゴールとします。

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

ここでは、今回の監視関連Ansibleロールの作成にあたって参考にした6つのServerspecファイルについて、その役割を簡単に紹介します。今回の監視フェーズでは、大きく「監視ツールの稼働」「監視対象サービスの監視」「内部スクリプトによる定期チェック」の3つを担保しています。

前回までのプロジェクトまでで、httpd(Apache)や sshd のインストール、起動・自動起動設定といった基本的な構成管理はすでに整っているものとし、本記事ではそれらを前提に、システムが継続的に安全な状態で動作していることをどのように監視・担保しているかという観点に焦点を当てています。

各Serverspecのテストケースは、「Ansibleによる構成管理の結果として、最終的にどのような“監視された安全な状態”を実現したいのか」を明確にするための指標として位置づけています。

本セクションではコードの詳細には踏み込まず、それぞれのテストが担保している監視・セキュリティ要件を概要レベルで整理していきます(※社外公開のため、一部の取得コマンドや設定ファイル名は抽象化しています)。

1. monitorix_spec.rb

Monitorixによるリソース監視の有効性を担保するテストです。

require 'spec_helper'

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

describe '[NaN]monitorixが実行中で自動起動も有効であること' do
  describe service('monitorix') do
    it { should be_running }
    it { should be_enabled }
  end
end

describe '[NaN]monitでmonitorixを監視していること' do
  describe command('monit status monitorix') do
    its(:stdout) { should match(/monitoring status\s+Monitored/) }
    its(:stdout) { should match(/monitoring mode\s+active/) }
  end

  describe file('/etc/monit.d/<service>') do
    it { should exist }
    its(:content) { should match(/check process monitorix with pidfile .*monitorix\.pid/) }
    its(:content) { should match(/start program .*monitorix/) }
    its(:content) { should match(/stop program .*monitorix/) }
  end
end

describe '[os-12]正しいネットワークインターフェース名が設定されていること' do
  active_interfaces = command('<get_active_interfaces_command>').stdout.split("\n")

  describe file('/etc/monitorix/monitorix.conf') do
    it { should exist }
    active_interfaces.each do |iface|
      its(:content) { should match(/list = #{iface}$/) }
      its(:content) { should match(/gateway = #{iface}$/) }
    end
  end
end
  • リソース監視ツールMonitorixがインストールされていること
  • Monitorixサービスが起動中であり、自動起動が有効であること
  • MonitがMonitorixを監視していること
  • Monit の監視定義が存在し、プロセス監視が正しく設定されていること
  • Monitorixの設定ファイルにおいて、実際に稼働しているネットワークインターフェースが正しく指定されていること

これにより、サーバーのリソースおよびネットワーク状況が実態に即して継続的に監視され、監視の停止や設定不備による監視漏れを防げる状態を担保しています。


2. monit_spec.rb

  • 監視ツールMonitがインストールされていること
  • Monitサービスが起動中であり、自動起動が有効であること

これにより、監視の中核となるMonitが常時稼働し、再起動後も自動復旧できることで、監視基盤が途切れずに機能し続ける状態を担保しています。


3. monit-target_spec.rb

  • Monitが重要なサービスを監視していること
  • 該当サービス用の監視定義ファイルが存在し、pidfileおよびstart/stop が定義されていること
  • Monitが監視ツール(Monitorixなど)自体も監視していること
  • 該当ツール用の監視定義ファイルが存在し、pidfileおよびstart/stop が定義されていること

これにより、重要なサービスや監視ツール自体の停止を即座に検知でき、サービスの可用性と監視の信頼性を維持できる状態を担保しています。


4. lsyncd_spec.rb

  • lsyncdがインストールされていること
  • lsyncdサービスが起動中であり、自動起動が有効であること

これにより、ファイル同期処理が継続的に実行され、データ不整合が発生しにくい安定した同期環境を担保しています。


5. rsync_spec.rb

  • rsyncがインストールされていること

これにより、ファイル同期処理で利用されるrsyncが導入されており、同期を実現するための前提が整っている状態を担保しています。


6. town-monitor-internal_spec.rb

  • サーバー内部監視スクリプトが適切に配置されていること
  • 定期実行とログ記録により監視が継続していること

これにより、サービス・プロセス・リソースといった内部状態が定期的に確認され、設定だけでなく実行実態を伴った監視が継続して行われている状態を担保しています。


Ansibleロールの作成

ここでは、Serverspecのテストケースを基に作成した Ansible ロールのうちmonitorix_spec.rbを例に、実行環境を考慮した構成管理について説明します。

monitorixロールの構成

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

roles/
└── monitorix/
    ├── defaults/
    │   └── main.yml                 # デフォルト変数の定義
    ├── handlers/
    │   └── main.yml                 # ハンドラー定義(service reload / restart など)
    ├── tasks/
    │   ├── main.yml                 # 各タスクファイルの呼び出し
    │   ├── monitorix_install.yml    # monitorix のインストールおよびサービス設定
    │   └── monitorix_config.yml     # 設定ファイルの配置・反映
    └── templates/
        ├── monitorix.conf.j2        # monitorixの設定ファイルテンプレート
        └── monitorix.j2             # monitからmonitorixを監視するための設定テンプレート

前回までと同様、処理内容ごとにタスクを分割し、tasks/main.ymlを起点として各タスクを呼び出す構成としています。 また、Monitorixに必要な Perl 依存関係や設定ファイルのパスはdefaults/main.ymlにまとめ、再利用性と可読性を高めています。

各ファイルの役割

ここでは、monitorixロールを構成する各タスクファイルについて、Serverspec で定義されている監視要件をどのようにAnsibleで実装しているのかを、ファイル単位で整理して説明します。(※ 社外公開のため、一部のコマンドやパスは抽象化しています)

1. tasks/monitorix_install.yml
---
- name: monitorixに必要なPerl依存関係をインストール
  ansible.builtin.package:
    name: "{{monitorix_perl_package}}"
    state: present
  tags:
    - monitor
    - monitorix
    - monitorix_deps

- name: "{{ monitorix_package }} のインストール"
  ansible.builtin.package:
    name: "{{ monitorix_package }}"
    state: present
  tags:
    - monitor
    - monitorix
    - monitorix_install

- name: "{{ monitorix_package }} の起動・自動起動"
  ansible.builtin.service:
    name: "{{ monitorix_package }}"
    state: started
    enabled: true
  when: not ansible_check_mode
  tags:
    - monitor
    - monitorix
    - monitorix_starter

- name: "{{ monitorix_package }} の設定ファイルエラーチェック"
  ansible.builtin.command: monitorix -c <monitorix_conf_path> -d none
  register: result
  changed_when: false
  failed_when: result.rc != 0
  tags:
    - monitor
    - monitorix
    - monitorix_configtest
  • Monitorixの動作に必要なPerl依存パッケージを事前にインストールし、Monitorixが正常に起動・動作できる前提環境を整備(MonitorixはPerlベースのツールであり、依存関係が不足していると起動時にエラーとなるため)
  • Monitorix本体パッケージをインストールする
  • Monitorixサービスを起動し、自動起動を有効化する
  • 設定ファイルの構文チェックを実施し、設定エラーがある場合はAnsible自体を失敗させることで、誤った設定のまま監視が開始されることを防ぐ
2. tasks/monitorix_config.yml
---
- name: 有効なネットワークインターフェースを取得
  ansible.builtin.shell: >
    <get_active_network_interfaces_command>
  register: active_interfaces
  changed_when: false
  tags:
    - monitor
    - monitorix
    - monitorix_network

- name: monitorix 設定ファイルを配置
  ansible.builtin.template:
    src: monitorix.conf.j2
    dest: "{{monitorix_conf_path}}"
    owner: "{{common_file_owner}}"
    group: "{{common_file_group}}"
    mode: "{{common_file_mode}}"
  vars:
    monitorix_interfaces: "{{ active_interfaces.stdout_lines }}"
  notify: reload monitorix
  tags:
    - monitor
    - monitorix
    - monitorix_config

- name: monit用 monitorix監視設定を配置
  ansible.builtin.template:
    src: monitorix.j2
    dest: "{{monitorix_monit_conf_path}}"
    owner: "{{common_file_owner}}"
    group: "{{common_file_group}}"
    mode: "{{common_file_mode}}"
  notify: reload monit
  tags:
    - monitor
    - monitorix
    - monit_config
  • サーバー上で 実際に有効となっているネットワークインターフェースを動的に取得し、固定値に依存しない形で監視対象インターフェースを特定している
  • 取得したネットワークインターフェース情報を変数として渡し、Monitorixの設定ファイルをテンプレートから生成・配置
  • MonitからMonitorixを監視するための設定ファイルをテンプレートとして配置し、Monitorix自体が停止した場合にも検知・復旧できる監視構成を実現

なお、Docker環境ではコンテナの再起動ごとにネットワークインターフェース名が変化するため、そのままではServerspecによるテストが失敗するケースがあります。このため、コンテナを再起動した場合には、再度monitorix.confを更新する必要がある点に注意が必要です。


冪等性の確認

作成したAnsibleロールを用いてサーバーを構築します。

以下は、monitorixロールを再度実行した際の実行ログです。注目したいのは、PLAY RECAPで changed=0となっている点です。

$ ./scripts/run-playbook.sh docker playbooks/tester.yml
PLAY [任意のテストを単一で実施する] ********************************************

TASK [Gathering Facts] ********************************************************
ok: [target_host]

TASK [monitorix : monitorixのインストール] ************************************
included: <roles_path>/monitorix/tasks/monitorix_install.yml for target_host

TASK [monitorix : monitorixに必要な依存パッケージをインストール] **************
ok: [target_host]

TASK [monitorix : monitorix のインストール] ***********************************
ok: [target_host]

TASK [monitorix : monitorix の起動・自動起動] *********************************
ok: [target_host]

TASK [monitorix : monitorix の設定ファイルエラーチェック] *********************
ok: [target_host]

TASK [monitorix : monitorix関連の設定] ****************************************
included: <roles_path>/monitorix/tasks/monitorix_config.yml for target_host

TASK [monitorix : 有効なネットワークインターフェースを取得] *******************
ok: [target_host]

TASK [monitorix : monitorix 設定ファイルを配置] *******************************
ok: [target_host]

TASK [monitorix : monit用 monitorix監視設定を配置] ****************************
ok: [target_host]

PLAY RECAP ********************************************************************
target_host      : ok=10   changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0  

このように、繰り返し実行しても結果が変わらない状態(冪等性)が担保できていることで、

  • 変更が必要なときだけ安全に差分適用できる
  • 不要な再起動や設定上書きによる事故を防げる
  • Serverspecが求める状態を継続的に維持できる

といった、運用面でのメリットにつながります。

Monitorixが起動しない問題

MonitorixのAnsibleロールを実装する中で、Monitorixが起動しないという問題に直面しました。Ansible の実行自体は成功しているものの、起動・自動起動のタスクが毎回changedとなっており、冪等性の観点からもサービスが安定していないように見える状態でした。

そこでまず、問題の切り分けを行うために、設定ファイルを変更せずにMonitorixの起動・自動起動のみを行うようにタスクを調整しました。 その状態でサーバー内を確認すると以下のように正常に起動ができていました(一部抜粋)。

$ systemctl status monitorix
● monitorix.service - Monitorix
   Loaded: loaded (/usr/lib/systemd/system/monitorix.service; enabled)
   Active: active (running)

この結果から、Monitorixが起動しない原因はサービスや依存関係ではなく、設定ファイル側にある可能性が高いと判断しました。

次に、Monitorixインストール時に自動生成されるデフォルトのmonitorix.confに着目しました。このファイルをベースとしてtemplates/monitorix.conf.j2に貼り付け、Serverspecで必要とされている箇所のみを最小限変更する形に修正しました。

その結果、Monitorixは正常に起動し、起動・自動起動のタスクも意図通りの挙動となり、Serverspecのテストもすべてパスするようになりました。

今回の経験を通して、設定ファイルを最小化しすぎるよりも、動作実績のあるデフォルト設定を基準に調整することが安定した構成管理につながると学びました。

まとめ・今後の展望

本記事では、前回までのセキュリティ系IaC化の取り組みに続くフェーズとして、監視をセキュリティ要件の一部として捉え、Serverspecを仕様とした構成管理で設計・実装する方法について紹介しました。

MonitやMonitorix、サーバー内部監視スクリプトといった監視・運用系の設定についても、「何がインストールされているか」「どのサービスが起動しているか」だけでなく、「実際に監視が機能している状態」を Serverspecによって定義し、それを満たすサーバーをAnsibleで構築しています。

これにより、監視や運用に関する設定についても、属人化しがちな知識や手作業をコードとして再現可能な形に落とし込むことができました。また、繰り返しAnsibleを実行しても差分が発生しない冪等性を確認することで、構成管理として安定した状態を維持できていることも検証しています。

今後は、システム基盤やユーザー管理なども含め、運用フェーズで重要となる領域を対象に、再現性と安全性を意識した構成管理を目指していきたいと考えています。

​

​