Verwenden von Azure Pipelines zum Erstellen und Bereitstellen einer Python Web-App für Azure App Service

Konfigurieren eines selbst gehosteten Agenten

Das Herunterladen von Python-Versionen wird für selbst gehostete Build-Agents nicht unterstützt. Um Ihren eigenen selbst gehosteten Agent zu verwenden, müssen Sie den Agent für die Ausführung von Python konfigurieren.

Um Kompatibilitätsprobleme zu vermeiden, stimmen Sie in diesem Fall die Python-Version auf die Laufzeitversion Ihrer Web-App in Azure App Services 3.11 ab. Sie müssen die Python-Version vorinstallieren. Verwenden Sie das vollständige Installationsprogramm, um eine pip-kompatible Version von Python zu erhalten.

Die gewünschte Python-Version muss dem Toolcache im selbst gehosteten Agent hinzugefügt werden, damit die Pipelineaufgabe sie verwenden kann. Normalerweise befindet sich der Toolcache im Verzeichnis _work/_tool des Agents. Alternativ können Sie den Pfad mit der Umgebungsvariable AGENT_TOOLSDIRECTORYüberschreiben. Erstellen Sie unter dem Toolsverzeichnis die folgende Verzeichnisstruktur basierend auf Ihrer Python-Version:

$AGENT_TOOLSDIRECTORY/
    Python/
        {version number}/
            {platform}/
                {tool files}
            {platform}.complete

Die Versionsnummer sollte dem Format von 1.2.3 entsprechen. Die Plattform sollte entweder x86 oder x64 sein. Bei den tool-Dateien sollte es sich um die entpackten Python-Versionsdateien handeln. {platform}.complete sollte eine 0-Byte-Datei sein, die wie x86.complete oder x64.complete aussieht und nur bedeutet, dass das Tool ordnungsgemäß im Cache installiert ist.

Um beispielsweise Python 3.11 auf einem 64-Bit-Windows-Computer zu verwenden, erstellen Sie die folgende Verzeichnisstruktur:

$AGENT_TOOLSDIRECTORY/
    Python/
        3.11.4/
            x64/
                {python files}
            x64.complete

Wenn der Computer, auf dem Ihr Agent gehostet wird, bereits über die Python-Version verfügt, die Sie verwenden möchten, können Sie die Dateien in den Toolcache kopieren. Wenn Sie nicht über die Python-Version verfügen, können Sie sie von der Python-Website herunterladen.

Erstellen eines Dienstprinzipals

Ein Dienstprinzipal ist eine Identität, die für Anwendungen, gehostete Dienste und automatisierte Tools für den Zugriff auf Azure-Ressourcen erstellt wurde. Dieser Zugriff ist auf die Rollen beschränkt, die dem Dienstprinzipal zugewiesen sind, sodass Sie steuern können, auf welche Ebene auf welche Ressourcen zugegriffen werden kann.

Führen Sie zum Erstellen eines Dienstprinzipals den folgenden Befehl in der Bash Cloud Shell aus. Ersetzen Sie <service-principal-name> durch einen Namen für Ihren Dienstprinzipal, <your-subscription-id> durch Ihre Azure-Abonnement-ID und <your-resource-group> durch die Ressourcengruppe für die Web-App.

az ad sp create-for-rbac --display-name <service-principal-name> --role contributor --scopes /subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>

Der Befehl gibt das folgende JSON-Objekt zurück:

{
  "appId": "<client GUID>",
  "displayName": "<service-principal-name">,
  "password": "<password-string>",
  "tenant": "<tenant GUID>"
  ...
}

Notieren Sie sich die Werte der appId, password und tenantId, die für die Erstellung einer Dienstverbindung im nächsten Abschnitt verwendet werden sollen.

1. Wählen Sie auf ihrer Azure DevOps-Projektseite Die Projekteinstellungen aus.

2. Wählen Sie unter "Projekteinstellungen" die Option "Pipelines>Service connections" aus.

3. Wählen Sie auf der Seite "Dienstverbindungen " die Option "Neue Dienstverbindung " oder " Dienstverbindung erstellen " aus, wenn diese Dienstverbindung der erste im Projekt ist.

   

4. Wählen Sie auf dem Bildschirm " Neue Dienstverbindung " azure Resource Manager und dann "Weiter" aus.

   

5. Wählen Sie auf dem Bildschirm " Neue Azure-Dienstverbindung " Ihren Identitätstyp aus. In diesem Beispiel wird die App-Registrierung (automatisch) verwendet, die empfohlen wird. Weitere Informationen zu Authentifizierungsmethoden finden Sie unter Verbinden mit Azure über eine Azure Resource Manager-Dienstverbindung.

6. Wählen Sie für Anmeldeinformationen, den Workload-Identitätsverbund (automatisch) aus.

7. Füllen Sie die folgenden Felder aus:

   • Bereichsebene: Abonnement auswählen.
   • Abonnement: Wählen Sie Ihr Azure-Abonnement.
   • Ressourcengruppe: Wählen Sie die Ressourcengruppe aus, die Ihre Web-App enthält.
   • Dienstverbindungsname: Geben Sie einen beschreibenden Namen für die Verbindung ein.
   • Gewähren von Zugriffsberechtigungen für alle Pipelines: Aktivieren Sie dieses Kontrollkästchen, um Zugriff auf alle Pipelines im Projekt zu gewähren.

8. Wählen Sie Speichern.

   

1. Wählen Sie auf ihrer Azure DevOps-Projektseite Die Projekteinstellungen aus.

2. Wählen Sie unter "Projekteinstellungen" die Option "Pipelines>Service connections" aus.

3. Wählen Sie auf der Seite "Dienstverbindungen " die Option "Neue Dienstverbindung " oder " Dienstverbindung erstellen " aus, wenn diese Dienstverbindung der erste im Projekt ist.

   

4. Wählen Sie auf dem Bildschirm " Neue Dienstverbindung " azure Resource Manager und dann "Weiter" aus.

   

5. Wählen Sie den Dienstprinzipal (manuell) und dann "Weiter" aus.

   

6. Füllen Sie auf dem Bildschirm " Neue Azure-Dienstverbindung " die folgenden Felder aus:

   • Umgebung: Wählen Sie Azure Cloud aus.
   • Bereichsebene: Abonnement auswählen.
   • Abonnement-ID: Geben Sie Ihre Azure-Abonnement-ID ein.
   • Abonnementname: Geben Sie Ihren Azure-Abonnementnamen ein.

7. Füllen Sie im Abschnitt "Authentifizierung " die folgenden Felder aus:

   • Dienstprinzipal-ID: Geben Sie den appId vom az ad sp create-for-rbac Befehl zurückgegebenen Wert ein.
   • Anmeldeinformationen: Wählen Sie den Dienstprinzipalschlüssel aus.
   • Dienstprinzipalschlüssel: Geben Sie den Wert ein, der vom az ad sp create-for-rbac-Befehl zurückgegeben wurde.
   • Mandanten-ID: Geben Sie den tenant vom az ad sp create-for-rbac Befehl zurückgegebenen Wert ein.
   • Wählen Sie Überprüfen, um die Verbindung zu verifizieren.

8. Geben Sie im Abschnitt "Details " unter "Dienstverbindungsname" einen Namen für die Dienstverbindung ein.

9. Aktivieren Sie das Kontrollkästchen zum Erteilen von Zugriffsberechtigungen für alle Pipelines.

10. Klicken Sie auf Verify and save.

    

1. Wählen Sie im linken Navigationsmenü für Ihr Projekt Pipelines aus.

2. Wählen Sie auf der Seite "Pipelines " die Option "Neue Pipeline" oder " Pipeline erstellen " aus, wenn diese Pipeline der erste im Projekt ist.

   

3. Wählen Sie auf dem Codebildschirm "Wo befindet sich Ihr Code " auf GitHub aus. Sie werden möglicherweise aufgefordert, sich bei GitHub anzumelden.

   

4. Wählen Sie auf dem "Repository auswählen"-Bildschirm Ihr geforktes Beispiel-Repository aus. GitHub fordert Sie möglicherweise erneut auf, Ihr GitHub-Kennwort einzugeben oder die GitHub-App von Azure Pipelines zu installieren. Folgen Sie den Anweisungen auf dem Bildschirm, um die App zu installieren. Weitere Informationen finden Sie unter GitHub-App-Authentifizierung.

   

5. Wählen Sie auf der Seite "Pipeline konfigurieren"die Option "Python to Linux Web App" in Azure aus.

6. Wählen Sie auf dem nächsten Bildschirm Ihr Azure-Abonnement und dann "Weiter" aus.

7. Wählen Sie auf dem nächsten Bildschirm Ihre Azure Web App aus, und wählen Sie "Überprüfen und Konfigurieren" aus.

Azure Pipelines erstellt eine azure-pipelines.yml Datei und zeigt sie im YAML-Pipeline-Editor an.

1. Wählen Sie im linken Navigationsmenü für Ihr Projekt Pipelines aus.

2. Wählen Sie auf der Seite "Pipelines " die Option "Neue Pipeline" oder " Pipeline erstellen " aus, wenn diese Pipeline der erste im Projekt ist.

   

3. Wählen Sie auf der Seite "Wo ist Ihre Codeseite" die Option "GitHub Enterprise Server" aus. Sie werden möglicherweise aufgefordert, sich bei GitHub anzumelden.

   

4. Wählen Sie auf der Registerkarte Repository auswählen Ihr geforktes Beispiel-Repository aus. GitHub fordert Sie möglicherweise erneut auf, Ihr GitHub-Kennwort einzugeben oder die GitHub-Erweiterung oder -App von Azure Pipelines zu installieren. Folgen Sie den Anweisungen auf dem Bildschirm, um die App zu installieren. Weitere Informationen finden Sie unter Zugriff auf GitHub-Repositorys.

   

5. Wählen Sie auf der Seite "Pipeline konfigurieren" die Option "Startpipeline" aus.

6. Ersetzen Sie auf der Seite "YaML überprüfen" den Inhalt der Startdatei azure-pipelines.yml durch die folgende YAML-Pipelinedatei. In der YAML-Datei:

   • Ersetzen Sie die Platzhalter <your-service-connection-name> und <your-web-app-name> durch Ihre eigenen Werte.

   • Ersetzen Sie den <your-pool-name> Namen des Agentpools, den Sie verwenden möchten, und ersetzen Sie sie <your-python-version> durch die Version von Python, die auf Ihrem Agent ausgeführt wird. Diese Version sollte mit der runtime_version JSON-Ausgabe des az webapp up Befehls übereinstimmen.

Das folgende vollständige Beispiel für die YAML-Pipelinedatei definiert Ihre CI/CD-Pipeline als eine Reihe von Phasen, Aufträgen und Schritten, wobei jeder Schritt die Details für verschiedene Aufgaben und Skripts enthält. Der generierte YAML-Code füllt die Platzhalter automatisch mit Werten für Ihre App und Verbindung auf.

trigger:
- main

variables:
  # Azure Resource Manager connection created during pipeline creation
  azureServiceConnectionId: '<GUID>'

  # Web app name
  webAppName: '<your-webapp-name>'

  # Agent VM image name
  vmImageName: 'ubuntu-latest'

  # Environment name
  environmentName: '<your-webapp-name>'

  # Project root folder. Point to the folder containing manage.py file.
  projectRoot: $(System.DefaultWorkingDirectory)

  pythonVersion: '3.11'

stages:
- stage: Build
  displayName: Build stage
  jobs:
  - job: BuildJob
    pool:
      vmImage: $(vmImageName)
    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python $(pythonVersion)'

    - script: |
        python -m venv antenv
        source antenv/bin/activate
        python -m pip install --upgrade pip
        pip install setuptools
        pip install -r requirements.txt
      workingDirectory: $(projectRoot)
      displayName: "Install requirements"

    - task: ArchiveFiles@2
      displayName: 'Archive files'
      inputs:
        rootFolderOrFile: '$(projectRoot)'
        includeRootFolder: false
        archiveType: zip
        archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
        replaceExistingArchive: true

    - upload: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
      displayName: 'Upload package'
      artifact: drop

- stage: Deploy
  displayName: 'Deploy Web App'
  dependsOn: Build
  condition: succeeded()
  jobs:
  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)
    strategy:
      runOnce:
        deploy:
          steps:

          - task: UsePythonVersion@0
            inputs:
              versionSpec: '$(pythonVersion)'
            displayName: 'Use Python version'

          - task: AzureWebApp@1
            displayName: 'Deploy Azure Web App : $(webAppName)'
            inputs:
              azureSubscription: $(azureServiceConnectionId)
              appName: $(webAppName)
              package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip

trigger:
- main

variables:
  # Azure Resource Manager connection created during pipeline creation
  azureServiceConnectionId: '<your-service-connection-name>'

  # Web app name
  webAppName: '<your-web-app-name>'

  # Environment name
  environmentName: '<your-web-app-name>'

  # Project root folder. 
  projectRoot: $(System.DefaultWorkingDirectory)

  # Python version: 
  pythonVersion: '<your-python-version>'

stages:
- stage: Build
  displayName: Build stage
  jobs:
  - job: BuildJob
pool:
      name: '<your-pool-name>'
      demands: python
    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python $(pythonVersion)'

    - script: |
        python -m venv antenv
        source antenv/bin/activate
        python -m pip install --upgrade pip
        pip install -r requirements.txt
      workingDirectory: $(projectRoot)
      displayName: "Install requirements"

    - task: ArchiveFiles@2
      displayName: 'Archive files'
      inputs:
        rootFolderOrFile: '$(projectRoot)'
        includeRootFolder: false
        archiveType: zip
        archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
        replaceExistingArchive: true

    - task: PublishBuildArtifacts@1
      inputs:
        PathtoPublish: '$(Build.ArtifactStagingDirectory)'
        ArtifactName: 'drop'
        publishLocation: 'Container'

- stage: Deploy
  displayName: 'Deploy Web App'
  dependsOn: Build
  condition: succeeded()
  jobs:
  - deployment: DeploymentJob
    pool:
      name: '<your-pool-name'
    environment: $(environmentName)
    strategy:
      runOnce:
        deploy:
          steps:

          - task: UsePythonVersion@0
            inputs:
              versionSpec: '$(pythonVersion)'
            displayName: 'Use Python version'

          - task: AzureWebApp@1
            displayName: 'Deploy Azure Web App : <your-web-app-name>'
            inputs:
              azureSubscription: $(azureServiceConnectionId)
              appName: $(webAppName)
              package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
              startUpCommand: 'startup.txt'

Die Buildphase enthält einen einzelnen Auftrag, der auf dem betriebssystem ausgeführt wird, das in der vmImageName Variablen definiert ist, in diesem Fall ubuntu-latest.

  - job: BuildJob
    pool:
      vmImage: $(vmImageName)

Die Buildphase enthält einen einzelnen Job, der auf einem Agent im pool durch den name Parameter identifiziert ausgeführt wird.

Sie können die Funktionalitäten des Agenten mit dem Schlüsselwort demands angeben. So gibt demands: python beispielsweise an, dass der Agent Python installiert haben muss. Um einen selbst gehosteten Agenten nach Namen anzugeben, können Sie demands: Agent.Name -equals <agent-name> verwenden.

  - job: BuildJob
    pool:
      name: <your-pool-name>
      demands: python

  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)

• Das deployment Schlüsselwort kennzeichnet, dass der Auftrag ein Bereitstellungsauftrag ist, der auf eine Umgebung abzielt, um dorthin bereitzustellen. Das environment wird automatisch in Ihrem Projekt erstellt, wenn der Auftrag ausgeführt wird.

• Der pool Parameter gibt den Bereitstellungs-Agent-Pool an und verwendet den Standard-Agent-Pool, wenn name kein Parameter angegeben ist. Der Agent wird auf dem betriebssystem ausgeführt, das in der vmImageName Variablen definiert ist, in diesem Fall ubuntu-latest.

  - deployment: DeploymentJob
    pool:
      name: <your-pool-name>
    environment: $(environmentName)

• Das deployment Schlüsselwort gibt an, dass der Auftrag ein Bereitstellungsauftrag ist, der auf eine Umgebung zur Bereitstellung abzielt. Das environment wird automatisch in Ihrem Projekt erstellt, wenn der Auftrag ausgeführt wird.

• Der pool Parameter gibt den Bereitstellungs-Agent-Pool an und muss einen Agent mit der Funktion zum Ausführen der in der Pipeline angegebenen Python-Version enthalten.