Chapter 13: デプロイレシピ

デプロイレシピ

本番環境にweb2pyをデプロイするには、幾つかの方法があります。詳細は、ホストによって提供されているサーバーの構成とサービスに依存します。

この章では次の点を考えてみます:

  • 本番環境(Apache、Nginx、Lighttpd、Cherokee)
  • セキュリティ
  • Redis とロードバランサを使った、スケーラビリティ
  • PythonAnywhere、Heroku、Amazon EC2、 そして Google App Engine プラットフォーム(GAE [gae])へのデプロイ

Apache
CGI
mod_python
mod_wsgi
mod_proxy
WSGI
Nginx
Heroku
PythonAnywhere

web2pyにはSSL [ssl] が有効な Rocket wsgiserver[rocket] というwebサーバーがあります。これは高速なwebサーバーですが、キャパシティ設定に制限があります。これによりweb2pyを、Apache[apache][Nginx] Lighttpd[lighttpd] 、 Cherokee[cherokee] でデプロイするのが最適です。これらのサーバーは無償のオープンソースで、カスタマイズでき、トランザクションの多い本番環境での信頼性が証明されています。静的なファイルを直接表示したり、HTTPSを処理したり、動的なコンテンツでweb2pyにコントロールを渡すことができます。

数年前までwebサーバーとwebアプリケーション間で通信に使う、標準的なインターフェースはCommon Gateway Interface (CGI)[cgi]でした。CGIの一番の問題は、HTTPリクエストのたびに新しいプロセスを作成することです。もしwebアプリケーションがインタプリタ言語で書かれている場合は、CGIスクリプトによって実行されたHTTPリクエストが新しいインタプリタ・インスタンスを作成します。これは処理が遅く、本番環境では避けるべきです。さらに、CGIは簡単な処理結果だけを扱えます。例えばファイルストリーミングを扱うことはできません。

web2pyはCGIへのインターフェースに、cgihandler.py ファイルを提供しています。

この問題に対する一つの解決策として、Apcheのmod_pythonモジュールを使う方法があります。Apache Software Foundationにより、mod_pythonプロジェクトは正式には破棄されましたが、今だに一般的な方法なのでここで説明することにします。mod_pythonはApacheが起動するとPythonのインタプリタのインスタンスを開始し、Pythonを毎回再起動せずに自身のスレッドでそれぞれのHTTPリクエストを処理します。mod_pythonはwebサーバーとwebアプリケーション間の通信に、独自のインターフェイスを使うので最適ではないですが、CGIよりは優れた解決策です。mod_pythonではホストされている全てのアプリケーションが、同じuser_id/group_idで実行されるので、セキュリィティ上の問題があります。

web2pyはmod_pythonへのインターフェースに、modpythonhandler.py ファイルを提供しています。

近年Pythonコミュニティは、webサーバーとwebアプリケーションを通信する、Pythonで書かれた新しい標準インターフェイスを開発する方向に進みました。それは Web Server Gateway Interface (WSGI) [wsgi-w] [wsgi-o] と呼ばれています。web2pyはWSGI上で構築されており、WSGIが使用できない時には、別のインターフェイスを使用するためのハンドラを提供しています。

ApacheはGraham Dumpletonが開発した、mod_wsgi[modwsgi] モジュール経由でWSGIをサポートします。

web2pyはWSGIへのインターフェースに、wsgihandler.py ファイルを提供しています。

一部のwebホスティングサービスは、mod_wsgiをサポートしていません。このケースではApaacheをproxyとして使用し、入ってくる全てのリクエストをweb2py組み込みのwebサーバー(例えばlocalhost:8000などで動作)に転送する必要があります。

mod_wsgiとmod_proxyどちらの場合でも、Apacheは静的なファイルとSSL暗号化を直接処理するように設定でき、web2pyの負荷を軽減します。

NginxはWSGIの代わりにuWSGIを使用します。独自のpythonアダプタが必要で、似ていますが異なるプロトコルです。

Lighttpd webサーバーはWSGIインターフェースをサポートしませんが、CGIを改良したFastCGI [fastcgi] インターフェイスをサポートします。FastCGIの主な目的は、webサーバーとCGIプログラム間のインターフェイスに関係するオーバーヘッドを削減することで、サーバーが一度により多くのHTTPリクエストを処理できるようになることです。

Lighttpd webサイトによると、"LighttpdはYouTubeやWikipediaといった、有名なWeb2.0サイトで使用されています。その高速なIOインフラストラクチャによって、同じハードウェアーを使った他のwebサーバーと比べても、数倍高いパフォーマンスを実現しています"。FastCGIを利用したLighttpdは実際、mod_wsgiを利用したApacheよりも高速です。

web2pyはFastCGIへのインターフェースに、fcgihandler.py ファイルを提供しています。

web2pyにはGoogle App Engine (GAE)へのインターフェースである、gaehandler.py もあります。GAEでは、webアプリケーションは "クラウド" で動作します。これはフレームワークが、ハードウェアの詳細から、完全に抽象化されていることを意味します。全てのリクエストを処理するのに必要な分だけ、webアプリケーションは自動で複製されます。ここで言う複製とは、単一のサーバー上で複数のスレッドというだけではなく、複数サーバー間でのマルチプロセスという意味です。GAEはファイルシステムへの書き込みを禁止し、全ての永続的なデータは Google BigTable か memcache に保存することで、このスケーラビリティのレベルを実現しています。

GAE以外のプラットフォームでは拡張性は懸念事項であり、web2pyアプリケーションでの調整が必要になる場合があります。拡張性を実現する最も一般的な方法は、ロードバランサ(簡単なラウンドロビン方式やそれぞれのサーバーからハートビートをフィードバックとして受け取るような高度な方式)の後方で、複数のwebサーバーを動作させることです。

複数のwebサーバーがあったとしても、データベースサーバは常に一つだけです。デフォルトのweb2pyは、セッション、エラーチケット、アップロードファイル、キャッシュをファイルシステムに保存します。このためデフォルトの構成では、それらのフォルダは共有フォルダである必要があります。

image

この章の残りの部分で、この標準のアプローチを改善する幾つかのレシピを考えます。次のようなことが含まれます:

  • セッションをデータベースやキャッシュに保存します。もしくは全く保存しません。
  • チケットをローカルのファイルシステムに保存した後に、バッチでデータベースに移動します。
  • cache.ramとcache.diskの代わりに、memcachedを利用します。
  • アップロードしたファイルは、共有フォルダの代わりにデータベースに保存します。

最初の三つのレシピには従うことを推奨しますが、一方で四つ目は、サイズの小さなファイルではメリットがありますが、大きなファイルで逆効果になる可能性があります。

anyserver.py

anyserver
bjoern
cgi
cherrypy
diesel
eventlet
fapws
flup
gevent
gunicorn
mongrel2
paste
tornado
twisted
wsgiref

web2pyには、次のポピュラーなサーバーへのWSGIインターフェイスを実装した、anyserver.py ファイルがあります: bjoern, cgi, cherrypy, diesel, eventlet, fapws, flup, gevent, gunicorn, mongrel2, paste, rocket, tornado, twisted, wsgiref

これらのサーバーのいずれかを使えます。例えばTornadoの場合、次のようになります:

python anyserver.py -s tornado -i 127.0.0.1 -p 8000 -l -P

ここで -l はロギング用、-P はプロファイラ用です。 全てのコマンドラインオプションの情報には、"-h" を使用してください:

1
python anyserver.py -h

Linux と Unix

本番デプロイへの第一歩

ここでは apache+python+mod_wsgi+web2py+postgresql を、ゼロからインストールする手順を説明します。

Ubuntuでは:

wget http://web2py.googlecode.com/hg/scripts/setup-web2py-ubuntu.sh
chmod +x setup-web2py-ubuntu.sh
sudo ./setup-web2py-ubuntu.sh

Fedoraでは:

wget http://web2py.googlecode.com/hg/scripts/setup-web2py-fedora.sh
chmod +x setup-web2py-fedora.sh
sudo ./setup-web2py-fedora.sh

どちらのスクリプトも標準設定で動作しますが、どのLinuxインストールも若干仕様が異なるので、実行する前にこれらのスクリプトのコードを確認しておいてください。Ubuntuについては、ほとんどの設定を以下で説明しています。後述のスケーラビリティの最適化については実施していません。

Apacheセットアップ

このセクションでは、Ubuntu 8.04 Server Editionをプラットフォームとして使用します。設定コマンドは他のDebianベースのLinuxディストリ ビューションによく似ていますが、Fedoraベースのシステム(apt-get の代わりに yum を使う)とは異なります。

初めに次のシェルコマンドを実行し、必要な全てのPythonとApacheのパッケージをインストールします:

1
2
3
4
5
6
7
8
sudo apt-get update
sudo apt-get -y upgrade
sudo apt-get -y install openssh-server
sudo apt-get -y install python
sudo apt-get -y install python-dev
sudo apt-get -y install apache2
sudo apt-get -y install libapache2-mod-wsgi
sudo apt-get -y install libapache2-mod-proxy-html

そして、ApacheのSSLモジュール、proxyモジュール、WSGIモジュールを有効にします:

1
2
3
4
5
sudo ln -s /etc/apache2/mods-available/proxy_http.load            /etc/apache2/mods-enabled/proxy_http.load
sudo a2enmod ssl
sudo a2enmod proxy
sudo a2enmod proxy_http
sudo a2enmod wsgi

SSLフォルダを作成し、SSL証明書をその中に配置します:

1
sudo mkdir /etc/apache2/ssl

SSL証明書はverisign.comのような認証局から取得する必要がありますが、テスト目的では、[openssl] での手順に従うことで自己署名証明書の生成できます。

そしてwebサーバーを再起動します:

1
sudo /etc/init.d/apache2 restart

Apache設定ファイル次にあります:

1
/etc/apache2/sites-available/default

Apacheログは次の所にあります:

1
/var/log/apache2/

mod_wsgi

上記のwebサーバーをインストールしたマシンに、web2pyソースをダウンロードして解凍します。

例えば、web2pyを /home/www-data/ 配下にインストールし、www-dataユーザとwww-dataグループに権限を与えます。この手順は次のシェルコマンドで実施できます:

1
2
3
4
cd /home/www-data/
sudo wget http://web2py.com/examples/static/web2py_src.zip
sudo unzip web2py_src.zip
sudo chown -R www-data:www-data /home/www-data/web2py

web2pyをmod_wsgiでセットアップするには、新しいApache設定ファイルを作成します:

1
/etc/apache2/sites-available/web2py

そして、次のコードを追加します:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<VirtualHost *:80>
  ServerName web2py.example.com
  WSGIDaemonProcess web2py user=www-data group=www-data display-name=%{GROUP}
  WSGIProcessGroup web2py
  WSGIScriptAlias / /home/www-data/web2py/wsgihandler.py

  <Directory /home/www-data/web2py>
    AllowOverride None
    Order Allow,Deny
    Deny from all
    <Files wsgihandler.py>
      Allow from all
    </Files>
  </Directory>

  AliasMatch ^/([^/]+)/static/(.*)            /users/www-data/web2py/applications/$1/static/$2
  <Directory /users/www-data/web2py/applications/*/static/>
    Order Allow,Deny
    Allow from all
  </Directory>

  <Location /admin>
  Deny from all
  </Location>

  <LocationMatch ^/([^/]+)/appadmin>
  Deny from all
  </LocationMatch>

  CustomLog /private/var/log/apache2/access.log common
  ErrorLog /private/var/log/apache2/error.log
</VirtualHost>

Apacheを再起動すると、全てのリクエストはRocket wsgiserverを経由しないで、web2pyに渡されます。

ここで、幾つかの説明しますと:

1
WSGIDaemonProcess web2py user=www-data group=www-data display-name=%{GROUP}

上のコードは、"web2py.example.com" に関連するデーモンプロセスグループを定義しています。 バーチャルホスト内にこれを定義することで、バーチャルホストはWSGIProcessGroupを使用してアクセスできます。これは同じサーバー名のポートが違うバーチャルホストも含みます。 "user" と "group" オプションには、web2pyをセットアップしたディレクトリへの書き込み権限があるユーザをセットするべきです。 Apacheを実行するデフォルトユーザに、web2pyインストレーション・ディレクトリへの書き込み権限を設定している場合、"user" と "group" を設定する必要はありません。 "display-name" オプションは、PSコマンドによって表示する実行可能なApache webサーバーのプロセス名の代わりに、"(wsgi-web2py)" のように出力する設定をします。 "processes" や "threads" オプションを指定しないことで、デーモンプロセスグループはプロセス内で15個のスレッドを実行する単一のプロセスを持ちます。 これは通常のほとんどのサイトで十分過ぎる設定なので、そのまま使用するべきです。 設定を上書きする場合、"wsgi.multiprocess" フラグをチェックする全てのブラウザ内WSGIデバッグツールが無効になるため、"processes=1" は使用しないでください。 これはどの "processes" オプションの使用でも、例え単一プロセスでさえも、フラグをtrueにセットしてしまいます。それらのツールではフラグがfalseにセットされていることが前提になります。 注意:もしアプリケーションコードやサードパーティ性の拡張モジュールがスレッドセーフでない場合は、"processes=5 threads-1" オプションを使用してください。 これは個々のプロセスがシングルスレッドであるデーモンプロセスグループに、五つのプロセスを作成します。 ガベージコレクトを適切に実施できずに、アプリケーションがPythonオブジェクトをリークする場合は、"maximum-requests=1000" を使うことも検討してください。

1
WSGIProcessGroup web2py

全てのWSGIアプリケーションの実行を、WSGIDaemonProcessディレクティブで設定されたデーモンプロセスグループに委譲します。

1
WSGIScriptAlias / /users/www-data/web2py/wsgihandler.py

web2pyアプリケーションをマウントします。この場合はwebサイトのrootにマウントされます。

1
2
3
<Directory /users/www-data/web2py>
  ...
</Directory>

ApacheにWSGIスクリプトファイルにアクセスする権限を与えます。

1
2
3
4
<Directory /users/www-data/web2py/applications/*/static/>
  Order Allow,Deny
  Allow from all
</Directory>

静的ファイルを検索する際に、web2pyをバイパスするようにApacheを設定します。

1
2
3
<Location /admin>
  Deny from all
</Location>

そして、

1
2
3
<LocationMatch ^/([^/]+)/appadmin>
  Deny from all
</LocationMatch>

adminappadmin へのパブリックアクセスをブロックします。

通常はWSGIスクリプトがあるディレクトリ全体にアクセスを許可するだけで良いですが、web2pyは管理者パスワードを含む他のソースコードが入っているディレクトリに、WSGIスクリプトを配置します。 技術的にはApacheは、マッピングされたURL経由してディレクトリを通過する全ユーザに対して、全てのファイルを提供する権限を与えます。このため、ディレクトリ全体を公開することは、セキュリティ上の問題を引き起こします。 セキュリティ問題を回避するため、WSGIスクリプトファイルを除くディレクトリのファイルへのアクセスを明示的に拒否し、より安全にするために、ユーザーによる.htaccessファイルの上書きを禁止します。

以上をまとめた、コメントの入ったApache wsgi設定ファイルは以下にあります:

1
scripts/web2py-wsgi.conf

このセクションは、mod_wsgi開発者のGraham Dumpletonの協力を得て作成されました。

パスワード設定

開発で、プログラムで管理者パスワードをセットする必要があるかもしれません。 これは、Bashシェルから行うことができます。

1
sudo -u www-data python -c "from gluon.main import save_password; save_password(raw_input('admin password: '),443)"

mod_wsgiとSSL

mod_wsgi and SSL

アプリケーション(例えば adminappadmin)で強制的にHTTPSを利用させるには、SSL証明書と秘密鍵を以下に保存します:

1
2
/etc/apache2/ssl/server.crt
/etc/apache2/ssl/server.key

そして、Apacheの設定ファイルweb2py.confを編集し、次のコードを追加します:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<VirtualHost *:443>
  ServerName web2py.example.com
  SSLEngine on
  SSLCertificateFile /etc/apache2/ssl/server.crt
  SSLCertificateKeyFile /etc/apache2/ssl/server.key

  WSGIProcessGroup web2py

  WSGIScriptAlias / /users/www-data/web2py/wsgihandler.py

  <Directory /users/www-data/web2py>
    AllowOverride None
    Order Allow,Deny
    Deny from all
    <Files wsgihandler.py>
      Allow from all
    </Files>
  </Directory>

  AliasMatch ^/([^/]+)/static/(.*)         /users/www-data/web2py/applications/$1/static/$2

  <Directory /users/www-data/web2py/applications/*/static/>
    Order Allow,Deny
    Allow from all
  </Directory>

  CustomLog /private/var/log/apache2/access.log common
  ErrorLog /private/var/log/apache2/error.log

</VirtualHost>

Apacheを再起動すると、次にアクセスできます:

1
2
3
https://www.example.com/admin
https://www.example.com/examples/appadmin
http://www.example.com/examples

しかし、次のものにはアクセスできません:

1
2
http://www.example.com/admin
http://www.example.com/examples/appadmin

mod_proxy

幾つかのUnix/LinuxディストリビューションはApacheを実行できますが、mod_wsgiをサポートしてないものがあります。この場合の一番簡単な解決策は、Apacheをプロキシとして実行し、静的ファイルのみをApacheに処理させます。

以下は最低限のApacheの設定です:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
NameVirtualHost *:80
#### deal with requests on port 80
<VirtualHost *:80>
   Alias / /users/www-data/web2py/applications
   ### serve static files directly
   <LocationMatch "^/welcome/static/.*">
    Order Allow, Deny
    Allow from all
   </LocationMatch>
   ### proxy all the other requests
   <Location "/welcome">
     Order deny,allow
     Allow from all
     ProxyRequests off
     ProxyPass http://localhost:8000/welcome
     ProxyPassReverse http://localhost:8000/
     ProxyHTMLURLMap http://127.0.0.1:8000/welcome/ /welcome
   </Location>
   LogFormat "%h %l %u %t "%r" %>s %b" common
   CustomLog /var/log/apache2/access.log common
</VirtualHost>

上記のスクリプトは、"welcome" アプリケーションだけを公開します。他のアプリケーションを公開したい場合は、対応する<Location>...</Location>に "welcome" アプリケーションと同様の構文を追加する必要があります。

スクリプトはweb2pyサーバーが、ポート8000を使用することを前提にしています。Apacheを再起動する前に、この点を再確認してください:

1
nohup python web2py.py -a '<recycle>' -i 127.0.0.1 -p 8000 &

-a オプションでパスワードを指定するか、パスワードの代わりに "<recycle>" パラメータを指定することができます。後者の場合は、前回保存されたパスワードが再利用され、シェル履歴にパスワードが保存されることはありません。

"<ask>" パラメータを使って、パスワード入力の要求を行うことも可能です。

nohup コマンドは、シェルを閉じた時にサーバーが落ちないようにします。nohupnohup.out に全てのログを出力します。

adminとappadminにHTTPSを強制的に利用させるには、代わりに次のApacheの設定ファイルを使用します:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
NameVirtualHost *:80
NameVirtualHost *:443
#### deal with requests on port 80
<VirtualHost *:80>
   Alias / /users/www-data/web2py/applications
   ### admin requires SSL
   <LocationMatch "^/admin">
     SSLRequireSSL
   </LocationMatch>
   ### appadmin requires SSL
   <LocationMatch "^/welcome/appadmin/.*">
     SSLRequireSSL
   </LocationMatch>
   ### serve static files directly
   <LocationMatch "^/welcome/static/.*">
     Order Allow,Deny
     Allow from all
   </LocationMatch>
   ### proxy all the other requests
   <Location "/welcome">
     Order deny,allow
     Allow from all
     ProxyPass http://localhost:8000/welcome
     ProxyPassReverse http://localhost:8000/
   </Location>
   LogFormat "%h %l %u %t "%r" %>s %b" common
   CustomLog /var/log/apache2/access.log common
</VirtualHost>
<VirtualHost *:443>
   SSLEngine On
   SSLCertificateFile /etc/apache2/ssl/server.crt
   SSLCertificateKeyFile /etc/apache2/ssl/server.key
   <Location "/">
     Order deny,allow
     Allow from all
     ProxyPass http://localhost:8000/
     ProxyPassReverse http://localhost:8000/
   </Location>
   LogFormat "%h %l %u %t "%r" %>s %b" common
   CustomLog /var/log/apache2/access.log common
</VirtualHost>
web2pyを共有ホスト上でmod_proxyを使用して動かす場合、管理画面は無効にしておく必要があります。そうしないと他のユーザに公開されてしまいます。 The administrative interface must be disabled when web2py runs on a shared host with mod_proxy, or it will be exposed to other users.

Linuxデーモンとして起動

mod_wsgiを使用する場合を除き、他のLinuxデーモンとして起動/停止/再起動できるようにweb2pyサーバーを設定することで、コンピュータのブート時に自動で起動することができます。

これを設定する方法は、個々のLinux/Unixディストリビューションで固有です。

web2pyフォルダには、この設定のために二つのスクリプトが用意されています:

1
2
scripts/web2py.ubuntu.sh
scripts/web2py.fedora.sh

Ubuntuや他のDebianベースのLinuxディストリビューションでは、"web2py.ubunu.sh" を編集し "/usr/lib/web2py" パスをweb2pyインストールパスに置き換え、次のシェルコマンドを実行することでファイルを適切なフォルダへ移動し、スタートアップサービスに登録し起動します:

1
2
3
sudo cp scripts/web2py.ubuntu.sh /etc/init.d/web2py
sudo update-rc.d web2py defaults
sudo /etc/init.d/web2py start

Fedoraや他のFedoraベースのディストリビューションでは、"web2py.fedora.sh" を編集し "/usr/lib/web2py" パスをweb2pyインストールパスに置き換え、次のシェルコマンドを実行することでファルを適切なフォルダに移動し、スタートアップサービスに登録し起動します:

1
2
3
sudo cp scripts/web2py.fedora.sh /etc/rc.d/init.d/web2pyd
sudo chkconfig --add web2pyd
sudo service web2py start

Nginx

Nginx は、その驚くべきパフォーマンスのために人気を集めている、フリーでオープンソースのwebサーバです。

従来のサーバとは異なり、Nginxはスレッドを使用しません。その代わりに並列性をハンドルするために、非同期/イベンドドリブン型アーキテクチャを使用しています。このアーキテクチャの結果、重い負荷の下でも、小さくそして予測可能なメモリを使用します。

Nginxは、HTTPサーバとリバースプロキシ以上です。これはまた、IMAP/POP3プロキシサーバでもあります。

Nginxの設定は容易です。そして設定ファイルはシンプルで、Apacheと較べてもコンパクトです。

NginxはWSGIをサポートしませんが、uWSGI [uwsgi] プロトコルのネイティブサポートを提供します。

uwsgi

Ubuntuでは、次のようにNginxをインストールできます:

1
apt-get -y install nginx-full

その後、次のように設定ファイルを作成する必要があります:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# file /etc/nginx/sites-available/web2py
server {
        listen          80;
        server_name     $hostname;
        #to enable correct use of response.static_version
        #location ~* /(\w+)/static(?:/_[\d]+.[\d]+.[\d]+)?/(.*)$ {
        #    alias /home/www-data/web2py/applications/$1/static/$2;
        #    expires max;
        #}
        location ~* /(\w+)/static/ {
            root /home/www-data/web2py/applications/;
            #remove next comment on production
            #expires max;
        }
        location / {
            #uwsgi_pass      127.0.0.1:9001;
            uwsgi_pass      unix:///tmp/web2py.socket;
            include         uwsgi_params;
            uwsgi_param     UWSGI_SCHEME $scheme;
            uwsgi_param     SERVER_SOFTWARE    nginx/$nginx_version;
        }
}
server {
        listen 443 default_server ssl;
        server_name     $hostname;
        ssl_certificate         /etc/nginx/ssl/web2py.crt;
        ssl_certificate_key     /etc/nginx/ssl/web2py.key;
        ssl_prefer_server_ciphers on;
        ssl_session_cache shared:SSL:10m;
        ssl_session_timeout 10m;
        ssl_ciphers ECDHE-RSA-AES256-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA;
        ssl_protocols SSLv3 TLSv1;
        keepalive_timeout    70;
        location / {
            #uwsgi_pass      127.0.0.1:9001;
            uwsgi_pass      unix:///tmp/web2py.socket;
            include         uwsgi_params;
            uwsgi_param     UWSGI_SCHEME $scheme;
            uwsgi_param     SERVER_SOFTWARE    nginx/$nginx_version;
        }
 
}

ファイルのシンボリックリンクとデフォルトの削除が必要です。

1
2
ln -s /etc/nginx/sites-available/web2py /etc/nginx/sites-enabled/web2py
rm /etc/nginx/sites-enabled/default

また、証明書のSSLフォルダを作成し、証明書を配置する必要があるかもしれません:

1
2
3
mkdir /etc/nginx/ssl
cp web2py.key /etc/nginx/ssl
cp web2py.crt /etc/nginx/ssl

その後、uWSGIをインストールしセットアップを行う必要があります。

1
2
sudo mkdir /etc/uwsgi
sudo mkdir /var/log/uwsgi

さらに、"/etc/uwsgi/web2py.xml" 設定ファイルを作成します:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<uwsgi>
    <socket>/tmp/web2py.socket</socket>
    <pythonpath>/home/www-data/web2py/</pythonpath>
    <mount>/=wsgihandler:application</mount>
    <master/>
    <processes>4</processes>
    <harakiri>60</harakiri>
    <reload-mercy>8</reload-mercy>
    <cpu-affinity>1</cpu-affinity>
    <stats>/tmp/stats.socket</stats>
    <max-requests>2000</max-requests>
    <limit-as>512</limit-as>
    <reload-on-as>256</reload-on-as>
    <reload-on-rss>192</reload-on-rss>
    <uid>www-data</uid>
    <gid>www-data</gid>
    <no-orphans/>
</uwsgi>

このファイルはApacheのケースと同様に、"/home/www-data/web2py" にweb2pyがインストールされていることを想定しています。

また二番目の設定ファイル "/etc/init/uwsgi-emperor.conf" の編集も必要です:

1
2
3
4
5
6
# Emperor uWSGI script 
description "uWSGI Emperor"
start on runlevel [2345]
stop on runlevel [06]
respawn
exec uwsgi --master --die-on-term --emperor /etc/uwsgi --logto /var/log/uwsgi/uwsgi.log

最後に全てを再起動します:

1
2
start uwsgi-emperor
/etc/init.d/nginx restart 

次のコマンドで、uwsgiをリロードできます。

1
restart uwsgi-emperor

次のコマンドで、ストップできます。

1
stop uwsgi-emperor

次のコマンドで、web2pyのみ(uwsgiのリスタートなしで)リロードできます。

1
touch /etc/uwsgi/web2py.xml

これらの全ての手順は、次に提供されているスクリプトによって、自動的に実行されます:

1
2
scripts/setup-web2py-nginx-uwsgi-on-centos.sh
scripts/setup-web2py-nginx-uwsgi-ubuntu.sh

Lighttpd

Lighttpd
FastCGI
fcgihandler

次のシェルコマンドで、Ubuntuや他のDebianベースのLinuxディストリビューションに、Lighttpdをインストールできます:

1
apt-get -y install lighttpd

インストールされたら、/etc/rc.local を編集し、fcgi web2pyバックグランドプロセスを作成します。

1
cd /var/www/web2py && sudo -u www-data nohup python fcgihandler.py &

そして、Lighttpd設定ファイルを編集する必要があります。

1
/etc/lighttpd/lighttpd.conf

上記のプロセスで作成されたソケットを見つけることができます。設定ファイルに以下のように記述します:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
server.modules              = (
        "mod_access",
        "mod_alias",
        "mod_compress",
        "mod_rewrite",
        "mod_fastcgi",
        "mod_redirect",
        "mod_accesslog",
        "mod_status",
)

server.port = 80
server.bind = "0.0.0.0"
server.event-handler = "freebsd-kqueue"
server.error-handler-404 = "/test.fcgi"
server.document-root = "/users/www-data/web2py/"
server.errorlog      = "/tmp/error.log"

fastcgi.server = (
  "/handler_web2py.fcgi" => (
      "handler_web2py" => ( #name for logs
         "check-local" => "disable",
         "socket" => "/tmp/fcgi.sock"
      )
   ),
)

$HTTP["host"] = "(^|.)example.com$" {
 server.document-root="/var/www/web2py"
    url.rewrite-once = (
      "^(/.+?/static/.+)$" => "/applications$1",
      "(^|/.*)$" => "/handler_web2py.fcgi$1",
    )
}

次に構文エラーをチェックします:

1
lighttpd -t -f /etc/lighttpd/lighttpd.conf

そして次のように、webサーバーを(再)起動します:

1
/etc/init.d/lighttpd restart

FastCGIは、web2pyをIPソケットで無く、Unixソケットにバインドする点に注意してください:

1
/tmp/fcgi.sock

これはLighttpdが、HTTP送受信を転送する部分です。UnixソケットはIPソケットより軽量で、それがLighttpd+FastCGI+web2pyが高速に動作する一つの理由です。 Apacheの場合は、静的ファイルディレクトリをLighttpdに直接処理させ、アプリケーションを強制的にHTTPS経由にする設定も可能です。詳細はLighttpdのドキュメントを参照してください。

このセクションの例は、web2pyslicesに投稿されたJohn Heenanの記事から引用しました。

web2pyをFastCGIを使った共有ホストで動かす場合、管理画面は無効にしておく必要があります。そうしないと、他のユーザに公開されてしまいます。

mod_pythonを使った共有ホスティング

しばしば、特に共有ホスト環境で、Apche設定ファイルを直接編集する権限がない場合があります。この本を書いている現在、mod_wsgiの登場によってメンテナンスがされていませんが、ほとんどのホストで未だmod_pythonを動かしています。

このような環境でもweb2pyを動かすことができます。ここでは、設定方法の例を示します。

web2pyの中身を "htdocs" フォルダに入れます。

web2pyフォルダに、次の内容の "web2py_modpython.py" を作成します:

1
2
3
4
5
6
from mod_python import apache
import modpythonhandler

def handler(req):
    req.subprocess_env['PATH_INFO'] = req.subprocess_env['SCRIPT_URL']
    return modpythonhandler.handler(req)

次の内容の ".htaccess" ファイルを作成/更新します:

1
2
3
SetHandler python-program
PythonHandler web2py_modpython
#PythonDebug On

この例は、Niktarによって提供されました。

FastCGIを使ったCherokee

Cherokee
FastCGI
Cherokeeは高速なwebサーバーで、web2pyのように設定用にAJAXが有効なwebベースの管理画面を提供します。管理画面はPythonで書かれており、ほとんどの変更に対してサーバーの再起動を必要としません。

以下、web2pyをCherokeeでセットアップするのに必要な手順です:

Cherokee[cherokee] をダウンロードします。

tarの展開、ビルド、そしてインストールします:

1
2
3
4
tar -xzf cherokee-0.9.4.tar.gz
cd cherokee-0.9.4
./configure --enable-fcgi && make
make install

"applications" フォルダの作成を確認するために、少なくとも一度はweb2pyを正常に起動します。

次のコードで、"startweb2py.sh" という名前のシェルスクリプトを作成します:

1
2
3
#!/bin/bash
cd /var/web2py
python /var/web2py/fcgihandler.py &

そして、スクリプトに実行権限を与えて実行してください。これはFastCGIハンドラで、web2pyが起動します。

Cherokeeとchroke-adminを起動します:

1
2
sudo nohup cherokee &
sudo nohup cherokee-admin &

デフォルトではchrokee-adminは、ローカルのポート9090だけを使用します。マシンへ完全な物理的アクセス権があれば問題ではありません。もうしそうでない場合は、次のオプションを利用し、強制的にIPアドレスとポートをバインドできます:

1
2
-b,  --bind[=IP]
-p,  --port=NUM

もしくは、SSHポートフォワード(より安全で、推奨される)を使用します:

1
ssh -L 9090:localhost:9090 remotehost

ブラウザで "http://localhost:9090" を開きます。もし全ての設定がOKであれば、cherokee-adminが表示されます。

cherokee-admin webインターフェイスで、"info sources" をクリックします。"Local Interpreter" を選びます。次のコードを記述して "Add New" をクリックします。

1
2
3
Nick: web2py
Connection: /tmp/fcgi.sock
Interpreter: /var/web2py/startweb2py.sh

最後は次のように、残りのステップを実行します:

  • "Virtual Servers" をクリックし、更に "Default" をクリックします。
  • "Behavior" をクリックし、更にその下の、"default" をクリックします。
  • リストボックスで、"List and Send" の代わりに、"FastCGI" を選択します。
  • 下部で、"web2py" を "Application Server" として選択します。
  • 全てのチェックボックス(Allow-x-sendfileは外すことも可能)をチェックします。もし警告表示がでたら、どれか一つのチェックボックスを無効にしてから有効にします(そうすることで、アプリケーションサーバーのパラメータを自動で再送信します。バグで上手く行かない時もあります)。
  • ブラウザで "http://あなたのサイト" を開くと、"Welcom to web2py" が表示されます。

Postgresql

PostgreSQLはフリーでオープンソースのデータベースで、実稼働を要求される環境で使用されています。例えば、.orgドメイン名を保存するデータベースに使用されて、データが何百テラバイトに拡張できることを証明されています。非常に高速で安定したトランザクションサポートを持ち、多くのデータベース保守タスクから管理者を解放するauto-vacuumという機能があります。

Ubuntuや他のDebianベースLinuxディストリビューションでは、PostgreSQLとそのPython APIを間単にインストールできます:

1
2
sudo apt-get -y install postgresql
sudo apt-get -y install python-psycopg2

webサーバーとデータベースは異なるマシンで運用したほうが賢明です。この場合、webサーバーを動かしているマシンは安全な内部(物理)ネットワーク、またはSSLトンネルでデータベースサーバーと接続されるべきです。

PostgreSQLの設定ファイルを編集します。

1
sudo nano /etc/postgresql/9.1/main/postgresql.conf

そして、次の二行を記述します。

1
2
3
4
5
6
7
...
listen_addresses = 'localhost' 
...
track_counts = on
...
autovacuum = on   # Enable autovacuum subprocess?  'on'
...

PostgreSQLのクライアント認証ファイルを編集します。

1
sudo nano /etc/postgresql/9.1/main/pg_hba.conf

そして、これらのメソッドの行を、trust に変更します。

1
2
3
4
5
6
7
8
...
# "local" is for Unix domain socket connections only
local   all             all                                     trust
# IPv4 local connections:
host    all             all             127.0.0.1/32            trust
# IPv6 local connections:
host    all             all             ::1/128                 trust
...

データベースサーバーを起動します:

1
sudo /etc/init.d/postgresql restart

PostgreSQLサーバーの再起動時に、どのポートで実行されているか表示されます。データベースサーバが複数で構成される場合を除き、5432のはずです。

PostgreSQLのログは、次の場所にあります:

1
/var/log/postgresql/

データベースサーバが起動し始めたら、web2pyアプリケーションに必要なユーザとデータベースを作成します:

1
2
3
4
5
sudo -u postgres createuser -PE -s myuser
postgresql> createdb -O myself -E UTF8 mydb
postgresql> echo 'The following databases have been created:'
postgresql> psql -l
postgresql> psql mydb

最初のコマンドは新規作成ユーザ myuser に、スーパーユーザ・アクセス権限を与えます。パスワードを入力するようプロンプトが表示されます。

どのweb2pyアプリケーションも、次のコマンドでこのデータベースに接続できます:

1
db = DAL("postgres://myuser:mypassword@localhost:5432/mydb")

mypassword はプロンプトの時に入力したパスワードであり、5432はデータベースサーバが起動しているポートです。

通常はアプリケーション毎に一つのデータベースを作成し、同じアプリケーションの複数のインスタンスは同じデータベースに接続します。異なるアプリケーション間で、同じデータベースを共有することもできます。

データベースのバックアップについては、PostgreSQLドキュメントにある、pg_dumppg_restore コマンドの部分を読んでください。

Linuxサービスとしてのスケジューラ開始 (upstart)

Linux (Upstartを使用した)上で、恒久的なデーモンとしてスケジューラをインストールするには、下の記述を /etc/init/web2py-scheduler.conf に入れます。web2pyインスタンスは<user>のホームディレクトリにインストールされており、ネットワークインターフェース eth0 上で、<user>としてアプリ<myapp>で実行されていると、仮定しています。

1
2
3
4
5
6
description "web2py task scheduler"
start on (local-filesystems and net-device-up IFACE=eth0)
stop on shutdown
respawn limit 8 60 # Give up if restart occurs 8 times in 60 seconds.
exec sudo -u <user> python /home/<user>/web2py/web2py.py -K <myapp>
respawn

その後に次のコマンドで、デーモンの起動/終了/再起動/状態チェック を行うことができます:

1
2
3
4
sudo start web2py-scheduler
sudo stop web2py-scheduler
sudo restart web2py-scheduler
sudo status web2py-scheduler

Windows

Apacheとmod_wsgi

Apache and mod_wsgi

WindowsでApacheとmod_wsgiをインストールするには、異なる手順が必要になります。 Python 2.5がインストールされ、web2pyがソースから起動されており、さらに c:/web2py にあることを前提に説明します。

最初に、必要なパッケージをダウンロードします:

  • [apache1] から Apache apache_2.2.11-win32-x86-openssl-0.9.8i.msi
  • [modwsgi1] から mod_wsgi

二つ目に、apache...msi を実行し、ウィザード画面に従います。サーバー・インフォメーション画面において、

image

全ての要求項目を入力します:

  • Network Domain: サーバーの現在のまたは登録予定のDNSドメインを入力します。もしサーバーの正式なDNS名がserver.mydomain.netの場合は、mydomain.netと入力します。
  • ServerName: サーバーの完全なDNS名です。上記の例で言うと、server.mydomain.netと入力します。完全修飾ドメイン名、もしくはショートカットではないweb2pyインストールのIPアドレスを入力します。詳細は、[apache2] を参照してください。
  • Administrator's Email Address: サーバー管理者またはwebマスターのメールアドレスを入力します。このアドレスはデフォルトで、クライアントへのエラーメッセージと共に表示されます。

特に必要がなければ、標準インストールで最後まで続行します。

ウィザードはデフォルトで、以下のフォルダにApacheをインストールします:

1
C:/Program Files/Apache Software Foundation/Apache2.2/

ここからは簡単にするためフォルダを、Apache2.2 と呼びます。

三つ目に、ダウンロードしたmod_wsgi.soを Apache2.2/modules にコピーします。

Apache2.2/modules

Chris Traversによって書かれ、2007年12月にMicrosoftのOpen Source Software Labで公開されました。

四つ目に、server.crtserver.key 証明書(前のセクションで説明した)を作成し、Apache2.2/conf フォルダに設置します。cnfファイルは、Apache2.2/conf/openssl.cnf にあることに注意してください。

五つ目に、Apache2.2/conf/httpd.conf を編集し、次の行のコメント(#文字)を外します。

1
LoadModule ssl_module modules/mod_ssl.so

他の全てのLoadModule行の後に、次のコードを追加します。

1
LoadModule wsgi_module modules/mod_wsgi.so

"Listen 80" の記述を検索し、次の行をその後に追加します。

1
Listen 443

あなたの設定値に従って、ドライブレター、ポート番号、サーバー名を変更し、一番最後に次の行を追加します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
NameVirtualHost *:443
<VirtualHost *:443>
  DocumentRoot "C:/web2py/applications"
  ServerName server1

  <Directory "C:/web2py">
    Order allow,deny
    Deny from all
  </Directory>

  <Location "/">
    Order deny,allow
    Allow from all
  </Location>

  <LocationMatch "^(/[\w_]*/static/.*)">
    Order Allow,Deny
    Allow from all
  </LocationMatch>

  WSGIScriptAlias / "C:/web2py/wsgihandler.py"

  SSLEngine On
  SSLCertificateFile conf/server.crt
  SSLCertificateKeyFile conf/server.key

  LogFormat "%h %l %u %t "%r" %>s %b" common
  CustomLog logs/access.log common
</VirtualHost>

設定を保存し、[Start > Program > Apache HTTP Server 2.2 > Configure Apache Server > Test Configuration] を使って設定を確認します。

もし問題が無ければコマンド画面が開いて閉じます。これで、次のようにApacheを起動できます:

[Start > Program > Apache HTTP Server 2.2 > Control Apache Server > Start]

もっと良いのは、タスクバーモニタを起動します。

[Start > Program > Apache HTTP Server 2.2 > Control Apache Server]

これで赤い羽根のようなタスクバーアイコン上の右クリックで、"Open Apache Monitor" を選択し、起動、停止、再起動を必要に応じて実行できます。

このセクションはJonathan Lundellによって作成されました。

Windowsサービスとして起動

Windows service

Linuxのデーモンは、Windowsではサービスと呼ばれます。 web2pyサーバーはWindowsサービスとして簡単に、インストール/起動/停止ができます。

web2pyをWindowsサービスとして使用するには、起動パラメータを使用した "options.py" を作成する必要があります:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import socket, os
ip = socket.gethostname()
port = 80
password = '<recycle>'
pid_filename = 'httpserver.pid'
log_filename = 'httpserver.log'
ssl_certificate = "
ssl_private_key = "
numthreads = 10
server_name = socket.gethostname()
request_queue_size = 5
timeout = 10
shutdown_timeout = 5
folder = os.getcwd()

既にモデルとして使用できる、"options_std.py" というファイルがweb2pyフォルダにあるため、"options.py" を一から作成する必要はありません。

"options.py" をweb2pyのインストール・フォルダに作成したら、次のコマンドでweb2pyをサービスとして追加できます:

1
python web2py.py -W install

オプションで、options.pyファイルを指定することができます:

1
python web2py.py -W install -L options.py

次のコマンドで、サービスの起動/停止を行うことができます:

1
2
python web2py.py -W start
python web2py.py -W stop

Windowsサービスとしてスケジューラの起動

Windows scheduler service

Windowsサービスとしてスケジューラを動かすと、多くの利点があります。 最も簡単な方法は、nssm(htp://www.nssm.cc より)をダウンロードすることです。nssmはオープンソースのスケジューリングヘルパーです。 これは実行可能コマンドを、ラップし変換してサービスに入れます。 スケジューラの起動コマンドは、pythonw.exe -K <appname> です。 ラップし、サービスにするために、nssmを使用しています。 実行前に、サービスの名前を選択する必要があります。 スケジューラを必要とする各アプリのために、特定のサービスを作成する強い利点があります。 従って、サービスのための命名規則は、web2py_scheduler_app1となるかもしれません。

nssm zipファイルを解凍した後に、使用しているアーキテクチャ用のバージョンを含んだフォルダでWindowsプロンプトを開き、次のように入力します。

1
nssm install web2py_scheduler_app1

これは、アプリケーションとオプションの入力を求める、ダイアログを表示します。 アプリケーションは、Pythonインストールから、pythonw.exeで実行可能です。 オプションはコマンドラインの残りの部分です。web2py.pyスクリプトへのフルパスを、指定する必要があるかもしれません。例えば、nssmダイアログのオプションフィールドは次のようになります:

1
c:\web2py\web2py.py -K app1

app1はアプリケーションの名前です。 where app1 is the name of your application.

これは複数のアプリケーションとスケジューラを起動することができます。しかしこのモードでは、web2pyは各アプリケーションのスケジューラを、サブプロセスに切り離します。 従って、もしスケジューラインスタンスのいづれかに問題が発生した場合でも、サービスによって起動したプロセスは死ぬことがなく、むしろ子プロセスが死にます。 その後の障害発生時に、自動によるサービス再起動を利用することができません。サービス毎に一つのアプリを利用すると、この弱点を回避することができます。

セッション保護と admin

security
admin

HTTPS経由で実行されている場合を除き、admin アプリケーションと appadmin コントローラを公開することは非常に危険です。そしてパスワードと証明書は、暗号化無しで通信されるべきではありません。これはweb2pyと、他のどのwebアプリケーションにも当てはまります。

アプリケーションで認証が必要な場合は、次のようにセッションクッキーを保護するべきです:

1
session.secure()

サーバー上で安全な本番環境をセットアップする簡単な方法は、まずweb2pyを停止し、web2pyのインストール・フォルダから全ての parameters_*.py ファイルを削除することです。そしてパスワード無しでweb2pyを起動します。これでadminとappadminは完全に無効になります。

1
nohup python web2py --nogui -p 8001 -i 127.0.0.1 -a '' &

次に、ローカルホストからだけアクセス可能な二つ目のweb2pyインスタンスを起動します:

1
nohup python web2py --nogui -p 8002 -i 127.0.0.1 -a '<ask>' &

そして、ローカルマシン(管理画面にアクセスしたいマシン)からサーバー(web2pyが実行されている、example.com)へ、SSHトンネルを作成します:

1
ssh -L 8002:127.0.0.1:8002 username@example.com

これでブラウザ経由の localhost:8002 で、管理画面へローカルに接続することができます。

トンネルが閉じている(ユーザがログアウト)時は、admin へ接続できないので設定は安全になります。

この方法は他のユーザが、web2pyを含むフォルダへの読み取りアクセスを持たない共有ホスト環境では安全です。そうでない時は、ユーザがサーバーから直接セッションクッキーを盗むことが可能です。

効率とスケーラビリティ

scalability

web2pyは簡単に、デプロイとセットアップができるように設計されています。これは効率やスケーラビリティに妥協しているという意味ではなく、拡張するには調整が必要な場合があるということです。

このセクションではローカルのロードバランスを提供するNATサーバーの後ろに、複数のweb2pyをインストールする場合を考えてみます。

この場合、幾つかの条件に合致するのであれば、web2pyはそのまま動作します。具体的には、それぞれのweb2pyアプリケーションの全てのインスタンスが、同一のデータベースサーバーにアクセスし、さらに同一のファイルを参照している必要があります。後者の条件は、次のフォルダを共有させることで実現が可能です。

1
2
3
4
applications/myapp/sessions
applications/myapp/errors
applications/myapp/uploads
applications/myapp/cache

共有フォルダは、ファイルロックをサポートしなければいけません。方法としては ZFS(ZFSはSun Microsystemsに開発されており、推奨する選択肢です)、NFS(ファイルロックを有効にするためにnlockmgrデーモンを実行する必要があるかもしれません)、もしくは、Samba(SMB)です。

web2pyフォルダ全体やアプリケーションフォルダ全体を共有することも可能ですが、ネットワーク帯域使用量が無駄に増加するだけなので良い方法ではありません。

共有する必要があるが、トランザクションの安全性を必要としないリソースを、共有ファイルシステムに移動します。これによってデータベースの負荷を減らすため、上記で説明した設定は、非常に拡張性が高いと考えます(一回一クライアントのみのセッションファイルのアクセス想定、常時必要なキャッシュのグローバルロック、一度のuploadsとerrorsへの書き込み/たくさんのファイルの読み取り)。

理想的には、データベースと共有ストレージは両方ともRAID構成であるべきです。データベースを共有フォルダと同じストレージに保存する間違いをしないでください、新しいボトルネックを作ってしまいます。

ケースバイケースで、追加での最適化実行が必要であり、それについては後述します。具体的には、どのように共有フォルダを一つずつ排除するか、そして代わりに関連データをデータベースに保存する方法を説明します。これは可能ですが、良い解決策とは限りません。それでも行う理由があるかもしれません。そのような理由の一つは、共有フォルダを自由にセットアップできない場合です。

効率のトリック

web2pyアプリケーションコードはリクエストの度に実行されるので、コードの量を最小限に抑えたい時があります。ここで以下の方法があります:

  • 一度だけ migrate=True を実行してから、全てのテーブルに migrate=False をセットします。
  • admin を使用し、アプリをバイトコードコンパイルします。
  • cache.ram をできる限り使用するため、有限なキーセットを使っているか確認します。あるいは、任意に拡張可能なキャッシュを使用してください。
  • モデル内のコードを最小化します: ここに関数を定義せず、それを必要とするコントローラに定義します。もっと良い方法は、モジュールに関数を定義し必要に応じてインポートして使用します。
  • 多くの関数を同じコントローラに記述するのではなく、多くのコントローラに幾つかの関数を定義します。
  • セッションを変更しない全てのコントローラや関数で、session.forget(response) を実行します。
  • web2py cronを使わず、代わりにバックグラウンドプロセスを利用するようにします。web2py cronは大量のPythonインスタンスを起動し、過剰にメモリを使用します。

データベースでのセッション

セッションフォルダの代わりに、データベースにセッションを保存するようにweb2pyに指示することが可能です。セッションの保存に同じデータベースを使用することになるとしても、それぞれ個別のアプリケーションに対して設定が必要です。

データベース接続を作成します。

1
db = DAL(...)

接続を確立する同じモデルファイル内に次のコードを追加するだけで、データベースにセッションを保存することができます:

1
session.connect(request, response, db)

もしテーブルがまだ存在しない場合、we2pyは web2py_session_アプリケーション名 という、以下のフィールドを持ったデータベースのテーブルを作成します:

1
2
3
4
5
6
Field('locked', 'boolean', default=False),
Field('client_ip'),
Field('created_datetime', 'datetime', default=request.now),
Field('modified_datetime', 'datetime'),
Field('unique_key'),
Field('session_data', 'text')

"unique_key" は、クッキー内のセッションを特定するために使用するuuidキーです。 "session_data" は、cPickledセッションデータです。

データベースアクセスを最小限にするために、必要がない場合はセッションを保存しないようにするべきです:

1
session.forget()

自動でforgetされたセッションは変更されません。

データベース上のセッションにより、"sessions" フォルダはアクセスされなくなるので、共有フォルダにする必要はなくなります。

セッションが無効の場合は、sessionform.accepts に渡してはいけません。また、session.flash やCRUDも使用できない点に、注意してください。

HAProxy 高可用性ロードバランサ

HAProxy

複数のweb2pyプロセスを複数のマシンで実行する必要がある場合は、データベースにセッションを保存したり、キャッシュする代わりに、スティッキー・セッションを利用したロードバランサを使用するオプションがあります。

Pound[pound] と HQProxy[haproxy] は、スティッキー・セッションを提供する、二つのHTTPロードバランサとリバースプロキシです。ここでは商用VPSホスティングで、より一般的な後者について説明します。

スティッキー・セッションは一度セッションクッキーが発行されたら、ロードバランサはセッションに関連付けられたクライアントからのリクエストを、常に同じサーバーにルーティングします。こうすることでファイルシステムを共有せずに、ローカルのファイルシステムにセッションを保存することができます。

HAProxyを使うためには:

初めに、Ubuntu テストマシンにインストールします:

1
sudo apt-get -y install haproxy

二つ目に、設定ファイル "/etc/haproxy.cfg" を以下のように編集します:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
## this config needs haproxy-1.1.28 or haproxy-1.2.1

global
      log 127.0.0.1   local0
      maxconn 1024
      daemon

defaults
      log     global
      mode    http
      option  httplog
      option  httpchk
      option  httpclose
      retries 3
      option redispatch
      contimeout      5000
      clitimeout      50000
      srvtimeout      50000

listen 0.0.0.0:80
      balance url_param WEB2PYSTICKY
      balance roundrobin
      server  L1_1 10.211.55.1:7003  check
      server  L1_2 10.211.55.2:7004  check
      server  L1_3 10.211.55.3:7004  check
      appsession WEB2PYSTICKY len 52 timeout 1h

listen ディレクティブは、どのポートで接続を待つかをHAProxyに指示します。 server ディレクティブは、プロキシサーバがどこにあるかを指示します。 appsession ディレクトリは、スティッキー・セッションを作成し WEB2PYSTICKY というクッキをこの目的で使用します。

三つ目に、この設定を有効にし、HAProxyを起動します:

1
/etc/init.d/haproxy restart

次のURLに、Poundのセットアップの同様の手順説明があります

1
http://web2pyslices.com/main/slices/take_slice/33

セッションのクリーンアップ

本番環境では、セッションが速く積み重なることに注意してください。web2pyは次のスクリプトを提供しています:

1
scripts/sessions2trash.py

バックグラウンドで実行され、定期的に一定期間アクセスされていない全てのセッションを削除します。web2pyは、これらのセッションをクリーンアップするスクリプトを提供します(ファイルベースのセッション及びデータベースのセッションのどちらでも有効です)。

次に典型的な使用例を挙げます:

  • 5分毎に期限切れのセッションを消去します:
1
nohup python web2py.py -S app -M -R scripts/sessions2trash.py &

もしくはWindowsでは、上記のスケジューラのセクションで説明したnssmを使用します。恐らく、web2py.pyとスクリプトフォルダの両方のフルパスが含まれることが必要で、末尾の & は必要ないです。

  • 詳細な出力と共に、有効期限に関わらず60分より古いセッションを消去し、終了します:
1
python web2py.py -S app -M -R scripts/sessions2trash.py -A -o -x 3600 -f -v
  • 有効期限に関わらず全てのセッションを消去し、終了します:
1
python web2py.py -S app -M -R scripts/sessions2trash.py -A -o -x 0

ここで、app はアプリケーション名です。

データベースでのファイルアップロード

デフォルトで、SQLFORMによって処理されたアップロードファイルは、安全に名前変更されフィルシステムの "uploads" フォルダに保存されます。フォルダの代わりにデータベースにアップロードファイルを保存させることを、web2pyに指示することも可能です。

次のテーブルを考えてみます:

1
2
3
db.define_table('dog',
    Field('name')
    Field('image', 'upload'))

dog.image はuploadタイプです。犬の名前と同じレコードにアップロード画像を保存するには、blobフィールドを追加しuploadフィールドにリンクするようにテーブル定義を修正する必要があります:

1
2
3
4
db.define_table('dog',
    Field('name')
    Field('image', 'upload', uploadfield='image_data'),
    Field('image_data', 'blob'))

ここで "image_data" は、任意につけた新しいblobフィールドの名前です。

3行目は通常通りアップロードされた画像の名前を安全に変更し、変更された新しい名前をimageフィールドに保存します。そして、ファイルシステムに保存する代わりに、"image_data" というuploadフィールドにデータを保存します。この全ての処理がSQLFORMによって自動で実行され、他のコードを変更する必要はありません。

この変更で、"uploads" フォルダは必要なくなります。

Google App Engineでは、デフォルトでuploadfieldが自動作成されるので、uploadfieldを定義しなくてもデータベースに保存されます。

チケットの収集

デフォルトでは、web2pyはチケット(エラー)をローカルのファイルシステムに保存します。一番のエラー原因は、本番環境でのデータベース障害であるため、データベースにチケットを直接保存することは意味がありません。

通常は稀なイベントのため、チケットの保存はボトルネックになりません。このため複数サーバーで構成された本番環境では、共有フォルダに保存するのも適当です。とはいえ管理者だけがチケットを取り出す必要があるので、共有されていないローカルの "エラー" フォルダにチケットを保存し、定期的に収集して削除するというのでも大丈夫です。

定期的にローカルのチケットをデータベースに移動する、という方法もあります。

このために、web2pyは次のスクリプトを提供します:

1
scripts/tickets2db.py

デフォルトでこのスクリプトは ticket_storage.txt という、プライベートフォルダに保存されたファイルからのdb uriを取得します。このファイルには次のような、DAL インスタンスへ直接渡す文字列を含める必要があります:

1
2
3
mysql://username:password@localhost/test
postgres://username:password@localhost/test
...

これは、スクリプトをそのまま残すことができます: もし複数のアプリケーションがある場合、全アプリケーションへの適切な接続を動的に選択します。もしuriをハードコーディングしたい場合は、except 行の直後に、db_stringへの2つめの参照を記述してください。 次のコマンドでスクリプトを実行できます:

1
nohup python web2py.py -S myapp -M -R scripts/tickets2db.py &

myappは対象となるアプリケーション名です。

このスクリプトはバックグラウンドで動作し、5分毎に全てのチケットをデータベースに移動して、ローカルチケットを消去します。 adminアプリの上部にある "switch to:db" ボタンをクリックすると、ファイルシステムに保存されている場合と全く同じように、エラーを表示することができます。

この変更で、エラーはデータベースに保存されるので、"errors" フォルダは共有フォルダである必要はありません。

Memcache

memcache

web2pyが提供する二つのタイプのキャッシュ: cache.ramcache.disk を説明しました。 どちらも複数のサーバーによる分散環境で動作しますが、期待通りには動作しません。具体的には cache.ram は、サーバレベルでのみキャッシュします。このため役には立ちません。cache.disk は、"cache" フォルダーがファイルロックをサポートする共有フォルダの場合を除き、同様にサーバレベルでキャッシュします。このため、スピードアップでは無く、主なボトルネックになります。

解決策としてはこれらは使わず、代わりにmemacheを使います。web2pyにはmemcache APIが付属しています。

memcacheを使うためには、例えば 0_memcache.py という新規のモデルファイルを作成し、次のコードを記述(もしくは追記)します:

1
2
3
4
from gluon.contrib.memcache import MemcacheClient
memcache_servers = ['127.0.0.1:11211']
cache.memcache = MemcacheClient(request, memcache_servers)
cache.ram = cache.disk = cache.memcache

最初の行はmemcacheをインポートします。2行目はmemcache socket(サーバー:ポート)のリストです。3行目はcache.memcacheを定義します。4行目は cache.ram

Memcacheオブジェクトを指している全く新しいキャッシュオブジェクトを定義するために、それらの一つだけを再定義するために選択することができます。

この変更で、"cache" フォルダはアクセスが無くなるので、共有フォルダである必要はありません。

このコードは、memcacheサーバーがローカルネットワークで動作していることが前提です。サーバーのセットアップ方法は、memcacheドキュメントを参照してください。

Memcacheでのセッション

セッションが必要だが、ロードバランサでスティッキ-・セッションを使用したくない場合は、memcacheにセッションを保存するオプションがあります:

1
2
from gluon.contrib.memdb import MEMDB
session.connect(request,response,db=MEMDB(cache.memcache))

Redisによるキャッシング

[redis]

Memcacheの代替としてRedisが使用できます。

Redis

Redisがインストールされており、localhostの6379ポートで実行されていることを前提にすると、次のコードで接続可能です(モデルに記述します):

from gluon.contrib.redis_cache import RedisCache
cache.redis = RedisCache('localhost:6379',db=None, debug=True)

'localhost:6379' は接続文字列です。db はDALオブジェクトではなく、Redisのデータベース名です。

cache.ramcache.disk の代わりに(もしくは一緒に)、cache.redis を使用できます。

次のコードでRedisの統計情報を取得できます:

1
cache.redis.stats()

Redisでのセッション

もしスタックとしてRedisがある場合、なぜセッションとして使用しないのでしょうか?。

from gluon.contrib.redis_session import RedisSession
sessiondb = RedisSession('localhost:6379',db=0, session_expiry=False)
session.connect(request, response, db = sessiondb)

コードは1Mセッションまでテストされています。Redisがメモリに収まることができる限り、1もしくは1Mセッションを処理するのに必要な時間は同じです。ファイルベースのセッションやDBベースのセッションは、40Kセッションまででスピードアップを感じさせない一方、その障壁の改善が顕著です。 セッション毎に1キー、プラス2キーが必要です。一つは整数値を保持(異なるセッションキーを割り当てるのに必要)し、他は生成されたセッション全てのセットを保持します(つまり1000セッションなら1002キー)。

session_expiry がセットされていない場合、セッションは通常通り処理され、 通常のセッションのクリーンアップ を一度はしばらく行う必要があります。

しかしながら、session_expiry がセットされている時は、自動的に n 秒後にセッションを削除します(例えば3600をセットすると、セッションが最後に更新されてから、正確に1時間後に期限切れになります)。 ただし時々、キーが保持している以前に発行された全てのセッションをセットを消去する、sessions2trash.py を実行する必要があります(1Mセッションを消去するのに3秒必要です)。

アプリケーションの削除

removing application

本番環境では、デフォルトアプリケーション: adminexampleswelcome をインストールしないほうが良いかもしれません。小さいですが必要がないアプリケーションだからです。

これらのアプリケーションを削除するのは簡単です、applicationsフォルダ下の対象のフォルダを削除するだけです。

レプリカデータベースの使用

高いパフォーマンスを必要とする本番環境では、たくさんのレプリカスレーブを持つマスタースレーブ・データベース構成や、恐らく一組のレプリカサーバがあるかもしれません。 DALは、このような状況を処理し、条件付きリクエストパラメータに応じて異なるサーバに接続することができます。 それを実現するAPIは、6章で説明済みです。以下はその例です:

1
2
from random import sample
db = DAL(sample(['mysql://...1','mysql://...2','mysql://...3'], 3))

この場合、異なるHTTPリクエストがランダムで異なるデータベースによって処理され、それぞれのDBが同じような頻度で使用されます。

シンプルなラウンドロビンを実装することもできます。

1
2
3
4
5
6
def fail_safe_round_robin(*uris):
     i = cache.ram('round-robin', lambda: 0, None)
     uris = uris[i:]+uris[:i] # rotate the list of uris
     cache.ram('round-robin', lambda: (i+1)%len(uris), 0)
     return uris
db = DAL(fail_safe_round_robin('mysql://...1','mysql://...2','mysql://...3'))

これは、リクエストに割り当てられたデータベースサーバーの接続に失敗した場合は、DALは順番に次のサーバーに接続を試みるという意味で、フェイルセーフです。

リクエストされたアクションやコントローラによって、異なるデータベースに接続することも可能です。マスタースレーブ・データベース構成で、あるアクションは読み取り専用で、いくらかの人物は読み取り/書き込みを両方します。前者はスレーブDBサーバーに安全に接続でき、後者はマスターに接続されるべきです。これは以下のように記述できます:

1
2
3
4
5
6
if request.function in read_only_actions:
   db = DAL(sample(['mysql://...1','mysql://...2','mysql://...3'], 3))
elif request.action in read_only_actions:
   db = DAL(shuffle(['mysql://...1','mysql://...2','mysql://...3']))
else:
   db = DAL(sample(['mysql://...3','mysql://...4','mysql://...5'], 3))

1、2、3はスレーブで、3、4、5はマスターです。

静的ファイルの圧縮

ブラウザは実行中にコンテンツの解凍ができ、これらのブラウザのための圧縮コンテンツは、帯域幅のセーブとレスポンスタイムを低減します。 今日では、ほとんどのwebサーバは実行中にコンテンツの圧縮と、要求するgzipコンテンツをブラウザに送信することができます。 しかしながら静的ファイルに対しては、何度も同じコンテンツを圧縮するため、CPUサイクルを無駄にしています。

scripts/zip_static_files.py を使えばCPUを無駄にすることなく、静的ファイルのgzipバージョンを作成できます。 cronで python web2py.py -S myapp -R scripts/zip_static_files.py のように実行します。スクリプトはgzipバージョンを作成(もしくは更新)し、ファイルと共に保存し、それらの名前に a.gz を追加する手配をします。 それらのファイルの送信を、webサーバが分かるようにする必要があるだけです。 [apache-content-negotiation] [nginx-gzipstatic]

PythonAnywhereでのデプロイ

1
PythonAnywhere
PythonAnywhere

PythonAnywhereはweb2pyアプリケーションをデプロイする、最も簡単な方法です。

PythonAnywhereはPython開発と、webブラウザでの表示とクラウドサーバ上で実行するホスティング環境です。それらは既に、Pythonを実行するために必要な全てのものがセットアップされています。我々の経験上、PythonAnywhereは使いやすく、速く、そしてパワフルです。そしてまた、MySQLデータベース、pythonシェル、Dropbox統合も提供しています。 もしフリー・ベーシックでは十分でない場合、プロフェッショナル・ホスティングが可能です。

PythonAnywhereを使用するには、アカウント作成、ログインが必要です。次に提供されたwebダッシュボードを使用し、web2pyタイプの新しいWebアプリを追加します。

image

image

インターフェースはまた、管理パスワードの入力を求めます。

image

web2pyフォルダがユーザフォルダに作成されます。

代わりに通常のようにweb2pyをインストールするのに、webベースBASHも使用可能です:

1
2
wget http://www.web2py.com/examples/static/web2py_src.zip
unzip web2py_src.zip

シェルからは常に、後で使用するために管理者パスワードを作成すべきです:

1
python -c "from gluon.main import save_password; save_password(raw_input('admin  password: '),433)"

その後、webインターフェースを使用して "Web" パネルに移動し、"/var/www/<username>_pythonanywhere_com_wsgi.py" ファイルを編集します。これはプログラム(私達のケースではweb2py)のエントリポイントで、推測できるような、WSGIプロトコルに基づいています。

"/var/www/<username>_pythonanywhere_com_wsgi.py" ファイルを編集し、次を記述します:

1
2
3
4
import sys
path = '/home/<username>/web2py'
if path not in sys.path: sys.path.append(path)
from wsgihandler import application # the web2py handler

ここで、"<username>" はPythonAnywhereのユーザ名です。

web2pyをインストールした後に、起動やwebサーバの設定が必要ないことに注意してください。PythonAnywhereはそれらを提供し、上記の設定ファイルを編集された時にリロードされます。 もしくは、ダッシュボード上の "Reload web app" ボタンを押してください。次のurlで、誰でも直ぐにアクセスできます:

1
http://yourusername.pythonanywhere.com/

そしてまた、サイトのセキュアなバージョンも提供されており、web2py管理インターフェースを使用する場合は次のように利用を強制されます:

1
https://yourusername.pythonanywhere.com/admin/default/index

PythonAnywhereチームのヘルプとサポートに感謝します。

Herokuでのデプロイ

[heroku]

Heroku

Herokuはモダンでアジャイルなマルチプラットフォーム・ソリューションです。Gitを使用して、クラウドサーバにアプリケーションをプッシュすることができます。Herokuユーザには、GitのインストールとHeroku SDKのインストールをしている必要があります。herokuのローカルで使用するSDK、プッシュするコマンド、そしてサーバ上での実行が、相互作用します。

定期的に更新されるためHeroku上で実行されるアプリケーションは、永続的なファイルシステムに依存することができません。このため、アプリケーションコードはファイルシステムに格納することができますが、全データはデータベースに格納することが必要です。HerokuはPostgreSQLに依存します。けれどもPostgreSQLはまた、Heroku SDKを使って設定され、さらにデータベースのURLは実行時に動的に割り当てられ、環境変数に格納されます。

これはweb2pyアプリケーションが、Heroku上で動作しデータベースを使用するためには、修正する必要があることを意味しています。

web2pyはこれを助けるため、"heroku.py" スクリプトを提供します。実施する必要がある全ては、次のコードの置き換えです:

1
db = DAL(...)

を次のようにします:

1
2
from gluon.contrib.heroku import get_db
db = get_db(name=None, pool_size=10)

ここで name は、Heroku PostgreSQL URIを含む環境変数です(HEROKU_POSTGRESQL_RED_URL のようなものです)。デフォルトは None で、もし HEROKU_POSTGRESQL_*_URL 環境変数だけある場合はそれを使用します。pool_size は、DALプールサイズです。

Herokuプラットフォーム上で非実行の場合は、get_db は開発データベース "sqlite://heroku.test.sqlite" を使用します。

両方のケースで、セッションはデータベースに保存されます。

web2pyは、heroku上でweb2pyインストールのデプロイのために、"scripts/setup-web2py-heroku.py" スクリプトを提供します。これは次の手順で実行します:

virtualenvとpsycopg2ドライバのインストールをします:

1
2
sudo pip install virtualenv
sudo pip install psycopg2

virtualenvの作成とアクティベートします。

1
2
virtualenv venv --distribute
source venv/bin/activate

その後、必要なファイルの作成を行います:

1
pip freeze > requirements.txt

そして、どのようにweb2pyを起動するかHerokuに指示するために、"Procfile" を作成します:

1
echo "web: python web2py.py -a 'yourpassword' -i 0.0.0.0 -p $PORT" > Procfile

別サーバを使用するために、変更が可能です。管理者パスワードを編集することが必要です。$PORT は実行時に値がセットされるため、正しくエスケープされている変数です。Python用の推奨サーバの一つのため、anyserver.py を使用したgunicornでの、web2pyの起動も検討すべきです。

最後に、次のスクリプトでGitリポジトリを作成します:

1
2
3
4
git init
git add .
git add Procfile
git commit -a -m "first commit"

Herokuに全てをプッシュし、起動します:

1
2
3
4
5
heroku create
git push heroku master
heroku addons:add heroku-postgresql:dev
heroku scale web=1
heroku open

heroku は、Heroku SDKのシェルコマンドの一部です。

このレシピを手助けしてくれた、HerokuのCraig Krestiensに感謝します。

EC2でのデプロイ

Amazon EC2

Amazon Elastic Compute Cloud (Amazon EC2) は、クラウドで変更可能なコンピューティング能力を提供するwebサービスです。これは、最大かつ、最も人気があるクラウドです。たくさんの他のクラウドプラットフォームもEC2で稼働しています。ディスクイメージを作成しデプロイすることにより、任意のアプリをEC2で動作させることができます。Amazonはまた、ファイルシステムの一部を共有しながら、画像を複製するためのAPIを提供します。

全体のプロセスの説明は、この本の範囲を超えています。しかし Amazon EC2 アカウントを持っている場合、次のTurnkey Hubを使い、準備作成されたweb2pyイメージの検索とデプロイすることが可能です:

https://hub.turnkeylinux.org/amazon/launch/web2py/

一度イメージをデプロイしたら、通常のVPSでログイン可能です。そしてAmazon EC2 webインターフェースで、管理(バックアップ/リストア/コピー)可能です。

Google App Engineでのデプロイ

Google App Engine

DALコードを含めて、Google App Engine(GAE)[gae] で、web2pyを動かすことが可能です。

GAEは2つのバージョンのPythonをサポートします:2.5と2.7です。web2pyは、デフォルトでは2.5を採用していますが両方サポートします(デフォルトは将来変更される可能であります)。"app.yaml" ファイルに、詳細な設定が書かれていますので参照ください。

GAEは、Google SQLデータベース(MySQLと互換)とGoogle NoSQL("Datastore" と呼ばれています)の両方をサポートします。

web2pyはどちらもサポートしており、実際には6章で詳しく説明した接続文字列で、同時に両方に接続することができます。

GAEプラットフォームは、通常のホスティング環境よりも幾つか良い点があります:

  • 簡単にデプロイができます。Googleは内部の構造を完全に抽象化します。
  • スケーラビリティがあります。同時アクセスリクエストの数だけ、何度でもアプリケーションを複製します。
  • SQLとNoSQLを選択できます(両方可)。

しかし、不利な点もあります:

  • ファイルシステムへの読み書きができません。
  • Googleの証明書で、appspot.comドメインを使用しないとHTTPSが利用できません。
  • 全てのPythonライブラリがサポートされているわけではありません(scipyは現時点でサポートされていない著名なライブラリです)。

Google Cloud SQL は通常のmyaslデータベースですが、Google Datastoreは幾つかの特定の不利な点があります:

  • 標準的なトランザクションがありません。クエリの強い一貫性より、結果整合性 です。
  • 複雑なDatastoreクエリがありません。具体的には JOINLIKEDATE/DATETIME 演算子がありません。
  • あるフィールドと同じフィールドを伴わない限り、複数の OR サブクエリがありません。

ここではGAEの簡単な解説とweb2py特有の問題を説明しました。詳細については公式のGAEドキュメントを参考にしてください。

注意:web2pyはバイナリ版ではなく、ソース版を実行する必要があります。

設定

注意すべき3つの設定ファイルがあります:

1
2
3
web2py/app.yaml
web2py/queue.yaml
web2py/index.yaml

開始点として app.yamlqueue.yaml は、テンプレートファイル app.example.yamlqueue.example.yaml から最も簡単に作成できます。 index.yaml はGoogleデプロイメントソフトウェアで自動で作成されたものです。

app.yaml は次の構造を持っています(...の部分は省略しています): app.yaml has the following structure (it has been shortened using ...):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
application: web2py
version: 1
api_version: 1
runtime: python
handlers:
- url: /_ah/stats.*
  ...
- url: /(?P<a>.+?)/static/(?P<b>.+)
  ...
- url: /_ah/admin/.*
  ...
- url: /_ah/queue/default
  ...
- url: .*
  ...
skip_files:
...

app.example.yaml (app.yaml にコピーする時)は、web2pyの welcome アプリケーションをデプロイするよう設定されますが、adminexample アプリケーションに対しては行いません。また、Google App Engineに登録したアプリケーションidで、web2py を置き換える必要があります。

url: /(.+?)/static/(.+) は処理速度を上げるため、web2pyロジックを呼び出すことなく、直接アプリの静的ファイルを提供するようGAEに指示します。

url:.* は他の全てのリクエストに、gaehandler.py を使うようにweb2pyに指示します。

skip_files: セッションは、GAEでデプロイする必要がないファイルのための、正規表現のリストです。次の特定の行について説明します:

1
2
 (applications/(admin|examples)/.*)|
 ((admin|examples|welcome).(w2p|tar))|

アンパックしたwelcomeの雛形アプリケーションを除いて、デフォルトアプリケーションをデプロイしないようにGAEに指示しています。ここに無効すべきアプリケーションを、さらに追加することができます。

アプリケーションidとバージョン設定以外には、app.yaml を編集する必要はあまりないかもしれません。もっとも、welcomeアプリケーションは除外するかもしれません。

ファイル queue.yaml は、GAEタスクキューを設定するのに使用されます。

ファイル index.yaml は、GAEのappserver(Google SDKについてくるwebサーバー)で、アプリケーションをローカルで実行する際に自動で作成されます。中身には以下のコードを含みます:

1
2
3
4
5
indexes:
- kind: person
  properties:
  - name: name
    direction: desc

この例ではGAEに、"name" フィールドをアルファベットの降順ソートした、"person" というテーブルのindexを作成するように指示します。対応するindexがないと、アプリケーションで検索やソートを行うことができません。

デプロイメントの前には常にappserverを使って、アプリをローカルで動かし全ての機能を確認することが重要です。これはテスト目的だけではなく、"index.yaml" を自動で作成する目的もあります。 時々このファイルを編集し、重複したエントリーなどを削除したりするなど掃除をした方が良いでしょう。

実行とデプロイメント

Linux

GAE SDKをインストール済みであるとします。執筆時にはGAEはPython 2.5.2で動作します。以下のappserverコマンドで、"web2py" フォルダ中のアプリケーションを実行できます:

1
python2.5 dev_appserver.py ../web2py

これでappserverが起動します。そして、次のURLでアプリケーションを実行できます:

1
http://127.0.0.1:8080/

GAEにアプリケーションをアップロードするには、前述したように "app.yaml" を編集し、適切なアプリケーションidをセットしたことを確認した上で、次を実行します:

1
python2.5 appcfg.py update ../web2py
Mac, Windows

MacやWindowsでは、Google App Engineランチャを使用できます。 次のリンクからダウンロードできます。[gae]

[File][Add Existing Application]を選択し、web2pyフォルダのトップレベルのパスをpathにセットし、そしてツールバーにある[Run]ボタンを押します。ローカルで動作確認できたら、ツールバーにある[Deploy]ボタンをクリックするだけでデプロイできます(アカウントを持っているのが前提です)。

image

GAE上でのweb2pyのチケット/エラーは、ログにアクセスしオンライン検索できるGAE管理コンソールに、同様のログが表示されます。

image

ハンドラの設定

gaehandler.py はGAE用に提供されているファイルで、いくつかのオプションがあります。以下はデフォルトの値です:

1
2
3
LOG_STATS = False
APPSTATS = True
DEBUG = False

LOG_STATS はページ表示にかかった時間をGAEのログに出力します。

APPSTATS はプロファイリング統計を提供するGAE appstatsを有効にします。次のURLでアクセスできます:

1
http://localhost:8080/_ah/stats

DEBUG はデバッグモードをセットします。gluon.settings.web2py_runtimeを使って、コードで明示的にチェックしない限り、実際には違いはありません。

ファイルシステムの無効

GAEではファイルシステムにアクセスできません。書き込みのためにファイルを開くこともできません。

このためGAEでは、"upload" フィールドが uploadfiled 属性を持つ持たないにかかわらず、web2pyは自動で全てのアップロードファイルをデータストアに保存します。

セッションとチケットもデータベースに保存する必要があり、以下のように明示しなければいけません:

1
2
3
4
5
if request.env.web2py_runtime_gae
    db = DAL('gae')
    session.connect(request,response,db)
else:
    db = DAL('sqlite://storage.sqlite')

上記のコードは、GAEで動作しているかをチェック、BigTableに接続、そしてweb2pyにセッションとチケットをそこに保存するように指示します。それ以外の場合はsqliteデータベースに接続します。このコードは雛形アプリケーションの "db.py" に、既に存在しています。

Memcache

必要であれば、memcacheにセッションを保存することができます:

1
2
3
4
5
6
7
from gluon.contrib.gae_memcache import MemcacheClient
from gluon.contrib.memdb import MEMDB
cache.memcache = MemcacheClient(request)
cache.ram = cache.disk = cache.memcache

db = DAL('gae')
session.connect(request,response,MEMDB(cache.memcache))

GAEではcache.ramとcache.diskは使用されるべきでありません、cache.memcacheを使用している点に注意してください。

Datastoreの問題

Google Clould SQLは普通のSQLデータベースのように機能し、書き込み時は実際にmysqlに基いています。Google Datastoreとは大きな違いがあります。

結果整合性

Google Datastoreが提供する 結果整合性 は特別な注意を要します。

Datastoreでは、Datasore主キー、もしくは共有エンティティグループに依存した、強い一貫性があるトランザクションを提供しています: 全ての後続のトランザクションもしくはクエリは、同一キーもしくはエンティティグループの、どの以前のトランザクションの結果も参照されます。

一方、主キーもしくは共有エンティティグループに依存しないクエリは 結果整合性 のみ提供しています: 新規もしくは更新されたデータは、通常数秒の明示されない遅延の後、最終的にクエリで利用可能になります。

web2pyは、Datastore主キーもしくはエンティティグループに依存しません。次の命令文は:

1
id = db.table.insert(field1=value1, field2=value2)

下記のような効果があります:

  • 新規行が、db.table に挿入されます。行はweb2pyによって値が割り当てられる、id を持ちます。行はDetastore主キーを持ちますが、しかしこの主キーは、id では なく、そして公開もされません。
  • db.table のインデックスは更新されます。特に、id のインデックスが更新され、新規行は 最終的に db.table.id でクエリすることが可能になります。

この2つのステップが完了した後のみ、新規データの id によるクエリが可能になります。 とりわけ、下のようなweb2pyで通常使われる模範例は フェイル します:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
def insert():
    form = SQLFORM(db.table)
    if form.process().accepted:
        session.flash = T('The data has been inserted.')
        redirect(URL('view', args=[form.vars.id]))
    return dict(form=form)

def view():
    row = db.table(request.args(0))
    if row is None:
        session.flash = T('Data not found')
        redirect(URL(index))
    form = SQLFORM(db.table, record=row, readonly=True)
    return dict(form=form)

ユーザが insert ページを訪れデータを挿入した後すぐに、ユーザは view ページにリダイレクトされます。Google Datastore を使用している場合、しばしば挿入したばかりのデータが view コントローラで見つかりません。なぜでしょう?。

何が起こっているのでしょう。insert コントローラでは、データベースにデータが挿入されており、そしてトランザクションは完了しています。その後、非同期でさらにトランザクション終了後に、Google Datastoreは db.tableid フィールドを含むインデックスの再構成をします。ユーザが view コントローラにアクセスした時に、新しいデータを既に含む db.table.id のインデックスが存在する保証はありません。このためユーザには、"Data not found" というメッセージが頻繁に表示されます。

JOINの無効

JOIN操作が無効です。Datastoreの典型的なリレーション機能は、web2pyのクエリからJOINを削除することと、データベースの非正規化を要求します。

Google App Engineは ListPeropertyStringListProperty といった、特別なフィールドタイプをサポートします。web2pyは以下の古い構文を使うことで、これらのタイプを使用できます:

1
2
3
4
from gluon.dal import gae
db.define_table('product',
    Field('name'),
    Field('tags', type=gae.StringListProperty())

もしくは、同等の新しい構文:

1
2
3
db.define_table('product',
    Field('name'),
    Field('tags', 'list:string')

どちらの場合も "tags" フィールドは StringListProperty タイプで、値はストリングのリストである必要があります。GAEのドキュメントに互換性に関する記載があります。 we2pyがフォームのコンテキストでフィールドをスマートに扱えること、リレーショナルデータベースでも動作すること、これらの理由により二つ目の記述の方が好ましいです。

同様にListProperty(int)にマッピングする list:integerlist:reference を、web2pyはサポートします。

list タイプの詳細は6章で説明されています。

データベースのマイグレーション

Google AppEngineへのマイグレーションに関して、良いプラクティスは次の通りです。 AppEngineは複数のコードバージョンをサポートしています。 ユーザに表示するサイトのコードバージョンを使用し(例えば、バージョン1)、管理者コードは他のコードバージョンを使用します(例えば、バージョン2)。app.yaml でバージョン2のために、次のようにハンドラを宣言します(Python2.7を使用していると仮定)。

1
2
3
4
- url: .*
  script: gaehandler.wsgiapp    # WSGI (Python 2.7 only)
  secure: optional
  login: admin

login: admin 句は、管理者がバージョン2を使用することができるようにします。 データベース接続文字列では、migrate_enabled=False を指定します。 マイグレーション実行では、マイグレーションへのデータベース同時アクセスを無効にすることをお勧めします。

次の手順に従ってください:

  • バージョン1のトップディレクトリ(/controllers/views などのディレクトリの親ディレクトリのこと)に DISABLED という名前のファイルを追加し、GAEに新しいバージョンをアップロードします。これはバージョンを1を無効にし、"The site is temporarily down for maintenance" というメッセージを表示します。
  • データベース接続文字列に migrate_enabled=True と記述し、バージョン2をアップロードします。そして管理者アカウントでサイトを訪問し、マイグレーションを動かします。
  • migrate_enabled=False にしてバージョン2をアップロードし、マイグレーションの実行を無効にします。
  • バージョン1から DISABLED ファイルを削除し、バージョン1のコードをアップロードします。これにより、サイトの全てが表示されるようになります。

GAEとhttps

アプリケーションのidが "myapp" の場合、GAEドメインは、

1
http://myapp.appspot.com/

です。これは、HTTPSでアクセスすることもできます

1
https://myapp.appspot.com/

この場合、Googleによって提供される "appspot.com" の証明書を使用します。

DNSエントリーの登録で、他のドメイン名でアプリを使用できますが、HTTPSは使用できません。執筆時点で、これはGAEの制限です。

第3版 - 翻訳: Omi Chiba レビュー: 中垣健志
第4版 - 翻訳: Yota Ichino レビュー: Hitoshi Kato
第5版 - 翻訳: Hitoshi Kato レビュー: Omi Chiba
 top