TOC

Servieren von Kolbenanwendungen mit Gunicorn und Nginx unter Ubuntu 16.04

Einführung

In diesem Handbuch richten wir eine einfache Python-Anwendung mit dem Flask-Micro-Framework unter Ubuntu 16.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. Die spezifischen Pakete, die Sie benötigen, hängen von der Version von Python ab, die Sie für Ihr Projekt verwenden.

Wenn SiePython 2 verwenden, geben Sie Folgendes ein: 

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

Wenn Sie stattdessenPython 3 verwenden, geben Sie Folgendes ein: 

sudo apt-get update
sudo apt-get install python3-pip python3-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.

Wenn SiePython 2 verwenden, geben Sie Folgendes ein: 

sudo pip install virtualenv

Wenn SiePython 3 verwenden, geben Sie Folgendes ein: 

sudo pip3 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:

Note

[.note] # Unabhängig davon, welche Python-Version Sie verwenden, sollten Sie bei Aktivierung der virtuellen Umgebung den Befehlpip verwenden (nichtpip3).
# 

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. Wir können dies verwenden, um die Funktionen zu definieren, die ausgeführt werden sollen, wenn eine bestimmte Route angefordert wird:

~/myproject/myproject.py

from flask import Flask
app = Flask(__name__)

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

if __name__ == "__main__":
    app.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.

Wenn Sie die anfängliche Anleitung zur Serverkonfiguration befolgt haben, sollte eine UFW-Firewall aktiviert sein. Um unsere Anwendung zu testen, müssen wir den Zugriff auf Port 5000 zulassen.

Öffnen Sie Port 5000, indem Sie Folgendes eingeben: 

sudo ufw allow 5000

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

python myproject.py

Besuchen Sie den Domainnamen oder die IP-Adresse Ihres Servers, gefolgt von:5000 in Ihrem Webbrowser: 

http://server_domain_or_IP:5000

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:

~/myproject/wsgi.py

from myproject import app

if __name__ == "__main__":
    app.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. Dies wird aus dem Namen des Moduls (wie üblich abzüglich der Erweiterung.py) plus dem Namen des aufrufbaren in der Anwendung erstellt. In unserem Fall wäre dieswsgi:app.

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:5000 wsgi:app

Rufen Sie den Domainnamen oder die IP-Adresse Ihres Servers auf, und fügen Sie Folgendes in Ihrem Webbrowser hinzu: 

http://server_domain_or_IP:5000

Sie sollten die Ausgabe Ihrer Anwendung erneut sehen:

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 Python-Befehle verwenden jetzt wieder die Python-Umgebung des Systems.

Erstellen Sie eine systemd Unit-Datei

Das nächste Stück, um das wir uns kümmern müssen, ist die systemd-Service-Unit-Datei. Durch das Erstellen einer System-Unit-Datei kann Ubuntus Init-System Gunicorn automatisch starten und unsere Flask-Anwendung bei jedem Start des Servers bedienen.

Erstellen Sie eine Unit-Datei mit der Endung .service im Verzeichnis / etc / systemd / system, um zu beginnen: 

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

Im Inneren beginnen wir mit dem Abschnitt[Unit], in dem Metadaten und Abhängigkeiten angegeben werden. Wir werden hier eine Beschreibung unseres Dienstes einfügen und das init-System anweisen, diese erst zu starten, nachdem das Netzwerkziel erreicht wurde:

/etc/systemd/system/myproject.service

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

Als Nächstes öffnen wir den Abschnitt[Service]. Wir geben den Benutzer und die Gruppe an, unter denen der Prozess ausgeführt werden soll. Wir geben unserem regulären Benutzerkonto den Besitz des Prozesses, da ihm alle relevanten Dateien gehören. Wir geben derwww-data-Gruppe Gruppenbesitz, damit Nginx problemlos mit den Gunicorn-Prozessen kommunizieren kann.

Anschließend ordnen wir das Arbeitsverzeichnis zu und legen die UmgebungsvariablePATHfest, damit das Init-System weiß, wo sich die ausführbaren Dateien für den Prozess befinden (in unserer virtuellen Umgebung). Anschließend geben wir den Befehl zum Starten des Dienstes an. Systemd erfordert, dass wir den vollständigen Pfad zur ausführbaren Datei von Gunicorn angeben, die in unserer virtuellen Umgebung installiert ist.

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 und das aufrufbare Python übergeben:

/etc/systemd/system/myproject.service

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

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

Schließlich fügen wir einen Abschnitt [Installieren] hinzu. Dies teilt systemd mit, mit was dieser Dienst verknüpft werden soll, wenn er beim Booten gestartet werden kann. Wir möchten, dass dieser Dienst gestartet wird, wenn das reguläre Mehrbenutzersystem ausgeführt wird:

/etc/systemd/system/myproject.service

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

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

[Install]
WantedBy=multi-user.target

Damit ist unsere systemd-Servicedatei vollständig. Speichern und schließen Sie es jetzt.

Wir können jetzt den von uns erstellten Gunicorn-Dienst starten und aktivieren, sodass er beim Booten startet: 

sudo systemctl start myproject
sudo systemctl enable 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:

/etc/nginx/sites-available/myproject

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:

/etc/nginx/sites-available/myproject

server {
    listen 80;
    server_name server_domain_or_IP;

    location / {
        include proxy_params;
        proxy_pass http://unix:/home/sammy/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 systemctl restart nginx

Als letztes müssen wir unsere Firewall erneut anpassen. Wir brauchen keinen Zugriff mehr über Port 5000, daher können wir diese Regel entfernen. Wir können dann den Zugriff auf den Nginx-Server erlauben: 

sudo ufw delete allow 5000
sudo ufw allow 'Nginx Full'

Sie sollten nun in Ihrem Webbrowser auf den Domainnamen oder die IP-Adresse Ihres Servers zugreifen können: 

http://server_domain_or_IP

Sie sollten die Ausgabe Ihrer Anwendung sehen:

Flask sample app

Note

[.Hinweis]##

Nach der Konfiguration von Nginx sollte der nächste Schritt die Sicherung des Datenverkehrs zum Server mithilfe von SSL / TLS sein. Dies ist wichtig, da alle Informationen, einschließlich der Passwörter, ohne diese Informationen im Klartext über das Netzwerk gesendet werden.

Der einfachste Weg, ein SSL-Zertifikat zum Sichern Ihres Datenverkehrs zu erhalten, ist die Verwendung von Let's Encrypt. Folgen Siethis guide, um Let's Encrypt mit Nginx unter Ubuntu 16.04 einzurichten.

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 eine systemd-Unit-Datei 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