1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

【第2章】DBスキーマ設計実践!PythonとJinja2で設定生成エンジンを構築

Last updated at Posted at 2025-12-04

images-021.png

【第2章】DBスキーマ設計実践!PythonとJinja2で設定生成エンジンを構築

安全な設定自動化の鍵となる「設計図」

現役インフラエンジニアのHITOSHIです。本記事シリーズは、「設定ドリフト」を根絶するためのDB SSOT(Single Source of Truth)構築を目的としています。本章は「設計 → 生成 → デプロイ」の3部構成のうち、設計と生成を扱い、SSOTの心臓部となる正確な設計図、すなわちDBスキーマ設計を進めます。

ここでは、SSOTの核となるDBスキーマ設計と、それを実現するためのカスタムリポジトリ(ローカルミラー)構築、そしてPython/Jinja2による設定ファイル生成エンジンの実装を具体的に解説します。

本記事で構築するSSOTシステムの全体像

本章で構築する設定生成エンジンの位置づけは以下の通りです。

学びポイント: SSOTのデータ(A)が、Pythonエンジン(B)によってデプロイ可能なファイル(C)に変換される流れを頭に入れておくと、記事全体の理解が深まります。


🧱 SSOTの核:DBスキーマの論理設計

DB SSOTでは、すべての設定情報を格納するために、正規化柔軟性を両立させたハイブリッドなDBスキーマ設計が求められます。

構成情報の核となる3つの主要テーブルと一意性

テーブル名 役割 主要なカラム 学びポイント
devices 物理・仮想デバイスの特定(CI) id (PK), hostname, ip_address, os_type, role, template_id (FK) どのサーバーにどの設定を適用するかという関係整合性の起点。
config_templates デプロイする設定ファイルの実体 id (PK), name, file_path, content (Jinja2テンプレート) ファイル名とテンプレート内容をDBで一元管理します。
config_vars 各デバイスに固有の設定変数 device_id (FK), key, value, variable_data (JSONB) 可変な設定を格納する心臓部。

堅牢性を高める複合一意制約とJSONBインデックス

実運用で設定の二重登録事故を防ぐため、config_varsテーブルには、デバイスとキーの組み合わせに対する複合一意制約を適用します。

-- PostgreSQLでの config_vars テーブル定義の例
CREATE TABLE config_vars (
    id SERIAL PRIMARY KEY,
    device_id INTEGER NOT NULL REFERENCES devices(id),
    variable_name VARCHAR(100) NOT NULL,
    variable_data JSONB NOT NULL 
);

-- 【重要】実運用で必須の複合一意制約
-- これにより、「同じデバイスに同じ設定キーが二重に登録される事故」を物理的に排除します。
ALTER TABLE config_vars
ADD CONSTRAINT uq_device_variable UNIQUE (device_id, variable_name);

-- JSONB内の要素をキー検索する場合、パフォーマンスを劇的に改善するインデックス
CREATE INDEX idx_config_vars_jsonb_path ON config_vars
    USING gin (variable_data jsonb_path_ops); 

学びポイント: SSOTのデータはシステムの正義です。物理的な制約(UNIQUE制約)を使って、データの整合性をDBレイヤーで保証することが、自動化の信頼性の土台となります。


⛓️ カスタムリポジトリ:SSOTのサプライチェーンを制御

SSOTから生成する設定ファイルは、サーバー構築時に大量のパッケージを参照します。その基盤が外部インターネットに依存していると、SSOTで担保しようとした設定の完全性が崩れるため、サプライチェーンの制御が必須となります。

apt-mirrorを使用したDebian系の構築手順

  1. 設定ファイル(/etc/apt/mirror.list)の編集
    セキュリティアップデートを忘れず含めます。

    # ミラーファイルを格納するディレクトリ
    set base_path    /mnt/mirror/apt
    
    # ミラー対象とするURLと構成
    deb http://ftp.jp.debian.org/debian stable main contrib non-free
    deb http://security.debian.org stable/updates main contrib non-free
    
  2. 実運用でのパッケージクリーンアップ
    ローカルミラーのストレージ肥大化を防ぐため、古いパッケージの削除(クリーンアップ)をジョブ化するのが実運用の定石です。apt-mirror実行後に/var/spool/apt-mirror/var/postmirror.shを編集し、古いパッケージを定期的に削除する処理を追加します。

学びポイント: SSOTの設定値は完璧でも、OSが外部の不安定なパッケージを参照していては意味がありません。SSOTは「設定」だけでなく、「環境」全体の信頼性を高めます。


🧪 実装:PythonとJinja2による設定ファイル生成エンジン

DBからデータを取得し、Jinja2を使ってテンプレートに流し込むことで、設定ファイルが自動生成されます。

H3: Pythonコード(設定生成スクリプトとアトミック戦略)

実運用を想定し、差分比較アトミックなファイル更新のロジックを組み込みます。

import os
import stat
from jinja2 import Environment, FileSystemLoader

TEMPLATE_DIR = os.path.abspath('./templates')
CONFIG_OUTPUT_DIR = os.path.abspath('./configs')
env = Environment(loader=FileSystemLoader(TEMPLATE_DIR))
os.makedirs(CONFIG_OUTPUT_DIR, exist_ok=True) 

def generate_config(device_id):
    # 【補足】DBから設定変数を取得する(例: SELECT * FROM config_vars WHERE device_id = %s)
    # 簡略化のためのダミーデータ
    data = {'hostname': 'web-01', 'log_level': 'info', 'nginx_vhosts': [...]} 
    template_name = 'nginx.conf.j2'
    output_path = os.path.join(CONFIG_OUTPUT_DIR, f"{data['hostname']}_nginx.conf")
    
    # 1. データのレンダリング
    template = env.get_template(template_name)
    output = template.render(data)
    
    # 2. 差分比較ロジック: 差分がなければスキップし、Ansibleの不要な実行を防ぐ
    if os.path.exists(output_path):
        with open(output_path, 'r') as rf:
            if rf.read() == output:
                print(f"[{output_path}] 差分なし → スキップ")
                return
    
    # 3. 【重要】Atomic Rename戦略
    # 一時ファイルに書き込み後、os.replaceでアトミックにリネームし、競合を回避
    tmp_path = output_path + ".tmp"
    
    try:
        with open(tmp_path, 'w') as f:
            f.write(output)
            
        os.replace(tmp_path, output_path) # Atomic Rename
        
        # 4. パーミッション設定
        os.chmod(output_path, stat.S_IRUSR | stat.S_IWUSR) # 600
        
        print(f"[{output_path}] 生成完了 (Atomic Update)")
    except Exception as e:
        print(f"ファイル書き込みエラー: {e}")

# (省略) DBコネクションとtry-finallyによるクローズ処理

Windows利用者への注意: Pythonのos.replace()のAtomicity(不可分性)はPOSIX(Linux/macOS)環境では保証されますが、Windows環境ではアンチウイルスソフト等により処理が干渉される場合があります。実環境ではLinuxサーバー上での実行を推奨します。

H3: Jinja2テンプレート例(nginx.conf.j2

# Generated by SSOT Engine for {{ hostname }}
# Log Level: {{ log_level }}

# (中略) Nginxの基本設定

http {
    # DBから取得したvhostsリストをループ処理
    {% for vhost in nginx_vhosts %}
    server {
        listen {{ vhost.port }};
        server_name {{ vhost.server_name }};

        location {{ vhost.location }} {
            proxy_pass http://backend_pool; # 実際の backend_pool は各社の構成に合わせて調整してください
        }
    }
    {% endfor %}
}

学びポイント: 競合回避os.replace())や冪等性(差分比較)といった、目立たないながらもシステムを支える「地味で堅実なロジック」こそが、本番環境の安定稼働には不可欠です。


🤝 まとめ:SSOTの心臓部が完成

本章では、設定自動化の中核となるDBスキーマ設計と、それを実現するための技術要素を具体的に解説しました。

  • DBスキーマ設計において、JSONBインデックス複合一意制約を導入し、堅牢性柔軟性を両立させました。
  • PythonとJinja2による生成エンジンには、アトミックリネーム差分比較といった、実運用に耐えうるロジックを組み込みました。
  • カスタムリポジトリは、SSOTの設定完全性を守るためのサプライチェーン制御として不可欠であることを明確にしました。

これにより、SSOTシステムの心臓部が完成しました。次のステップは、この生成されたファイルをTCS OSサーバーに送り届けることです。

  • 第3章では、Ansibleを使い、生成した設定ファイルをTCS OSへセキュアに展開するデプロイメント戦略について解説します。秘密情報の扱いKubernetes ConfigMapへの応用を掘り下げます。

我々 株式会社 十志では、本記事で扱ったDB SSOTやTCS OSの研究開発を継続しています。技術的知見は随時公開していますので、興味のある方はぜひご覧ください。


※本記事は筆者が所属する株式会社 十志での研究開発知見を一般化したものであり、特定製品の宣伝目的ではありません。

個人的な感想:複雑なインフラを一元管理するDBスキーマを設計する作業は、まるで巨大なパズルを解くような知的な喜びがありますね。設計が固まり、生成エンジンが動いた瞬間、頭の中で全てのサーバーがカチッと収まるような感覚がして、思わずニヤリとしてしまいます。

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?