Django-Apps, die auf GKE ausgeführt werden, werden dynamisch dem Traffic entsprechend skaliert.
In dieser Anleitung wird davon ausgegangen, dass Sie mit der Django-Webentwicklung vertraut sind. Wenn Sie mit der Django-Entwicklung noch nicht vertraut sind, sollten Sie zuerst Ihre erste Django-Anwendung schreiben.
In dieser Anleitung wird insbesondere Django beschrieben. Sie können diesen Bereitstellungsprozess auch mit anderen Django-basierten Frameworks wie Wagtail und Django CMS verwenden.
Außerdem muss Docker installiert sein.
Lernziele
In dieser Anleitung wird Folgendes beschrieben:
- Cloud SQL-Datenbank erstellen und verbinden
- Secret-Werte von Kubernetes erstellen und verwenden
- Django-Anwendung in Google Kubernetes Engine bereitstellen
Kosten
In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:
Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen.
Hinweis
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.
-
Enable the Cloud SQL, GKE and Compute Engine APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.
-
Enable the Cloud SQL, GKE and Compute Engine APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
Umgebung vorbereiten
Beispielanwendung klonen
Den Code für die Django-Beispielanwendung finden Sie im Repository GoogleCloudPlatform/python-docs-samples auf GitHub.
Sie können entweder das Beispiel als ZIP-Datei herunterladen und entpacken oder das Repository auf Ihren lokalen Computer klonen:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Gehen Sie zum Verzeichnis mit dem Beispielcode:
Linux/macOS
cd python-docs-samples/kubernetes_engine/django_tutorial
Windows
cd python-docs-samples\kubernetes_engine\django_tutorial
Python-Einrichtung bestätigen
Diese Anleitung setzt auf Python, um die Beispielanwendung auf Ihrem Computer auszuführen. Der Beispielcode erfordert auch die Installation von Abhängigkeiten.
Weitere Informationen finden Sie im Leitfaden zur Python-Entwicklungsumgebung.
Prüfen Sie, ob Python mindestens Version 3.7 hat.
python -V
Sie sollten
Python 3.7.3
oder höher haben.Erstellen Sie eine virtuelle Python-Umgebung und installieren Sie Abhängigkeiten:
Linux/macOS
python -m venv venv source venv/bin/activate pip install --upgrade pip pip install -r requirements.txt
Windows
python -m venv env venv\scripts\activate pip install --upgrade pip pip install -r requirements.txt
Cloud SQL-Auth-Proxy herunterladen, um von Ihrem lokalen Computer aus eine Verbindung zu Cloud SQL herzustellen
Nach der Bereitstellung verwendet die Anwendung den in die Google Kubernetes Engine-Umgebung integrierten Cloud SQL Auth-Proxy, um mit der Cloud SQL-Instanz zu kommunizieren. Sie müssen jedoch eine lokale Kopie des Cloud SQL Proxys in Ihrer Entwicklungsumgebung installieren und verwenden, um die Anwendung lokal zu testen. Weitere Informationen finden Sie im Leitfaden für den Cloud SQL Auth-Proxy.
Der Cloud SQL Auth-Proxy verwendet die Cloud SQL API, um mit Ihrer SQL-Instanz zu interagieren. Dazu ist eine Authentifizierung der Anwendung über gcloud erforderlich.
Authentifizieren und rufen Sie Anmeldedaten für die API ab:
gcloud auth application-default login
Laden Sie den Cloud SQL Auth-Proxy herunter und installieren Sie ihn auf Ihrem lokalen Computer.
Linux 64-Bit
- Laden Sie den Cloud SQL Auth-Proxy herunter:
wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy
- Machen Sie den Cloud SQL Auth-Proxy ausführbar:
chmod +x cloud_sql_proxy
Linux 32-Bit
- Laden Sie den Cloud SQL Auth-Proxy herunter:
wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.386 -O cloud_sql_proxy
- Wenn der Befehl
wget
nicht gefunden wird, führen Siesudo apt-get install wget
aus und wiederholen Sie den Downloadbefehl. - Machen Sie den Cloud SQL Auth-Proxy ausführbar:
chmod +x cloud_sql_proxy
macOS 64-Bit
- Laden Sie den Cloud SQL Auth-Proxy herunter:
curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.amd64
- Machen Sie den Cloud SQL Auth-Proxy ausführbar:
chmod +x cloud_sql_proxy
macOS 32-Bit
- Laden Sie den Cloud SQL Auth-Proxy herunter:
curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.386
- Machen Sie den Cloud SQL Auth-Proxy ausführbar:
chmod +x cloud_sql_proxy
Mac M1
- Laden Sie den Cloud SQL Auth-Proxy herunter:
curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.arm64
- Machen Sie den Cloud SQL Auth-Proxy ausführbar:
chmod +x cloud_sql_proxy
Windows 64-Bit
Klicken Sie mit der rechten Maustaste auf https://dl.google.com/cloudsql/cloud_sql_proxy_x64.exe, wählen Sie Link speichern unter aus und laden Sie den Cloud SQL Auth-Proxy herunter. Benennen Sie die Datei incloud_sql_proxy.exe
um.Windows 32-Bit
Klicken Sie mit der rechten Maustaste auf https://dl.google.com/cloudsql/cloud_sql_proxy_x86.exe, wählen Sie Link speichern unter aus und laden Sie den Cloud SQL Auth-Proxy herunter. Benennen Sie die Datei incloud_sql_proxy.exe
um.Docker-Image des Cloud SQL Auth-Proxys
Der Einfachheit halber sind mehrere Container-Images, die den Cloud SQL Auth-Proxy enthalten, auf GitHub im Cloud SQL Auth-Proxy-Repository verfügbar. Mit folgendem Befehl können Sie das neueste Image mithilfe von Docker auf Ihren lokalen Computer übertragen:docker pull gcr.io/cloudsql-docker/gce-proxy:1.30.1
Andere Betriebssysteme
Für andere Betriebssysteme, die hier nicht aufgeführt sind, können Sie den Cloud SQL Auth-Proxy aus der Quelle kompilieren.Sie können den Download an einen gemeinsam genutzten Speicherort verschieben, z. B. in einen Speicherort in Ihrem
PATH
oder in Ihr Basisverzeichnis. Wenn Sie das tun, müssen Sie beim Starten des Cloud SQL Auth-Proxys später in der Anleitung bei der Verwendung voncloud_sql_proxy
-Befehlen auf den ausgewählten Standort verweisen.- Laden Sie den Cloud SQL Auth-Proxy herunter:
Sicherungsdienste erstellen
In dieser Anleitung werden verschiedene Google Cloud-Dienste verwendet, um die Datenbank, den Medienspeicher und den Secret-Speicher bereitzustellen, die das bereitgestellte Django-Projekt unterstützen. Diese Dienste werden in einer bestimmten Region bereitgestellt. Zur Steigerung der Effizienz zwischen den Diensten sollten alle Dienste in derselben Region bereitgestellt werden. Weitere Informationen zur nächstgelegenen Region finden Sie unter Produktverfügbarkeit nach Region.
Cloud SQL for PostgreSQL-Instanz einrichten
Django unterstützt offiziell mehrere relationale Datenbanken, bietet aber für PostgreSQL die beste Unterstützung. PostgreSQL wird von Cloud SQL unterstützt. In dieser Anleitung wird daher dieser Datenbanktyp verwendet.
Im folgenden Abschnitt wird das Erstellen einer PostgreSQL-Instanz, einer Datenbank und eines Datenbanknutzers für die Anwendung beschrieben.
Erstellen Sie die PostgreSQL-Instanz:
Console
Rufen Sie in der Cloud Console die Seite Cloud SQL-Instanzen auf.
Klicken Sie auf Instanz erstellen.
Klicken Sie auf PostgreSQL.
Geben Sie im Feld Instanz-ID den Wert
INSTANCE_NAME
ein.Geben Sie das Passwort für den Postgres-Nutzer ein.
Übernehmen Sie für die anderen Felder die Standardwerte.
Klicken Sie auf Erstellen.
Es dauert einige Minuten, bis die Instanz erstellt und einsatzbereit ist.
gcloud
Erstellen Sie die PostgreSQL-Instanz:
gcloud sql instances create INSTANCE_NAME \ --project PROJECT_ID \ --database-version POSTGRES_13 \ --tier db-f1-micro \ --region REGION
Ersetzen Sie Folgendes:
INSTANCE_NAME
: der Name der Cloud SQL-InstanzPROJECT_ID
: die Google Cloud-Projekt-IDREGION
: die Google Cloud-Region
Es dauert einige Minuten, bis die Instanz erstellt und einsatzbereit ist.
Erstellen Sie in der erstellten Instanz eine Datenbank:
Console
- Wechseln Sie auf der Instanzseite zum Tab Datenbanken.
- Klicken Sie auf Datenbank erstellen.
- Geben Sie im Dialogfeld Datenbankname
DATABASE_NAME
ein. - Klicken Sie auf Erstellen.
gcloud
Erstellen Sie die Datenbank in der kürzlich erstellten Instanz:
gcloud sql databases create DATABASE_NAME \ --instance INSTANCE_NAME
Ersetzen Sie
DATABASE_NAME
durch einen Namen für die Datenbank in der Instanz.
Erstellen Sie einen Datenbanknutzer:
Console
- Wechseln Sie auf der Instanzseite zum Tab Nutzer.
- Klicken Sie auf Nutzerkonto hinzufügen.
- Im Dialogfeld Nutzerkonto zur Instanz hinzufügen unter „Integrierte Authentifizierung”:
- Geben Sie den Nutzernamen
DATABASE_USERNAME
ein. - Geben Sie das Passwort
DATABASE_PASSWORD
ein. - Klicken Sie auf Add.
gcloud
Erstellen Sie den Nutzer in der kürzlich erstellten Instanz:
gcloud sql users create DATABASE_USERNAME \ --instance INSTANCE_NAME \ --password DATABASE_PASSWORD
Ersetzen Sie
PASSWORD
durch ein sicheres Passwort.
Dienstkonto erstellen
Für den Proxy ist ein Dienstkonto mit Bearbeitungsberechtigungen für Ihre Cloud SQL-Instanz erforderlich. Weitere Informationen zu Dienstkonten finden Sie in der Authentifizierungsübersicht für Google Cloud.
- Rufen Sie in der Cloud Console die Seite Dienstkonten auf.
- Wählen Sie das Projekt aus, in dem sich die Cloud SQL-Instanz befindet.
- Klicken Sie auf Dienstkonto erstellen.
- Geben Sie im Feld Name des Dienstkontos einen Namen für das Dienstkonto ein.
- Ändern Sie die Dienstkonto-ID in einen eindeutigen, leicht erkennbaren Wert und klicken Sie dann auf Erstellen und fortfahren.
-
Klicken Sie auf das Feld Rolle auswählen und wählen Sie eine der folgenden Rollen aus:
- Cloud SQL > Cloud SQL-Client
- Cloud SQL > Cloud SQL-Bearbeiter
- Cloud SQL > Cloud SQL-Administrator
- Klicken Sie auf Fertig, um das Erstellen des Dienstkontos abzuschließen.
- Klicken Sie auf das Aktionsmenü für das neue Dienstkonto und wählen Sie Schlüssel verwalten aus.
- Klicken Sie auf das Drop-down-Menü Schlüssel hinzufügen und dann auf Neuen Schlüssel erstellen.
-
Prüfen Sie, ob der Schlüsseltyp JSON ist, und klicken Sie dann auf Erstellen.
Die Datei mit dem privaten Schlüssel wird auf Ihren Computer heruntergeladen. Sie können die Datei an einen anderen Speicherort verschieben. Bewahren Sie die Schlüsseldatei sicher auf.
Datenbankeinstellungen konfigurieren
Verwenden Sie die folgenden Befehle, um Umgebungsvariablen für den Datenbankzugriff festzulegen. Diese Umgebungsvariablen werden für lokale Tests verwendet.
Linux/macOS
export DATABASE_NAME=DATABASE_NAME
export DATABASE_USER=DATABASE_USERNAME
export DATABASE_PASSWORD=DATABASE_PASSWORD
Windows
set DATABASE_USER=DATABASE_USERNAME
set DATABASE_PASSWORD=DATABASE_PASSWORD
GKE-Konfiguration einrichten
Diese Anwendung wird in einer einzigen Kubernetes-Konfiguration namens
polls
dargestellt. Ersetzen Sie inpolls.yaml
<your-project-id>
durch Ihre Google Cloud-Projekt-ID (PROJECT_ID).Führen Sie den folgenden Befehl aus und notieren Sie den Wert von
connectionName
:gcloud sql instances describe INSTANCE_NAME --format "value(connectionName)"
Ersetzen Sie in der Datei
polls.yaml
die Variable<your-cloudsql-connection-string>
durch den WertconnectionName
.
App auf lokalem Computer ausführen
Nachdem die Sicherungsdienste konfiguriert wurden, können Sie die App jetzt auf Ihrem Computer ausführen. Diese Einrichtung ermöglicht die lokale Entwicklung, das Erstellen eines Superuser und das Anwenden von Datenbankmigrationen.
Starten Sie den Cloud SQL Auth-Proxy in einem separaten Terminal:
Linux/macOS
./cloud_sql_proxy -instances="PROJECT_ID:REGION:INSTANCE_NAME"=tcp:5432
Windows
cloud_sql_proxy.exe -instances="PROJECT_ID:REGION:INSTANCE_NAME"=tcp:5432
Dadurch wird eine Verbindung vom lokalen Computer zur Cloud SQL-Instanz hergestellt, sodass lokale Tests durchgeführt werden können. Brechen Sie die Ausführung des Cloud SQL Auth-Proxys nicht ab, solange Sie die Anwendung noch lokal testen. Wenn Sie diesen Prozess in einem separaten Terminal ausführen, können Sie weiter arbeiten, während dieser Prozess ausgeführt wird.
Legen Sie in einem neuen Terminal die Projekt-ID lokal fest:
Linux/macOS
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
Windows
set GOOGLE_CLOUD_PROJECT=PROJECT_ID
Führen Sie die Django-Migrationen aus, um die Modelle und Assets einzurichten:
python manage.py makemigrations python manage.py makemigrations polls python manage.py migrate python manage.py collectstatic
Starten Sie den Django-Webserver:
python manage.py runserver
Wechseln Sie in Ihrem Browser zu http://localhost:8000.
Auf der Seite wird der folgende Text angezeigt: "Hello, world. Sie befinden sich im Umfragenindex." Der auf Ihrem Computer ausgeführte Django-Webserver stellt die Beispiel-App-Seiten bereit.
Drücken Sie
Ctrl
/Cmd
+C
, um den lokalen Webserver zu beenden.
Admin-Konsole von Django verwenden
Um sich in der Admin-Konsole von Django anzumelden, müssen Sie einen Superuser erstellen. Da Sie eine lokal zugängliche Verbindung zur Datenbank haben, können Sie Verwaltungsbefehle ausführen:
Erstellen Sie einen Superuser: Sie werden aufgefordert, einen Nutzernamen, eine E-Mail-Adresse und ein Passwort einzugeben.
python manage.py createsuperuser
Starten Sie einen lokalen Webserver:
python manage.py runserver
Wechseln Sie in Ihrem Browser zu http://localhost:8000/admin.
Melden Sie sich mit dem Nutzernamen und dem Passwort an, die Sie beim Ausführen von
createsuperuser
verwendet haben.
Anwendung in GKE bereitstellen
Wenn die Anwendung in Google Cloud bereitgestellt wird, verwendet sie den Gikenorn-Server. Gunicorn stellt keine statischen Inhalte bereit, sodass die App zur Bereitstellung statischer Inhalte Google Cloud Storage verwendet.
Statische Ressourcen sammeln und hochladen
Erstellen Sie einen Cloud Storage-Bucket und machen Sie ihn öffentlich lesbar.
gsutil mb gs://PROJECT_ID_MEDIA_BUCKET gsutil defacl set public-read gs://PROJECT_ID_MEDIA_BUCKET
Sammeln Sie alle lokalen statischen Inhalte in einem Ordner:
python manage.py collectstatic
Laden Sie die statischen Inhalte zu Cloud Storage hoch:
gsutil -m rsync -r ./static gs://PROJECT_ID_MEDIA_BUCKET/static
Setzen Sie in
mysite/settings.py
den Wert vonSTATIC_URL
auf die folgende URL und ersetzen Sie[YOUR_GCS_BUCKET]
durch Ihren Bucket-Namen:http://storage.googleapis.com/PROJECT_ID_MEDIA_BUCKET/static/
GKE einrichten
Zur Initialisierung von GKE rufen Sie die Seite Cluster auf.
Wenn Sie GKE zum ersten Mal in einem Projekt verwenden, müssen Sie warten, bis die Meldung "Kubernetes Engine wird vorbereitet. Dies kann einige Minuten dauern" nicht mehr angezeigt wird.
-
gcloud container clusters create polls \ --scopes "https://www.googleapis.com/auth/userinfo.email","cloud-platform" \ --num-nodes 4 --zone "us-central1-a"
Wurde Ihnen folgender Fehler angezeigt: "Projekt [PROJECT_ID] wurde nicht vollständig mit den standardmäßigen Dienstkonten initialisiert."?
GKE initialisieren
Wenn Sie eine Fehlermeldung erhalten haben, rufen Sie die Google Cloud Console auf, um GKE in Ihrem Projekt zu initialisieren.
Warten Sie, bis die Meldung "Kubernetes Engine wird aktiviert. Dies kann einige Minuten dauern" erlischt.
Nachdem der Cluster erstellt wurde, verwenden Sie das
kubectl
-Befehlszeilentool, das zum gcloud-Tool gehört, um mit dem GKE-Cluster zu interagieren. Dagcloud
undkubectl
separate Tools sind, musskubectl
für die Interaktion mit dem richtigen Cluster konfiguriert sein.gcloud container clusters get-credentials polls --zone "us-central1-a"
Cloud SQL einrichten
Es sind mehrere Secrets erforderlich, damit die GKE-App eine Verbindung zu Ihrer Cloud SQL-Instanz herstellen kann. Ein Secret ist für den Zugriff auf Instanzebene (die Verbindung) erforderlich, die anderen beiden für den Datenbankzugriff. Weitere Informationen zu den beiden Ebenen der Zugriffskontrolle finden Sie unter Instanzzugriffskontrolle.
Geben Sie zum Erstellen des Secrets für den Zugriff auf Instanzebene den Speicherort (
[PATH_TO_CREDENTIAL_FILE]
) des JSON-Dienstkontoschlüssels an, den Sie beim Erstellen Ihres Dienstkontos heruntergeladen haben (siehe Dienstkonto erstellen):kubectl create secret generic cloudsql-oauth-credentials \ --from-file=credentials.json=[PATH_TO_CREDENTIAL_FILE]
Verwenden Sie zum Erstellen der Secrets für den Datenbankzugriff die in Schritt 2 von Cloud SQL-Instanz initialisieren definierte SQL-Datenbank, den Nutzernamen und das Passwort:
kubectl create secret generic cloudsql \ --from-literal=database=DATABASE_NAME \ --from-literal=username=DATABASE_USERNAME \ --from-literal=password=DATABASE_PASSWORD
Rufen Sie das öffentliche Docker-Image für den Cloud SQL-Proxy ab.
docker pull b.gcr.io/cloudsql-docker/gce-proxy
Erstellen Sie ein Docker-Image und ersetzen Sie dabei
<your-project-id>
durch Ihre Projekt-ID.docker build -t gcr.io/PROJECT_ID/polls .
Konfigurieren Sie Docker so, dass
gcloud
als Credential Helper verwendet wird. Dadurch können Sie das Image an Container Registry übertragen:gcloud auth configure-docker
Übertragen Sie das Docker-Image per Push. Ersetzen Sie
<your-project-id>
durch Ihre Projekt-ID.docker push gcr.io/PROJECT_ID/polls
Erstellen Sie die GKE-Ressource:
kubectl create -f polls.yaml
Anwendung in GKE bereitstellen
Nach der Erstellung der Ressourcen befinden sich im Cluster drei polls
-Pods.
Prüfen Sie den Status der Pods:
kubectl get pods
Warten Sie einige Minuten, bis sich der Status der Pods in Running
befindet. Wenn die Pods nicht bereit sind oder neu gestartet werden, können Sie die Logs für einen bestimmten Pod abrufen, um das Problem zu ermitteln. [YOUR-POD-ID]
ist Teil der Ausgabe, die vom vorherigen kubectl get pods
- Befehl zurückgegeben wurde.
kubectl logs [YOUR_POD_ID]
Ausführung der App in Google Cloud ansehen
Wenn die Pods einsatzbereit sind, können Sie die öffentliche IP-Adresse des Load-Balancers abrufen:
kubectl get services polls
Notieren Sie sich die Adresse EXTERNAL-IP
und rufen Sie in Ihrem Browser http://[EXTERNAL-IP]
auf, um die Landingpage von Django-Abfragen aufzurufen und auf die Admin-Konsole zuzugreifen.
Den Code verstehen
Beispielanwendung
Die Django-Beispiel-App wurde mit den Django-Standardtools erstellt. Mit den folgenden Befehlen werden das Projekt und die Umfrage-App erstellt:
django-admin startproject mysite
python manage.py startapp polls
Die grundlegenden Ansichten, Modelle und Routenkonfigurationen werden aus Erste Django-Anwendung schreiben (Teil 1 und Teil 2) kopiert.
Datenbankkonfiguration
settings.py
enthält die Konfiguration für Ihre SQL-Datenbank:
Konfigurationen für Kubernetes-Pods
Die Datei polls.yaml
gibt zwei Kubernetes-Ressourcen an. Der erste ist der Dienst, der einen konsistenten Namen und eine private IP-Adresse für die Django-Web-App definiert. Der zweite ist ein HTTP-Load-Balancer mit einer öffentlichen externen IP-Adresse.
Der Dienst stellt einen Netzwerknamen und eine IP-Adresse bereit und GKE-Pods führen den Anwendungscode hinter dem Dienst aus.
Die Datei polls.yaml
gibt ein Deployment an, mit dem deklarative Updates für GKE-Pods zur Verfügung gestellt werden. Der Dienst leitet den Traffic zum Deployment um, indem er die Auswahl des Dienstes mit dem Label des Deployments abgleicht. In diesem Fall entspricht der Selektor polls
dem Label polls
.
Bereinigen
Damit Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen nicht in Rechnung gestellt werden, löschen Sie entweder das Projekt, das die Ressourcen enthält, oder Sie behalten das Projekt und löschen die einzelnen Ressourcen.
Projekt löschen
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Einzelne Ressourcen löschen
Wenn Sie das Projekt nicht löschen möchten, löschen Sie die einzelnen Ressourcen.
Löschen Sie den Google Kubernetes Engine-Cluster:
gcloud container clusters delete polls
Löschen Sie das Docker-Image, das Sie in Container Registry hochgeladen haben:
gcloud container images delete gcr.io/PROJECT_ID/polls
Löschen Sie die Cloud SQL-Instanz:
gcloud sql instances delete INSTANCE_NAME
Weitere Informationen
- PostgreSQL für die Produktion konfigurieren
- Weitere Informationen zu Django in Google Cloud