コンテナのローリング更新時にデータベースのマイグレーションをアプリケーションの起動から分離する方法

Eva Wong は テクニカルライター であり、 生粋の技術好き としてZimaSpaceで活動しています。ホームラボやオープンソースソフトウェア をこよなく愛する生粋のギークで、複雑な技術概念をわかりやすく、実践的なガイド にまとめることを得意としています。Evaは、セルフホスティングは難しいものではなく、楽しむものだと考えています。チュートリアルを通じて、初めてのNAS構築からDockerコンテナの使いこなしまで、コミュニティがハードウェアのセットアップをわかりやすく理解できるよう 支援しています。、初めてのNAS構築からDockerコンテナの習得まで。

スキーマ変更を各アプリコンテナの起動時ではなく、明示的なデプロイ手順として1回実行すれば、データベース移行の重複を防ぎやすくなります。

予防策として、移行の実行主体、認証情報、完了シグナルをそれぞれ1つにし、新しいレプリカがトラフィックを処理し始める前に移行を完了させます。Web コンテナとワーカーコンテナはスキーマ変更権限を取得せずに再起動できるようにし、移行ジョブが成功するまでロールアウトを待機させ、旧バージョンと新バージョンのアプリが短時間共存できるスキーマ変更を設計します。これにより、すべてのレプリカが同じ移行履歴を最初に認識することを期待するのではなく、競合状態そのものを取り除けます。

通常のアプリ起動処理から移行コマンドを削除する

イメージのエントリーポイント、Compose コマンド、ワーカーコマンド、ヘルスチェック用ラッパー、デプロイスクリプトで、移行が自動実行される箇所を確認します。意図的に移行ステップとして選んだ再起動でない限り、スキーマを変更せずにアプリケーションを再起動できるようにします。

Octopus のデプロイに関する記事では、移行には独自のライフサイクルが必要であり、すべてのマイクロサービスプロセスの起動に結び付けるべきではないと説明しています。

必要な場所で移行バイナリを利用できるようにしても、Web のエントリーポイントと別のジョブの両方から実行しないでください。フレームワークのロック機構に依存する複数の起動経路より、実行主体を明確に1つにする方が監査しやすくなります。

デプロイ前に移行ジョブを1つ実行する

リリースと同じ移行ファイルを使う単発ジョブを作成し、対象データベースが期待されるスキーマ状態に達した場合にのみ正常終了させます。その結果をアプリケーションのロールアウトの条件にします。

最近のロールアウトガイドでは、各レプリカが起動時に競合するのではなく、1つのジョブをロールアウト前に実行する方法を紹介しています。

アプリケーションサービスと同じように移行タスクをスケールしないでください。移行ジョブには、対象データベースごとに1つの実行主体、上限時間、ログ、そして新しいアプリバージョンをブロックする明確な失敗状態が必要です。

移行の成功を条件にアプリケーションの起動を制御する

移行ステージが成功を報告するまで、新しい Web コンテナとワーカーコンテナを待機させます。ただし、待機中の各コンテナで移行を再実行させないでください。依存するのは実行結果であり、スキーマ変更の再実行ではありません。

Andrew Lock のデプロイパターンでは、アプリの Pod が移行を待機する一方で、移行ロジックは一元管理されます。

小規模なホームサーバースタックでは、専用のComposeサービスと制御されたデプロイスクリプトを使って、同じ原則を実装できます。マイグレーションが失敗した場合にロールアウトが明確に停止するよう、仕組みはシンプルに保ちます。

重複稼働中は後方互換性のあるスキーマ変更を行う

ローリングデプロイでは、一時的に旧バージョンと新バージョンのアプリが1つのデータベースに同時に接続することがあります。旧バージョンが使わなくなる前にフィールドを削除または名前変更するマイグレーションは避けてください。

最近のゼロダウンタイムマイグレーションガイドでは、破壊的な整理の前に追加的なスキーマ変更を適用できるよう、縮小の前に拡張することを推奨しています。

必要に応じて、大規模な変更を拡張、バックフィル、切り替え、縮小のフェーズに分けます。古いレプリカがリクエストを処理している間に、新しいコンテナだけが理解できるスキーマをマイグレーションジョブで作成してはなりません。

マイグレーションの認証情報をアプリのレプリカから分離する

可能であれば、スキーマ変更権限を持つデータベースアカウントは、一度だけ実行するマイグレーションのステージに限って使用します。通常のアプリコンテナには、アプリケーションデータに必要な範囲の読み書き権限のみを付与します。

Liquibaseのデプロイ記事では、データベースの変更は自動化で管理するという、変更を制御し再現可能な形で適用する方法が説明されています。

この分離により、アプリプロセスが再起動または複製された場合でも、誤ってマイグレーションが実行される可能性が低くなります。昇格された認証情報は、通常の長時間稼働するサービス環境ではなく、デプロイ用のシークレットパスに保存してください。

ロールアウトでバッチが2回適用されないことを確認する

使い捨てのデータベースまたは復元したスナップショットでデプロイをテストし、アプリのレプリカを複数起動して再起動し、デプロイコマンドを再実行します。マイグレーションのステージでは、既存のスキーマ状態を報告し、2回目の変更を行わないことを確認してください。

JetBrainsは、通常のアプリ起動前にデプロイのステップとしてマイグレーションを実行するという運用ルールを推奨しています。

アプリの再起動でスキーマが変更されず、失敗したマイグレーションによってリリースが停止し、ロールアウトを繰り返し実行してもデータベースが変更されない状態になれば、予防ポリシーは完成です。重複実行がすでに発生した場合は、関連するZimaSpaceの記事重複マイグレーションの診断を復旧手順として参照してください。

サポートとヒント

続きを読む

Get More Builds Like This

Stay in the Loop

Get updates from Zima - new products, exclusive deals, and real builds from the community.

Stay in the Loop preferences

We respect your inbox. Unsubscribe anytime.