How to deploy for minimum Python Flask application on Apache / Apache上で最小構成のPython Flaskアプリをデプロイする方法

WSGIファイルの設定

$ cd /home/ubuntu/
$ mkdir -p hoge/test # hogeアプリのディレクトリ、各種コードはhoge/testに格納する
$ cd hoge
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install flask mod_wsgi
$ vim flaskapp.wsgi
# flaskapp.wsgi
import sys
sys.path.insert(0. '/home/ubuntu/hoge') # wsgiは絶対パスによる参照が必要
from test import app as application # 後述

Flaskアプリの実装

$ cd /home/ubuntu/hoge/test
$ vim __init__.py
# __init__.py
from flask import Flask
app = Flask(__name__)

@app.route('/')
def index():
    return 'hoge'

if __name__ == '__main__':
    app.run(host='0.0.0.0')

Apacheの設定、.confの編集

$ cd /etc/apache2/sites-available/
$ sudo cp 000-default.conf 000-default.conf.bk # バックアップ
$ sudo vim 000-default.conf
# 000-default.conf
LoadModule wsgi_module "/home/ubuntu/hoge/venv/lib/python3.8/site-packages/mod_wsgi/server/mod_wsgi-py38.cpython-38-x86_64-linux-gnu.so" # 補足①を参照
WSGIPythonHome "/home/ubuntu/hoge/venv"
WSGIScriptAlias /hoge /home/ubuntu/hoge/flaskapp.wsgi
<VirtualHost *:80>
        # The ServerName directive sets the request scheme, hostname and port that
        # the server uses to identify itself. This is used when creating
        # redirection URLs. In the context of virtual hosts, the ServerName
        # specifies what hostname must appear in the request's Host: header to
        # match this virtual host. For the default virtual host (this file) this
        # value is not decisive as it is used as a last resort host regardless.
        # However, you must set it for any further virtual host explicitly.
        #ServerName www.example.com

        ServerAdmin webmaster@localhost
        ServerName sample.com
        DocumentRoot /var/www/html

        <Directory /home/ubuntu/hoge > # アクセス許可のためのディレクティブ設定
                Require all granted
        </Directory>

        # Available loglevels: trace8, ..., trace1, debug, info, notice, warn,
        # error, crit, alert, emerg.
        # It is also possible to configure the loglevel for particular
        # modules, e.g.
        #LogLevel info ssl:warn

        ErrorLog ${​​​​​APACHE_LOG_DIR}​​​​​​​​​​​​/error.log
        CustomLog ${​​​​​​​​​​​​​​​​​​​APACHE_LOG_DIR}​​​​​​​​​​​​​​​​​​​​​​​​​​/access.log combined

        # For most configuration files from conf-available/, which are
        # enabled or disabled at a global level, it is possible to
        # include a line for only one particular virtual host. For example the
        # following line enables the CGI configuration for this host only
        # after it has been globally disabled with "a2disconf".
        #Include conf-available/serve-cgi-bin.conf
</VirtualHost>

補足① wsgi_module、WSGIPythonHomeの取得

以下コマンドで各種パスを取得

$ mod_wsgi module-config

How to deploy for Python Flask application with API / View separation / APIとViewを切り分けたPython Flaskアプリのデプロイ方法

参考記事

https://loochs.org/how-to-deploy-for-minimum-flask-application-on-apache-apache/

初めに

以下のような構成でアプリをデプロイしたいとする

APIの実装

$ cd /home/ubuntu/hoge/test
$ vim api/body.py
# api/body.py

from flask import Flask, Blueprint

api = Blueprint('api', __name__) # apiをモジュールとして定義

@api.route('/')
def index():
    return 'This is api'

上記のapiをモジュールとして読み込むためにアプリロジックを以下のようにする。

$ vim __init__.py
# __init__.py

import sys
sys.path.insert(0, '/home/ubuntu/hoge/test')

from flask import Flask
app = Flask(__name__)

from api.body import api
app.regster_blueprint(api, url_prefix='/api')

@app.route('/')
def index():
    return 'This is app route'

if __name__ = '__main__':
    app.run(host='0.0.0.0')

Apacheの設定変更

任意のurl、例えばhttp://sample.com/hoge/api でレスポンスが得られるようにしたい

$ cd /etc/apache2/sites-available/
$ sudo vim 000-default.conf
# 000-default.conf
LoadModule wsgi_module "/home/ubuntu/hoge/venv/lib/python3.8/site-packages/mod_wsgi/server/mod_wsgi-py38.cpython-38-x86_64-linux-gnu.so" # 補足①を参照
WSGIPythonHome "/home/ubuntu/hoge/venv"
WSGIScriptAlias /hoge /home/ubuntu/hoge/flaskapp.wsgi
<VirtualHost *:80>
        # The ServerName directive sets the request scheme, hostname and port that
        # the server uses to identify itself. This is used when creating
        # redirection URLs. In the context of virtual hosts, the ServerName
        # specifies what hostname must appear in the request's Host: header to
        # match this virtual host. For the default virtual host (this file) this
        # value is not decisive as it is used as a last resort host regardless.
        # However, you must set it for any further virtual host explicitly.
        #ServerName www.example.com

        ServerAdmin webmaster@localhost
        ServerName sample.com
        DocumentRoot /var/www/html

        <Directory /home/ubuntu/hoge > # アクセス許可のためのディレクティブ設定
                Require all granted
        </Directory>

        # Available loglevels: trace8, ..., trace1, debug, info, notice, warn,
        # error, crit, alert, emerg.
        # It is also possible to configure the loglevel for particular
        # modules, e.g.
        #LogLevel info ssl:warn

        ErrorLog ${​​​​​APACHE_LOG_DIR}​​​​​​​​​​​​/error.log
        CustomLog ${​​​​​​​​​​​​​​​​​​​APACHE_LOG_DIR}​​​​​​​​​​​​​​​​​​​​​​​​​​/access.log combined

        # For most configuration files from conf-available/, which are
        # enabled or disabled at a global level, it is possible to
        # include a line for only one particular virtual host. For example the
        # following line enables the CGI configuration for this host only
        # after it has been globally disabled with "a2disconf".
        #Include conf-available/serve-cgi-bin.conf
</VirtualHost>

GCPのVM-アパッチサーバー(Debian)を定期アップデートする

VMが月1ペースで落ちてしまいホストしているサイトがアクセス不可になる事象を回避したくて定期アプデを仕込みました。

cronを使う

crontabクロンタブ、あるいはクローンタブ、クーロンタブとも)コマンドはUnix系オペレーティングシステム (OS) において、コマンドの定時実行のスケジュール管理を行うために用いられるコマンドである。

https://ja.wikipedia.org/wiki/Crontab

/etc配下に関連するファイルが存在します。

ご存知のとおり、Debian系の cron は以下の 2か所に置かれた crontabファイルを認識します。 /etc/crontab /etc/cron.d/* また、/etc/cron.hourly/、/etc/cron.daily/ などの事前定義済みのディレクトリ (以降、総称して「/etc/cron./」と呼びます。) 配下に実行ファイルを置いておけば、配置したディレクトリに応じて毎時〜毎月の頻度で定期実行してくれます。

https://tech.quickguard.jp/posts/etc-cron-debian-specific/

crontabとcron.*の違い

両者の違いについては以下のような解説がなされています。Linux distribution共通なのがcrontabでcron.*はその点の注意が必要だと。

この違いについては、Debianのcron(8)のマニュアルページに詳しく書かれています。主な違いは、/etc/cron.d が個別のファイルで構成されているのに対し、crontab はユーザごとに 1 つのファイルを管理することです。したがって、スクリプトを使って /etc/cron.d の内容を管理するのは簡単ですし (自動インストールや更新の場合)、エディタを使って crontab を管理するのは簡単です (実際にはエンドユーザの場合)。 その他の重要な違いは、すべてのディストリビューションが/etc/cron.dをサポートしているわけではないことと、/etc/cron.d内のファイルは(有効なcronジョブであること以外に)いくつかの要件を満たさなければならないことです。ファイルの所有者はrootでなければならず、run-partsの命名規則(ドットはなく、文字、数字、アンダースコア、ハイフンのみ)に従わなければなりません。 /etc/cron.d を使用する場合は、代わりに /etc/cron.hourly、/etc/cron.daily、/etc/cron.weekly、/etc/cron.monthly のいずれかを検討するのがよいでしょう。

https://unix.stackexchange.com/questions/417323/what-is-the-difference-between-cron-d-as-in-etc-cron-d-and-crontab

結論、どうすればいいのか

$ sudo vim /etc/cron.monthly/update.sh

#! /bin/sh
/usr/bin/apt-get update #リポジトリの更新(root権限が必要)
/usr/bin/apt-get autoclean -y
/usr/bin/apt-get dist-upgrade -y 
sudo service apache2 restart

それぞれのコマンドについて

apt-get update

update は、パッケージのインデックスファイルをソースから再同期させるために使用されます。利用可能なパッケージのインデックスは、/etc/apt/sources.list で指定された場所から取得されます。例えば、Debian アーカイブを使用している場合、このコマンドは Packages.gz ファイルを取得してスキャンし、新規および更新されたパッケージに関する情報を利用できるようにします。アップデートは、アップグレードやディス トアップの前に必ず実行してください。パッケージファイルのサイズを事前に知ることができないため、全体の進捗メーターが正しくないことにご注意ください。

http://manpages.ubuntu.com/manpages/jammy/en/man8/apt-get.8.html

apt-get upgrade

apt-get には「スマートな」競合解決システムがあり、必要に応じて重要度の低いパッケージを犠牲にして、最も重要なパッケージをアップグレードしようとします。/etc/apt/sources.list ファイルには、必要なパッケージファイルを取得する場所のリストが含まれています。個々のパッケージの一般的な設定を上書きする仕組みについては、 apt_preferences(5) も参照してください。

http://manpages.ubuntu.com/manpages/jammy/en/man8/apt-get.8.html

apt-get autoclean

オートクリーンは、クリーンと同様に、取得したパッケージファイルのローカルリポジトリを消去します。異なる点は、ダウンロードできなくなったパッケージファイルや、ほとんど役に立たないパッケージファイルのみを削除することです。これにより、キャッシュが制御不能になることなく、長期間にわたって維持することができます。設定オプションの APT::Clean-Installed が off に設定されていると、 インストールされたパッケージが消去されるのを防ぎます。

http://manpages.ubuntu.com/manpages/jammy/en/man8/apt-get.8.html