在docker上部署python的flask框架的教程

docker

本文中,我将尝试展示用docker开发python应用(主要是web应用)的可行方法。虽然我本人专注于python的flask微框架,但本文目的是演示如何通过docker更好地开发和共享应用程序,(由任何语言和框架开发的应用程序)。docker通过封装依赖项,大大减少了开发环境和正式产品的差距。

大多数python开发人员在开发中使用virtualenv。它提供了一种易用的机制让应用程序使用自己专用的依赖项,这些依赖项可能与在其它应用程序或操作系统存在冲突(尤其是不同的pyhton版本,还有不同的库版本等等)。个人而言,我对virtualenv一直没有太大兴趣,原因如下:

我经常忘记启用它,或者在切换工程时忘记切换它,这会遇到含糊的出错信息,另人倍感困惑。
它无法提供“纯粹的”隔离,只能是python级别的隔离(系统库和非python的依赖项仍然会出问题)。
我通常不想在正式产品中运行它,这就意味着在开发环境和正式产品的不一致。
它让人感觉有点“黑客”作法:它是依靠修改脚本和设置新路径实现的。

( 查看 pythonrants的这篇文章 了解更多为什么你可能不想用virtualenv )

那么,怎么做docker才能变得更好呢?docker本质上提供了非常轻量化的vms(在说法上可以称为“容器”),我们可以使用其创建一个高标准隔离并能大大减少失配的开发和产品环境。(如果你不熟悉docker,却还想学习更多,你可以查看我在爱丁堡技术座谈会上介绍docker的谈话)。

当我们建立一个小型的可视化web app,我自己和mark coleman使用这种方法(文档在这)。这(里面)划出了一个基本镜像安装python 2.7,还有一些flask管理以及postgresql的内容。我会依据这个镜像去开发一个hello world的web应用。我假设你是在linux上开发,并且你已经有git,还安装了docker,macos的指令应该非常类似。通过克隆和建立基本镜像开始:

$ git clone https://github.com/mrmrcoleman/python_webapp
$ docker build -t python_webapp .

现在,我们需要为容器中添加一些代码并详细写明。我们打算新建一个仅仅指向docker镜像的项目来完成这项工作,而不是直接修改之前的项目。

创建一个具有下列结构的新项目:

代码如下:

├── dockerfile
├── example_app
│ ├── app
│ │ ├── __init__.py
│ │ └── views.py
│ └── __init__.py
├── example_app.wsgi

或者克隆该地址的示例项目: https://github.com/amouat/example_app.git

在example_app/app/_init_.py中写入:

from flask import flask
app = flask(__name__)
from app import views

使另一个_init_.py为空。在views.py中写入:

from app import app
@app.route(‘/’)
@app.route(‘/index’)
def index():
return “hello, world!”

以上就是我们的一个hello world应用的最小flask版本。我在 这个教程中也使用过类似的代码,所以如果你刚刚接触flask或者python,你可以根据上述提到的教程,使用docker而不是virtualenv继续学习。

为了使之运行在docker容器内部,我们还需要做一些操作。在我们的实例apache服务器中,example_app.wsgi文件包含了连接python代码和web服务器的指令。该文件应当包含下列内容:

import site
site.addsitedir(‘/opt/example_app/’)
from app import app as application

最终,我们需要一个dockerfile来构建容器并运行容器。在我们的实例中,它看起来是这样的:

from python_webapp
maintainer amouat
add example_app.wsgi /var/www/flaskapp/flaskapp.wsgi
cmd service apache2 start && tail -f /var/log/apache2/error.log

add那行为启动wsgi注入了一些代码。cmd那行在启动容器,启动apache web服务器时获取任何可能的错误信息,并将其发送至stdout。

如果你下列操作:

$ docker build -t example_app .
$ docker run -p 5000:5000 -v $(pwd)/example_app:/opt/example_app/ -i -t example_app

你应当会得到这样的回馈:通过浏览器打开地址localhost:5000,你会看到你的网站正在运行。如果你实在vm或者vagrant中运行,记得打开5000端口。

现在我们运行了web服务器,已经非常接近我们在产品中使用的东西了(我有意的使用apache来做这点而不是python默认的web服务器)。我们通过从主机向容器映射的方式向容器中注入代码;也可以在dockerfile命令行中是用add来添加代码,但那样的话当我们队代码进行改动时,每次都需要重新构建容器。

然而,这仍然不是很好 ;开发中我们真的希望使用很大程度上帮助我们调试的python web服务器。该高兴的是我们不用对dockerfile进行任何修改。在example_app文件从创建一个run.py文件开始,按照一下内容:

!flask/bin/python
from app import app
app.run(debug = true, host=’0.0.0.0′)

这将启动python的带调试的web服务器并监听所有连接,我们也能从容器外访问。现在用下列命令重启容器:

$ docker run -p 5000:5000 -v $(pwd)/example_app:/opt/example_app/ -i -t example_app python /opt/example_app/run.py

你能看到网页又运行了。这次我们显式地提供运行的命令(”python /opt/example_app/ryn.py”),它覆盖了dockerfile中的cmd行的设置。现在如果编辑在主机上的源程序,就能马上看到网页上的改变。

让我们花点时间看看我们的收获:

一个运行在隔离容器中的web应用,容器完全封装了应用的python依赖项和系统依赖项。
能够使用现有编辑器或ide开发代码并直接查看变化,就像在本地编辑一样。
比以前更接近正式产品的运行环境。
没有使用virtualenv。

如果你想知道如何以这种方式建立程序发布的途径,可以看看mark coleman写的关于前面提到的可视化web应用的文章。

不幸的是,这一切还不完美。还有下列几个问题:

你可能仍会遇到需要使用virtualenv或其等价解决方案的情况,例如库的操作系统版本与你的程序所需版本间的冲突。
我们还没完全解决数据托管的问题,仍需做某些测试。
我假设的“产品”是一个docker容器,但实际情况常常并非如此而且docker托管本身也刚刚起步。

尽管如此,我仍然认为这向软件开发的更好未来迈了一大步,大大减轻了部署软件和管理依赖项的痛苦。

Posted in 未分类