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

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

前回の記事では、セキュリティ要件の一部として、MonitやMonitorix、内部監視スクリプトといった監視設定をServerspecを仕様としてIaC化する取り組みをご紹介しました。

今回のブログではその続きとして、システム基盤(OSの基本設定)を構成管理に組み込むフェーズを扱います。セキュリティや監視といった機能を正しく動かすためには、その土台となるOS環境が安定して整備されていることが欠かせません。

本記事では、基本ツールの導入、Swap領域の確保、パッケージ管理用リポジトリの有効化といったシステム基盤に関わる要件を、Serverspecによって仕様として定義し、それを満たすサーバーを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       │
└─────────────────────┘

構成管理の設計と実装

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

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

ここでは、今回のシステム基盤関連Ansibleロールの作成にあたって参考にした5つのServerspecファイルについて、その役割を簡単に紹介します。 今回の基盤フェーズでは、次の3つの観点を担保しています。

  • 基本ツールの整備(Gitなどの導入)
  • OS設定の統一(hostname・Swap など)
  • パッケージ管理基盤の有効化(dnfリポジトリ)

前回までのプロジェクトでは、監視やセキュリティ設定など各ミドルウェアの構成管理を進める中で、それぞれのロール内でEPELリポジトリやGitを個別に導入する形をとっていました。今回はそれらを暗黙の前提とせず、依存関係を整理したうえで、基本ツールやリポジトリ設定をシステム基盤としてまとめて再定義しています。

また、Swap領域の確保やhostnameの統一といったOSレベルの設定についても独立した要件として整理し、後続のミドルウェア構築や運用フェーズを安定して支えられる土台作りに焦点を当てています。

各Serverspecのテストケースは、最終的にどのような「安定したシステム基盤の状態」を実現したいのかを明確にするための指標として位置づけています。

本セクションではコードの詳細には踏み込まず、それぞれのテストが担保しているシステム基盤要件を概要レベルで整理していきます。(※ 社外公開のため、一部のコマンドやパスは抽象化しています)

1. system-hostname_spec.rb

require 'spec_helper'

describe '[os-7] hostnameが指定されたものとなっていること' do
  describe command('hostname') do
    its(:stdout) { should match /<expected_hostname>/}
  end
end 
  • サーバーのhostnameが指定された値に統一されていること

これにより、監視・ログ管理・運用上の識別が容易になり、管理対象が明確な状態を担保しています。


2. misc_spec.rb

  • Gitやvimなど、サーバー運用に必要となる基本ツールがインストールされていること

これにより、後続のミドルウェア構築や運用作業を進めるための基本的な環境が整っている状態を担保しています。


3. system-swap_spec.rb

  • Swap領域(swapfile)が作成されていること

これにより、負荷がかかった状況でもプロセスが落ちにくくなり、OSが安定して稼働できる基盤状態を担保しています。


4. system_hosts.allow_spec.rb

  • hosts.allowに関連するwarningがログに出力されていないこと

これにより、OS設定に潜む問題を早期に検知でき、運用上の不安要素が残っていない状態を担保しています。


5. dnfrepos_spec.rb

require 'spec_helper'

describe '[NaN] リポジトリが有効になっていること' do
  describe yumrepo('epel') do
    it { should exist }
    it { should be_enabled }
  end

  describe yumrepo('remi') do
    it { should exist }
    it { should be_enabled }
  end
end
  • 追加パッケージリポジトリ(例:EPEL/Remi)が存在し、有効化されていること

これにより、後続の監視ツールやミドルウェア導入がスムーズに行える、構成管理の前提条件が満たされた状態を担保しています。


Ansibleロールの作成

ここでは、Serverspecのテストケースを基に作成したAnsibleロールのうち、system-hostname_spec.rbおよびdnfrepos_spec.rbに対応する実装を例に、実行環境を考慮した構成管理について説明します。

osロール(system-hostname_spec.rb)の構成

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

roles/
└── os/
    ├── defaults/
    │   └── main.yml    # デフォルト変数
    ├── handlers/
    │   └── main.yml      # ハンドラー定義(service reloadなど)      
    └── tasks/
        ├── main.yml      # タスクファイルの呼び出し
        ├── system-hostname.yml  # 実際のタスクファイル
        ├── ...

前回までと同様、処理内容ごとにタスクを分割し、tasks/main.ymlを起点として各タスクを呼び出す構成としています。

osロールで担保している基盤要件

ここでは、osロールの中でも中核となるタスクファイルについて、Serverspecで定義された基盤要件をどのようにAnsibleで実装しているかを説明します。(※ 社外公開のため、一部のコマンドやパスは抽象化しています)

tasks/system-hostname.yml
- name: 現在のホスト名を確認
  ansible.builtin.command: hostname -f
  register: current_hostname
  changed_when: false

- name: ホスト名が取得できているか確認
  ansible.builtin.assert:
    that:
      - (current_hostname.stdout | trim) | length > 0
    fail_msg: "hostnameが取得できませんでした"

- name: 設定したいホスト名を指定
  ansible.builtin.set_fact:
    expected_hostname: "<expected_hostname>"

- name: D-Bus の有無を確認
  ansible.builtin.stat:
    path: /run/dbus/system_bus_socket
  register: dbus_socket
  changed_when: false

- name: "ホスト名を設定(永続: hostnamectl)"
  ansible.builtin.command: "hostnamectl set-hostname {{ expected_hostname }}"
  become: yes
  when:
    - ansible_service_mgr == "systemd"
    - dbus_socket.stat.exists

- name: 現在のホスト名を取得
  ansible.builtin.command: hostname
  register: current_short_hostname
  changed_when: false

- name: "ホスト名を設定(即時: hostname)"
  ansible.builtin.command: "hostname {{ expected_hostname }}"
  become: yes
  when: 
    - not (ansible_service_mgr == "systemd" and dbus_socket.stat.exists)
    - (current_short_hostname.stdout | trim) != expected_hostname

このタスクでは、Serverspecで求められているホスト名の要件を満たすために、サーバーのhostnameを統一する処理を実装しています。ホスト名は監視やログ管理など運用全体で参照される重要な識別情報であるため、構成管理の段階で仕様通りに揃えておくことが基盤整備として重要になります。

実装上の工夫として、systemd環境かどうか、D-Busが利用可能かどうかといった実行環境の差異を考慮し、設定方法を場合分けしています。これにより、Dockerなど制約のある検証環境でも同じServerspecの要件を安定して満たせるようにしています。また、すでに設定済みの場合は再設定を行わないことで冪等性も担保しています。

このように、ホスト名を一貫した状態に揃えることで、後続の監視・セキュリティ・ミドルウェア構築が前提とする基盤条件を整備し、安定した運用につながる構成管理を実現しています。

reposロール(dnfrepos_spec.rb)の構成

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

roles/
└── os/
    ├── defaults/
    │   └── main.yml    # デフォルト変数      
    └── tasks/
        ├── main.yml      # タスクファイルの呼び出し
        └── dnfrepos.yml  # 実際のタスクファイル

パッケージ名やリポジトリ名などはdefaults/main.ymlにまとめ、再利用性と可読性を高めています。

reposロールで担保している基盤要件

ここでは、reposロールの中でも中核となるタスクファイルについて、Serverspecで定義された基盤要件をどのようにAnsibleで実装しているかを説明します。(※ 社外公開のため、一部のコマンドやパスは抽象化しています)

tasks/dnfrepos.yml
---
- name: import Remi GPG key
  ansible.builtin.rpm_key:
    key: "{{ dnfrepos_gpg_keys.remi }}"
    state: present
  when: ansible_os_family == "RedHat"
  tags:
    - dnfrepos

- name: EPELリポジトリをインストール
  ansible.builtin.package:
    name: "{{ dnfrepos_epel_package }}"
    state: present
  when: ansible_os_family == "RedHat"
  tags:
    - dnfrepos
    - epel

- name: Remiリポジトリインストール
  ansible.builtin.package:
    name: "{{ dnfrepos_remi_package }}"
    state: present
  when: ansible_os_family == "RedHat"
  tags:
    - dnfrepos
    - remi

- name: 対象repoセクションのenabledを1にする
  ansible.builtin.replace:
    path: "{{ dnfrepos_dir }}/{{ item }}.repo"
    regexp: '(^\[\s*{{ item }}\s*\][\s\S]*?)(^\s*enabled\s*=\s*)[01]\s*$'
    replace: '\g<1>\g<2>1'
  loop: "{{ dnfrepos_list }}"
  when: ansible_os_family == "RedHat"
  tags:
    - dnfrepos
    - epel
    - remi

このタスクでは、Serverspecで求められている追加リポジトリ要件を満たすために、EPEL/Remiといったdnfリポジトリを構成管理で整備しています。

実装上の工夫として具体的には、まずGPGキーを事前に取り込むことで、パッケージ署名検証エラーを防ぎ、安全にリポジトリを利用できる状態を整えています。また、AnsibleのFactsを利用してOSファミリーを判定し、RedHat系環境にのみ処理を限定することで、環境依存による不要なエラーを回避しています。

このように、リポジトリ設定を各ロールの“暗黙の前提”として扱うのではなく、基盤要件として明示的に定義することで、後続の構成管理が安定して実行できる状態を担保しています。

冪等性の確認

以下はsystem-hostname.ymlを再度実行した際の実行ログです(一部抜粋)。

$ ansible-playbook playbooks/tester.yml -i inventories/docker

PLAY [任意のテストを単一で実施する] ****************************************

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

TASK [os : ホスト名設定タスクの実行] *********************************
included: <roles_path>/os/tasks/system-hostname.yml for target_host

TASK [os : 現在のホスト名を確認] ************************************
ok: [target_host]

TASK [os : ホスト名が取得できているか確認] **************************
ok: [target_host]

...

TASK [os : ホスト名を設定(即時: hostname)] ****************************
skipping: [target_host]

PLAY RECAP **********************************************************
target_host : ok=XX   changed=0   failed=0   skipped=X

実行ログを見ると、ホスト名設定のタスクが skipping となっていることが分かります。これは、現在のホスト名がすでに<expected_hostname>と一致しており、再設定を行う必要がないと判断されたためです

このように、既存の状態が要件を満たしている場合には変更を行わずスキップされる挙動となっており、不要な設定変更が発生しないことが確認できます。

Docker環境でhostnamectlが失敗した話

system-hostname.ymlタスクの実装当初、単純にhostnamectl set-hostnameを利用してホスト名を設定していました。

しかし、Dockerコンテナ環境ではD-Busが動作しておらず、hostnamectlがエラーとなるケースがあることが判明しました。

そこで本実装では、

  1. D-Busソケットの有無を確認

  2. systemd環境かどうかを判定

  3. 利用可能な場合のみhostnamectlを使用

  4. それ以外の環境では hostname コマンドで即時反映

という分岐処理を追加しています。

このように実行環境に応じて処理を切り替えることで、コンテナ環境でも物理サーバー環境でも安定して動作する構成管理を実現しています。

まとめ・今後の展望

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

hostnameの統一やSwap領域の確保、EPEL/Remiの有効化などは、ミドルウェア構築の前提となる基盤要件です。これらを「環境ごとに手作業で整える」のではなく、「あるべき状態をテストとして定義し、それをコードで再現する」形で整理しています。

これにより、後続の監視ロールやセキュリティロールが暗黙の依存に頼らず、安定して動作する土台をAnsibleで一貫して構築できるようになりました。また、Docker環境におけるhostnamectlの制約など、実行環境の差分を吸収しながら構成管理を行う工夫も取り入れています。

今後は、今回整備したシステム基盤に加え、ユーザー・権限管理やDB、Webサーバー設定など、より運用に近い領域についてもServerspecを起点に要件を整理し、「テストを仕様としたIaC」の適用範囲をさらに広げていきたいと考えています。

​

​