Развёртывание с 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 = '%s.tar.gz' % dist

    # upload the package to the temporary folder on the server
    put('dist/%s' % filename, '/tmp/%s' % filename)

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

    # remove the uploaded package
    run('rm -r /tmp/%s' % 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. Сначала он выполнит упаковку, чтобы у нас был готов наш архив, а затем выполнит deploy и загрузит исходный код на все серверы и установит его там. Благодаря файлу setup.py мы автоматически подтянем необходимые библиотеки в нашу виртуальную среду.

Следующие шаги

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

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

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