前書き
このガイドでは、Ubuntu 14.04でFlaskマイクロフレームワークを使用して簡単なPythonアプリケーションをセットアップします。 この記事の大部分は、Gunicornアプリケーションサーバーをセットアップしてアプリケーションを起動し、Nginxをフロントエンドリバースプロキシとして機能させる方法について説明します。
前提条件
このガイドを開始する前に、サーバーで非rootユーザーを構成する必要があります。 このユーザーは、管理機能を実行できるように、sudo特権を持っている必要があります。 これを設定する方法については、initial server setup guideに従ってください。
アプリケーションサーバーがFlaskアプリとの通信に使用するWSGI仕様の詳細については、this guideのリンクされたセクションを参照してください。 これらの概念を理解すると、このガイドを理解しやすくなります。
続行する準備ができたら、読み進めてください。
Ubuntuリポジトリからコンポーネントをインストールする
最初のステップは、リポジトリから必要なすべてのピースをインストールすることです。 Pythonコンポーネントをインストールして管理するために、Pythonパッケージマネージャーであるpipをインストールします。 また、Gunicornコンポーネントの一部を構築するために必要なPython開発ファイルも入手します。 Nginxもインストールします。
ローカルパッケージインデックスを更新してから、次のように入力してパッケージをインストールします。
sudo apt-get update
sudo apt-get install python-pip python-dev nginxPython仮想環境を作成する
次に、Flaskアプリケーションをシステム上の他のPythonファイルから分離するために、仮想環境を設定します。
pipを使用してvirtualenvパッケージをインストールすることから始めます。
sudo pip install virtualenvこれで、Flaskプロジェクトの親ディレクトリを作成できます。 作成後、ディレクトリに移動します。
mkdir ~/myproject
cd ~/myproject次を入力して、FlaskプロジェクトのPython要件を保存する仮想環境を作成できます。
virtualenv myprojectenvこれにより、Pythonとpipのローカルコピーがプロジェクトディレクトリ内のmyprojectenvというディレクトリにインストールされます。
仮想環境にアプリケーションをインストールする前に、アクティブ化する必要があります。 これを行うには、次のように入力します。
source myprojectenv/bin/activateプロンプトが変わり、仮想環境内で操作していることが示されます。 この(myprojectenv)user@host:~/myproject$のようになります。
Flaskアプリケーションのセットアップ
仮想環境にいるので、FlaskとGunicornをインストールして、アプリケーションの設計を開始できます。
FlaskとGunicornをインストールする
pipのローカルインスタンスを使用して、FlaskとGunicornをインストールできます。 次のコマンドを入力して、これらの2つのコンポーネントを取得します。
pip install gunicorn flaskサンプルアプリを作成する
Flaskが使用可能になったので、簡単なアプリケーションを作成できます。 フラスコはマイクロフレームワークです。 より多くのフル機能のフレームワークが提供するツールの多くは含まれておらず、主にプロジェクトにインポートしてWebアプリケーションの初期化を支援できるモジュールとして存在します。
アプリケーションはもっと複雑かもしれませんが、Flaskアプリを単一のファイルで作成します。これをmyproject.pyと呼びます。
nano ~/myproject/myproject.pyこのファイル内に、アプリケーションコードを配置します。 基本的に、フラスコをインポートし、Flaskオブジェクトをインスタンス化する必要があります。 これを使用して、特定のルートが要求されたときに実行する機能を定義できます。 コードapplicationでFlaskアプリケーションを呼び出して、WSGI仕様にある例を複製します。
from flask import Flask
application = Flask(__name__)
@application.route("/")
def hello():
return "Hello There!
"
if __name__ == "__main__":
application.run(host='0.0.0.0')これは基本的に、ルートドメインにアクセスしたときに表示するコンテンツを定義します。 完了したら、ファイルを保存して閉じます。
次のように入力して、Flaskアプリをテストできます。
python myproject.pyサーバーのドメイン名またはIPアドレスにアクセスし、続いてWebブラウザの端末出力で指定されたポート番号（ほとんどの場合:5000）にアクセスします。 このようなものが見えるはずです。
終了したら、ターミナルウィンドウでCTRL-Cを数回押して、Flask開発サーバーを停止します。
WSGIエントリポイントを作成する
次に、アプリケーションのエントリポイントとして機能するファイルを作成します。 これにより、Gunicornサーバーにアプリケーションとの対話方法が通知されます。
ファイルをwsgi.pyと呼びます。
nano ~/myproject/wsgi.pyファイルは非常にシンプルで、アプリケーションからFlaskインスタンスをインポートして実行するだけです。
from myproject import application
if __name__ == "__main__":
application.run()完了したら、ファイルを保存して閉じます。
Gunicornのプロジェクト提供能力のテスト
先に進む前に、Gunicornが正しく実行できることを確認する必要があります。
これを行うには、エントリポイントの名前を渡すだけです。 また、公開するインターフェイスで開始されるように、バインドするインターフェイスとポートを指定します。
cd ~/myproject
gunicorn --bind 0.0.0.0:8000 wsgiWebブラウザの末尾に:8000が追加されたサーバーのドメイン名またはIPアドレスにアクセスすると、次のようなページが表示されます。
正しく機能していることを確認したら、ターミナルウィンドウでCTRL-Cを押します。
これで仮想環境が完成したので、非アクティブ化できます。
deactivateこれで、すべての操作はシステムのPython環境に対して実行されます。
Upstartスクリプトを作成する
次に注意する必要があるのは、Upstartスクリプトです。 Upstartスクリプトを作成すると、Ubuntuの初期化システムがGunicornを自動的に起動し、サーバーが起動するたびにFlaskアプリケーションを提供できます。
開始するには、/etc/initディレクトリ内に.confで終わるスクリプトファイルを作成します。
sudo nano /etc/init/myproject.conf内部では、スクリプトの目的の簡単な説明から始めます。 その直後に、このスクリプトがシステムによって開始および停止される条件を定義します。 通常のシステムランタイム番号は2、3、4、5であるため、システムがこれらのランレベルのいずれかに達したときにスクリプトを開始するように指示します。 他のランレベルで停止するように指示します（サーバーの再起動時、シャットダウン時、シングルユーザーモードなど）。
description "Gunicorn application server running myproject"
start on runlevel [2345]
stop on runlevel [!2345]initシステムに、プロセスが失敗した場合にプロセスを再起動するように指示します。 次に、Gunicornを実行するユーザーとグループを定義する必要があります。 プロジェクトファイルはすべて自分のユーザーアカウントによって所有されているため、実行するユーザーとして自分自身を設定します。 Nginxサーバーはwww-dataグループの下で実行されます。 Nginxがソケットファイルを読み書きできるようにする必要があるため、このグループにプロセスの所有権を与えます。
description "Gunicorn application server running myproject"
start on runlevel [2345]
stop on runlevel [!2345]
respawn
setuid user
setgid www-data次に、ファイルを正しく見つけて処理できるようにプロセスを設定する必要があります。 すべてのPythonコンポーネントを仮想環境にインストールしたため、これをパスとして環境変数を設定する必要があります。 また、プロジェクトディレクトリに変更する必要があります。 その後、使用したいオプションを指定してGunicornアプリケーションを呼び出すだけです。
3つのワーカープロセスを開始するように指示します（必要に応じて調整します）。 また、myproject.sockというプロジェクトディレクトリ内にUnixソケットファイルを作成してバインドするように指示します。 007のumask値を設定して、所有者とグループへのアクセスを許可するソケットファイルが作成され、他のアクセスは制限します。 最後に、WSGIエントリポイントのファイル名を渡す必要があります。
description "Gunicorn application server running myproject"
start on runlevel [2345]
stop on runlevel [!2345]
respawn
setuid user
setgid www-data
env PATH=/home/user/myproject/myprojectenv/bin
chdir /home/user/myproject
exec gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi完了したら、ファイルを保存して閉じます。
次のように入力して、すぐにプロセスを開始できます。
sudo start myprojectリクエストをプロキシするためのNginxの構成
これで、Gunicornアプリケーションサーバーが起動して実行され、プロジェクトディレクトリ内のソケットファイルに対する要求を待機するはずです。 Nginxを構成して、そのソケットにWebリクエストを渡すように構成ファイルに少し追加する必要があります。
Nginxのsites-availableディレクトリに新しいサーバーブロック構成ファイルを作成することから始めます。 ガイドの残りの部分と一致させるために、これを単にmyprojectと呼びます。
sudo nano /etc/nginx/sites-available/myprojectサーバーブロックを開き、Nginxにデフォルトのポート80でリッスンするように指示します。 また、サーバーのドメイン名またはIPアドレスのリクエストにこのブロックを使用するように指示する必要があります。
server {
listen 80;
server_name server_domain_or_IP;
}追加する必要がある他の唯一のものは、すべての要求に一致するロケーションブロックです。 このブロック内に、設定する必要のあるいくつかの一般的なプロキシパラメータを指定するproxy_paramsファイルを含めます。 次に、proxy_passディレクティブを使用して定義したソケットにリクエストを渡します。
server {
listen 80;
server_name server_domain_or_IP;
location / {
include proxy_params;
proxy_pass http://unix:/home/user/myproject/myproject.sock;
}
}実際にアプリケーションを提供するために必要なのはそれだけです。 完了したら、ファイルを保存して閉じます。
作成したNginxサーバーブロック構成を有効にするには、ファイルをsites-enabledディレクトリにリンクします。
sudo ln -s /etc/nginx/sites-available/myproject /etc/nginx/sites-enabledそのディレクトリにあるファイルで、次のように入力して構文エラーをテストできます。
sudo nginx -t問題が発生せずにこれが返された場合、Nginxプロセスを再起動して新しい構成を読み取ることができます。
sudo service nginx restartこれで、Webブラウザでサーバーのドメイン名またはIPアドレスにアクセスして、アプリケーションを表示できるようになります。
結論
このガイドでは、Python仮想環境内にシンプルなFlaskアプリケーションを作成しました。 WSGI対応のアプリケーションサーバーがインターフェイスできるようにWSGIエントリポイントを作成し、この機能を提供するようにGunicornアプリサーバーを構成します。 その後、起動時にアプリケーションサーバーを自動的に起動するUpstartスクリプトを作成しました。 Webクライアントトラフィックをアプリケーションサーバーに渡し、外部リクエストを中継するNginxサーバーブロックを作成しました。
Flaskは非常にシンプルですが、非常に柔軟なフレームワークであり、構造や設計に制限をかけすぎることなく、アプリケーションに機能を提供することを目的としています。 このガイドで説明されている一般的なスタックを使用して、設計したフラスコアプリケーションを提供できます。