TOC

Servieren von Kolbenanwendungen mit Gunicorn und Nginx unter Ubuntu 14.04

Einführung

In diesem Handbuch richten wir eine einfache Python-Anwendung mit dem Flask-Micro-Framework unter Ubuntu 14.04 ein. Der Großteil dieses Artikels befasst sich mit der Einrichtung des Gunicorn-Anwendungsservers zum Starten der Anwendung und von Nginx als Front-End-Reverse-Proxy.

Voraussetzungen

Bevor Sie mit diesem Handbuch beginnen, sollte auf Ihrem Server ein Benutzer ohne Rootberechtigung konfiguriert sein. Dieser Benutzer muss über die Berechtigungen vonsudoverfügen, damit er Verwaltungsfunktionen ausführen kann. Befolgen Sie unsereinitial server setup guide, um zu erfahren, wie Sie dies einrichten.

Um mehr über die WSGI-Spezifikation zu erfahren, die unser Anwendungsserver für die Kommunikation mit unserer Flask-App verwendet, können Sie den verknüpften Abschnitt vonthis guide lesen. Das Verständnis dieser Konzepte erleichtert das Befolgen dieser Anleitung.

Wenn Sie bereit sind fortzufahren, lesen Sie weiter.

Installieren Sie die Komponenten aus den Ubuntu-Repositories

Unser erster Schritt wird sein, alle Teile, die wir brauchen, aus den Repositories zu installieren. Wir werdenpip, den Python-Paketmanager, installieren, um unsere Python-Komponenten zu installieren und zu verwalten. Wir erhalten auch die Python-Entwicklungsdateien, die zum Erstellen einiger Gunicorn-Komponenten benötigt werden. Wir werden jetzt auch Nginx installieren.

Aktualisieren Sie Ihren lokalen Paketindex und installieren Sie die Pakete, indem Sie Folgendes eingeben: 

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

Erstellen Sie eine virtuelle Python-Umgebung

Als Nächstes richten wir eine virtuelle Umgebung ein, um unsere Flask-Anwendung von den anderen Python-Dateien auf dem System zu isolieren.

Beginnen Sie mit der Installation des Paketsvirtualenv mitpip: 

sudo pip install virtualenv

Jetzt können wir ein übergeordnetes Verzeichnis für unser Flask-Projekt erstellen. Wechseln Sie in das Verzeichnis, nachdem Sie es erstellt haben: 

mkdir ~/myproject
cd ~/myproject

Wir können eine virtuelle Umgebung zum Speichern der Python-Anforderungen unseres Flask-Projekts erstellen, indem Sie Folgendes eingeben: 

virtualenv myprojectenv

Dadurch wird eine lokale Kopie von Python undpip in einem Verzeichnis namensmyprojectenv in Ihrem Projektverzeichnis installiert.

Bevor wir Anwendungen in der virtuellen Umgebung installieren, müssen wir sie aktivieren. Sie können dies tun, indem Sie Folgendes eingeben: 

source myprojectenv/bin/activate

Ihre Eingabeaufforderung ändert sich und zeigt an, dass Sie jetzt in der virtuellen Umgebung arbeiten. Es wird ungefähr so ​​aussehen wie(myprojectenv)user@host:~/myproject$.

Einrichten einer Kolbenanwendung

Jetzt, da Sie sich in Ihrer virtuellen Umgebung befinden, können wir Flask und Gunicorn installieren und mit dem Entwerfen unserer Anwendung beginnen:

Installieren Sie Flasche und Gunicorn

Wir können die lokale Instanz vonpip verwenden, um Flask und Gunicorn zu installieren. Geben Sie die folgenden Befehle ein, um diese beiden Komponenten abzurufen: 

pip install gunicorn flask

Erstellen Sie eine Beispiel-App

Nachdem wir Flask zur Verfügung haben, können wir eine einfache Anwendung erstellen. Der Kolben ist ein Mikrorahmen. Es enthält nicht viele der Tools, die für umfassendere Frameworks geeignet sind, und ist hauptsächlich als Modul vorhanden, das Sie in Ihre Projekte importieren können, um Sie bei der Initialisierung einer Webanwendung zu unterstützen.

Während Ihre Anwendung möglicherweise komplexer ist, erstellen wir unsere Flask-App in einer einzigen Datei, die wirmyproject.py nennen: 

nano ~/myproject/myproject.py

In dieser Datei platzieren wir unseren Anwendungscode. Grundsätzlich müssen wir flask importieren und ein Flask-Objekt instanziieren. Hiermit können wir die Funktionen definieren, die ausgeführt werden sollen, wenn eine bestimmte Route angefordert wird. Wir rufen unsere Flask-Anwendung im Codeapplication auf, um die Beispiele zu replizieren, die Sie in der WSGI-Spezifikation finden: 

from flask import Flask
application = Flask(__name__)

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

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

Dies definiert im Wesentlichen, welcher Inhalt angezeigt wird, wenn auf die Stammdomäne zugegriffen wird. Speichern und schließen Sie die Datei, wenn Sie fertig sind.

Sie können Ihre Flask-App testen, indem Sie Folgendes eingeben: 

python myproject.py

Besuchen Sie den Domainnamen oder die IP-Adresse Ihres Servers, gefolgt von der in der Terminalausgabe angegebenen Portnummer (höchstwahrscheinlich:5000) in Ihrem Webbrowser. Sie sollten so etwas sehen:

Flask sample app

Wenn Sie fertig sind, drücken Sie einige Male STRG-C im Terminalfenster, um den Flask-Entwicklungsserver zu stoppen.

Erstellen Sie den WSGI-Einstiegspunkt

Als Nächstes erstellen wir eine Datei, die als Einstiegspunkt für unsere Anwendung dient. Dies teilt unserem Gunicorn-Server mit, wie er mit der Anwendung interagieren soll.

Wir werden die Dateiwsgi.py aufrufen: 

nano ~/myproject/wsgi.py

Die Datei ist unglaublich einfach. Wir können einfach die Flask-Instanz aus unserer Anwendung importieren und dann ausführen: 

from myproject import application

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

Speichern und schließen Sie die Datei, wenn Sie fertig sind.

Testen von Gunicorns Fähigkeit, dem Projekt zu dienen

Bevor wir weitermachen, sollten wir überprüfen, ob Gunicorn richtig kann.

Wir können dies tun, indem wir einfach den Namen unseres Einstiegspunkts übergeben. Wir geben auch die Schnittstelle und den Port an, an den die Bindung erfolgen soll, damit sie auf einer öffentlich verfügbaren Schnittstelle gestartet werden: 

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

Wenn Sie den Domainnamen oder die IP-Adresse Ihres Servers mit:8000 am Ende Ihres Webbrowsers aufrufen, sollte eine Seite angezeigt werden, die folgendermaßen aussieht:

Flask sample app

Wenn Sie die ordnungsgemäße Funktion bestätigt haben, drücken Sie STRG-C in Ihrem Terminalfenster.

Wir sind jetzt mit unserer virtuellen Umgebung fertig und können sie deaktivieren: 

deactivate

Alle Vorgänge werden jetzt in der Python-Umgebung des Systems ausgeführt.

Erstellen Sie ein Upstart-Skript

Das nächste Stück, um das wir uns kümmern müssen, ist das Upstart-Skript. Das Erstellen eines Upstart-Skripts ermöglicht Ubuntus Init-System, Gunicorn automatisch zu starten und unsere Flask-Anwendung zu bedienen, wenn der Server startet.

Erstellen Sie eine Skriptdatei mit der Endung.conf im Verzeichnis/etc/init, um zu beginnen: 

sudo nano /etc/init/myproject.conf

Im Folgenden beginnen wir mit einer einfachen Beschreibung des Zwecks des Skripts. Unmittelbar danach definieren wir die Bedingungen, unter denen dieses Skript vom System gestartet und gestoppt wird. Die normalen Systemlaufzeitnummern sind 2, 3, 4 und 5. Wir weisen Sie daher an, unser Skript zu starten, wenn das System einen dieser Runlevel erreicht. Wir werden es anweisen, auf jedem anderen Runlevel anzuhalten (z. B. wenn der Server neu startet, herunterfährt oder sich im Einzelbenutzermodus befindet): 

description "Gunicorn application server running myproject"

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

Wir teilen dem init-System mit, dass es den Prozess neu starten soll, falls er jemals fehlschlägt. Als nächstes müssen wir den Benutzer und die Gruppe definieren, als die Gunicorn ausgeführt werden soll. Unsere Projektdateien gehören sämtlich unserem eigenen Benutzerkonto, sodass wir uns selbst als ausführenden Benutzer festlegen. Der Nginx-Server wird unter der Gruppewww-dataausgeführt. Wir brauchen Nginx, um in der Lage zu sein, aus der Socket-Datei zu lesen und in diese zu schreiben. 

description "Gunicorn application server running myproject"

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

respawn
setuid user
setgid www-data

Als Nächstes müssen wir den Prozess so einrichten, dass er unsere Dateien korrekt findet und verarbeitet. Wir haben alle unsere Python-Komponenten in einer virtuellen Umgebung installiert. Daher müssen wir als Pfad eine Umgebungsvariable festlegen. Wir müssen auch in unser Projektverzeichnis wechseln. Anschließend können wir einfach die Gunicorn-Anwendung mit den Optionen aufrufen, die wir verwenden möchten.

Wir werden es anweisen, 3 Worker-Prozesse zu starten (passen Sie dies nach Bedarf an). Wir werden es auch anweisen, eine Unix-Socket-Datei in unserem Projektverzeichnis mit dem Namenmyproject.sock zu erstellen und an diese zu binden. Wir setzen einen umask-Wert von007, damit die Socket-Datei erstellt wird, die den Zugriff auf den Eigentümer und die Gruppe ermöglicht, während der andere Zugriff eingeschränkt wird. Schließlich müssen wir den WSGI-Einstiegspunkt-Dateinamen übergeben: 

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

Speichern und schließen Sie die Datei, wenn Sie fertig sind.

Sie können den Vorgang sofort starten, indem Sie Folgendes eingeben: 

sudo start myproject

Konfigurieren von Nginx für Proxy-Anforderungen

Unser Gunicorn-Anwendungsserver sollte nun betriebsbereit sein und auf Anforderungen in der Socket-Datei im Projektverzeichnis warten. Wir müssen Nginx so konfigurieren, dass Webanforderungen an diesen Socket weitergeleitet werden, indem wir einige kleine Ergänzungen zu seiner Konfigurationsdatei vornehmen.

Beginnen Sie mit der Erstellung einer neuen Serverblock-Konfigurationsdatei imsites-available-Verzeichnis von Nginx. Wir nennen diesemyproject einfach, um mit dem Rest des Handbuchs Schritt zu halten: 

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

Öffnen Sie einen Serverblock und weisen Sie Nginx an, den Standardport 80 abzuhören. Wir müssen es auch anweisen, diesen Block für Anfragen nach dem Domainnamen oder der IP-Adresse unseres Servers zu verwenden: 

server {
    listen 80;
    server_name server_domain_or_IP;
}

Das einzige andere, was wir hinzufügen müssen, ist ein Standortblock, der zu jeder Anfrage passt. In diesem Block enthalten wir die Dateiproxy_params, in der einige allgemeine Proxy-Parameter angegeben sind, die festgelegt werden müssen. Anschließend übergeben wir die Anforderungen an den Socket, den wir mit der Direktiveproxy_passdefiniert haben: 

server {
    listen 80;
    server_name server_domain_or_IP;

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

Das ist eigentlich alles, was wir für unsere Anwendung benötigen. Speichern und schließen Sie die Datei, wenn Sie fertig sind.

Verknüpfen Sie die Datei mit dem Verzeichnissites-enabled, um die soeben erstellte Nginx-Serverblockkonfiguration zu aktivieren: 

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

Mit der Datei in diesem Verzeichnis können wir nach Syntaxfehlern suchen, indem wir Folgendes eingeben: 

sudo nginx -t

Wenn dies ohne Anzeichen von Problemen zurückkommt, können wir den Nginx-Prozess neu starten, um die neue Konfiguration zu lesen: 

sudo service nginx restart

Sie sollten nun in der Lage sein, den Domainnamen oder die IP-Adresse Ihres Servers in Ihrem Webbrowser aufzurufen und Ihre Anwendung anzuzeigen:

Flask sample app

Fazit

In diesem Handbuch haben wir eine einfache Flask-Anwendung in einer virtuellen Python-Umgebung erstellt. Wir erstellen einen WSGI-Einstiegspunkt, damit jeder WSGI-fähige Anwendungsserver mit ihm kommunizieren kann, und konfigurieren dann den Gunicorn-App-Server so, dass er diese Funktion bereitstellt. Anschließend haben wir ein Upstart-Skript erstellt, um den Anwendungsserver beim Booten automatisch zu starten. Wir haben einen Nginx-Serverblock erstellt, der den Webclient-Datenverkehr an den Anwendungsserver weiterleitet und externe Anforderungen weiterleitet.

Flask ist ein sehr einfaches, aber äußerst flexibles Framework, mit dem Sie Ihre Anwendungen mit Funktionen versehen können, ohne die Struktur und das Design zu stark einzuschränken. Mit dem in diesem Handbuch beschriebenen allgemeinen Stapel können Sie die von Ihnen entworfenen Kolbenanwendungen bedienen.

Related