Traffine I/O

日本語

2023-04-19

Twelve-Factor App

Twelve-Factor Appとは

Twelve-Factor Appは、特にウェブベースやSoftware as a Service(SaaS)アプリケーションなどのモダンなアプリケーションを構築するための方法論です。この方法論は、スケーラビリティ、保守性、移植性の向上を目指した12のベストプラクティスを提案しています。これらの原則により、開発からデプロイまでのさまざまな段階でシームレスに移行し、クラウド環境で効率的に動作するアプリケーションの開発が容易になります。

Twelve Factors

以下では、12の要素を解説し、それぞれの重要性、適用方法、およびベストプラクティスについて紹介します。

要素1:コードベース

1つのコードベースからの複数のデプロイメント

最初の要素は、アプリケーションがバージョン管理システムで追跡される単一のコードベースを持つべきであると述べています。このコードベースから複数のデプロイメントが行われます。この原則は、アプリケーションのライフサイクルの異なる段階での保守性と一貫性を促進します。

Git、Mercurial、またはSVNなどのバージョン管理システムを使用することで、開発者は効率的にコードベースを管理し、変更を追跡し、コードの競合を回避することができます。

バージョン管理

バージョン管理は、現代のソフトウェア開発において重要な要素です。これにより、コードの変更履歴を記録するだけでなく、複数のコントリビュータが互いの作業を上書きすることなく同時に作業することも可能です。コードベースに対してバージョン管理を行い、アプリケーションの真実の情報源として活用することが不可欠です。

要素2:依存関係

依存関係の管理

依存関係とは、アプリケーションが依存する外部のライブラリやツールのことです。第2の要素では、環境に依存することなく依存関係を明示的に宣言し、分離することを提案しています。これにより、アプリケーションがさまざまな環境で一貫して動作することができます。

依存関係の分離

Pythonの仮想環境、Node.jsのnpm、RubyのBundlerなどのツールを使用することで、アプリケーションの依存関係を分離することができます。この分離により、アプリケーションがシステム全体のパッケージに暗黙的に依存することなく動作するため、バージョンの競合や環境間の一貫性の問題を回避できます。

要素3:設定

設定とコードの分離

第3の要素では、設定とコードの分離の重要性が強調されています。設定にはデータベースの認証情報、APIキー、環境固有の設定など、デプロイごとに変化する可能性がある全ての要素が含まれます。これらの設定をコードベースに保存すると、セキュリティの脆弱性や移植性の低下につながる可能性があります。

環境変数

環境変数は、設定を管理するための一般的な手法です。環境変数を使用することで、設定をコードベースとは別に保持し、コードを変更することなく簡単に変更することができます。

要素4:バックエンドサービス

バックエンドサービスをアタッチされたリソースとして扱う

データベース、メッセージングシステム、キャッシュなどのバックエンドサービスは、アプリケーションがローカルのサービスとサードパーティのサービスの区別をすることなく、同じように扱うべきです。

緩い結合

抽象化により、アプリケーションはコードの変更なしにさまざまなサービスプロバイダー間を簡単に切り替えることができます。サービスのエンドポイントや認証情報などの設定の詳細は、環境変数に保存されるべきです。

要素5:ビルド、リリース、実行

デプロイプロセス

第5の要素では、デプロイプロセスをビルド、リリース、実行の3つのステージに分割することが提案されています。ビルドステージではコードのコンパイルと依存関係の解決が行われます。リリースステージではビルドと設定の統合が行われます。実行ステージではアプリケーションが実行環境で実行されます。

不変なリリース

リリースが作成されたら、それは不変であるべきです。つまり、それに変更を加えることはできません。変更が必要な場合は、ビルドステージから新しいリリースを作成する必要があります。

要素6:プロセス

ステートレスプロセス

第6の要素では、アプリケーションは1つまたは複数のステートレスプロセスとして実行されるべきであるとアドバイスされています。つまり、アプリケーションはローカルストレージに永続性を依存するべきではありません。クラウド環境では通常、ローカルストレージは一時的なものです。

プロセスのスケーリング

ステートレス性により、アプリケーションは水平方向にスケーリングすることができます。各プロセスは独立しており、他の実行中のプロセスとは何も共有しません。

要素7:ポートバインディング

自己完結型サービス

アプリケーションは自己完結であり、実行環境にWebサーバーをランタイムインジェクションすることに依存すべきではありません。アプリケーションはリクエストを処理するために自分自身をポートにバインドできる必要があります。

ポートバインディングによるサービスの公開

この要素では、Webアプリケーションが外部のWebサーバーに依存せず、ポートにバインドして受信リクエストを処理できることが重要です。これにより、アプリケーションのスケーリング、デプロイ、管理が容易になります。

要素8:並行性

プロセスモデル

Twelve-Factor Appにおける並行性は、アプリケーションが垂直方向のスケーリングではなく水平方向のスケーリング(既存のインスタンスにパワーを追加するのではなく、より多くの実行インスタンスを追加する)によってスケールする能力を指します。アプリケーションは、バックプレーンを介して通信する複数の小さなプロセスの集合体として設計されるべきです。

プロセスモデルによるスケールアウト

これにより、アプリケーションは単純により多くのプロセスを追加することで容易にスケールアウトできます。さまざまなタイプの作業を異なるタイプのプロセスに割り当てることができ、ワークロードの要件に基づいて独立してスケールすることができます。

要素9:廃棄容易性

高速な起動と優雅なシャットダウン

アプリケーションは迅速に起動し、シグナルを受け取った際に優雅にシャットダウンできる必要があります。これにより、アプリケーションの迅速かつ信頼性の高いスケール、デプロイ、リリースが可能になります。

使い捨て可能なコンポーネントによる頑強性

コンポーネントを使い捨て可能にすることで、システムは障害や変更から自動的に回復することができ、頑強性と耐久性が向上します。

要素10:開発/本番一致

継続的なデプロイ

この要素では、開発、ステージング、本番の環境をできるだけ類似させることの重要性が強調されています。これにより、開発サイクルの早い段階で問題を特定し、解決することが容易になり、継続的なデプロイが容易になります。

開発、ステージング、本番をできるだけ類似させる

開発と本番の間の差を小さくすることで、チームはより効率的かつ信頼性の高い方法で本番の問題を理解し、対処することができます。これには、類似したバックエンドサービス、データベース、環境設定を使用することが含まれます。

要素11:ログ

ログストリーム

アプリケーションはログファイルの管理に関与する必要はありません。代わりに、アプリケーションは標準出力にログを書き込むことで、実行環境がログをキャプチャできるようにします。

ログの管理とモニタリング

本番環境では、ログストリームを集約し、モニタリングし、それに基づいてアラートを生成するログ管理システムを持つことが重要です。これにより、デバッグ、パフォーマンスのモニタリング、ユーザーの行動の理解に役立ちます。

要素12:管理プロセス

管理タスクの実行

データベースのマイグレーションなどのワンオフの管理タスクは、アプリケーションの通常の長時間実行プロセスと同じ環境で実行するべきです。

ワンオフプロセス

これにより、全ての管理タスクがアプリケーションと同じ環境で実行され、不一致や予期しない動作が減少します。ワンオフプロセスは、バージョン管理システム内のコードを使用して自動化され、管理されるべきです。

参考

https://12factor.net

Ryusei Kakujo

researchgatelinkedingithub

Focusing on data science for mobility

Bench Press 100kg!