ボリューム、ネットワーク、シークレットの Docker Compose 変更レビュー用チェックリスト

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

安全な方法は、データパス、ネットワーク到達性、シークレットを保護するレンダリング済み設定のレビューと、元に戻せるデプロイ確認を、単一のコマンドではなく、観測可能なゲートの連続として扱うことです。

ホームサーバー上のDocker Composeアプリケーションスタックでは、Composeの編集によって、永続ストレージ、接続性、シークレットの受け渡しが異なるコンテナとして再作成されるおそれがあります。現在の識別情報と復旧ポイントを記録し、最も影響の小さい判別方法から始め、別の変数を変更する前に合否の結果を解釈してください。ストレージが不安定になった場合や、復旧可能な唯一のコピーが露出する場合は中止してください。以下の手順は、元のワークロードが正常に動作するか、証拠がエスカレーションの境界に達した場合にのみ終了します。

レビュー前に実効設定をレンダリングする

稼働中のデプロイで使用しているComposeファイルのセット、プロジェクト名、作業ディレクトリ、環境ファイル、プロファイル、イメージタグを固定してください。シークレット値が露出しない方法でdocker compose configを実行し、レンダリングしたモデルを安全に保存して、最後に正常稼働していたデプロイと比較してください。

Composeの動作は補間とマージ済みファイルに左右されるため、編集したYAMLだけを確認しても、実際に適用される変更を見落とすことがあります。レンダリング済みCompose設定のレビューでは、解決済みの設定を検証し、デプロイ計画を確認することを推奨しています。これにより、レビューを単なる書式確認ではなく、実行時の比較にできます。

変数が未設定、プロジェクト名が予期せず変更、イメージタグが記録済みのダイジェストなしに可変、またはレンダリングされたファイルに認証情報が含まれている場合は中止してください。pull、build、upコマンドを実行する前に、これらの条件を解消してください。

永続ボリュームとバインドマウントをすべて追跡する

各サービスについて、コンテナ内のマウント先を名前付きボリュームまたはホストパスに対応付け、設定ファイル、データベースファイル、アップロード、キャッシュのどれを保持しているかを特定し、想定どおりの所有権でソースが存在することを確認してください。特に相対パスは、作業ディレクトリが変わると、気付かないうちに新しい空のフォルダーを指すことがあるため注意してください。

明示的なボリューム名と外部ボリュームの設定を、現在のDockerボリューム一覧と照合します。プロジェクト名が変わると新しいプレフィックス付きボリュームが作成され、古いデータはそのまま残ることがあり、アプリケーションがリセットされたように見える場合があります。ステートフルなデータをバックアップし、再作成を許可する前に現在のボリューム検査結果を記録してください。

関連する ZimaSpace の記事アップグレード時に永続的なアプリ設定を保護するでは、アプリのアップグレード時に設定が失われる問題を取り上げています。レビューで永続的なアプリの状態が適切に分離されていなかったことが判明した場合は、この記事を参考にしてください。新しく作成したボリュームに、正体のわからないファイルをコピーして問題を覆い隠さないでください。

ネットワーク、ポート、シークレットの受け渡しを確認する

ネットワーク名、エイリアス、IPファミリー、公開ポート、ホストへのバインド、リバースプロキシの転送先を比較してください。データベースが引き続き非公開であること、プロキシがアプリケーションのサービス名を引き続き名前解決できること、変更後にすべてのインターフェースで管理ポートが公開されないことを確認してください。

各シークレットについて、値は記録せずに、取得元、利用者、マウントパスまたは環境変数キー、ファイルモード、ローテーション担当者を記録してください。新しい設定が、既存の保護されたファイルまたは外部シークレットを参照していることを確認してください。また、ログ、ビルド引数、ラベル、レンダリング差分にシークレットが漏れていないことを確かめてください。

ネットワークまたはシークレットの変更は、意図された利用者がそのネットワークにアクセスできる、またはシークレットを読み取れる一方で、意図しないピアはできない場合にのみ、レビューを通過します。変更に認証情報の同時ローテーションが必要な場合は、取り消し不能な再起動でまとめて実施せず、デプロイを重複稼働フェーズと失効フェーズに分けてください。

再作成を段階的に行い、ロールバックを検証する

スタックを起動する前にイメージをプルし、提案されたサービス変更を確認してください。復旧可能な時間帯にデプロイし、アーキテクチャ上可能であれば、まずリスクの低い依存サービスを1つ再作成してください。続行する前に、ヘルスチェック、ログ、マウント、DNS解決、公開ソケットを監視してください。

ログイン、データの読み取り1件、破棄可能な書き込み1件、バックグラウンドジョブ、リバースプロキシ経由のアクセスをテストしてください。スタックを1回再起動し、プロセスの再作成後もボリュームとシークレットの参照が維持されることを確認してください。コンテナが単に実行中と表示されるだけで、変更が成功したと判断しないでください。

受け入れ確認が完了するまで、以前の Compose ファイル、環境変数の参照、イメージダイジェスト、データのバックアップを保持してください。アプリが空の状態で起動した、データベースが予期せずマイグレーションされた、シークレットが不足している、または管理ポートが公開された場合は、直ちにロールバックしてください。保存済みのレンダリング差分から原因を調査してください。

サポートとヒント

続きを読む

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.