Django in der App Engine-Standardumgebung ausführen

---

Django-Anwendungen, die in der App Engine-Standardumgebung ausgeführt werden, werden dynamisch entsprechend dem Traffic 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.

In dieser Anleitung wird Django 4 verwendet, das mindestens Python 3.8 erfordert. Die App Engine-Standardumgebung unterstützt Python 3.7 und höher, einschließlich Python 3.8.

Lernziele

In dieser Anleitung wird Folgendes beschrieben:

• Cloud SQL-Datenbank erstellen und verbinden
• Secret-Werte von Secret Manager erstellen und verwenden
• Django-App in der App Engine-Standardumgebung bereitstellen

Kosten

In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:

• App Engine
• Cloud SQL
• Secret Manager

Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen. Neuen Google Cloud-Nutzern steht möglicherweise eine kostenlose Testversion zur Verfügung.

Hinweise

1. 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.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud SQL Admin API, Secret Manager, and Cloud Build APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud SQL Admin API, Secret Manager, and Cloud Build APIs.

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.
12. Initialisieren Sie App Engine, falls noch nicht geschehen, und wählen Sie Ihre bevorzugte Region aus:

    gcloud app create
    

Umgebung vorbereiten

Beispielanwendung klonen

Den Code für die Django-Beispielanwendung finden Sie im Repository GoogleCloudPlatform/python-docs-samples auf GitHub.

1. 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
   

2. Gehen Sie zum Verzeichnis mit dem Beispielcode:

   Linux/macOS

   cd python-docs-samples/appengine/standard_python3/django
   

   Windows

   cd python-docs-samples\appengine\standard_python3\django
   

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.

1. Prüfen Sie, ob Python mindestens Version 3.8 hat.

    python -V
   

   Sie sollten Python 3.8.0 oder höher haben.

   Hinweis: Wenn die Versionsnummer mit "2" beginnt, müssen Sie möglicherweise python3 anstelle von python ausführen. Wenn ja, sollten Sie bei der Ausführung von python-Befehlen auf die ausgewählte Python-Installation verweisen.

2. 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 venv
   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

Hinweis: Wenn Sie diese Anleitung über Cloud Shell ausführen, ist dieser Abschnitt nicht erforderlich.

Nach der Bereitstellung verwendet die Anwendung den in die App Engine-Standardumgebung 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 die gcloud CLI erforderlich.

1. Authentifizieren und rufen Sie Anmeldedaten für die API ab:

   gcloud auth application-default login
   

2. Laden Sie den Cloud SQL Auth-Proxy herunter und installieren Sie ihn auf Ihrem lokalen Computer.

   Linux 64-Bit

   1. Laden Sie den Cloud SQL Auth-Proxy herunter:

      curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.linux.amd64
      

   2. Machen Sie den Cloud SQL Auth-Proxy ausführbar:

      chmod +x cloud-sql-proxy
      

   Linux 32-Bit

   1. Laden Sie den Cloud SQL Auth-Proxy herunter:

      curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.linux.386
      

   2. Wenn der Befehl curl nicht gefunden wird, führen Sie sudo apt install curl aus und wiederholen Sie den Downloadbefehl.
   3. Machen Sie den Cloud SQL Auth-Proxy ausführbar:

      chmod +x cloud-sql-proxy
      

   macOS 64-Bit

   1. Laden Sie den Cloud SQL Auth-Proxy herunter:

      curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.darwin.amd64
      

   2. Machen Sie den Cloud SQL Auth-Proxy ausführbar:

      chmod +x cloud-sql-proxy
      

   Mac M1

   1. Laden Sie den Cloud SQL Auth-Proxy herunter:

        curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.darwin.arm64
        

   2. 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://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.x64.exe und wählen Sie Link speichern unter aus, um den Cloud SQL Auth-Proxy herunterzuladen. Benennen Sie die Datei in cloud-sql-proxy.exe um.

   Windows 32-Bit

   Klicken Sie mit der rechten Maustaste auf https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.x86.exe und wählen Sie Link speichern unter aus, um den Cloud SQL Auth-Proxy herunterzuladen. Benennen Sie die Datei in cloud-sql-proxy.exe um.

   Docker-Image des Cloud SQL Auth-Proxys

   Der Cloud SQL Auth-Proxy hat verschiedene Container-Images, z. B. distroless, alpine und buster. Das standardmäßige Cloud SQL Auth-Proxy-Container-Image verwendet distroless, das keine Shell enthält. Wenn Sie eine Shell oder verwandte Tools benötigen, laden Sie ein auf alpine oder buster basierendes Image herunter. Weitere Informationen finden Sie unter Container-Images von Cloud SQL Auth-Proxy.

   Sie können das neueste Image mithilfe von Docker mit dem folgenden Befehl auf Ihren lokalen Computer übertragen:

   docker pull gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.14.1
   

   Hinweis: Der Cloud SQL Auth-Proxy verwendet ein Repository, das die Domain gcr.io unterstützt, aber Images aus Artifact Registry bereitstellt. Weitere Informationen finden Sie unter Von Container Registry wechseln.

   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 von cloud-sql-proxy-Befehlen auf den ausgewählten Standort verweisen.

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.

In dieser Anleitung werden die integrierten Hostingmechanismen für statische Assets in der App Engine-Standardumgebung verwendet.

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.

1. Erstellen Sie die PostgreSQL-Instanz:

   Console

   1. Rufen Sie in der Google Cloud Console die Seite Cloud SQL-Instanzen auf.

      Zur Seite "Cloud SQL-Instanzen"

   2. Klicken Sie auf Instanz erstellen.

   3. Klicken Sie auf PostgreSQL auswählen.

   4. Wählen Sie unter SQL-Version die Option „Enterprise“ aus.

   5. Wählen Sie unter Version die Option „Sandbox“ aus.

   6. Geben Sie im Feld Instanz-ID den Wert INSTANCE_NAME ein.

   7. Geben Sie das Passwort für den Postgres-Nutzer ein.

   8. Übernehmen Sie für die anderen Felder die Standardwerte.

   9. Klicken Sie auf Instanz erstellen.

   Es dauert einige Minuten, bis die Instanz einsatzbereit ist.

   gcloud

   • Erstellen Sie die PostgreSQL-Instanz:

     gcloud sql instances create INSTANCE_NAME \
         --project PROJECT_ID \
         --database-version POSTGRES_16 \
         --tier db-n1-standard-2 \
         --region REGION
     

   Dabei gilt:

   • INSTANCE_NAME: der Name der Cloud SQL-Instanz
   • PROJECT_ID: die Google Cloud-Projekt-ID
   • REGION: die Google Cloud-Region

   Es dauert einige Minuten, bis die Instanz erstellt und einsatzbereit ist.

2. Erstellen Sie in der erstellten Instanz eine Datenbank:

   Console

   1. Wechseln Sie auf der Instanzseite zum Tab Datenbanken.
   2. Klicken Sie auf Datenbank erstellen.
   3. Geben Sie im Dialogfeld Datenbankname DATABASE_NAME ein.
   4. 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.

3. Erstellen Sie einen Datenbanknutzer:

   Hinweis: Nutzer, die auf diese Weise erstellt wurden, erhalten zusätzliche Datenbankrechte. Eine alternative Methode finden Sie unter Datenbanknutzerberechtigungen einschränken.

   Console

   1. Wechseln Sie auf der Instanzseite zum Tab Nutzer.
   2. Klicken Sie auf Nutzerkonto hinzufügen.
   3. Wählen Sie im Dialogfeld Authentifizierungstyp auswählen unter „Integrierte Authentifizierung“ eine der folgenden Optionen aus:
   4. Geben Sie den Nutzernamen DATABASE_USERNAME ein.
   5. Geben Sie das Passwort DATABASE_PASSWORD ein.
   6. 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.

Secret-Werte im Secret Manager speichern

Nachdem die Sicherungsdienste nun konfiguriert sind, benötigt Django Informationen zu diesen Diensten. Anstatt diese Werte direkt in den Django-Quellcode einzufügen, verwendet diese Anleitung Secret Manager, um diese Informationen sicher zu speichern.

Django-Umgebungsdatei als Secret Manager-Secret erstellen

Sie speichern die Einstellungen, die zum Starten von Django erforderlich sind, in einer gesicherten Umgebung. Die Beispielanwendung 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 für den Zugriff durch die App Engine-Standardumgebung konfiguriert.

1. Erstellen Sie eine Datei mit dem Namen .env und definieren Sie den Datenbank-Verbindungsstring, den Namen des Medien-Buckets sowie einen neuen SECRET_KEY-Wert:

   echo DATABASE_URL=postgres://DATABASE_USERNAME:DATABASE_PASSWORD@//cloudsql/PROJECT_ID:REGION:INSTANCE_NAME/DATABASE_NAME > .env
   echo GS_BUCKET_NAME=PROJECT_ID_MEDIA_BUCKET >> .env
   echo SECRET_KEY=$(cat /dev/urandom | LC_ALL=C tr -dc '[:alpha:]'| fold -w 50 | head -n1) >> .env
   

2. Speichern Sie das Secret in Secret Manager:

   Console

   1. Rufen Sie in der Google Cloud Console die Seite Secret Manager auf.

      Zur Seite „Secret Manager“

   2. Klicken Sie auf Secret erstellen.

   3. Geben Sie im Feld Name django_settings ein.

   4. Fügen Sie im Dialogfeld Secret-Wert den Inhalt Ihrer .env-Datei ein.

   5. Klicken Sie auf Secret erstellen.

   6. Löschen Sie die lokale Datei, um lokale Einstellungsüberschreibungen zu verhindern.

   gcloud

   1. Erstellen Sie das neue Secret django_settings mit dem Wert der Datei .env:

      gcloud secrets create django_settings --data-file .env
      

   2. Löschen Sie die lokale Datei, um lokale Einstellungsüberschreibungen zu verhindern:

      rm .env
      

3. Konfigurieren Sie den Zugriff auf das Secret:

   Console

4. Klicken Sie auf den Tab Berechtigungen.

5. Klicken Sie auf Zugriff erlauben.

6. Geben Sie in das Feld Neue Mitglieder [e-mail] ein und drücken Sie dann Enter.

7. Wählen Sie im Drop-down-Menü Rolle die Option Secret Manager Secret Accessor aus.

8. Klicken Sie auf Speichern.

gcloud

1. Gewähren Sie dem App Engine-Standarddienstkonto Zugriff auf das Secret:

   gcloud secrets add-iam-policy-binding django_settings \
       --member serviceAccount:[e-mail] \
       --role roles/secretmanager.secretAccessor
   

Achten Sie in der Ausgabe darauf, dass bindings das neue Dienstkonto auflistet.

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.

1. Starten Sie den Cloud SQL Auth-Proxy in einem separaten Terminal:

   Linux/macOS

   ./cloud-sql-proxy PROJECT_ID:REGION:INSTANCE_NAME
   

   Windows

   cloud-sql-proxy.exe PROJECT_ID:REGION:INSTANCE_NAME
   

   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.

2. Legen Sie im ursprünglichen Terminal die Projekt-ID lokal fest (von der Secret Manager API verwendet):

   Linux/macOS

   export GOOGLE_CLOUD_PROJECT=PROJECT_ID
   

   Windows

   set GOOGLE_CLOUD_PROJECT=PROJECT_ID
   

3. Legen Sie eine Umgebungsvariable fest, die angibt, dass Sie den Cloud SQL Auth-Proxy verwenden (dieser Wert wird im Code erkannt):

   Linux/macOS

   export USE_CLOUD_SQL_AUTH_PROXY=true
   

   Windows

   set USE_CLOUD_SQL_AUTH_PROXY=true
   

4. 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
   

5. Starten Sie den Django-Webserver:

   python manage.py runserver 8080
   

6. Rufen Sie in Ihrem Browser http://localhost:8080 auf.

   Klicken Sie in Cloud Shell auf die Schaltfläche Webvorschau und wählen Sie Vorschau auf Port 8080 aus.

   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.

7. 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:

1. Erstellen Sie einen Superuser: Sie werden aufgefordert, einen Nutzernamen, eine E-Mail-Adresse und ein Passwort einzugeben.

   python manage.py createsuperuser
   

2. Starten Sie einen lokalen Webserver:

   python manage.py runserver
   

3. Wechseln Sie in Ihrem Browser zu http://localhost:8000/admin.

4. Melden Sie sich mit dem Nutzernamen und dem Passwort an, die Sie beim Ausführen von createsuperuser verwendet haben.

Hinweis: Da Sie mit Ihrer Cloud SQL-Datenbank verbunden sind, melden Sie sich mit denselben Anmeldedaten in der bereitgestellten Django-Anwendung an.

App in der App Engine-Standardumgebung bereitstellen

Nachdem alle Sicherungsdienste eingerichtet wurden und die Anwendung lokal getestet wurde, können Sie die Anwendung jetzt für die App Engine-Standardumgebung bereitstellen:

1. Laden Sie die Anwendung hoch, indem Sie den folgenden Befehl ausführen, der die Anwendung wie unter app.yaml beschrieben bereitstellt und die neu bereitgestellte Version als Standardversion festlegt, sodass der gesamte neue Traffic verarbeitet wird:

   gcloud app deploy

2. Bestätigen Sie die Einstellungen, indem Sie „Ja” eingeben, wenn Sie dazu aufgefordert werden.
3. Warten Sie auf die Nachricht, dass das Update abgeschlossen ist.
4. Öffnen Sie app.yaml und aktualisieren Sie den Wert von APPENGINE_URL mit Ihrer bereitgestellten URL:

   ...
   env_variables:
       APPENGINE_URL: https://PROJECT_ID.uc.r.appspot.com
   

5. Laden Sie Ihre Konfigurationsänderungen hoch:

   gcloud app deploy

Bereitgestellte Anwendung ausführen

Die Anwendung wurde bereitgestellt und kann jetzt aufgerufen werden:

• Öffnen Sie die bereitgestellte Website:

  gcloud app browse
  

• Alternativ können Sie die URL anzeigen und manuell öffnen:

  gcloud app describe --format "value(defaultHostname)"
  

Ihre Anfrage wird von einem Webserver bearbeitet, der in der App Engine-Standardumgebung ausgeführt wird.

Anwendung aktualisieren

Zum Aktualisieren der Anwendung nehmen Sie die Änderungen am Code vor und führen dann den Befehl gcloud app deploy noch einmal aus.

Bei der Bereitstellung wird eine neue Version der App erstellt und zur Standardversion hochgestuft. Die früheren Versionen Ihrer Anwendung bleiben erhalten. Alle Anwendungsversionen dieser Art sind kostenpflichtige Ressourcen. Löschen Sie zur Senkung der Kosten die nicht standardmäßigen Versionen Ihrer Anwendung.

Für die Produktion konfigurieren

Sie haben jetzt eine funktionierende Django-Bereitstellung, es können jedoch weitere Schritte ausgeführt werden, damit Ihre Anwendung produktionsbereit ist.

Debugging deaktivieren

Prüfen Sie, ob die Variable DEBUG in mysite/settings.py auf False festgelegt ist. Dadurch werden für Nutzer keine detaillierten Fehlerseiten angezeigt, die Informationen über die Konfigurationen auslesen können.

Berechtigungen für Datenbanknutzer einschränken

Alle Nutzer, die mit Cloud SQL erstellt wurden, haben die Berechtigungen, die der Rolle cloudsqlsuperuser zugeordnet sind: CREATEROLE, CREATEDB und LOGIN.

Erstellen Sie den Nutzer in PostgreSQL manuell, um diese Berechtigungen zu vermeiden. Das interaktive psql-Terminal muss installiert sein oder nutzen Sie Cloud Shell, wo das Tool vorinstalliert ist.

Console

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

2. Verwenden Sie in Cloud Shell den integrierten INSTANCE_NAME-Client, um eine Verbindung zur Instanz herzustellen:

   gcloud sql connect INSTANCE_NAME --user postgres
   

3. Geben Sie das Nutzerpasswort für Postgres ein.

   Sie verwenden jetzt psql. Die postgres=>-Eingabeaufforderung sollte nun angezeigt werden.

4. Erstellen Sie einen Nutzer:

   CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
   

   Ersetzen Sie PASSWORD durch ein zufälliges, eindeutiges Passwort.

5. Gewähren Sie dem neuen Nutzer uneingeschränkte Rechte für die neue Datenbank:

   GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
   

6. Beenden Sie psql:

   \q
   

gcloud

Hinweis: Alle Nutzer, die mit Cloud SQL erstellt wurden, haben die Berechtigungen, die der Rolle cloudsqlsuperuser zugeordnet sind: CREATEROLE, CREATEDB und LOGIN. In dieser Anleitung wird der Nutzer direkt in PostgreSQL erstellt.

1. Starten Sie eine Verbindung zur SQL-Instanz:

   gcloud sql connect INSTANCE_NAME --user postgres
   

   Ersetzen Sie INSTANCE_NAME durch die erstellte Cloud SQL-Instanz.

2. Geben Sie das Nutzerpasswort für Postgres ein.

   Sie verwenden jetzt psql. Die postgres=>-Eingabeaufforderung sollte nun angezeigt werden.

3. Erstellen Sie einen Nutzer:

   CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
   

4. Gewähren Sie dem neuen Nutzer uneingeschränkte Rechte für die neue Datenbank:

   GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
   

5. Beenden Sie psql:

   \q
   

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 wurden 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 sie mithilfe von django-environ in die Umgebung abzurufen:

env = environ.Env(DEBUG=(bool, False))
env_file = os.path.join(BASE_DIR, ".env")

if os.path.isfile(env_file):
    # Use a local secret file, if provided

    env.read_env(env_file)
# ...
elif os.environ.get("GOOGLE_CLOUD_PROJECT", None):
    # Pull secrets from Secret Manager
    project_id = os.environ.get("GOOGLE_CLOUD_PROJECT")

    client = secretmanager.SecretManagerServiceClient()
    settings_name = os.environ.get("SETTINGS_NAME", "django_settings")
    name = f"projects/{project_id}/secrets/{settings_name}/versions/latest"
    payload = client.access_secret_version(name=name).payload.data.decode("UTF-8")

    env.read_env(io.StringIO(payload))
else:
    raise Exception("No local .env or GOOGLE_CLOUD_PROJECT detected. No secrets found.")

Mit dem Secret wurden mehrere Secret-Werte gespeichert, um die Anzahl der verschiedenen Secrets zu reduzieren, die konfiguriert werden mussten.

CSRF-Konfigurationen

Django bietet einen integrierten Schutz vor Cross-Site Request Forgery (CSRF). Ab Django 4.0 müssen Sie Django die gehostete URL mitteilen, damit der bestmögliche Schutz für Nutzer gewährleistet werden kann, die Daten einreichen.

Sie geben die URL der App als Umgebungsvariable in der Datei settings.py an. Dieser Wert wird von Django für die entsprechenden Einstellungen verwendet.

# SECURITY WARNING: It's recommended that you use this when
# running in production. The URL will be known once you first deploy
# to App Engine. This code takes the URL and converts it to both these settings formats.
APPENGINE_URL = env("APPENGINE_URL", default=None)
if APPENGINE_URL:
    # Ensure a scheme is present in the URL before it's processed.
    if not urlparse(APPENGINE_URL).scheme:
        APPENGINE_URL = f"https://{APPENGINE_URL}"

    ALLOWED_HOSTS = [urlparse(APPENGINE_URL).netloc]
    CSRF_TRUSTED_ORIGINS = [APPENGINE_URL]
    SECURE_SSL_REDIRECT = True
else:
    ALLOWED_HOSTS = ["*"]

Lokale Secret-Überschreibungen

Wenn im lokalen Dateisystem eine .env-Datei gefunden wird, wird sie anstelle des Werts aus Secret Manager verwendet. Eine lokale .env-Datei kann bei lokalen Tests hilfreich sein (z. B. bei der lokalen Entwicklung einer SQLite-Datenbank oder anderen lokalen Einstellungen).

Datenbankverbindung

Die Datei settings.py enthält die Konfiguration für Ihre SQL-Datenbank. Dabei wird der env.db()-Hilfs-Object aus django-environ verwendet, um den in DATABASE_URL festgelegten Verbindungsstring in die DATABASES-Einstellung zu laden.

Wenn Sie die Anwendung lokal ausführen und den Cloud SQL Auth-Proxy zum Zugriff auf die gehostete Datenbank verwenden, werden die Datenbankeinstellungen mit dem Flag USE_CLOUD_SQL_AUTH_PROXY so angepasst, dass der Proxy verwendet wird.

# Use django-environ to parse the connection string
DATABASES = {"default": env.db()}

# If the flag as been set, configure to use proxy
if os.getenv("USE_CLOUD_SQL_AUTH_PROXY", None):
    DATABASES["default"]["HOST"] = "127.0.0.1"
    DATABASES["default"]["PORT"] = 5432

Gehostete statische Inhalte

Die Datei app.yaml enthält Konfigurationsinformationen für die Bereitstellung in App Engine. Diese app.yaml - Datei gibt an, dass App Engine statische Dateien aus dem Verzeichnis static/ bereitstellt:

runtime: python39

env_variables:
  # This setting is used in settings.py to configure your ALLOWED_HOSTS
  # APPENGINE_URL: PROJECT_ID.uc.r.appspot.com

handlers:
# This configures Google App Engine to serve the files in the app's static
# directory.
- url: /static
  static_dir: static/

# This handler routes all requests not caught above to your main app. It is
# required when static routes are defined, but can be omitted (along with
# the entire handlers section) when there are no static files defined.
- url: /.*
  script: auto

Wenn Sie die Anwendung lokal ausführen und DEBUG aktiviert ist, werden diese Dateien lokal von Django bereitgestellt:

from django.conf import settings
from django.conf.urls.static import static
from django.contrib import admin
from django.urls import include, path

urlpatterns = [
    path("", include("polls.urls")),
    path("admin/", admin.site.urls),
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

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

Achtung: Das Löschen von Projekten hat folgende Auswirkungen:

• Alle Inhalte des Projekts werden gelöscht. Wenn Sie für die Aufgaben in diesem Dokument ein bereits bestehendes Projekt verwendet haben und dieses löschen, werden auch alle anderen im Rahmen des Projekts erstellten Daten gelöscht.
• Benutzerdefinierte Projekt-IDs gehen verloren. Beim Erstellen dieses Projekts haben Sie möglicherweise eine benutzerdefinierte Projekt-ID erstellt, die Sie weiterhin verwenden möchten. Damit die URLs, die die Projekt-ID nutzen, z. B. eine appspot.com-URL, erhalten bleiben, sollten Sie ausgewählte Ressourcen innerhalb des Projekts löschen, statt das gesamte Projekt.

Wenn Sie mehrere Architekturen, Anleitungen und Kurzanleitungen durcharbeiten möchten, können Sie die Überschreitung von Projektkontingenten verhindern, indem Sie Projekte wiederverwenden.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Nächste Schritte

• PostgreSQL für die Produktion konfigurieren
• Weitere Informationen zu Django in Google Cloud