Använda Azure Pipelines för att skapa och distribuera en Python-webbapp till Azure App Service

• En Azure-prenumeration. Om du inte har en skapar du ett kostnadsfritt konto.
• Ett GitHub-konto. Om du inte har en kan du skapa en kostnadsfritt.
• En Azure DevOps Services-organisation. Skapa en kostnadsfritt.

• En Azure-prenumeration Om du inte har en skapar du ett kostnadsfritt konto.
• Ett GitHub-konto. Om du inte har en kan du skapa en kostnadsfritt.
• En Azure DevOps-server.
• En lokalt installerad agent. Om du behöver skapa en lokalt installerad agent kan du läsa Mer information om lokalt installerade agenter.

1. I en webbläsare går du till dev.azure.com och loggar in.
2. Välj din organisation.
3. Skapa ett nytt projekt genom att välja Nytt projekt eller Skapa projekt om du skapar det första projektet i organisationen.
4. Ange ett projektnamn.
5. Välj Synlighet för projektet.
6. Välj Skapa.

1. I en webbläsare går du till din Azure DevOps Server.
2. Välj din samling.
3. Skapa ett nytt projekt genom att välja Nytt projekt eller Skapa projekt om du skapar det första projektet i samlingen.
4. Ange ett projektnamn.
5. Välj Synlighet för projektet.
6. Välj Skapa.

Skapa ett huvudnamn för tjänsten

Ett huvudnamn för en tjänst är en identitet som skapas för att appar, värdbaserade tjänster och automatiserade verktyg ska få åtkomst till Azure-resurser. Den här åtkomsten är begränsad till de roller som tilldelats tjänstens huvudnamn, vilket ger dig kontroll över vilka resurser som kan nås och på vilken nivå.

Om du vill skapa ett huvudnamn för tjänsten går du till Cloud Shell (bash) och kör följande kommando. Ersätt <service-principal-name> med ett namn för tjänstens huvudnamn, <your-subscription-id> med ditt prenumerations-ID och <your-resource-group> med resursgruppen för webbappen.

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

Kommandot returnerar ett JSON-objekt som liknar följande exempel:

{
  "clientId": "<client GUID>",
  "clientSecret": "<string-value>",
  "subscriptionId": "<subscription GUID>",
  "tenantId": "<tenant GUID>",
  ...
}

Anteckna clientIdvärdena , clientSecret, subscriptionIdoch tenantId . Du behöver dessa värden för att skapa en tjänstanslutning i nästa avsnitt.

1. På projektsidan väljer du Projektinställningar.

   

2. Välj Tjänstanslutningar i avsnittet Pipelines på menyn.

3. Välj Skapa tjänst anslutning.

4. Välj Azure Resource Manager och välj Nästa.

   

5. Välj din autentiseringsmetod och välj Nästa.

6. I dialogrutan Ny Azure-tjänstanslutning anger du den information som är specifik för den valda autentiseringsmetoden. Mer information om autentiseringsmetoder finns i Ansluta till Azure med hjälp av en Azure Resource Manager-tjänstanslutning.

   Om du till exempel använder en autentiseringsmetod för arbetsbelastningsidentitetsfederation (automatisk) eller tjänstens huvudnamn (automatisk) anger du nödvändig information.

   

   Fält	Beskrivning
   Omfångsnivå	Välj Prenumeration.
   Abonnemang	Ditt Azure-prenumerationsnamn.
   Resursgrupp	Namnet på resursgruppen som innehåller webbappen.
   Namn på tjänstanslutning	Ett beskrivande namn för anslutningen.
   Bevilja åtkomstbehörigheter till alla pipelines	Välj det här alternativet om du vill bevilja åtkomst till alla pipelines.

7. Välj Spara.

Den nya anslutningen visas i listan Tjänstanslutningar och är redo att användas i Din Azure Pipeline.

1. På projektsidan väljer du Projektinställningar.

   

2. Välj Tjänstanslutningar i avsnittet Pipelines på menyn.

3. Välj Skapa tjänst anslutning.

4. Välj Azure Resource Manager och välj Nästa.

   

5. På Ny Azure-tjänstanslutning väljer du Tjänstens huvudnamn (manuell) och väljer Nästa

6. Fyll i nödvändig information i nästa dialogruta.

   

   Fält	Beskrivning
   Miljö	Välj Azure Cloud.
   Omfångsnivå	Välj Prenumeration.
   Prenumerations-ID	Ditt prenumerations-ID.
   Prenumerationsnamn	Ditt Azure-prenumerationsnamn.
   Tjänstens huvudnamn-ID	Värdet appId från JSON-objektet som returneras av az ad sp create-for-rbac kommandot.
   Nyckel för tjänsthuvudnamn	Värdet password från JSON-objektet som returneras av az ad sp create-for-rbac kommandot.
   Klientorganisations-ID	Värdet tenant från JSON-objektet som returneras av az ad sp create-for-rbac kommandot.

7. Välj Verifiera för att verifiera anslutningen.

8. Ange ett namn på tjänstanslutningen.

9. Se till att Bevilja åtkomstbehörigheter till alla pipelines har valts .

10. Välj Verifiera och spara.

Den nya anslutningen visas i listan Tjänstanslutningar och är klar för Azure Pipelines att använda från projektet.

Konfigurera en lokalt installerad agent

Om du använder en egen lokalt installerad agent måste du konfigurera agenten så att den kör Python. Nedladdning av Python-versioner stöds inte på lokalt installerade agenter. Du måste förinstallera Python-versionen. Använd det fullständiga installationsprogrammet för att hämta en pip-kompatibel version av Python.

För att undvika inkompatibla problem bör du matcha Python-versionen med körningsversionen i din Azure App Services-webbapp. Körningsversionen visas i JSON-utdata för az webapp up kommandot.

Den önskade Python-versionen måste läggas till i verktygscacheminnet på den lokalt installerade agenten så att uppgiften kan använda den. Normalt finns verktygscachen under _work/_tool-katalogen för agenten. Alternativt kan sökvägen åsidosättas med miljövariabeln AGENT_TOOLSDIRECTORY. Under verktygskatalogen skapar du följande katalogstruktur baserat på din Python-version:

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

Versionsnumret bör följa formatet 1.2.3. Plattformen ska antingen vara x86 eller x64. Verktygsfilerna ska vara de uppackade Python-versionsfilerna. {platform}.complete Ska vara en 0-byte-fil som ser ut som x86.complete eller x64.complete som bara betyder att verktyget är korrekt installerat i cacheminnet.

Om du till exempel använder Python 3.11 på en 64-bitars Windows-dator ser katalogstrukturen ut så här:

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

Om du redan har den Python-version som du vill använda på den dator som är värd för din agent kan du kopiera filerna till verktygscacheminnet. Om du inte har Python-versionen kan du ladda ned den från Python-webbplatsen.

1. Välj Pipelines på den vänstra navigeringsmenyn.

   

2. Välj Skapa pipeline.

   

3. I dialogrutan Var är din kod väljer du GitHub. Du kan uppmanas att logga in på GitHub.

   

4. På skärmen Välj en lagringsplats väljer du den förgrenade exempellagringsplatsen.

   

5. Du kan uppmanas att ange ditt GitHub-lösenord igen som en bekräftelse.

6. Om Azure Pipelines-tillägget inte är installerat på GitHub uppmanar GitHub dig att installera Azure Pipelines-tillägget .

   

   På den här sidan bläddrar du ned till avsnittet Lagringsplatsåtkomst , väljer om tillägget ska installeras på alla lagringsplatser eller endast valda och väljer sedan Godkänn och installera.

   

7. I dialogrutan Konfigurera din pipeline väljer du Python till Linux-webbapp i Azure.

8. Välj din Azure-prenumeration och välj Fortsätt.

9. Om du använder ditt användarnamn och lösenord för att autentisera öppnas en webbläsare där du kan logga in på ditt Microsoft-konto.

10. Välj webbappens namn i listrutan och välj Verifiera och konfigurera.

Azure Pipelines skapar en azure-pipelines.yml-fil och visar den i YAML-pipelinesredigeraren. Pipelinefilen definierar DIN CI/CD-pipeline som en serie steg, jobb och steg, där varje steg innehåller information om olika uppgifter och skript. Ta en titt på pipelinen för att se vad den gör. Kontrollera att alla standardindata är lämpliga för din kod.

1. Välj Pipelines på navigeringsmenyn.

   

2. Välj Skapa pipeline.

   

3. I dialogrutan Var är din kod väljer du GitHub Enterprise Server. Du kan uppmanas att logga in på GitHub.

   

4. På fliken Välj en lagringsplats väljer du den förgrenade exempellagringsplatsen.

   

5. Du kan uppmanas att ange ditt GitHub-lösenord igen som en bekräftelse.

6. Om Azure Pipelines-tillägget inte är installerat på GitHub uppmanar GitHub dig att installera Azure Pipelines-tillägget .

   

   På den här sidan bläddrar du ned till avsnittet Lagringsplatsåtkomst , väljer om tillägget ska installeras på alla lagringsplatser eller endast valda och väljer sedan Godkänn och installera.

   

7. I dialogrutan Konfigurera din pipeline väljer du Startpipeline.

8. Ersätt innehållet i azure-pipelines.yml-filen med följande kod.

   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 setup
           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'
   
   

9. Ersätt följande platshållare med dina egna värden:

   Platshållare	Beskrivning
   <your-service-connection-name>	Namnet på tjänstanslutningen som du skapade.
   <your-web-app-name>	Namnet på din Azure App Service-webbapp.
   <your-pool-name>	Namnet på den agentpool som du vill använda.
   <your-python-version>	Den version av Python som körs på din agent. Det är en bra idé att matcha den här versionen med Python-versionen som körs i webbappen. Webbappversionen visas i JSON-utdata för az webapp up kommandot.

Den fullständiga YAML-filen för pipelinen visas nedan:

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 setup
        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

Avsnittet variables innehåller följande variabler:

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.
projectRoot: $(System.DefaultWorkingDirectory)

# Python version: 3.11. Change this to match the Python runtime version running on your web app.
pythonVersion: '3.11'

Avsnittet variables innehåller följande variabler:

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

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

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

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

# Python version: 3.11. Change this to the version that is running on your agent and web app.
pythonVersion: '3.11'

Byggsteget innehåller ett enda jobb som körs på det operativsystem som definierats i variabeln vmImageName.

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

Byggsteget innehåller ett enda jobb som körs på en agent i poolen som identifieras av namnparametern. Du kan ange agentfunktionerna med nyckelordet demands . Anger till exempel demands: python att agenten måste ha Python installerat. Om du vill ange en lokalt installerad agent efter namn kan du använda nyckelordet demands: Agent.Name -equals <agent-name> .

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

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

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

I steps pipelinen är:

1. Använd uppgiften UsePythonVersion för att ange vilken version av Python som ska användas på agenten. Versionen definieras i variabeln pythonVersion .

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

2. Distribuera webbappen med hjälp av AzureWebApp@1. Den här uppgiften distribuerar pipelineartefakten drop till webbappen.

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

   Parameter	Beskrivning
   azureSubscription	Azure Resource Manager-tjänstens anslutnings-ID eller namn som ska användas.
   appName	Namnet på webbappen.
   package	Platsen för den .zip fil som ska distribueras.

   Eftersom python-vscode-flask-tutorial-lagringsplatsen innehåller samma startkommando i en fil med namnet startup.txt kan du ange filen genom att lägga till parametern: startUpCommand: 'startup.txt'.

I steps pipelinen är:

1. Använd uppgiften UsePythonVersion för att ange vilken version av Python som ska användas på agenten. Versionen definieras i variabeln pythonVersion .

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

2. Distribuera webbappen med hjälp av AzureWebApp@1. Den här uppgiften distribuerar pipelineartefakten drop till webbappen.

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

   Parameter	Beskrivning
   azureSubscription	Azure Resource Manager-tjänstens anslutnings-ID eller namn som ska användas.
   appName	Namnet på webbappen.
   package	Platsen för den .zip fil som ska distribueras.

   Eftersom python-vscode-flask-tutorial-lagringsplatsen innehåller samma startkommando i en fil med namnet startup.txt kan du ange filen genom att lägga till parametern: startUpCommand: 'startup.txt'.

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

   Parameter	Beskrivning
   azureSubscription	Azure Resource Manager-tjänstens anslutnings-ID eller namn som ska användas.
   appName	Namnet på webbappen.
   package	Platsen för den .zip fil som ska distribueras.
   startUpCommand	Kommandot som ska köras när appen har distribuerats. Exempelappen använder startup.txt.