Bereitstellen einer Python-FastAPI-Web-App mit PostgreSQL in Azure

• Ein Azure-Konto mit einem aktiven Abonnement. Falls Sie kein Azure-Konto besitzen, können Sie kostenlos eines erstellen.
• Kenntnisse von Python mit FastAPI-Entwicklung.

• Ein Azure-Konto mit einem aktiven Abonnement. Falls Sie kein Azure-Konto besitzen, können Sie kostenlos eines erstellen.
• Azure Developer CLI installiert. Sie können die Schritte mit der Azure Cloud Shell ausführen, da azure Developer CLI bereits installiert ist.
• Kenntnisse von Python mit FastAPI-Entwicklung.

1. Erstellen von App Service- und PostgreSQL-Ressourcen

In diesem Schritt erstellen Sie die Azure-Ressourcen. Die in diesem Tutorial ausgeführten Schritte erstellen eine Reihe standardmäßig sicherer Ressourcen, die App Service und Azure Database for PostgreSQL umfassen. Für den Erstellungsprozess geben Sie Folgendes an:

• Der Name der Web-App. Es ist der Name, der als Teil des DNS-Namens für Ihre Web-App verwendet wird.
• Die Region in der die App physisch weltweit ausgeführt wird.
• Der Laufzeitstapel für die App. Hier wählen Sie die Version von Python aus, die für Ihre App verwendet werden soll.
• Der Hostingplan für die App. Dies ist der Tarif, der die Features und Skalierungskapazität für Ihre App enthält.
• Die Ressourcengruppe für die App. Mit einer Ressourcengruppe können Sie (in einem logischen Container) alle für die Anwendung benötigten Azure-Ressourcen gruppieren.

Melden Sie sich beim Azure-Portal an, und führen Sie die folgenden Schritte aus, um Ihre Azure App Service-Ressourcen zu erstellen.

2. Überprüfen der Verbindungseinstellungen

Der Erstellungs-Assistent hat die Konnektivitätsvariablen für Sie bereits als App-Einstellungen generiert. App-Einstellungen sind eine Möglichkeit, um Verbindungsgeheimnisse aus Ihrem Coderepository herauszuhalten. Wenn Sie bereit sind, Ihre geheimen Schlüssel an einen sichereren Speicherort zu verschieben, finden Sie in der Schnellstartanleitung: Azure Key Vault-Zertifikatclientbibliothek für Python.

3. Bereitstellen von Beispielcode

In diesem Schritt konfigurieren Sie die GitHub-Bereitstellung mithilfe von GitHub Actions. Es ist nur eine der vielen Möglichkeiten, um App Service bereitzustellen, aber auch eine hervorragende Möglichkeit, eine kontinuierliche Integration in Ihren Bereitstellungsprozess zu haben. Standardmäßig startet jede git push in Ihrem GitHub-Repository die Build- und Bereitstellungsaktion.

Treten Probleme auf? Überprüfen Sie das Handbuch zur Problembehandlung.

4. Generieren des Datenbankschemas

In einem vorherigen Abschnitt haben Sie src/entrypoint.sh als Startbefehl für Ihre App hinzugefügt. entrypoint.sh enthält die folgende Zeile: python3 src/fastapi_app/seed_data.py. Mit diesem Befehl wird Ihre Datenbank migriert. In der Beispiel-App wird damit nur sichergestellt, dass die richtigen Tabellen in Ihrer Datenbank erstellt werden. Er füllt diese Tabellen nicht mit Daten auf.

In diesem Abschnitt führen Sie diesen Befehl manuell zu Demonstrationszwecken aus. Mit der durch das virtuelle Netzwerk geschützten PostgreSQL-Datenbank besteht die einfachste Möglichkeit zum Ausführen des Befehls in einer SSH-Sitzung mit dem App Service-Container.

5. Navigieren zur App

6. Streamen von Diagnoseprotokollen

Die Beispiel-App verwendet das Protokollierungsmodul der Python-Standardbibliothek, um Probleme mit Ihrer Anwendung zu diagnostizieren. Die Beispiel-App enthält Aufrufe des Protokollierungsmoduls, wie im folgenden Code dargestellt.

@app.get("/", response_class=HTMLResponse)
async def index(request: Request, session: Session = Depends(get_db_session)):
    logger.info("root called")
    statement = (
        select(Restaurant, func.avg(Review.rating).label("avg_rating"), func.count(Review.id).label("review_count"))
        .outerjoin(Review, Review.restaurant == Restaurant.id)
        .group_by(Restaurant.id)
    )

Es kann mehrere Minuten dauern, bis Ereignisse in den Diagnoseprotokollen angezeigt werden. Weitere Informationen zur Protokollierung in Python-Apps finden Sie unter Einrichten von Azure Monitor für Ihre Python-Anwendung.

7. Bereinigen von Ressourcen

Wenn Sie fertig sind, können Sie alle Ressourcen aus Ihrem Azure-Abonnement löschen, indem Sie die Ressourcengruppe löschen.

1. Erstellen von Azure-Ressourcen und Bereitstellen einer Beispiel-App

In diesem Schritt erstellen Sie die Azure-Ressourcen und stellen eine Beispiel-App für App Service für Linux bereit. Die in diesem Tutorial ausgeführten Schritte erstellen eine Reihe standardmäßig sicherer Ressourcen, die App Service und Azure Database for PostgreSQL umfassen.

1. Klonen Sie den starter-no-infra-Branch des Beispielrepositorys in einem lokalen Terminal, sofern noch nicht geschehen.

   git clone -b starter-no-infra https://github.com/Azure-Samples/msdocs-fastapi-postgresql-sample-app
   cd msdocs-fastapi-postgresql-sample-app
   

   Dieser geklonte Branch ist Ihr Ausgangspunkt. Er enthält eine einfache datengesteuerte FastAPI-Anwendung.

2. Führen Sie im Repositorystamm azd init aus.

   azd init --template msdocs-fastapi-postgresql-sample-app
   

3. Wenn Sie dazu aufgefordert werden, geben Sie die folgenden Antworten:

   Frage	Antwort
   Das aktuelle Verzeichnis ist nicht leer. Möchten Sie ein Projekt hier in <Ihr Verzeichnis> initialisieren?	J
   Was möchten Sie mit diesen Dateien tun?	Meine vorhandenen Dateien unverändert lassen
   Geben Sie einen neuen Umgebungsnamen ein.	Geben Sie einen eindeutigen Namen ein. Die azd-Vorlage verwendet diesen Namen als Teil des DNS-Namens Ihrer Web-App in Azure (<app-name>.azurewebsites.net). Alphanumerische Zeichen und Bindestriche sind zulässig.

4. Führen Sie den azd up-Befehl aus, um die notwendigen Azure-Ressourcen und den App-Code bereitzustellen. Wenn Sie noch nicht bei Azure angemeldet sind, startet der Browser und fordert Sie auf, sich anzumelden. Der azd up Befehl fordert Sie außerdem auf, das gewünschte Abonnement und den gewünschten Speicherort für die Bereitstellung auszuwählen.

   azd up
   

   Die Ausführung des Befehls azd up kann mehrere Minuten dauern. Außerdem wird Ihr Anwendungscode kompiliert und bereitgestellt. Während der Ausführung stellt der Befehl Nachrichten zum Bestimmungs- und Bereitstellungsprozess bereit, einschließlich eines Links zur Bereitstellung in Azure. Wenn er abgeschlossen ist, zeigt der Befehl auch einen Link zur Bereitstellungsanwendung an.

   Diese azd-Vorlage enthält Dateien (azure.yaml und das Infrastrukturverzeichnis ), die eine sichere standardmäßige Architektur mit den folgenden Azure-Ressourcen generieren:

   • Ressourcengruppe → Der Container für alle erstellten Ressourcen.
   • App Service-Plan → Definiert die Computeressourcen für App Service. Es wird ein Linux-Plan auf der B1-Ebene angegeben.
   • Virtuelles Netzwerk → in die App Service-App integriert und isoliert den Back-End-Netzwerkdatenverkehr.
   • Azure Database for PostgreSQL flexible Server → Nur innerhalb des virtuellen Netzwerks zugänglich. Eine Datenbank und ein Benutzer werden für Sie auf dem Server erstellt.
   • Private DNS-Zone → Aktiviert die DNS-Auflösung des PostgreSQL-Servers im virtuellen Netzwerk.
   • Log Analytics-Arbeitsbereich → Dient als Zielcontainer für Ihre App, um ihre Protokolle zu versenden, wo Sie auch die Protokolle abfragen können.

5. Wenn der azd up Befehl abgeschlossen ist, notieren Sie sich die Werte für die Abonnement-ID, den App-Dienst und die Ressourcengruppe in der Ausgabe. Sie verwenden sie in den folgenden Abschnitten. Die Ausgabe sollte ähnlich wie die folgende (teilweise) Ausgabe aussehen:

   Subscription: Your subscription name (1111111-1111-1111-1111-111111111111)
   Location: East US
   
     You can view detailed progress in the Azure Portal:
     https://portal.azure.com/#view/HubsExtension/DeploymentDetailsBlade/~/overview/id/%2Fsubscriptions%2F1111111-1111-1111-1111-111111111111%2Fproviders%2FMicrosoft.Resources%2Fdeployments%2Fyourenv-1721867673
   
     (✓) Done: Resource group: yourenv-rg
     (✓) Done: Virtual Network: yourenv-e2najjk4vewf2-vnet
     (✓) Done: App Service plan: yourenv-e2najjk4vewf2-service-plan
     (✓) Done: Log Analytics workspace: yourenv-e2najjk4vewf2-workspace
     (✓) Done: Application Insights: yourenv-e2najjk4vewf2-appinsights
     (✓) Done: Portal dashboard: yourenv-e2najjk4vewf2-dashboard
     (✓) Done: App Service: yourenv-e2najjk4vewf2-app-service
     (✓) Done: Azure Database for PostgreSQL flexible server: yourenv-e2najjk4vewf2-postgres-server
     (✓) Done: Cache for Redis: yourenv-e2najjk4vewf2-redisCache
     (✓) Done: Private Endpoint: cache-privateEndpoint
   
   SUCCESS: Your application was provisioned in Azure in 32 minutes.
   You can view the resources created under the resource group yourenv-rg in Azure Portal:
   https://portal.azure.com/#@/resource/subscriptions/1111111-1111-1111-1111-111111111111/resourceGroups/yourenv-rg/overview
   
   Deploying services (azd deploy)
   
     (✓) Done: Deploying service web
     - Endpoint: https://yourenv-e2najjk4vewf2-app-service.azurewebsites.net/
   
   

2. Untersuchen der Datenbankverbindungszeichenfolge

Die Azd-Vorlage generiert die Konnektivitätsvariablen für Sie als App-Einstellungen. App-Einstellungen sind eine Möglichkeit, um Verbindungsgeheimnisse aus Ihrem Coderepository herauszuhalten.

1. Suchen Sie in der Datei infra/resources.bicep die App-Einstellungen und die Einstellung für AZURE_POSTGRESQL_CONNECTIONSTRING.

   resource appSettings 'config' = {
     name: 'appsettings'
     properties: {
         SCM_DO_BUILD_DURING_DEPLOYMENT: 'true'
         AZURE_POSTGRESQL_CONNECTIONSTRING: 'dbname=${pythonAppDatabase.name} host=${postgresServer.name}.postgres.database.azure.com port=5432 sslmode=require user=${postgresServer.properties.administratorLogin} password=${databasePassword}'
         SECRET_KEY: secretKey
         AZURE_REDIS_CONNECTIONSTRING: 'rediss://:${redisCache.listKeys().primaryKey}@${redisCache.name}.redis.cache.windows.net:6380/0'
       }
   }
   

2. AZURE_POSTGRESQL_CONNECTIONSTRING enthält die Verbindungszeichenfolge für die Postgres-Datenbank in Azure. Sie müssen sie verwenden, um eine Verbindung damit herzustellen. Sie finden den Code, der diese Umgebungsvariable verwendet, in src/fastapi/models.py:

   sql_url = ""
   if os.getenv("WEBSITE_HOSTNAME"):
       logger.info("Connecting to Azure PostgreSQL Flexible server based on AZURE_POSTGRESQL_CONNECTIONSTRING...")
       env_connection_string = os.getenv("AZURE_POSTGRESQL_CONNECTIONSTRING")
       if env_connection_string is None:
           logger.info("Missing environment variable AZURE_POSTGRESQL_CONNECTIONSTRING")
       else:
           # Parse the connection string
           details = dict(item.split('=') for item in env_connection_string.split())
   
           # Properly format the URL for SQLAlchemy
           sql_url = (
               f"postgresql://{quote_plus(details['user'])}:{quote_plus(details['password'])}"
               f"@{details['host']}:{details['port']}/{details['dbname']}?sslmode={details['sslmode']}"
           )
   
   else:
       logger.info("Connecting to local PostgreSQL server based on .env file...")
       load_dotenv()
       POSTGRES_USERNAME = os.environ.get("DBUSER")
       POSTGRES_PASSWORD = os.environ.get("DBPASS")
       POSTGRES_HOST = os.environ.get("DBHOST")
       POSTGRES_DATABASE = os.environ.get("DBNAME")
       POSTGRES_PORT = os.environ.get("DBPORT", 5432)
   
       sql_url = f"postgresql://{POSTGRES_USERNAME}:{POSTGRES_PASSWORD}@{POSTGRES_HOST}:{POSTGRES_PORT}/{POSTGRES_DATABASE}"
   
   engine = create_engine(sql_url)
   

3. Untersuchen des Startbefehls

Azure App Service erfordert einen Startbefehl, um Ihre FastAPI-App auszuführen. Die azd-Vorlage legt diesen Befehl in Ihrer App Service-Instanz für Sie fest.

1. Suchen Sie in der Datei infra/resources.bicep die Deklaration für Ihre Website und dann die Einstellung für appCommandLine. Dies ist die Einstellung für den Startbefehl.

   resource web 'Microsoft.Web/sites@2024-11-01' = {
     name: '${prefix}-app-service'
     location: location
     tags: union(tags, { 'azd-service-name': 'web' })
     kind: 'app,linux'
     properties: {
       serverFarmId: appServicePlan.id
       siteConfig: {
         alwaysOn: true
         linuxFxVersion: 'PYTHON|3.11'
         ftpsState: 'Disabled'
         appCommandLine: 'src/entrypoint.sh'
         minTlsVersion: '1.2'
       }
       httpsOnly: true
     }
     identity: {
       type: 'SystemAssigned'
     }
   

2. Der Startbefehl führt die Datei "src/entrypoint.sh" aus. Überprüfen Sie den Code in dieser Datei, um die Befehle zu verstehen, die der App-Dienst ausführt, um Ihre App zu starten:

   #!/bin/bash
   set -e
   python3 -m pip install --upgrade pip
   python3 -m pip install -e src
   python3 src/fastapi_app/seed_data.py
   python3 -m gunicorn fastapi_app:app -c src/gunicorn.conf.py
   

Weitere Informationen zur App-Konfiguration und zum Starten in App Service finden Sie unter Konfigurieren einer Linux Python-App für Azure App Service.

4. Generieren des Datenbankschemas

Möglicherweise haben Sie im vorherigen Abschnitt bemerkt, dass entrypoint.sh die folgende Zeile enthält: python3 src/fastapi_app/seed_data.py Mit diesem Befehl wird Ihre Datenbank migriert. In der Beispiel-App wird damit nur sichergestellt, dass die richtigen Tabellen in Ihrer Datenbank erstellt werden. Er füllt diese Tabellen nicht mit Daten auf.

In diesem Abschnitt führen Sie diesen Befehl zu Demonstrationszwecken manuell aus. Mit der durch das virtuelle Netzwerk geschützten PostgreSQL-Datenbank besteht die einfachste Möglichkeit zum Ausführen des Befehls in einer SSH-Sitzung mit dem App Service-Container.

1. Verwenden Sie den Wert des App-Diensts , den Sie zuvor in der azd-Ausgabe erwähnt haben, um die URL für die SSH-Sitzung zu erstellen und im Browser zu diesem zu navigieren:

2. Führen Sie im SSH-Terminal python3 src/fastapi_app/seed_data.py aus. Wenn dies erfolgreich ist, stellt der App-Dienst eine erfolgreiche Verbindung mit der Datenbank bereit.

   

   Hinweis

   Nur Änderungen an Dateien in /home können über den Neustart der App hinaus beibehalten werden. Änderungen außerhalb von /home bleiben nicht erhalten.

5. Navigieren zur App

1. Suchen Sie in der azd-Ausgabe die URL für Ihre App, und navigieren Sie im Browser dorthin. Die URL sieht in der AZD-Ausgabe wie folgt aus:

   Deploying services (azd deploy)
   
     (✓) Done: Deploying service web
     - Endpoint: <URL>
   

2. Fügen Sie ein paar Restaurants zu der Liste hinzu.

   

   Glückwunsch! Sie führen eine Web-App in Azure App Service aus, mit sicherer Konnektivität zu Azure Database for PostgreSQL.

6. Streamen von Diagnoseprotokollen

Azure App Service kann Protokolle erfassen, um Sie bei der Diagnose von Problemen mit Ihrer Anwendung zu unterstützen. Aus Gründen der Einfachheit hat die azd-Vorlage bereits die Protokollierung im lokalen Dateisystem aktiviert.

Die Beispiel-App verwendet das Protokollierungsmodul der Python-Standardbibliothek zum Ausgeben von Protokollen. Die Beispielanwendung enthält Aufrufe zum Logger.

@app.get("/", response_class=HTMLResponse)
async def index(request: Request, session: Session = Depends(get_db_session)):
    logger.info("root called")
    statement = (
        select(Restaurant, func.avg(Review.rating).label("avg_rating"), func.count(Review.id).label("review_count"))
        .outerjoin(Review, Review.restaurant == Restaurant.id)
        .group_by(Restaurant.id)
    )

Um auf den Protokolldatenstrom zuzugreifen, öffnen Sie Ihre App im Azure-Portal. Wählen Sie Überwachung>Protokolldatenstrom aus.

Es kann mehrere Minuten dauern, bis Ereignisse in den Diagnoseprotokollen angezeigt werden. Erfahren Sie mehr über die Protokollierung in Python-Apps in der Reihe zum Einrichten von Azure Monitor für Ihre Python-Anwendung.

7. Bereinigen von Ressourcen

Führen Sie azd down aus, um alle Azure-Ressourcen in der aktuellen Bereitstellungsumgebung zu löschen.

azd down