【Python】Flask、Django项目的部署【原创】
文章目录
0. 参考
- Gunicorn官方文档
- Supervisor官方文档
- Django 部署基础
- Django 部署(Nginx)
- 从django、flask、tornado的部署说起
- Supervisor使用详解
- supervisor(一)基础篇
1. 概述
Python的web框架主要有Django、Flask等，而这两个都是运行在WSGI协议之上的框架
这些框架部署的链路一般是：Nginx -> uWSGI -> Python Web程序，通常还会结合Supervisor工具来进行监听启停
先了解以下概念：
- WSGI：Web Server Gateway Interface，WSGI不是服务器，python模块，框架，API或者任何软件，只是一种规范，描述web server如何与web application通信的规范。要实现WSGI协议，必须同时实现web server和web application，目前主流的Python web框架都是基于这个规范实现的。
- uwsgi：与WSGI一样是一种通信协议，是uWSGI服务器的独占协议，用于定义传输信息的类型，简洁高效的uwsgi协议是选择uWSGI作为部署工具的重要理由之一
- uWSGI：是一个web服务器，实现了WSGI协议、uwsgi协议、http协议等
- Nginx：Nginx是一个Web服务器，是一个反向代理工具，我们通常用它来部署静态文件。主流的Python Web开发框架都遵循WSGI规范。
- Supervisor：一个进程管理工具。任何人都不能保证程序不异常退出，不被人误杀，所以一个典型的工程做法就是使用Supervisor看守着你的进程，一旦异常退出它会立马进程重新启动起来。
补充：
WSGI协议主要包括server和application两部分
- WSGI server负责从客户端接收请求，将request转发给application，将application返回的response返回给客户端
- WSGI application接收由server转发的request，处理请求，并将处理结果返回给server。application中可以包括多个栈式的中间件(middlewares)，这些中间件需要同时实现server与application，因此可以在WSGI服务器与WSGI应用之间起调节作用：对服务器来说，中间件扮演应用程序，对应用程序来说，中间件扮演服务器。
WSGI协议其实是定义了一种server与application解耦的规范，即可以有多个实现WSGI server的服务器，也可以有多个实现WSGI application的框架，那么就可以选择任意的server和application组合实现自己的web应用。例如uWSGI和Gunicorn都是实现了WSGI server协议的服务器，Django，Flask是实现了WSGI application协议的web框架，可以根据项目实际情况搭配使用
uWSGI通过WSGI规范和我们编写的服务进程通讯，然后通过自带的高效的 uwsgi 协议和 Nginx进行通讯，最终Nginx通过HTTP协议将服务对外透出。
当一个访问进来的时候，首先到 Nginx，Nginx会把请求（HTTP协议）转换uwsgi协议传递给uWSGI，uWSGI通过WSGI和web server进行通讯取到响应结果，再通过uwsgi协议发给Nginx，最终Nginx以HTTP协议发现响应给用户。
但其实呢，uWSGI本身是支持HTTP协议的，也支持静态文件部署，这个链路是可以不用Nginx的，即uWSGI -> Python Web程序，但是Nginx会更加稳定且支持的并发量更高，所以主流的做法一般都是在前面加一层Nginx来做反向代理，避免并发量过大时候uWSGI直接服务挂掉
如下图：
Django、Flask都有自己实现的简单的WSGI server，比如Django启动的时候使用python manage.py runserver，而在线上的时候一般会使用其他的WSGI server,比如gunicorn
2. Gunicorn
Gunicorn是一个WSGI HTTP Server，是用来替代Django、Flask自带的Server，自带的Server只能单线程运行，而Gunicorn能并发多线程，轻量级的资源消耗以及高性能等特点
主流做法是使用Gunicorn来进行托管启动Python的web项目，另外使用supervisor来进行启停和状态的监控，一般会在Gunicorn的前端放置一个HTTP Proxy Server, 譬如Nginx。
如图：
下面就以Flask为例子
注意：前提是已经安装好了Flask以及虚拟环境virtualenv等
A. 安装
pip install gunicorn
注意：Linux下一般为pip3 install gunicorn
B. 创建项目
创建项目目录
mkdir -p /var/www/html/flask_test
cd /var/www/html/flask_test
创建入口文件vim app.py
from flask import Flask
app = Flask(__name__)
@app.route('/demo', methods=['GET'])
def demo():
return "Hello, This is a Demo"
C. 命令行配置
gunicorn支持命令行中定义配置，也支持-c参数从配置文件中读取配置
先来测试一下命令行配置
执行 gunicorn -b 0.0.0.0:9100 app:app
注意：不指定-b 0.0.0.0:9100的话，默认是只能本机访问，并且端口默认为8000
D. 测试
浏览器访问：IP:9100/demo
E. 文件配置
一般情况下线上的项目都是通过加载配置文件来启动的，-c参数来加载配置文件
Gunicorn配置文件一般是在项目根目录下的
在这里我使用的是项目目录下的supervisor目录
创建日志目录
mkdir -p /tmp/logs/flask_test
创建配置文件
mkdir -p /var/www/html/flask_test/supervisor
touch /var/www/html/flask_test/supervisor/gunicorn_conf.py
常用的配置信息：
bind：绑定的IP和端口，默认是127.0.0.1:8000
workers：用于处理工作进程的数量，为正整数，默认为1。worker推荐的数量为当前的CPU个数*2 + 1
worker_class：要使用的工作模式，默认为sync（同步），支持以下模式：
sync：同步
eventlet：异步模式，协程并发，需要eventlet>=0.9.7
gevent：异步模式，需要gevent>=0.13
tornado：异步模式，需要tornado>=0.2
gthread：线程工作模式，利用线程池管理连接
gaiohttp：异步模式，需要aiohttp>=0.21.5
threads：处理请求的工作线程数，使用指定数量的线程运行每个worker。为正整数，默认为1，只使用与gevent工作模式
timeout：超过这么多秒后工作将被杀掉，并重新启动。一般设定为30秒
graceful_timeout：接收到重启信号后，worker可以在graceful_timeout时间内，继续处理完当前请求
reload：代码更新时将重启工作，默认为False。此设置用于开发环境
spew：是否打印服务器执行过的每一条语句，默认False
chdir：加载应用程序之前，进入到该目录
daemon：是否守护进程，默认False
raw_env：设置环境变量(key=value)，将变量传递给执行环境，如：raw_env=["abc=123"]
accesslog：访问日志路径
access_log_format：访问日志格式
errorlog：错误日志路径
loglevel：错误日志输出等级
proc_name：进程名
user： 指定worker进程的运行用户名。
group： 指定worker进程运行用户所在组。
更多配置参考官方文档
简单的配置文件gunicorn_conf.py（无日志切割）
import multiprocessing
bind = '0.0.0.0:9100'
workers = multiprocessing.cpu_count() * 2 + 1 #进程数
reload = True
loglevel = 'info'
timeout = 600
log_path = "/tmp/logs/flask_test"
accesslog = log_path + '/gunicorn.access.log'
errorlog = log_path + '/gunicorn.error.log'
通用的配置文件gunicorn_conf.py（带日志切割）
import multiprocessing
bind = '0.0.0.0:9100'
workers = multiprocessing.cpu_count() * 2 + 1 #进程数
reload = True
loglevel = 'info'
timeout = 600
log_path = "/tmp/logs/flask_test"
logconfig_dict = {
'version':1,
'disable_existing_loggers': False,
"root": {
"level": "INFO",
"handlers": ["console"]
},
'loggers':{
"gunicorn.error": {
"level": "INFO",# 打日志的等级可以换的，下面的同理
"handlers": ["error_file"], # 对应下面的键
"propagate": 1,
"qualname": "gunicorn.error"
},
"gunicorn.access": {
"level": "INFO",
"handlers": ["access_file"],
"propagate": 0,
"qualname": "gunicorn.access"
}
},
'handlers':{
"error_file": {
"class": "logging.handlers.RotatingFileHandler",
'maxBytes': 1024*1024*20, # 20 MB
'backupCount': 10,
'encoding': 'utf8',
"formatter": "generic",
"filename": log_path + "/gunicorn.error.log"
},
"access_file": {
"class": "logging.handlers.RotatingFileHandler",
'maxBytes': 1024*1024*20,
'backupCount': 10,
'encoding': 'utf8',
"filename": log_path + "/gunicorn.access.log",
},
'console': {
'class': 'logging.StreamHandler',
'level': 'DEBUG',
'formatter': 'generic',
},
},
'formatters':{
"generic": {
"format": "%(asctime)s [%(process)d] [%(name)s:%(lineno)d] [%(module)s:%(funcName)s] [%(levelname)s] %(message)s", # 打日志的格式
"class": "logging.Formatter"
}
}
}
F. 文件配置启动
使用以下命令来启动：gunicorn -c gunicorn_conf.py app:app
注意：在gunicorn 20.x版本中，如果配置文件中的logconfig_dict中不加以下的代码：
"root": {
"level": "INFO",
"handlers": ["console"]
},
那么在使用gunicorn来启动（gunicorn -c gunicorn_conf.py app:app）的时候可能会报错，报错信息如下：
Error: Unable to configure root logger.
参考：https://github.com/benoitc/gunicorn/issues/2250
3. Supervisor
Supervisor是用Python开发的一套通用的进程管理程序，能将一个普通的命令行进程变为后台daemon，并监控进程状态，异常退出时能自动重启。
它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动，这样只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，可以选择是否自己启动和报警。
supervisor还提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程。
A. 安装
有多种方式：
yum install supervisor
pip install supervisor
easy_install supervisor
安装好了之后，默认的配置文件是在: /etc/supervisord.conf
而子进程配置目录 /etc/supervisord.d/
B. 配置文件说明
配置文件说明
[unix_http_server]
file=/tmp/supervisor.sock ;UNIX socket 文件，supervisorctl 会使用
;chmod=0700 ;socket文件的mode，默认是0700
;chown=nobody:nogroup ;socket文件的owner，格式：uid:gid
;[inet_http_server] ;HTTP服务器，提供web管理界面
;port=127.0.0.1:9001 ;Web管理后台运行的IP和端口，如果开放到公网，需要注意安全性
;username=user ;登录管理后台的用户名
;password=123 ;登录管理后台的密码
[supervisord]
logfile=/tmp/supervisord.log ;日志文件，默认是 $CWD/supervisord.log
logfile_maxbytes=50MB ;日志文件大小，超出会rotate，默认 50MB，如果设成0，表示不限制大小
logfile_backups=10 ;日志文件保留备份数量默认10，设为0表示不备份
loglevel=info ;日志级别，默认info，其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ;pid 文件
nodaemon=false ;是否在前台启动，默认是false，即以 daemon 的方式启动
minfds=1024 ;可以打开的文件描述符的最小值，默认 1024
minprocs=200 ;可以打开的进程数的最小值，默认 200
[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord，路径与unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord
; [program:xx]是被管理的进程配置参数，xx是进程的名称
[program:xx]
command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run ; 程序启动命令
autostart=true ; 在supervisord启动的时候也自动启动
startsecs=10 ; 启动10秒后没有异常退出，就表示进程正常启动了，默认为1秒
autorestart=true ; 程序退出后自动重启,可选值：[unexpected,true,false]，默认为unexpected，表示进程意外杀死后才重启
startretries=3 ; 启动失败自动重试次数，默认是3
user=tomcat ; 用哪个用户启动进程，默认是root
priority=999 ; 进程启动优先级，默认999，值小的优先启动
redirect_stderr=true ; 把stderr重定向到stdout，默认false
stdout_logfile_maxbytes=20MB ; stdout 日志文件大小，默认50MB
stdout_logfile_backups = 20 ; stdout 日志文件备份数，默认是10
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false ;默认为false,进程被杀死时，是否向这个进程组发送stop信号，包括子进程
killasgroup=false ;默认为false，向进程组发送kill信号，包括子进程
;包含其它配置文件
[include]
files = supervisord.d/*.ini ;可以指定一个或多个以.ini结束的配置文件
常用的子进程配置（supervisord.d/*.ini）如下：
user=root：用哪个用户启动进程，默认是root
command：程序启动命令
environment=ENV="dev"：设置环境变量的
directory=/var/www/html/flask_test/：进程运行前，会前切换到这个目录
autorestart=true ; 程序退出后自动重启,可选值：[unexpected,true,false]
redirect_stderr=true ; 把stderr重定向到stdout，默认false
stdout_logfile=/tmp/logs/flask_test/stdout.log ; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile_maxbytes=50MB ; stdout 日志文件大小，默认50MB
stdout_logfile_backups = 20 ; stdout 日志文件备份数，默认是10
C. 创建子进程配置
创建子进程配置实例
vim /etc/supervisord.d/flask_test.ini
[program:flask_test]
user=root
environment=ENV="dev"
directory=/var/www/html/flask_test/
command=/usr/local/python3/bin/gunicorn app:app -c ./supervisor/gunicorn_conf.py
autorestart=true
redirect_stderr=true
stdout_logfile=/tmp/logs/flask_test/stdout.log
stdout_logfile_maxbytes=50MB
stdout_logfile_backups=10
相当于执行
export ENV="dev"
gunicorn -c app:app /var/www/html/flask_test/supervisor/gunicorn_conf.py
注意：command中需要使用绝对路径，直接写gunicorn有可能会报can’t find command ‘gunicorn’，可以通过whereis gunicorn来获取路径
注意：启动命令的话不同框架的启动命令不一致，Flask一般是 ：
gunicorn app:app -c ./supervisor/gunicorn_conf.py
而Django一般是：
gunicorn 项目名.wsgi:application -c ./supervisor/gunicorn_conf.py
注意：如果这里的user不为root的话，那么对应的日志目录的权限也需要加上该user的权限，否则会报无权限
另外，如果该项目有celery的话，还需要再配置两个program：
vim /etc/supervisord.d/flask_test.ini
[program: flask_test-celery-work]
user=root
environment=ENV="dev"
directory=/var/www/html/flask_test/
command=/usr/local/python3/bin/celery -A flask_test worker -l info
autorestart=true
redirect_stderr=true
stdout_logfile=/tmp/logs/flask_test/celery-work.stdout.log
stdout_logfile_maxbytes=50MB
stdout_logfile_backups=10
[program: flask_test-celery-beat]
user=root
environment=ENV="dev"
directory=/var/www/html/flask_test/
command=/usr/local/python3/bin/celery -A flask_test beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
autorestart=true
redirect_stderr=true
stdout_logfile=/tmp/logs/flask_test/celery-beat.stdout.log
stdout_logfile_maxbytes=50MB
stdout_logfile_backups=10
注意：celery同样是需要绝对路径的，可以通过whereis celery来获取
注意：子进程的配置文件，同样也是需要放在项目根目录下的，我这里的做法是放在项目根目录下的supervisor目录下，该目录下一般会有三个文件，gunicorn.py、dev.conf、prod.conf，其中dev.conf和prod.conf跟/etc/supervisord.d/xxx.ini的一样的，主要是不同的环境放不同的配置文件而已
即：
一般的Python项目，根目录下会新增一个目录（我这里是supervisor目录），用来放置gunicorn和supervisord的配置文件
里面至少有：
- dev.conf：测试环境下对应 /ect/supervisord.d/*.ini
- prod.conf：生产环境下对应 /ect/supervisord.d/*.ini
- gunicorn_conf.py：gunicorn配置文件
D. 启动和开机重启
启动和开机启动
systemctl start supervisord.service //启动supervisor并加载默认配置文件
systemctl enable supervisord.service //将supervisor加入开机启动项
如果已经是启动supervisord，只是需要新增子进程项目的话，那么可以使用以下命令进行加载：
supervisorctl reload
补充：
相关命令
supervisorctl status //查看所有进程的状态
supervisorctl stop es //停止es
supervisorctl start es //启动es
supervisorctl restart es //重启es
supervisorctl start all //启动全部
supervisorctl stop all //停止全部
supervisorctl restart all //重启全部
supervisorctl update //配置文件修改后使用该命令加载新的配置
supervisorctl reload //重新启动配置中的所有程序
注意：命令行直接输入supervisorctl即可进入supervisorctl的shell交互界面，此时上面的命令不带supervisorctl可直接使用
E. 挂载Nginx
上面已经能够通过 IP:9100 进行访问了，但在线上环境中，为了更加稳定安全，一般会在前面加一层Nginx
Nginx配置如下：
vim /etc/nginx/conf.d/flask.test.com.conf
server {
server_name flask.test.com;
listen 80;
location / {
proxy_pass http://127.0.0.1:9100;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
}
保存之后通过以下命令来验证新的Nginx配置是否有问题：nginx -t
然后重启nginx：
systemctl restart nginx
# 或者是nginx -s reload也可以
本地设置host即可访问flask.test.com/demo
上一篇： javascript的一些细节知识
下一篇： Flask项目的部署