docker-compose 运行 Flask 应用最佳实践

---

背景

  以前部署应用，需要各种环境配置，各种shell操作才能搭建一套可用的服务。现在有了Docker之后，部署方式变了更加容易，不容易出现配置错误，环境不一致问题。解决了在本地环境可以运行，迁移到线上出现各种问题，这些问题大多出现在线上和本地环境有差异，配置容易出现错误等情况。那么docker-compose 和 docker 之间存在着什么联系呢？

先来看看docker-compose 的定义：
「定义和运行多个 Docker 容器的应用（Defining and running multi-container Docker applications）」

  我们知道 docker 可以通过 Dockerfile 模板文件来定义一个应用容器。实际应用中，经常遇到多个容器相配合运行一套应用程序的情况。比如，实现一个Flask应用，除了 Flask 服务本身之外，还需要一些数据库服务容器等。Compose 恰好满足了这样的需求。它允许用户通过一个单独的 docker-compose.yml 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。
  通过 Docker-Compose 用户可以很容易地用一个配置文件定义一个多容器的应用，然后使用一条指令安装这个应用的所有依赖，完成构建。Docker-Compose解决了容器与容器之间如何管理编排的问题。

实施步骤

使用 Dockerfile 定制镜像

  镜像的定制实际上就是定制每一层所添加的配置、文件，因为 Flask 应用需要一些环境依赖才能运行起来。所以想要将 Flask 应用运行在 Docker 容器中，该容器必须将该应用所有的环境依赖安装好。而 Dockerfile 就是提供给我们配置相关的环境依赖等操作。Dockerfile 是一个文本文件，其内包含了一条条的指令(Instruction)，每一条指令构建一层，因此每一条指令的内容，就是描述该层应当如何构建。

下面以我的GitHub项目 flask-v2ex 应用的 Dockerfile 文件为例：

FROM daocloud.io/python:3.5

MAINTAINER Guoweikuang 
RUN mkdir -p /home/guoweikuang/app 
WORKDIR /home/guoweikuang/app 

ADD ./requirements.txt /home/guoweikuang/app/requirements.txt 

RUN pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple --upgrade pip 
RUN pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt 

ADD . /home/guoweikuang/app 

CMD python manage.py runserver -h 0.0.0.0

FROM: 指定了基础镜像，以该镜像为基础，在其上进行定制操作
MAINTAINER: 用来指定镜像创建者信息
RUN: 创建了 **/home/guoweikuang/app** 文件夹 (后面 RUN pip3 安装Python扩展库)
WORKDIR: 切换目录，可以多次切换(相当于cd命令)
ADD: 从本地目录相应文件拷贝到容器路径里
CMD: 设置container启动时执行的操作，运行 Flask 应用并设置host为0.0.0.0

编写 docker-compose.yml 文件

docker-compose.yml 文件将把所有的东西关联起来。它描述了应用的构成（一个 web 服务和一个数据库）、使用的 Docker 镜像、镜像之间的连接、挂载到容器的卷，以及服务开放的端口。

下面以我的GitHub项目 flask-v2ex 应用的 docker-compose.yml 文件为例:

version: '2'

services:
  web:
    build: .
    container_name: flask_v2ex
    ports:
      - "5000:5000"
  redis:
    image: "redis:alpine"

compose 中定义了两个服务 web 和 redis。

• web 服务
  • build: 使用当前目录的 Dockerfile build 的镜像
  • ports: 映射宿主机 5000 端口到容器的 5000 端口
  • container_name: 指定了容器的名字
• redis 服务
  • image: 使用 Docker Hub 中的 redis 镜像

使用 compose 构建并运行 Flask 应用

在运行 docker-compose up 之前，需要做一些修改，把项目里关于redis连接配置进行修改

r = redis.Redis(host='localhost', port=6379, decode_responses=True)

修改为：

r = redis.Redis(host='redis', port=6379, decode_responses=True)

在flask-v2ex 项目的根目录下使用 docker-compose up 命令，如下所示：

$ docker-compose up

Starting flask_v2ex         ... done
Starting flask_v2ex_redis_1 ... done
Attaching to flask_v2ex_redis_1, flask_v2ex
redis_1  | 1:C 01 Jul 07:46:52.053 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
redis_1  | 1:C 01 Jul 07:46:52.053 # Redis version=4.0.6, bits=64, commit=00000000, modified=0, pid=1, just started
redis_1  | 1:C 01 Jul 07:46:52.053 # Warning: no config file specified, using the default config. In order to specify a config file use redis-server /path/to/redis.conf
redis_1  | 1:M 01 Jul 07:46:52.064 * Running mode=standalone, port=6379.
redis_1  | 1:M 01 Jul 07:46:52.064 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128.
redis_1  | 1:M 01 Jul 07:46:52.064 # Server initialized
redis_1  | 1:M 01 Jul 07:46:52.065 # WARNING you have Transparent Huge Pages (THP) support enabled in your kernel. This will create latency and memory usage issues with Redis. To fix this issue run the command 'echo never > /sys/kernel/mm/transparent_hugepage/enabled' as root, and add it to your /etc/rc.local in order to retain the setting after a reboot. Redis must be restarted after THP is disabled.
redis_1  | 1:M 01 Jul 07:46:52.065 * DB loaded from disk: 0.000 seconds
redis_1  | 1:M 01 Jul 07:46:52.065 * Ready to accept connections
flask_v2ex |  * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
flask_v2ex |  * Restarting with stat
flask_v2ex |  * Debugger is active!
flask_v2ex |  * Debugger PIN: 742-073-002

可以看到 Docker 守护进程里监听着 5000 端口了。可以通过http://localhost:5000 访问 Flask 应用。

docker-compose 使用

• docker-compose up -d : 后台运行
• docker-compose stop: 停止正在运行的服务
• docker-compose down: 关闭所有容器并删除，默认保留 数据卷
• docker-compose ps：列出当前运行的服务状态和相关信息

$ docker-compose ps
       Name                     Command               State           Ports
------------------------------------------------------------------------------------
flask_v2ex           /bin/sh -c python manage.p ...   Up      0.0.0.0:5000->5000/tcp
flask_v2ex_redis_1   docker-entrypoint.sh redis ...   Up      6379/tcp

• docker-compose run: 一次性命令。 例如查看 web 服务的环境变量:

$ docker-compose run web env 

PATH=/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
HOSTNAME=e4b6b17f39dc
TERM=xterm
LANG=C.UTF-8
GPG_KEY=97FC712E4C024BBEA48A61ED3A5CA953F73C700D
PYTHON_VERSION=3.5.4
PYTHON_PIP_VERSION=9.0.1
HOME=/root

如果需要停止已经运行中的服务，可以通过ctrl + c 或者 docker-compose stop 来停止服务。

参考

Docker从入门到实践 --实战Django
使用Dockerfile构建Docker镜像