TOC

Как обслуживать колбу с помощью Gunicorn и Nginx в Ubuntu 14.04

Вступление

В этом руководстве мы будем настраивать простое приложение Python с использованием микро-фреймворка Flask в Ubuntu 14.04. Основная часть этой статьи будет посвящена тому, как настроить сервер приложений Gunicorn для запуска приложения и Nginx в качестве внешнего прокси-сервера.

Предпосылки

Перед началом работы с этим руководством на вашем сервере должен быть настроен пользователь без полномочий root. У этого пользователя должны быть праваsudo, чтобы он мог выполнять административные функции. Чтобы узнать, как это настроить, следуйте нашимinitial server setup guide.

Чтобы узнать больше о спецификации WSGI, которую наш сервер приложений будет использовать для связи с нашим приложением Flask, вы можете прочитать связанный разделthis guide. Понимание этих концепций облегчит следовать этому руководству.

Когда вы будете готовы продолжить, читайте дальше.

Установите компоненты из репозитория Ubuntu

Нашим первым шагом будет установка всех необходимых нам частей из репозиториев. Мы установимpip, менеджер пакетов Python, чтобы устанавливать наши компоненты Python и управлять ими. Мы также получим файлы для разработки на Python, необходимые для сборки некоторых компонентов Gunicorn. Мы также установим Nginx сейчас.

Обновите локальный индекс пакетов, а затем установите пакеты, набрав: 

sudo apt-get update
sudo apt-get install python-pip python-dev nginx

Создать виртуальную среду Python

Затем мы настроим виртуальную среду, чтобы изолировать наше приложение Flask от других файлов Python в системе.

Начните с установки пакетаvirtualenv, используяpip: 

sudo pip install virtualenv

Теперь мы можем создать родительский каталог для нашего проекта Flask. Перейдите в каталог после его создания: 

mkdir ~/myproject
cd ~/myproject

Мы можем создать виртуальную среду для хранения требований Python нашего проекта Flask, набрав: 

virtualenv myprojectenv

Это установит локальную копию Python иpip в каталог с именемmyprojectenv в каталоге вашего проекта.

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

source myprojectenv/bin/activate

Ваше приглашение изменится, чтобы указать, что вы сейчас работаете в виртуальной среде. Это будет выглядеть примерно так(myprojectenv)user@host:~/myproject$.

Установите приложение для колб

Теперь, когда вы находитесь в своей виртуальной среде, мы можем установить Flask и Gunicorn и приступить к разработке нашего приложения:

Установите колбу и Gunicorn

Мы можем использовать локальный экземплярpip для установки Flask и Gunicorn. Введите следующие команды, чтобы получить эти два компонента: 

pip install gunicorn flask

Создать образец приложения

Теперь, когда у нас есть Flask, мы можем создать простое приложение. Колба - это микрорамка. Он не включает в себя многие инструменты, которые могут иметь более полнофункциональные фреймворки, и существует в основном как модуль, который вы можете импортировать в свои проекты, чтобы помочь вам при инициализации веб-приложения.

Хотя ваше приложение может быть более сложным, мы создадим наше приложение Flask в одном файле, который мы назовемmyproject.py: 

nano ~/myproject/myproject.py

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

from flask import Flask
application = Flask(__name__)

@application.route("/")
def hello():
    return "
Hello There!
"

if __name__ == "__main__":
    application.run(host='0.0.0.0')

Это в основном определяет, какой контент представить при доступе к корневому домену. Сохраните и закройте файл, когда вы закончите.

Вы можете проверить свое приложение Flask, набрав: 

python myproject.py

Посетите доменное имя или IP-адрес вашего сервера, а затем номер порта, указанный в выводе терминала (скорее всего,:5000) в вашем веб-браузере. Вы должны увидеть что-то вроде этого:

Flask sample app

Когда вы закончите, несколько раз нажмите CTRL-C в окне терминала, чтобы остановить сервер разработки Flask.

Создать точку входа WSGI

Далее мы создадим файл, который будет служить точкой входа для нашего приложения. Это скажет нашему серверу Gunicorn, как взаимодействовать с приложением.

Назовем файлwsgi.py: 

nano ~/myproject/wsgi.py

Файл невероятно прост, мы можем просто импортировать экземпляр Flask из нашего приложения и затем запустить его: 

from myproject import application

if __name__ == "__main__":
    application.run()

Сохраните и закройте файл, когда вы закончите.

Тестирование способности Gunicorn служить проекту

Прежде чем двигаться дальше, мы должны проверить, что Gunicorn может правильно.

Мы можем сделать это, просто передав ему имя нашей точки входа. Мы также определим интерфейс и порт для привязки, чтобы он запускался на общедоступном интерфейсе: 

cd ~/myproject
gunicorn --bind 0.0.0.0:8000 wsgi

Если вы посетите доменное имя или IP-адрес своего сервера с добавлением:8000 в конце в вашем веб-браузере, вы должны увидеть страницу, которая выглядит следующим образом:

Flask sample app

Когда вы подтвердите, что он работает правильно, нажмите CTRL-C в окне терминала.

Теперь мы закончили с нашей виртуальной средой, поэтому мы можем ее деактивировать: 

deactivate

Любые операции теперь будут выполняться в системной среде Python.

Создать сценарий Upstart

Следующая часть, о которой нам нужно позаботиться, это сценарий Upstart. Создание сценария Upstart позволит системе инициализации Ubuntu автоматически запускать Gunicorn и обслуживать наше приложение Flask при каждой загрузке сервера.

Создайте файл сценария, заканчивающийся на.conf, в каталоге/etc/init, чтобы начать: 

sudo nano /etc/init/myproject.conf

Внутри мы начнем с простого описания цели скрипта. Сразу после этого мы определим условия, при которых этот скрипт будет запускаться и останавливаться системой. Обычные числа времени выполнения системы - 2, 3, 4 и 5, поэтому мы скажем ему запустить наш скрипт, когда система достигнет одного из этих уровней запуска. Мы скажем, чтобы он остановился на любом другом уровне выполнения (например, когда сервер перезагружается, выключается или в однопользовательском режиме): 

description "Gunicorn application server running myproject"

start on runlevel [2345]
stop on runlevel [!2345]

Мы сообщим системе инициализации, что она должна перезапустить процесс, если он когда-нибудь потерпит неудачу. Далее нам нужно определить пользователя и группу, под которой будет запускаться Gunicorn. Все наши файлы проекта принадлежат нашей собственной учетной записи пользователя, поэтому мы будем устанавливать себя в качестве пользователя для запуска. Сервер Nginx работает в группеwww-data. Нам нужно, чтобы Nginx мог читать и записывать в файл сокета, поэтому мы передадим этой группе право собственности на процесс: 

description "Gunicorn application server running myproject"

start on runlevel [2345]
stop on runlevel [!2345]

respawn
setuid user
setgid www-data

Далее нам нужно настроить процесс так, чтобы он мог правильно находить наши файлы и обрабатывать их. Мы установили все наши компоненты Python в виртуальную среду, поэтому нам нужно установить переменную среды с этим путем. Нам также нужно перейти в наш каталог проектов. После этого мы можем просто вызвать приложение Gunicorn с опциями, которые мы хотели бы использовать.

Мы скажем ему запустить 3 рабочих процесса (при необходимости измените это). Мы также укажем ему создать и привязать файл сокета Unix в каталоге нашего проекта под названиемmyproject.sock. Мы установим значение umask007, чтобы файл сокета был создан, предоставляя доступ владельцу и группе, ограничивая при этом другой доступ. Наконец, нам нужно передать имя файла точки входа WSGI: 

description "Gunicorn application server running myproject"

start on runlevel [2345]
stop on runlevel [!2345]

respawn
setuid user
setgid www-data

env PATH=/home/user/myproject/myprojectenv/bin
chdir /home/user/myproject
exec gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi

Сохраните и закройте файл, когда вы закончите.

Вы можете сразу начать процесс, набрав: 

sudo start myproject

Настройка запросов Nginx к прокси

Наш сервер приложений Gunicorn теперь должен быть запущен и ожидает запросов к файлу сокета в каталоге проекта. Нам нужно настроить Nginx для передачи веб-запросов в этот сокет, внеся несколько небольших дополнений в его файл конфигурации.

Начните с создания нового файла конфигурации серверного блока в каталоге Nginxsites-available. Мы просто назовем этоmyproject, чтобы соответствовать остальной части руководства: 

sudo nano /etc/nginx/sites-available/myproject

Откройте блок сервера и скажите Nginx прослушивать порт 80 по умолчанию. Мы также должны указать ему использовать этот блок для запросов на доменное имя или IP-адрес нашего сервера: 

server {
    listen 80;
    server_name server_domain_or_IP;
}

Единственное, что нам нужно добавить - это блок местоположения, соответствующий каждому запросу. В этот блок мы включим файлproxy_params, который определяет некоторые общие параметры проксирования, которые необходимо установить. Затем мы передадим запросы в сокет, который мы определили с помощью директивыproxy_pass: 

server {
    listen 80;
    server_name server_domain_or_IP;

    location / {
        include proxy_params;
        proxy_pass http://unix:/home/user/myproject/myproject.sock;
    }
}

Это фактически все, что нам нужно для обслуживания нашего приложения. Сохраните и закройте файл, когда вы закончите.

Чтобы включить только что созданную конфигурацию блока сервера Nginx, свяжите файл с каталогомsites-enabled: 

sudo ln -s /etc/nginx/sites-available/myproject /etc/nginx/sites-enabled

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

sudo nginx -t

Если это возвращается без указания каких-либо проблем, мы можем перезапустить процесс Nginx, чтобы прочитать нашу новую конфигурацию: 

sudo service nginx restart

Теперь вы сможете перейти к доменному имени или IP-адресу вашего сервера в веб-браузере и увидеть свое приложение:

Flask sample app

Заключение

В этом руководстве мы создали простое приложение Flask в виртуальной среде Python. Мы создаем точку входа WSGI, чтобы любой сервер приложений с поддержкой WSGI мог взаимодействовать с ней, а затем настроили сервер приложений Gunicorn для обеспечения этой функции. После этого мы создали скрипт Upstart для автоматического запуска сервера приложений при загрузке. Мы создали серверный блок Nginx, который передает трафик веб-клиента на сервер приложений, передавая внешние запросы.

Flask - это очень простая, но чрезвычайно гибкая структура, предназначенная для обеспечения функциональности ваших приложений, не слишком ограничивая структуру и дизайн. Вы можете использовать общий стек, описанный в этом руководстве, для обслуживания разработанных вами колб.

Related