構成管理

目次

• 概要
• 使用する場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

環境変数、構成ファイル、シークレット、フィーチャーフラグ、および 12-factor アプリ方法論に従う、環境全体でのアプリケーション構成管理の包括的ガイド。

使用する場面

• 異なる環境の構成設定
• シークレットと認証情報の管理
• フィーチャーフラグの実装
• 構成階層の作成
• 12-factor アプリの原則に従う
• クラウドサービスへの構成移行
• 動的構成の実装
• マルチテナント構成の管理

クイックスタート

最小限の動作例：

# .env.development
NODE_ENV=development
PORT=3000
DATABASE_URL=postgresql://localhost:5432/myapp_dev
REDIS_URL=redis://localhost:6379
LOG_LEVEL=debug
API_KEY=dev-api-key-12345

# .env.production
NODE_ENV=production
PORT=8080
DATABASE_URL=${DATABASE_URL}  # From environment
REDIS_URL=${REDIS_URL}
LOG_LEVEL=info
API_KEY=${API_KEY}  # From secret manager

# .env.test
NODE_ENV=test
DATABASE_URL=postgresql://localhost:5432/myapp_test
LOG_LEVEL=error

リファレンスガイド

references/ ディレクトリの詳細な実装：

ガイド	内容
環境変数	環境変数
構成階層	構成階層
シークレット管理	シークレット管理
フィーチャーフラグ	フィーチャーフラグ
12-Factor アプリ構成	12-Factor アプリ構成
構成検証	構成検証
動的構成（リモート構成）	動的構成（リモート構成）

ベストプラクティス

✅ すべきこと

• 環境変数に構成を保存する
• 環境ごとに異なる構成ファイルを使用する
• 起動時に構成を検証する
• 機密データにはシークレット管理を使用する
• シークレットをバージョン管理にコミットしない
• 合理的なデフォルト値を提供する
• すべての構成オプションをドキュメント化する
• タイプセーフな構成オブジェクトを使用する
• 構成階層を実装する（ベース + オーバーライド）
• フィーチャーフラグを段階的ロールアウトに使用する
• 12-factor アプリの原則に従う
• 欠落した構成に対する適切な劣化を実装する
• API 呼び出しを削減するためにシークレットをキャッシュする

❌ すべきではないこと

• ソースコードに構成をハードコードする
• 実際のシークレットを含む .env ファイルをコミットする
• サービス全体で異なる構成フォーマットを使用する
• プレーンテキストでシークレットを保存する
• API を通じて構成を公開する
• 本番環境の認証情報を開発環境で使用する
• 構成検証エラーを無視する
• 至る所で process.env に直接アクセスする
• データベースに構成を保存する（循環依存）
• 構成とビジネスロジックを混在させる