全案件共通の雛形サーバーをAnsible・Serverspecで構築できるようにした話

こんにちは、AI Labの緒方健太です。

これまで社内では、サーバー構築案件で必要となる設定の多くを自動化したAnsibleと、その設定が正しく反映されているかをServerspecで検証するServerchecker2を整備してきました。

関連記事:Serverspecでサーバー設定の自動テストをさらに拡充した話

今回はこれらをベースに、全案件で共通して作成する「雛形サーバー」に必要な部分を整理し、AlmaLinux 9の雛形サーバーを自動で構築・検証できるようにした内容を紹介します。

ここでいう雛形サーバーとは、OSの基本設定や共通して利用するミドルウェアなど、どの案件でも必要となる設定をあらかじめ済ませ、案件固有の設定を追加する前の状態にしたサーバーを指します。

目次

課題

既存のAnsible・Serverchecker2は、実際のサーバー構築案件を広くカバーする「完全版」として作られていました。 そのため、案件固有の設定や、特定の構成を前提としたテストも含まれていました。

全案件共通の雛形サーバーを作るには、既存のroleやテストをそのまま利用するのではなく、「雛形サーバーの段階で何を保証するか」を整理する必要があります。

また、社内の構築手順と既存コードで、設定内容や期待値が一致していない箇所もありました。

さらに、AlmaLinux 9では、従来のOS環境とパッケージやリポジトリ、設定ファイルの構成が異なる部分があります。既存コードをそのまま利用できない箇所については、AlmaLinux 9に合わせた修正が必要でした。

今回の目標

まっさらなAlmaLinux 9のサーバーに対してAnsibleを実行し、案件固有の構築を始める前の雛形サーバーを作成できる状態を目指しました。

さらに、構築後のサーバーに対してServerchecker2を実行し、雛形サーバーとして必要な設定が意図した状態になっていることを自動で検証できるようにします。

最終的には、次の流れで利用できることを目標としました。

Ansibleで雛形サーバーを構築
    ↓
Serverchecker2で構築結果を検証
    ↓
案件固有の構築

Ansibleの整理

まず、完全版のAnsibleから、雛形サーバーで必要となる処理を整理しました。

既存のroleをすべて持ってくるのではなく、社内の構築手順と照らし合わせながら、雛形サーバーの段階で必要となる処理を選別しました。

主に、次のような設定を対象としています。

  • OSの基本設定
  • EPEL、Remiなどのリポジトリ設定
  • NTP、タイムゾーン
  • rsyslog、logrotate
  • SSH、SFTP
  • cron
  • Apache
  • PHP、PHP-FPM
  • MariaDB
  • Postfix
  • vsftpd
  • Monitorix、Monitなどの監視設定

ただし、既存のAnsibleにある処理をそのまま抜き出せばよいわけではありません。

構築手順には記載されているものの既存のAnsibleでは実装されていない処理や、既存コードと構築手順で設定内容が異なる箇所もありました。

そのため、既存の実装を利用できる部分は活用しつつ、構築手順を基準に内容を見直し、不足する処理については追加で実装しました。

例えば、今回の雛形サーバーで利用するパッケージをAlmaLinux 9上で導入するため、CRBリポジトリを有効化する処理を追加しています。

- name: dnf config-managerをインストール
  ansible.builtin.dnf:
    name: dnf-plugins-core
    state: present
  when:
    - ansible_distribution == "AlmaLinux"
    - ansible_distribution_major_version == "9"

- name: AlmaLinux 9のCRBリポジトリを有効化
  community.general.dnf_config_manager:
    name: crb
    state: enabled
  when:
    - ansible_distribution == "AlmaLinux"
    - ansible_distribution_major_version == "9"

また、dnf.confについても構築手順と照らし合わせ、不要なfastestmirror設定を削除するようにしました。

- name: dnf.confからfastestmirrorの設定を削除する
  ansible.builtin.ini_file:
    path: /etc/dnf/dnf.conf
    section: main
    option: fastestmirror
    state: absent
  when: ansible_os_family == "RedHat"

このように、完全版から必要な処理を選別するだけでなく、構築手順やAlmaLinux 9の環境に合わせて不足する処理を補っています。

AlmaLinux 9での動作確認

整理したAnsibleは、実際にまっさらなAlmaLinux 9のサーバーへ適用して動作を確認しました。

既存コードには以前のOS環境を前提とした処理もあり、AlmaLinux 9では利用できるパッケージや設定ファイルの構成が異なる箇所がありました。

そのため、単にAnsibleが正常終了することだけではなく、構築後のサーバーが構築手順で求められる状態になっているかを実機上で確認しながら進めました。

例えば、利用するリポジトリやパッケージ、PHP-FPMの設定、rsyslogの設定ファイルなどについて、Ansibleの実行結果とAlmaLinux 9の実際の状態を確認し、必要に応じて処理を修正しています。

また、一度正常に構築できた後には、同じAnsibleを再度実行して冪等性も確認しました。

その中で、パッケージ更新後の再起動についても、毎回実行するのではなく、実際に更新があった場合だけ実行するようにしています。

- name: パッケージを最新化
  ansible.builtin.dnf:
    name: '*'
    state: latest
  register: dnf_update

- name: サーバーを再起動
  ansible.builtin.reboot:
  when: dnf_update.changed

2回目以降の実行では、設定済みの項目が不要にchangedになっていないか、不要な再起動などが発生しないかを確認し、問題があれば実装を見直しました。

このように、Ansibleの実行と実機での確認・修正を繰り返し、まっさらなAlmaLinux 9から雛形サーバーの状態を再現できるようにしました。

Serverchecker2の整理

Ansibleとあわせて、Serverchecker2についても雛形サーバー向けにテストを整理しました。

完全版のServerchecker2には多くのServerspecテストがありますが、その中には案件固有の構成を前提とするものもあります。

そこでAnsibleと同様に、構築手順と照らし合わせながら、 「雛形サーバーの段階で、この設定を保証する必要があるか」という基準でテストを選別しました。

例えば、SSHの起動状態や22番ポートのListen、PHP-FPMの起動状態、Postfixの設定など、雛形サーバーの構築結果として確認する必要があるテストを残しています。

一方、nginxやlsyncd、案件固有のVirtualHostやユーザーなど、雛形サーバーでは前提としない構成のテストは対象から外しました。

また、構築手順では確認が必要でも、既存のServerchecker2にテストが存在しない項目については、新たにServerspecテストを追加しました。

例えば、Ansible側で設定したAlmaLinux 9のリポジトリについても、Serverchecker2から状態を確認しています。

describe '[NaN] EPEL/Remiリポジトリがインストールされていること' do
  describe yumrepo('epel') do
    it { should exist }
    it { should be_enabled }
  end

  describe yumrepo('remi') do
    it { should exist }
  end
end

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

describe '[NaN] dnf.confにfastestmirrorが設定されていないこと' do
  describe file('/etc/dnf/dnf.conf') do
    its(:content) { should_not match /^\s*fastestmirror\s*=/ }
  end
end

ここでは、単にテストを追加するだけではなく、Ansibleが実際に保証している状態とテストの期待値が一致しているかも見直しました。

例えばAnsibleではRemiのrelease RPMとGPGキーを導入していますが、Remiリポジトリを常時有効化する処理は実装していません。そのため、Serverchecker2ではRemiのrepo定義が存在することを確認し、有効化されていることまでは要求していません。

このように、Ansibleで設定する内容とServerchecker2で検証する内容を対応させることで、雛形サーバーとして必要な状態を自動で構築・検証できるようにしました。

まとめ

今回、既存の完全版Ansible・Serverchecker2をベースに、全案件共通の雛形サーバーを構築・検証するための構成を整備しました。

完全版をそのまま利用するのではなく、構築手順を基準として雛形サーバーに必要な処理・テストを選別し、不足している処理の追加や既存実装の修正を行いました。また、実際にまっさらなAlmaLinux 9へ適用し、構築結果や冪等性を確認しながら調整しています。

これにより、案件ごとにサーバー構築を始める前に、全案件共通の部分をAnsibleで構築し、その状態をServerchecker2で検証できるようになりました。

今後は、今回整理した雛形サーバーの構成をベースに、案件固有の設定まで含む完全版のAnsible・Serverchecker2についても整理・拡充していく予定です。

また、OSや各ミドルウェアのバージョンが変わった際にも対応しやすいよう、Ansibleの実装とServerchecker2のテストの対応関係を維持しながら、変更箇所を把握・修正しやすい構成へ改善していきたいと考えています。

​

​