Serverspecを仕様としたデータベース向けAnsibleロールの設計と実装

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

前回の記事では、ユーザーおよび権限管理をテーマに、Serverspecを仕様としてAnsibleでIaC化する取り組みをご紹介しました。運用ユーザーの作成やsudo権限の整理を通じて、環境間で一貫した権限状態を担保する構成管理を実装しました。

今回はその続きとして、データベース(DB)領域の構成管理フェーズを扱います。アプリケーションやWebサーバーを支える基盤として、データベースは欠かせない存在です。本プロジェクトでは、データベースパッケージのインストールおよびサービスの起動・自動起動設定を、Serverspecを仕様として整理し、Ansibleロールとして実装していきます。

また、Serverspecには直接テストコードが用意されていないデータベースやユーザーの作成についても、実運用を見据えた要件として整理し、構成管理に組み込みました。単に「パッケージが入っている状態」だけでなく、実際に利用可能なデータベース環境を整備することをゴールとしています。

本記事では、Serverspecを起点としたこれまでの設計方針を引き継ぎながら、データベース構築をどのようにIaCとして実装していくのかを紹介します。

目次

開発環境

これまでの環境と同様で以下の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テストケースの概要

ここでは、今回のデータベース関連のAnsibleロールの作成にあたって参考にしたServerspecファイルについて、その役割を簡単に紹介します。

今回参考にしたServerspecテストは、主に次の状態を担保しています。

  • 指定されたバージョンのデータベースパッケージが正しくインストールされていること
  • データベースサービスが起動中であり、自動起動が有効になっていること
  • (MariaDBの場合)必要なリポジトリが有効化されていること

前回のユーザー・権限管理フェーズでは、サーバー操作の主体となるユーザーとアクセス制御を整理しました。今回はその続きとして、アプリケーションを支えるデータベース基盤そのものの整備に焦点を当てています。

各Serverspecのテストケースは、最終的に目指す「利用可能なデータベース環境の状態」を示す指標として位置づけています。単にパッケージが存在するだけでなく、適切なバージョンが導入され、サービスとして常に利用可能な状態であることを確認しています。

本セクションではコードの詳細には踏み込まず、それぞれのテストが担保しているシステム基盤要件を概要レベルで整理していきます。


1. mariadb_spec.rb

require 'spec_helper'

describe '[NaN] mariadb <db_major_version>がインストールされていること' do
  describe package('MariaDB-server') do
    it { should be_installed.with_version('<db_major_version>') }
  end

  describe package('MariaDB-client') do
    it { should be_installed.with_version('<db_major_version>') }
  end
end

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

describe '[NaN] リポジトリが有効となっていること' do
  describe yumrepo('<db_repo>') do
    it { should exist }
    it { should be_enabled }
  end
end
  • MariaDB(server/client)が指定バージョンでインストールされていること
  • MariaDBサービスが起動中であり、自動起動が有効になっていること
  • MariaDBのリポジトリが存在し、有効化されていること

これにより、データベースが必要なバージョンで導入され、再起動後も継続して利用できる状態が整い、運用上必要なDB基盤が安定して動作する状態を担保しています。

(※ 社外公開のため一部抽象化してあります)

2. mysql_spec.rb

  • MySQL(server/client)が指定バージョンでインストールされていること
  • MySQLサービスが起動中であり、自動起動が有効になっていること

mariadb_spec.rbと同様に、運用上必要なDB基盤が安定して動作する状態を担保しています。

mariadbロールの作成

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

ロールの構成

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

roles/
└── mariadb/
    ├── defaults/
    │   └── main.yml    # デフォルト変数
    └── tasks/
        ├── main.yml      # タスクファイルの呼び出し
        ├── install.yml   # MariaDBパッケージのインストール
        ├── repo.yml      # MariaDBリポジトリ設定
        ├── service.yml   # MariaDBサービス設定
        ├── client_libs.yml   # MySQLのクライアントライブラリをインストール
        └── db.yml        # MariaDBのDB初期設定

前回までと同様、処理内容ごとにタスクを分割し、tasks/main.ymlを起点として各タスクを呼び出す構成としています。また、defaults/main.ymlには、MariaDBのリポジトリ情報、インストールパッケージ、サービス名などを変数としてまとめています。 これにより、環境差分は変数の書き換えのみで対応でき、ロール自体の再利用性と可読性を高めています。

ロールのタスクファイル

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

1. tasks/repo.yml

---
- name: MariaDB リポジトリを追加
  ansible.builtin.yum_repository:
    name: mariadb
    description: "MariaDB Repository"
    baseurl: "{{ mariadb_repo_baseurl }}"
    enabled: true
    gpgcheck: true
    gpgkey: "{{ mariadb_repo_gpgkey }}"
  tags:
    - mariadb
    - mariadb_install

このタスクでは、MariaDB専用のリポジトリを追加し、意図したバージョンのパッケージを取得できる状態を構成管理で定義しています。

標準リポジトリのままでは、OSが提供する別バージョンのMariaDBがインストールされる可能性があります。そのため、yum_repositoryモジュールを用いて専用リポジトリを明示的に追加し、GPGキーによる署名検証を有効にすることで、安全かつ再現性のあるパッケージ取得経路を確保しています。

実装上のポイントは、リポジトリ定義をインストール処理から分離している点です。これにより、

  • パッケージ取得元の変更が容易になる
  • バージョンアップ時の影響範囲を限定できる

といった設計上のメリットがあります。

2. tasks/install.yml

---
- name: MariaDBパッケージをインストール
  ansible.builtin.dnf:
    name: "{{ mariadb_packages }}"
    state: present
    update_cache: true
    enablerepo: mariadb
  when: not ansible_check_mode
  tags:
    - mariadb
    - mariadb_install

- name: MariaDB操作用の依存(PyMySQL)をインストール
  ansible.builtin.dnf:
    name: python3-PyMySQL
    state: present
  tags:
    - mariadb
    - mariadb_install

このタスクでは、Serverspecで求められている「指定バージョンのMariaDBがインストールされていること」という要件を満たすために、必要なパッケージ群を構成管理で導入しています。単にパッケージを入れるだけでなく、対象リポジトリを明示的に指定することで、意図したバージョンを確実に取得できる構成としています。

また、AnsibleからMariaDBを操作するための依存パッケージ(PyMySQL)もあわせて導入することで、後続のデータベース作成やユーザー管理タスクが安定して実行できる前提条件を整えています。

3. tasks/service.yml

---
- name: MariaDB サービスを有効化して起動
  ansible.builtin.service:
    name: "{{ mariadb_service }}"
    state: started
    enabled: true
  when: not ansible_check_mode
  tags:
    - mariadb
    - mariadb_starter

このタスクでは、MariaDBサービスを起動し、あわせて自動起動を有効化することで、Serverspecで定義された「データベースが起動中であり、自動起動が有効であること」という要件を満たしています。

4. tasks/db.yml

- name: アプリケーション用データベースを作成する
  community.mysql.mysql_db:
    name: "{{ app_db_name }}"
    state: present
    login_user: "{{ mariadb_admin_user }}"
    login_unix_socket: "{{ mariadb_unix_socket }}"
  when: not ansible_check_mode
  tags:
    - mariadb
    - mariadb_init

- name: アプリケーション用ユーザーを作成する
  community.mysql.mysql_user:
    name: "{{ app_db_user }}"
    password: "{{ app_db_password }}"
    host: "{{ app_db_user_host }}"
    state: present
    login_user: "{{ mariadb_admin_user }}"
    login_unix_socket: "{{ mariadb_unix_socket }}"
  when: not ansible_check_mode
  tags:
    - mariadb
    - mariadb_init

- name: アプリケーション用ユーザーにデータベース権限を付与する
  community.mysql.mysql_user:
    name: "{{ app_db_user }}"
    host: "{{ app_db_user_host }}"
    priv: "{{ app_db_name }}.*:{{ app_db_privileges }}"
    state: present
    login_user: "{{ mariadb_admin_user }}"
    login_unix_socket: "{{ mariadb_unix_socket }}"
  when: not ansible_check_mode
  tags:
    - mariadb
    - mariadb_init

このタスク群では、MariaDBサービスが起動した後に、アプリケーションが利用するデータベース環境を構成管理で定義しています。

単にデータベースを作成するだけでなく、「アプリケーションが安全かつ再現性をもって動作できる状態」をコードとして保証することを目的としています。

5. tasks/client_libs.yml

---
- name: MySQLクライアントライブラリをインストール
  ansible.builtin.dnf:
    name: "{{ mysql_client_rpms }}"
    state: present
    update_cache: true
    disable_gpg_check: true
  when: not ansible_check_mode
  tags:
    - mariadb
    - mariadb_client_libs

このタスクでは、MariaDBサーバーとは別に、MySQLのクライアントライブラリをインストールしています。

一見すると冗長に見える構成ですが、この選択には実運用上の理由があります。詳細は後述します。

初期設定まで構成管理に含めた理由

今回のServerspecでは、「MariaDBのインストール」や「サービスの起動」といった要件は定義されていましたが、「データベースの作成」「アプリケーションユーザーの作成」「権限付与」までは求められていませんでした。

しかし、実運用を想定すると、「DBサーバーが起動している」だけでは不十分です。アプリケーションが動作するためには、

  • 利用するデータベースが存在する
  • アプリ専用ユーザーが存在する
  • 適切な権限が付与されている

状態まで保証する必要があります。

そのため、テスト要件には含まれていなくても、実用性を考慮して初期設定まで構成管理に含めました。

MariaDB環境でMySQLクライアントライブラリを入れた理由

今回、データベースサーバーには MariaDB(公式リポジトリ版) を使用しています。しかし、監視ツールである Monitorix をインストールする際にパッケージ競合エラーが発生しました。

原因は Monitorix の依存関係にあります。Monitorix は内部でperl-DBD-MySQLを使用しており、そのためにMySQLクライアントライブラリ(libmysqlclient.so) が必要になります。

今回、Monitorixのインストール時に以下の流れが発生します。

monitorix
  → perl-DBD-MySQL
    → mysql-libs
      → mysql-common

ここで問題になるのがmysql-commonです。

MariaDB公式パッケージ(MariaDB-common)と MySQL公式パッケージ(mysql-common)は、同じファイルを持っているため 共存できません。そのため、MariaDB導入済み環境でMySQL関連パッケージが自動で入ろうとするとファイル競合が発生します。

解決方法

以下の手順で構成を整理しました。

  1. MariaDB公式リポジトリからMariaDBをインストール(Monitorixロールより先に実行)

  2. MySQLのクライアントライブラリのみをインストール(client_libs.yml)

  3. Monitorixロールを実行

重要なのは、MySQLサーバーは入れていないという点です。インストールしたのは以下のクライアント関連パッケージのみです。

mysql-community-common
mysql-community-client-plugin
mysql-community-libs

Monitorixが必要としているのは、MySQLサーバーではなくクライアントライブラリだけです。

  • サーバー:MariaDB
  • クライアントライブラリ:MySQL互換
  • 監視ツール:Monitorix

という役割分離を行うことで、パッケージ競合を回避できました。

まとめ・今後の展望

本記事では、前回取り組んだユーザー作成やsudo権限付与といったユーザー・権限管理フェーズに続き、データベース領域の構成管理をServerspecを仕様として設計・実装する方法について紹介しました。

今回のプロジェクトでは、MariaDB(およびMySQLクライアント)のパッケージインストール、サービスの起動・自動起動設定をAnsibleで定義し、「指定バージョンのDBが常に利用可能な状態で動作していること」をテストによって担保しました。単にパッケージが存在するだけでなく、再起動後も継続して利用できる状態までを構成管理に含めています。

さらに、Serverspecには直接コードが用意されていない部分についても、実運用を見据えてデータベースの作成、アプリケーション用ユーザーの作成、権限付与の整備までを自動化しました。これにより、インフラ構築後に手作業で行われがちな初期設定を排除し、再現性の高いデータベース基盤を実現しています。

また、Ansibleからデータベース操作を行うための依存パッケージ(MySQLクライアントやPyMySQLなど)もあわせて導入することで、構成管理全体が安定して実行できる前提条件を整備しました。

今後は、今回整備したデータベース基盤を前提として、nginxなどのWebサーバー領域へと対象を広げていく予定です。これまでと同様に、Serverspecを仕様として“あるべき状態”を明確に定義し、それを満たす構成をAnsibleで実装するというアプローチを継続し、サービスレイヤー全体のIaC化を進めていきます。

​

​