シェルスクリプトの冪等設計｜何度実行しても安全な初期設定スクリプトをステートファイルと条件分岐で実現する方法

この記事のポイント

・ステートファイルと条件分岐で「実行済みかどうか」を管理できる
・ユーザー・コマンド・ファイルは「存在確認してから作成」が鉄則
・設定ファイルの上書きは事前バックアップ＋差分チェックで安全化できる
・冪等スクリプトはCI/CDや障害復旧にもそのまま再利用できる

#!/bin/bash
set -euo pipefail

# ステートファイルのパス
STATE_DIR="/var/lib/myapp"
STATE_FILE="${STATE_DIR}/initialized.done"

# ステートファイルが存在すれば終了
if [ -f "${STATE_FILE}" ]; then
    echo "[SKIP] 初期設定は既に完了しています（${STATE_FILE}）"
    exit 0
fi

echo "[RUN] 初期設定を開始します..."
mkdir -p "${STATE_DIR}"

# --- ここに初期設定の処理を書く ---

# 完了マーカーを作成
touch "${STATE_FILE}"
echo "[DONE] 初期設定が完了しました"

# 1回目の実行
$ sudo bash setup.sh
[RUN] 初期設定を開始します...
[DONE] 初期設定が完了しました

# 2回目の実行（スキップされる）
$ sudo bash setup.sh
[SKIP] 初期設定は既に完了しています（/var/lib/myapp/initialized.done）

#!/bin/bash
set -euo pipefail

# ユーザーの存在チェック（idコマンドの終了コードを使う）
if id "webuser" &>/dev/null; then
    echo "[SKIP] ユーザー webuser は既に存在します"
else
    useradd -r -s /sbin/nologin webuser
    echo "[CREATE] ユーザー webuser を作成しました"
fi

# コマンドの存在チェック（command -v で確認）
if command -v nginx &>/dev/null; then
    echo "[SKIP] nginx はインストール済みです"
else
    dnf install -y nginx
    echo "[INSTALL] nginx をインストールしました"
fi

# ディレクトリの存在チェック
TARGET_DIR="/etc/myapp/conf.d"
if [ -d "${TARGET_DIR}" ]; then
    echo "[SKIP] ディレクトリ ${TARGET_DIR} は既に存在します"
else
    mkdir -p "${TARGET_DIR}"
    echo "[CREATE] ディレクトリ ${TARGET_DIR} を作成しました"
fi

#!/bin/bash
set -euo pipefail

CONF_SRC="/opt/myapp/templates/myapp.conf"
CONF_DST="/etc/myapp/myapp.conf"

# 配置先が存在し、かつ内容が同じならスキップ
if [ -f "${CONF_DST}" ] && diff -q "${CONF_SRC}" "${CONF_DST}" &>/dev/null; then
    echo "[SKIP] ${CONF_DST} は最新の状態です"
    exit 0
fi

# 既存ファイルをバックアップしてから上書き
if [ -f "${CONF_DST}" ]; then
    cp "${CONF_DST}" "${CONF_DST}.$(date +%Y%m%d_%H%M%S).bak"
    echo "[BACKUP] 既存の設定ファイルをバックアップしました"
fi

cp "${CONF_SRC}" "${CONF_DST}"
echo "[UPDATE] ${CONF_DST} を更新しました"

create_user() {
    local username="$1"
    local uid="$2"

    if id "${username}" &>/dev/null; then
        echo "[SKIP] ユーザー ${username} は既に存在します（$(id "${username}")）"
        return 0
    fi

    useradd -r -u "${uid}" -s /sbin/nologin "${username}"
    echo "[CREATE] ユーザー ${username} (uid=${uid}) を作成しました"
}

create_user "webuser" 8080
create_user "appuser" 8081

# webuser が未作成の場合
[CREATE] ユーザー webuser (uid=8080) を作成しました
[CREATE] ユーザー appuser (uid=8081) を作成しました

# 2回目の実行（どちらもスキップ）
[SKIP] ユーザー webuser は既に存在します（uid=8080(webuser) gid=8080(webuser) groups=8080(webuser)）
[SKIP] ユーザー appuser は既に存在します（uid=8081(appuser) gid=8081(appuser) groups=8081(appuser)）

install_package() {
    local pkg="$1"

    if rpm -q "${pkg}" &>/dev/null; then
        echo "[SKIP] ${pkg} はインストール済みです（$(rpm -q "${pkg}")）"
        return 0
    fi

    echo "[INSTALL] ${pkg} をインストールします..."
    dnf install -y "${pkg}"
    echo "[DONE] ${pkg} のインストールが完了しました"
}

install_package "nginx"
install_package "rsync"

# 1回目：未インストール
[INSTALL] nginx をインストールします...
Complete!
[DONE] nginx のインストールが完了しました

# 2回目：インストール済み
[SKIP] nginx はインストール済みです（nginx-1.22.1-3.module+el9.2.0+13177+da0eeee8.x86_64）
[SKIP] rsync はインストール済みです（rsync-3.2.3-19.el9.x86_64）

deploy_config() {
    local src="$1"
    local dst="$2"

    # 配置先ディレクトリを作成（-p で冪等）
    mkdir -p "$(dirname "${dst}")"

    # 内容が同じならスキップ
    if [ -f "${dst}" ] && diff -q "${src}" "${dst}" &>/dev/null; then
        echo "[SKIP] $(basename "${dst}") は最新の状態です"
        return 0
    fi

    # バックアップしてから上書き
    if [ -f "${dst}" ]; then
        cp "${dst}" "${dst}.$(date +%Y%m%d_%H%M%S).bak"
    fi

    cp "${src}" "${dst}"
    echo "[UPDATE] ${dst} を配置しました"
}

deploy_config "/opt/myapp/templates/nginx.conf" "/etc/nginx/nginx.conf"
deploy_config "/opt/myapp/templates/app.conf"  "/etc/myapp/app.conf"

#!/bin/bash
# server-init.sh  サーバー初期設定スクリプト（冪等設計）
# 実行環境: RHEL 9.4 / Rocky Linux 9.4
set -euo pipefail

# 定数定義
SCRIPT_NAME="$(basename "$0")"
STATE_DIR="/var/lib/server-init"
LOG_FILE="/var/log/server-init.log"

log() {
    local level="$1"; shift
    echo "[$(date '+%Y-%m-%d %H:%M:%S')] [${level}] $*" | tee -a "${LOG_FILE}"
}

# ステートファイルによる実行管理
mkdir -p "${STATE_DIR}"

run_once() {
    local step_name="$1"
    local state_file="${STATE_DIR}/${step_name}.done"

    if [ -f "${state_file}" ]; then
        log "SKIP" "ステップ [${step_name}] は完了済みです"
        return 0
    fi

    log "RUN" "ステップ [${step_name}] を開始します"
    "${@:2}"
    touch "${state_file}"
    log "DONE" "ステップ [${step_name}] が完了しました"
}

# 個別処理関数
step_create_users() {
    if ! id webuser &>/dev/null; then
        useradd -r -u 8080 -s /sbin/nologin webuser
        log "INFO" "ユーザー webuser を作成しました"
    fi
}

step_install_packages() {
    for pkg in nginx rsync; do
        if ! rpm -q "${pkg}" &>/dev/null; then
            dnf install -y "${pkg}"
            log "INFO" "${pkg} をインストールしました"
        fi
    done
}

step_deploy_configs() {
    local nginx_conf="/etc/nginx/conf.d/myapp.conf"
    if [ ! -f "${nginx_conf}" ]; then
        cp "/opt/myapp/templates/myapp.conf" "${nginx_conf}"
        log "INFO" "nginx 設定ファイルを配置しました"
    fi
}

# メイン処理（run_once でステップ管理）
run_once "create_users"      step_create_users
run_once "install_packages"  step_install_packages
run_once "deploy_configs"    step_deploy_configs

log "INFO" "全ての初期設定が完了しました"

# 1回目の実行
[2026-08-05 10:22:10] [RUN]  ステップ [create_users] を開始します
[2026-08-05 10:22:10] [INFO] ユーザー webuser を作成しました
[2026-08-05 10:22:10] [DONE] ステップ [create_users] が完了しました
[2026-08-05 10:22:11] [RUN]  ステップ [install_packages] を開始します
[2026-08-05 10:22:14] [INFO] nginx をインストールしました
[2026-08-05 10:22:16] [INFO] rsync をインストールしました
[2026-08-05 10:22:16] [DONE] ステップ [install_packages] が完了しました
[2026-08-05 10:22:16] [RUN]  ステップ [deploy_configs] を開始します
[2026-08-05 10:22:16] [INFO] nginx 設定ファイルを配置しました
[2026-08-05 10:22:16] [DONE] ステップ [deploy_configs] が完了しました
[2026-08-05 10:22:16] [INFO] 全ての初期設定が完了しました

# 2回目の実行（全ステップスキップ）
[2026-08-05 10:30:05] [SKIP] ステップ [create_users] は完了済みです
[2026-08-05 10:30:05] [SKIP] ステップ [install_packages] は完了済みです
[2026-08-05 10:30:05] [SKIP] ステップ [deploy_configs] は完了済みです
[2026-08-05 10:30:05] [INFO] 全ての初期設定が完了しました

# 特定ステップのステートを削除して再実行
$ sudo rm /var/lib/server-init/install_packages.done
$ sudo bash server-init.sh
[2026-08-05 11:05:01] [SKIP] ステップ [create_users] は完了済みです
[2026-08-05 11:05:01] [RUN]  ステップ [install_packages] を開始します
[2026-08-05 11:05:05] [DONE] ステップ [install_packages] が完了しました
[2026-08-05 11:05:05] [SKIP] ステップ [deploy_configs] は完了済みです
[2026-08-05 11:05:05] [INFO] 全ての初期設定が完了しました

# 全ステートを削除して最初からやり直す
$ sudo rm -f /var/lib/server-init/*.done

# NG：-e は同名ディレクトリでも真になる
if [ -e "/var/lib/myapp/initialized.done" ]; then
    echo "スキップ"  # ディレクトリが存在してもスキップされてしまう
fi

# OK：-f は通常ファイルのみ真
if [ -f "/var/lib/myapp/initialized.done" ]; then
    echo "スキップ"  # ファイルのみスキップ
fi

# NG：id コマンドが終了コード1を返した瞬間にスクリプトが終了する
set -e
id "webuser"  # ユーザーが存在しない場合、ここで exit 1 が起きる

# OK：if 文の中では set -e の即時終了が適用されない
if id "webuser" &>/dev/null; then
    echo "存在する"
else
    echo "存在しない"
fi