TOC

Как обслуживать колбу с помощью Gunicorn и Nginx на CentOS 7

Вступление

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

Предпосылки

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

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

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

Установите компоненты из репозиториев CentOS и EPEL

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

Вы можете включить репо EPEL, набрав: 

sudo yum install epel-release

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

Вы можете установить все эти компоненты, набрав: 

sudo yum install python-pip python-devel gcc 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.

Создать системный файл модуля

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

Для начала создайте файл, заканчивающийся на.service, в каталоге/etc/systemd/system: 

sudo nano /etc/systemd/system/myproject.service

Внутри мы начнем с раздела[Unit], который используется для указания метаданных и зависимостей. Мы разместим здесь описание нашего сервиса и сообщим системе init, что запускать его нужно только после достижения цели сети: 

[Unit]
Description=Gunicorn instance to serve myproject
After=network.target

Затем мы откроем раздел[Service]. Мы укажем пользователя и группу, под которой мы хотим запустить процесс. Мы дадим право нашей учетной записи обычного пользователя на процесс, поскольку он владеет всеми соответствующими файлами. Мы передадим право владения группой пользователей Nginx, чтобы она могла легко взаимодействовать с процессами Gunicorn.

Затем мы составим карту рабочего каталога и установим переменную окруженияPATH, чтобы система инициализации знала, где находятся наши исполняемые файлы для процесса (в нашей виртуальной среде). Затем мы укажем команду для запуска службы. Systemd требует, чтобы мы указали полный путь к исполняемому файлу Gunicorn, который установлен в нашей виртуальной среде.

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

[Unit]
Description=Gunicorn instance to serve myproject
After=network.target

[Service]
User=user
Group=nginx
WorkingDirectory=/home/user/myproject
Environment="PATH=/home/user/myproject/myprojectenv/bin"
ExecStart=/home/user/myproject/myprojectenv/bin/gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi

Последний фрагмент, который нам нужно добавить в файл, - это раздел[Install]. Это скажет Systemd, с чем связать этот сервис, если мы включим его при загрузке. Мы хотим, чтобы эта служба запускалась, когда обычная многопользовательская система запущена и работает: 

[Unit]
Description=Gunicorn instance to serve myproject
After=network.target

[Service]
User=user
Group=nginx
WorkingDirectory=/home/user/myproject
Environment="PATH=/home/user/myproject/myprojectenv/bin"
ExecStart=/home/user/myproject/myprojectenv/bin/gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi

[Install]
WantedBy=multi-user.target

На этом наш сервисный файл Systemd завершен. Сохраните и закройте его сейчас.

Теперь мы можем запустить созданную нами службу Gunicorn и включить ее так, чтобы она запускалась при загрузке: 

sudo systemctl start myproject
sudo systemctl enable myproject

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

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

Начните с открытия файла конфигурации Nginx по умолчанию: 

sudo nano /etc/nginx/nginx.conf

Откройте серверный блок чуть выше другого блокаserver {}, который уже находится в файле: 

http {
    . . .

    include /etc/nginx/conf.d/*.conf;

    server {
    }

    server {
        listen 80 default_server;

        . . .

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

server {
    listen 80;
    server_name server_domain_or_IP;
}

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

server {
    listen 80;
    server_name server_domain_or_IP;

    location / {
        proxy_set_header Host $http_host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_pass http://unix:/home/user/myproject/myproject.sock;
    }
}

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

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

Вы можете добавить пользователяnginx в свою группу пользователей с помощью следующей команды. Заменитеuser своим именем пользователя в команде: 

sudo usermod -a -G user nginx

Теперь мы можем дать нашей группе пользователей права на выполнение в нашем домашнем каталоге. Это позволит процессу Nginx входить и получать доступ к контенту в пределах: 

chmod 710 /home/user

С установленными разрешениями мы можем проверить наш файл конфигурации Nginx на наличие синтаксических ошибок: 

sudo nginx -t

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

sudo systemctl start nginx
sudo systemctl enable nginx

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

Flask sample app

Заключение

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

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

Related