Развёртывание с Fabric

Fabric — это инструмент для Python, похожий на Makefiles, но с возможностью выполнения команд на удалённом сервере. В сочетании с правильно настроенным пакетом Python (Большие приложения как пакеты) и хорошей концепцией конфигураций (Обработка конфигураций) очень легко развертывать приложения Flask на внешних серверах.

Прежде чем начать, вот быстрый контрольный список вещей, которые мы должны гарантировать заранее:

Fabric 1.0 должен быть установлен локально. В этом руководстве предполагается использование последней версии Fabric.
Приложение должно уже быть пакетом и требует наличия работающего файла setup.py (Развертывание с помощью Setuptools).
В следующем примере мы используем mod_wsgi для удалённых серверов. Конечно, вы можете использовать свой любимый сервер, но в этом примере мы выбрали Apache + mod_wsgi, потому что его очень легко настроить и он имеет простой способ перезагрузки приложений без прав root.

Создание первого Fabfile

Fabfile — это то, что управляет тем, что выполняет Fabric. Он называется fabfile.py и выполняется командой fab. Все функции, определённые в этом файле, появятся как подкоманды fab. Они выполняются на одном или нескольких хостах. Эти хосты могут быть определены либо в fabfile, либо в командной строке. В этом случае мы добавим их в fabfile.

Вот базовый пример, который может загрузить текущий исходный код на сервер и установить его в существующей виртуальной среде:

from fabric.api import *

# the user to use for the remote commands
env.user = 'appuser'
# the servers where the commands are executed
env.hosts = ['server1.example.com', 'server2.example.com']

def pack():
    # build the package
    local('python setup.py sdist --formats=gztar', capture=False)

def deploy():
    # figure out the package name and version
    dist = local('python setup.py --fullname', capture=True).strip()
    filename = f'{dist}.tar.gz'

    # upload the package to the temporary folder on the server
    put(f'dist/{filename}', f'/tmp/{filename}')

    # install the package in the application's virtualenv with pip
    run(f'/var/www/yourapplication/env/bin/pip install /tmp/{filename}')

    # remove the uploaded package
    run(f'rm -r /tmp/{filename}')

    # touch the .wsgi file to trigger a reload in mod_wsgi
    run('touch /var/www/yourapplication.wsgi')

Выполнение Fabfile

Теперь как выполнить этот fabfile? Вы используете команду fab. Чтобы развернуть текущую версию кода на удалённом сервере, вы бы использовали следующую команду:

$ fab pack deploy

Однако это требует, чтобы на нашем сервере уже была создана папка /var/www/yourapplication и /var/www/yourapplication/env была виртуальной средой. Кроме того, мы не создаём файл конфигурации или .wsgi на сервере. Итак, как мы инициализируем новый сервер в нашей инфраструктуре?

Это теперь зависит от количества серверов, которые мы хотим настроить. Если у нас всего один сервер приложений (что характерно для большинства приложений), создание команды в fabfile для этого избыточно. Но, очевидно, вы можете это сделать. В таком случае вы, вероятно, назовёте её setup или bootstrap, а затем передадите имя сервера явно в командной строке:

$ fab -H newserver.example.com bootstrap

Чтобы настроить новый сервер, выполните примерно следующие шаги:

Создайте структуру каталогов в /var/www:

$ mkdir /var/www/yourapplication
$ cd /var/www/yourapplication
$ virtualenv --distribute env

Загрузите новый файл application.wsgi на сервер и файл конфигурации приложения (например, application.cfg)
Создайте новую конфигурацию Apache для yourapplication и активируйте её. Убедитесь, что активирована функция отслеживания изменений файла .wsgi, чтобы мы могли автоматически перезагрузить приложение, изменив этот файл. См. mod_wsgi (Apache).

Итак, теперь вопрос в том, откуда берутся файлы application.wsgi и application.cfg?

Файл WSGI

Файл WSGI должен импортировать приложение и также установить переменную среды, чтобы приложение знало, где искать конфигурацию. Вот короткий пример, который делает именно это:

import os
os.environ['YOURAPPLICATION_CONFIG'] = '/var/www/yourapplication/application.cfg'
from yourapplication import app

Само приложение затем должно инициализироваться так, чтобы искать конфигурацию по этой переменной среды:

app = Flask(__name__)
app.config.from_object('yourapplication.default_config')
app.config.from_envvar('YOURAPPLICATION_CONFIG')

Этот подход подробно описан в разделе Обработки конфигураций документации.

Файл конфигурации

Как упоминалось выше, приложение найдёт правильный файл конфигурации, посмотрев переменную среды YOURAPPLICATION_CONFIG. Поэтому мы должны поместить конфигурацию в место, где приложение сможет её найти. Файлы конфигурации обладают недружелюбным свойством, различаясь на всех компьютерах, поэтому их обычно не включают в систему контроля версий.

Популярный подход заключается в хранении файлов конфигурации для разных серверов в отдельном репозитории системы контроля версий и их проверке на всех серверах. Затем файл, активный для сервера, символически связан в ожидаемое место (например: /var/www/yourapplication).

В любом случае, в нашем случае мы ожидаем только один или два сервера и можем загрузить их заранее вручную.

Первое развёртывание

Теперь мы можем выполнить первое развёртывание. Мы настроили серверы так, что они имеют свои виртуальные среды и активированные конфигурации apache. Теперь мы можем упаковать приложение и развернуть его:

$ fab pack deploy

Fabric теперь подключится ко всем серверам и выполнит команды, как они написаны в fabfile. Сначала он выполнит pack, чтобы подготовить наш tarball, а затем выполнит deploy, загрузит исходный код на все серверы и установит его там. Благодаря файлу setup.py мы автоматически подключим необходимые библиотеки к нашей виртуальной среде.

Дальнейшие шаги

С этого момента можно сделать многое, чтобы сделать развёртывание действительно приятным:

Создайте команду bootstrap, которая инициализирует новые серверы. Она может инициализировать новую виртуальную среду, должным образом настроить apache и т. д.
Поместите файлы конфигурации в отдельный репозиторий системы контроля версий и символически свяжите активные конфигурации в нужное место.
Вы также можете поместить свой код приложения в репозиторий и проверить последнюю версию на сервере, а затем установить. Таким образом, вы также можете легко вернуться к предыдущим версиям.
Включите функциональность тестирования, чтобы вы могли развернуть приложение на внешнем сервере и запустить набор тестов.

Работа с Fabric увлекательна, и вы заметите, что написание команды fab deploy и автоматическое развертывание вашего приложения на один или несколько удаленных серверов — это довольно магическое действие.