Bei dieser Anleitung wird vorausgesetzt, dass Sie mit der Django-Webentwicklung vertraut sind. Der Beispielcode dient zum Einbinden von grundlegenden Ansichten, Modellen und Routenkonfigurationen. In Verbindung mit dem interaktiven Django-Administrator zeigt dieses Codebeispiel, wie Sie verwaltete Datenbanken, Objektspeicher, verschlüsselte Secrets und Build-Pipelines in serverloses Computing einbinden.
In dieser Anleitung wird insbesondere Django beschrieben. Sie können diesen Bereitstellungsprozess auch mit anderen Django-basierten Frameworks wie Wagtail und Django CMS verwenden.

Kosten
Hinweis
-
Melden Sie sich bei Ihrem Google-Konto an.
Wenn Sie noch kein Konto haben, melden Sie sich hier für ein neues Konto an.
-
Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.
-
Die Abrechnung für das Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für Ihr Projekt aktiviert ist.
- Cloud Run, Cloud SQL, Cloud Build, Secret Manager, and Compute Engine APIs aktivieren.
- Installieren und initialisieren Sie das Cloud SDK.
- Achten Sie darauf, dass das für diese Anleitung verwendete Konto über ausreichende Berechtigungen verfügt.
Django App klonen
Nachdem Sie die Voraussetzungen erfüllt haben, laden Sie die Django-Beispiel-App herunter und stellen Sie sie bereit. In den folgenden Abschnitten erfahren Sie, wie Sie die Anwendung konfigurieren, ausführen und bereitstellen.
Django-App klonen
Der Code für die Django-Beispiel-App befindet sich 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/run/django
Windows
cd python-docs-samples\run\django
Sicherungsdienste vorbereiten
In dieser Anleitung werden verschiedene Google Cloud-Dienste verwendet, um die Datenbank, den Medienspeicher und den geheimen Speicher zur Verfügung zu stellen, der das bereitgestellte Django-Projekt unterstützt. Diese Dienste werden in einer bestimmten Region bereitgestellt. Aus Gründen der Effizienz zwischen Diensten empfiehlt es sich, alle Dienste in derselben Region bereitzustellen. Weitere Informationen zur nächstgelegenen Region finden Sie unter Regionale Produkte.
Cloud SQL for PostgreSQL-Instanz einrichten
Django unterstützt mehrere relationale Datenbanken, bietet aber für PostgreSQL die beste Unterstützung. Dies ist einer der in Cloud SQL angebotenen Datenbanktypen.
In den folgenden Abschnitten wird die Erstellung einer PostgreSQL-Instanz, einer Datenbank und eines Datenbanknutzers für die Umfrage-App beschrieben.
PostgreSQL-Instanz erstellen
Console
Wechseln Sie in der Cloud Console zur Seite Cloud SQL-Instanzen.
Klicken Sie auf Instanz erstellen.
Klicken Sie auf PostgreSQL.
Geben Sie im Feld Instanz-ID einen Namen für die Instanz ein (
INSTANCE_NAME
).Geben Sie das Passwort für den Postgres-Nutzer ein.
Übernehmen Sie für die anderen Felder die Standardwerte.
Klicken Sie auf Erstellen.
gcloud
Erstellen Sie die PostgreSQL-Instanz:
gcloud sql instances create INSTANCE_NAME \ --project PROJECT_ID \ --database-version POSTGRES_12 \ --tier db-f1-micro \ --region REGION
Dabei gilt:
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.
Legen Sie ein Passwort für den Nutzer
postgres
fest.gcloud sql users set-password postgres \ --instance INSTANCE_NAME --prompt-for-password
Datenbank erstellen
Console
Wechseln Sie in der Cloud Console zur Seite Cloud SQL-Instanzen.
Wählen Sie die Instanz INSTANCE_NAME aus.
Wechseln Sie 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 innerhalb 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 innerhalb der Instanz.
Nutzer erstellen
Console
-
Aktivieren Sie Cloud Shell in der Cloud Console.
Verwenden Sie in Cloud Shell den integrierten
gcloud
-Client, um eine Verbindung zur InstanzINSTANCE_NAME
herzustellen:gcloud sql connect INSTANCE_NAME --user postgres
Geben Sie das Nutzerpasswort für Postgres ein.
Du verwendest jetzt
psql
. Diepostgres=>
-Eingabeaufforderung sollte nun angezeigt werden.Erstellen Sie einen Nutzer:
CREATE USER 'django' WITH PASSWORD 'PASSWORD';
Ersetzen Sie
PASSWORD
durch ein ausreichend geheimes Passwort.Gewähren Sie dem neuen Nutzer uneingeschränkte Rechte für die neue Datenbank:
GRANT ALL PRIVILEGES ON DATABASE 'DATABASE_NAME' TO 'django';
Beenden Sie
psql
:\q
gcloud
Stellen Sie eine Verbindung zur SQL-Instanz her:
gcloud sql connect INSTANCE_NAME --user postgres
Ersetzen Sie
INSTANCE_NAME
durch die erstellte Cloud SQL-Instanz.Geben Sie das Nutzerpasswort für Postgres ein.
Du verwendest jetzt
psql
. Diepostgres=>
-Eingabeaufforderung sollte nun angezeigt werden.Erstellen Sie einen Nutzer:
CREATE USER 'django' WITH PASSWORD 'PASSWORD';
Gewähren Sie dem neuen Nutzer uneingeschränkte Rechte für die neue Datenbank:
GRANT ALL PRIVILEGES ON DATABASE 'DATABASE_NAME' TO 'django';
Beenden Sie
psql
:\q
Cloud Storage-Bucket einrichten
Sie können die in Django enthaltenen statischen Inhalte sowie von Nutzern hochgeladene Medien in einem hochverfügbaren Objektspeicher mit Cloud Storage speichern.
Das Paket django-storages[google]
steuert die Interaktion von Django mit diesem Speicher-Back-End.
Console
- Wechseln Sie in der Cloud Console zum Cloud Storage-Browser.
- Klicken Sie auf Bucket erstellen.
- Geben Sie im Dialogfeld Bucket erstellen die folgenden Attribute an:
- Ein eindeutiger Bucket-Name gemäß den Anforderungen für Bucket-Namen.
- Standardspeicherklase: Standard
- Standort: MEDIA_BUCKET
- Klicken Sie auf Erstellen.
gcloud
Das gsutil-Befehlszeilentool wurde bei der Installation des Cloud SDK installiert.
Erstellen Sie einen Cloud Storage-Bucket:
gsutil mb -l REGION gs://PROJECT_ID_MEDIA_BUCKET
Ersetzen Sie
MEDIA_BUCKET
durch ein Suffix für den Medien-Bucket. In Kombination mit der Projekt-ID wird dadurch ein eindeutiger Bucket-Name erstellt.
Secret-Werte im Secret Manager speichern
Nachdem die Sicherungsdienste konfiguriert sind, benötigt Django Informationen zu diesen Diensten. Anstatt diese Werte direkt in den Django-Quellcode einzufügen, wird in dieser Anleitung Secret Manager zum sicheren Speichern dieser Informationen verwendet.
Cloud Run und Cloud Build nutzen die jeweiligen Dienstkonten für Secrets, die durch eine E-Mail-Adresse mit der Projektnummer identifiziert werden.
Django-Umgebungsdatei als Secret Manager-Secret erstellen
Sie speichern die Einstellungen, die zum Starten von Django erforderlich sind, in einer sicheren .env
-Datei.
Der Beispielcode verwendet die Secret Manager API, um den Secret-Wert abzurufen, und das Paket django-environ
, um die Werte in die Django-Umgebung zu laden. Das Secret ist so konfiguriert, dass es sowohl für Cloud Build als auch für Cloud Run zugänglich ist, da in beiden Diensten Django ausgeführt wird.
Erstellen Sie eine Datei mit dem Namen
.env
und definieren Sie den Datenbank-Verbindungsstring, den Namen des Medien-Buckets sowie einen neuenSECRET_KEY
-Wert:DATABASE_URL=postgres://django:PASSWORD@//cloudsql/PROJECT_ID:REGION:INSTANCE_NAME/DATABASE_NAME GS_BUCKET_NAME=PROJECT_ID_MEDIA_BUCKET SECRET_KEY=(a random string, length 50)
Speichern Sie das Secret in Secret Manager:
Console
Rufen Sie in der Cloud Console die Seite „Secret Manager“ auf.
Klicken Sie auf Secret erstellen.
Geben Sie im Feld Name
django_settings
ein.Wählen Sie im Dialogfeld Datei hochladen die lokal gespeicherte
.env
-Datei aus.Klicken Sie auf Secret erstellen.
Notieren Sie sich die unter Details für django_settings angezeigte Projektnummer:
projects/PROJECTNUM/secrets/django_settings
Klicken Sie auf Mitglied hinzufügen.
Geben Sie in das Feld Neue Mitglieder
PROJECTNUM-compute@developer.gserviceaccount.com
ein und drücken Sie dannEnter
.Geben Sie in das Feld Neue Mitglieder
PROJECTNUM@cloudbuild.gserviceaccount.com
ein und drücken Sie dannEnter
.Wählen Sie im Drop-down-Menü Rolle die Option Secret Manager Secret Accessor aus.
Klicken Sie auf Speichern.
gcloud
Erstellen Sie ein neues Secret,
django_settings
:gcloud secrets create django_settings --replication-policy automatic
Fügen Sie die Datei
.env
als Version des Secrets hinzu.gcloud secrets versions add django_settings --data-file .env
Prüfen Sie Folgendes, um die Erstellung des Secrets zu bestätigen:
gcloud secrets describe django_settings
Notieren Sie sich die Projektnummer.
projects/PROJECTNUM/secrets/django_settings
Gewähren Sie dem Cloud Run-Dienstkonto Zugriff auf das Secret:
gcloud secrets add-iam-policy-binding django_settings \ --member serviceAccount:PROJECTNUM-compute@developer.gserviceaccount.com \ --role roles/secretmanager.secretAccessor
Gewähren Sie dem Cloud Build-Dienstkonto Zugriff auf das Secret:
gcloud secrets add-iam-policy-binding django_settings \ --member serviceAccount:PROJECTNUM@cloudbuild.gserviceaccount.com \ --role roles/secretmanager.secretAccessor
Achten Sie in der Ausgabe darauf, dass
bindings
die beiden Dienstkonten als Mitglieder auflistet.
Secret für das Administratorpasswort von Django erstellen
Der Django-Administrator wird normalerweise durch Ausführen des interaktiven Verwaltungsbefehls createsuperuser
erstellt.
In dieser Anleitung wird eine Datenmigration verwendet, um den Administrator zu erstellen, wobei das genannte Passwort aus Secret Manager abgerufen wird.
Console
- Rufen Sie in der Cloud Console die Seite „Secret Manager“ auf.
Klicken Sie auf Secret erstellen.
Geben Sie im Feld Name
superuser_password
ein.Geben Sie in das Feld Secret-Wert ein zufälliges Passwort ein.
Klicken Sie auf Secret erstellen.
Notieren Sie sich die unter Details für superuser_password angezeigte Projektnummer (
projects/PROJECTNUM/secrets/superuser_password
).Klicken Sie auf Mitglied hinzufügen.
Geben Sie in das Feld Neue Mitglieder
PROJECTNUM@cloudbuild.gserviceaccount.com
ein und drücken Sie dannEnter
.Wählen Sie im Drop-down-Menü Rolle die Option Secret Manager Secret Accessor aus.
Klicken Sie auf Speichern.
gcloud
Erstellen Sie ein neues Secret,
superuser_password
:gcloud secrets create superuser_password --replication-policy automatic
Fügen Sie ein zufällig generiertes Passwort als Version des Secrets hinzu:
cat /dev/urandom | tr -dc 'a-zA-Z0-9' | head -c30 > superuser_password gcloud secrets versions add superuser_password --data-file superuser_password
Gewähren Sie Cloud Build Zugriff auf das Secret:
gcloud secrets add-iam-policy-binding superuser_password \ --member serviceAccount:PROJECTNUM@cloudbuild.gserviceaccount.com \ --role roles/secretmanager.secretAccessor
Achten Sie in der Ausgabe darauf, dass
bindings
nur Cloud Build als Mitglied auflistet.
Cloud Build Zugriff auf Cloud SQL gewähren
Damit Cloud Build die Datenbankmigrationen anwenden kann, müssen Sie Cloud Build Berechtigungen für den Zugriff auf Cloud SQL erteilen.
Console
Wechseln Sie in der Cloud Console zur Seite Identitäts- und Zugriffsverwaltung.
Wenn Sie den Eintrag für
PROJECTNUM@cloudbuild.gserviceaccount.com
bearbeiten möchten, klicken Sie auf Bearbeiten.Klicken Sie auf Weitere Rolle hinzufügen.
Wählen Sie im Dialogfeld Rolle auswählen die Option Cloud SQL-Client aus.
Klicken Sie auf Speichern.
gcloud
Gewähren Sie Cloud Build die Berechtigung, auf Cloud SQL zuzugreifen:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:PROJECTNUM@cloudbuild.gserviceaccount.com \ --role roles/cloudsql.client
Erste Bereitstellung der Anwendung
Da die Sicherungsdienste nun eingerichtet sind, können Sie jetzt den Cloud Run-Dienst bereitstellen.
Verwenden Sie die bereitgestellte Datei
cloudmigrate.yaml
, um mithilfe von Cloud Build das Image zu erstellen, die Datenbankmigrationen auszuführen und die statischen Assets zu füllen:gcloud builds submit --config cloudmigrate.yaml --substitutions _INSTANCE_NAME=INSTANCE_NAME,_REGION=REGION
Dieser erste Build-Vorgang kann einige Minuten dauern.
Wenn der Build erfolgreich ist, stellen Sie den Cloud Run-Dienst zum ersten Mal bereit. Legen Sie die Dienstregion, das Basis-Image und die verbundene Cloud SQL-Instanz fest:
gcloud run deploy polls-service \ --platform managed \ --region REGION \ --image gcr.io/PROJECT_ID/polls \ --add-cloudsql-instances PROJECT_ID:REGION:INSTANCE_NAME \ --allow-unauthenticated
Aus der angezeigten Ausgabe sollte hervorgehen, dass die Bereitstellung erfolgreich war, und es sollte eine Dienst-URL ausgegeben werden:
Service [polls-service] revision [polls-service-00001-tug] has been deployed and is serving 100 percent of traffic at https://polls-service-
-uc.a.run.app Rufen Sie die Dienst-URL auf, um sich den bereitgestellten Dienst anzeigen zu lassen.
Wenn in der Dienst-URL „You're at the polls index“ („Sie befinden sich im Umfrageindex“) angezeigt wird, wurde die Django-Anwendung erfolgreich bereitgestellt. Wenn Sie sich als Django-Administrator anmelden möchten, fügen Sie
/admin
an die URL an und melden Sie sich mit dem Nutzernamenadmin
und dem zuvor festgelegten Passwort an.Nach der Authentifizierung wird der Django-Administrator angezeigt. In der Umfrage-App ist das Fragenmodell zu sehen.
Mindestberechtigungen festlegen (optional)
Standardmäßig wird dieser Dienst mit dem Standarddienstkonto von Compute bereitgestellt. In einigen Fällen kann die Verwendung des Standarddienstkontos jedoch zu viele Berechtigungen gewähren. Wenn Sie stärker einschränken möchten, müssen Sie ein eigenes Dienstkonto erstellen und nur die Berechtigungen erteilen, die für Ihren Dienst erforderlich sind. Die erforderlichen Berechtigungen variieren je nach Dienst. Dies hängt von den Ressourcen ab, die von einem bestimmten Dienst verwendet werden.
Für diesen Dienst sind mindestens folgende Projektrollen erforderlich:
- Cloud Run-Aufrufer
- Cloud SQL-Client
- Storage-Administrator im Medien-Bucket
- Secret Manager-Zugriffsfunktion im Django-Einstellungs-Secret. (Der Zugriff auf das Django-Administratorschlüssel ist nicht erforderlich.
So erstellen Sie ein Dienstkonto mit den erforderlichen Berechtigungen:
Erstellen Sie in Cloud Shell ein Dienstkonto mit den erforderlichen Rollen:
gcloud iam service-accounts create polls-service-account SERVICE_ACCOUNT=polls-service-account@PROJECT_ID.iam.gserviceaccount.com # Cloud Run Invoker gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:${SERVICE_ACCOUNT} \ --role roles/run.Invoker # Cloud SQL Client gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:${SERVICE_ACCOUNT} \ --role roles/cloudsql.client # Storage Admin, on the media bucket gsutil iam ch \ serviceAccount:${SERVICE_ACCOUNT}:roles/storage.objectAdmin \ gs://MEDIA_BUCKET # Secret Accessor, on the Django settings secret. gcloud secrets add-iam-policy-binding django_settings \ --member serviceAccount:${SERVICE_ACCOUNT} \ --role roles/secretmanager.secretAccessor
Stellen Sie den Dienst bereit und verknüpfen Sie ihn mit dem neuen Dienstkonto:
gcloud run deploy polls-service \ --platform managed \ --region REGION \ --service-account ${SERVICE_ACCOUNT}
Anwendung noch einmal bereitstellen
Die ersten Schritte zum Bereitstellen waren zwar komplex, aber die erneute Bereitstellung ist relativ einfach.
Führen Sie das Build- und Migrationsskript von Cloud Build aus:
gcloud builds submit --config cloudmigrate.yaml \ --substitutions _INSTANCE_NAME=INSTANCE_NAME,_REGION=REGION
Stellen Sie den Dienst bereit und geben Sie dabei nur die Region und das Image an:
gcloud run deploy polls-service \ --platform managed \ --region REGION \ --image gcr.io/PROJECT_ID/polls
Code verstehen
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.
Secrets aus Secret Manager
Die Datei settings.py
enthält Code, der die Secret Manager Python API verwendet, um die neueste Version des benannten Secrets abzurufen und mit django-environ
in die Umgebung zu übertragen:
Mit django_settings
wurden mehrere Secret-Werte gespeichert, um die Anzahl der verschiedenen Secrets zu reduzieren, die konfiguriert werden mussten.
Obwohl superuser_password
direkt über die Befehlszeile hätte erstellt werden können, wurde stattdessen die dateibasierte Methode verwendet. Beim Generieren über die Befehlszeile wurde mit head -c
geprüft, wie lange der verwendete, zufällig generierte String ist. Gleichzeitig wurde sichergestellt, dass am Ende der Datei kein Zeilenvorschubzeichen enthalten war. Dies hätte bei der Eingabe des Passworts als Django-Administrator zu Problemen geführt.
Datenbankverbindung
Da das django_settings
-Secret einen speziell formatierten String für die Datenbankverbindung enthielt, kann die Datenbankhilfsfunktion von django-environ
aufgerufen werden, um den Wert DATABASES
zuzuweisen:
Im Gegensatz zur Definition separater Werte für die Komponenten der Datenbankverbindungsinformationen wurde diese Methode verwendet.
In der Cloud gespeichert
Die Datei settings.py
verwendet auch django-storages
, um den Cloud Storage-Medien-Bucket direkt in das Projekt einzubinden:
Automatisierung mit Cloud Build
Die cloudmigrate.yaml
-Datei führt nicht nur die typischen Image-Build-Schritte aus, mit denen das Container-Image erstellt und in die Container Registry übertragen wird, sondern auch die Django-Befehle migrate
und collectstatic
. Diese benötigen Zugriff auf die Datenbank. Erreicht wird dies mit app-engine-exec-wrapper, einer Hilfefunktion für Cloud SQL Proxy:
In dieser Konfiguration werden Substitutionsvariablen verwendet. Wenn Sie die Werte direkt in der Datei ändern, kann das Flag --substitutions
zum Zeitpunkt der Migration weggelassen werden.
In dieser Konfiguration werden nur vorhandene Migrationen angewendet. Fügen Sie einen Schritt makemigrations
hinzu, um diese Konfiguration zur Generierung von Migrationen zu erweitern.
Wenn Sie die Cloud Build-Konfiguration erweitern möchten, um die Bereitstellung in eine einzige Konfiguration aufzunehmen, ohne zwei Befehle ausführen zu müssen, finden Sie weitere Informationen unter Kontinuierliche Bereitstellung aus Git mit Cloud Build. Dies erfordert die beschriebenen IAM-Änderungen.
Erstellung von Superusern mit Datenmigrationen
Der Django-Verwaltungsbefehl createsuperuser
kann nur interaktiv ausgeführt werden, das heißt, wenn der Nutzer Informationen als Reaktion auf eine Eingabeaufforderung eingeben kann. Sie können diesen Befehl zwar mit dem Cloud SQL-Proxy verwenden und Befehle innerhalb einer lokalen Docker-Konfiguration ausführen, Sie können den Superuser aber auch als Datenmigration erstellen:
Clean-up
- Wechseln Sie in der Cloud Console zur Seite Ressourcen verwalten.
- Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie dann auf Löschen.
- Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie auf Shut down (Beenden), um das Projekt zu löschen.