Как обслуживать приложения Flask с помощью uWSGI и Nginx в Ubuntu 14.04

Вступление

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

Предпосылки

Перед началом работы с этим руководством на вашем сервере должен быть настроен пользователь без полномочий root. Этот пользователь должен иметь права + sudo +, чтобы он мог выполнять административные функции. Чтобы узнать, как это настроить, следуйте нашему https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-14-04 руководство по установке исходного сервера].

Чтобы узнать больше о uWSGI, нашем сервере приложений и спецификации WSGI, вы можете прочитать связанный раздел https://www.digitalocean.com/community/tutorials/how-to-set-up-uwsgi-and-nginx-to -serve-python-apps-on-ubuntu-14-04 # определения и концепции [это руководство]. Понимание этих концепций облегчит следовать этому руководству.

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

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

Нашим первым шагом будет установка всех необходимых нам частей из репозиториев. Мы установим + pip +, менеджер пакетов Python, чтобы установить и управлять нашими компонентами Python. Мы также получим файлы для разработки на Python, необходимые для сборки uWSGI, и сейчас мы также установим 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 ~/
cd ~/

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

virtualenv

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

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

source /bin/activate

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

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

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

Установите Flask и uWSGI

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

pip install uwsgi flask

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

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

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

nano ~//.py

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

from flask import Flask
application = Flask(__name__)

@application.route("/")
def hello():
   return "<h1 style='color:blue'>Hello There!</h1>"

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

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

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

python .py

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

изображение: https: //assets.digitalocean.com/articles/nginx_uwsgi_wsgi_1404/test_app.png [Пример приложения Flask]

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

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

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

Мы назовем файл + wsgi.py +:

nano ~//wsgi.py

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

from  import application

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

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

Настроить uWSGI

Наше заявление написано, и наша точка входа установлена. Теперь мы можем перейти к uWSGI.

Тестирование uWSGI Serving

Первое, что мы сделаем, это протестируем, чтобы убедиться, что uWSGI может обслуживать наше приложение.

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

uwsgi --socket 0.0.0.0:8000 --protocol=http -w wsgi

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

изображение: https: //assets.digitalocean.com/articles/nginx_uwsgi_wsgi_1404/test_app.png [Пример приложения Flask]

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

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

deactivate

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

Создание файла конфигурации uWSGI

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

Поместим это в каталог нашего проекта и назовем его + myproject.ini +:

nano ~//.ini

Внутри мы начнем с заголовка + [uwsgi] +, чтобы uWSGI знал, как применить настройки. Мы определим модуль, ссылаясь на наш файл + wsgi.py +, за исключением расширения:

[uwsgi]
module = wsgi

Далее мы скажем uWSGI запустить в режиме master и запустить пять рабочих процессов для обслуживания текущих запросов:

[uwsgi]
module = wsgi

master = true
processes = 5

Когда мы тестировали, мы выставили uWSGI на сетевой порт. Однако мы будем использовать Nginx для обработки реальных клиентских подключений, которые затем будут передавать запросы в uWSGI. Поскольку эти компоненты работают на одном и том же компьютере, предпочтительным является сокет Unix, поскольку он более безопасный и быстрый. Мы вызовем сокет + myproject.sock + и поместим его в этот каталог.

Мы также должны изменить разрешения для сокета. Позже мы передадим группе Nginx право собственности на процесс uWSGI, поэтому нам нужно убедиться, что владелец группы сокета может читать информацию из нее и записывать в нее. Мы также очистим сокет, когда процесс остановится, добавив опцию «вакуум»:

[uwsgi]
module = wsgi

master = true
processes = 5

socket = .sock
chmod-socket = 660
vacuum = true

Последнее, что нам нужно сделать, это установить опцию + die-on-term +. Это необходимо, потому что система инициации Upstart и uWSGI имеют разные представления о том, что должны означать разные сигналы процесса. Установка этого выравнивает два системных компонента, реализуя ожидаемое поведение:

[uwsgi]
module = wsgi

master = true
processes = 5

socket = .sock
chmod-socket = 660
vacuum = true

die-on-term = true

Возможно, вы заметили, что мы не указали протокол, как мы это сделали из командной строки. Это связано с тем, что по умолчанию uWSGI говорит с использованием протокола + uwsgi +, быстрого двоичного протокола, предназначенного для взаимодействия с другими серверами. Nginx может говорить по этому протоколу изначально, поэтому лучше использовать его, чем форсировать связь по HTTP.

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

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

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

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

sudo nano /etc/init/.conf

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

description "uWSGI server instance configured to serve "

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

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

description "uWSGI server instance configured to serve "

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

setuid
setgid www-data

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

description "uWSGI server instance configured to serve "

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

setuid
setgid www-data

env PATH=/home////bin
chdir /home//
exec uwsgi --ini .ini

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

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

sudo start

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

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

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

sudo nano /etc/nginx/sites-available/

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

server {
   listen 80;
   server_name ;
}

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

server {
   listen 80;
   server_name ;

   location / {
       include uwsgi_params;
       uwsgi_pass unix:/home///.sock;
   }
}

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

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

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

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

sudo nginx -t

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

sudo service nginx restart

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

изображение: https: //assets.digitalocean.com/articles/nginx_uwsgi_wsgi_1404/test_app.png [Пример приложения Flask]

Заключение

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

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

Related