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

Konfigurera en lokalt installerad agent

Nedladdning av Python-versioner stöds inte på lokala byggagenter. Om du vill använda en egen lokalt installerad agent måste du konfigurera agenten så att den kör Python.

För att undvika kompatibilitetsproblem matchar du Python-versionen med körningsversionen i din Azure App Services-webbapp, 3.11 i det här fallet. Du måste förinstallera Python-versionen. Använd det fullständiga installationsprogrammet för att hämta en pip-kompatibel version av Python.

Den önskade Python-versionen måste läggas till i verktygscacheminnet på den lokalt installerade agenten så att pipelineaktiviteten kan använda den. Normalt finns verktygscachen under _work/_tool-katalogen för agenten. Du kan också åsidosätta sökvägen 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 vill använda Python 3.11 på en 64-bitars Windows-dator skapar du följande katalogstruktur:

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

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

Skapa ett huvudnamn för tjänsten

Ett huvudnamn för tjänsten är en identitet som skapats för program, värdbaserade tjänster och automatiserade verktyg för å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 på vilken nivå.

Om du vill skapa ett huvudnamn för tjänsten kör du följande kommando i Bash Cloud Shell. Ersätt <service-principal-name> med ett namn för tjänstens huvudnamn, <your-subscription-id> med ditt Azure-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 följande JSON-objekt:

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

Anteckna värdena appId, passwordoch som tenantId ska användas för att skapa en tjänstanslutning i nästa avsnitt.

1. På sidan Azure DevOps-projekt väljer du Projektinställningar.

2. I Projektinställningar väljer du Pipelines>Service-anslutningar.

3. På sidan Tjänstanslutningar väljer du Ny tjänstanslutning eller Skapa tjänstanslutning om den här tjänstanslutningen är den första i projektet.

   

4. På skärmen Ny tjänstanslutning väljer du Azure Resource Manager och sedan Nästa.

   

5. På skärmen Ny Azure-tjänstanslutning väljer du din identitetstyp. I det här exemplet används appregistrering (automatisk), vilket rekommenderas. Mer information om autentiseringsmetoder finns i Ansluta till Azure med hjälp av en Azure Resource Manager-tjänstanslutning.

6. För Autentiseringsuppgifter väljer du Arbetsbelastningsidentitetsfederation (automatisk).

7. Slutför följande fält:

   • Omfångsnivå: Välj Prenumeration.
   • Prenumeration: Välj din Azure-prenumeration.
   • Resursgrupp: Välj den resursgrupp som innehåller webbappen.
   • Tjänstanslutningsnamn: Ange ett beskrivande namn för anslutningen.
   • Bevilja åtkomstbehörigheter till alla pipelines: Markera den här kryssrutan om du vill bevilja åtkomst till alla pipelines i projektet.

8. Välj Spara.

   

1. På sidan Azure DevOps-projekt väljer du Projektinställningar.

2. I Projektinställningar väljer du Pipelines>Service-anslutningar.

3. På sidan Tjänstanslutningar väljer du Ny tjänstanslutning eller Skapa tjänstanslutning om den här tjänstanslutningen är den första i projektet.

   

4. På skärmen Ny tjänstanslutning väljer du Azure Resource Manager och sedan Nästa.

   

5. Välj Tjänstens huvudnamn (manuell) och välj sedan Nästa.

   

6. På skärmen Ny Azure-tjänstanslutning fyller du i följande fält:

   • Miljö: Välj Azure Cloud.
   • Omfångsnivå: Välj Prenumeration.
   • Prenumerations-ID: Ange ditt Azure-prenumerations-ID.
   • Prenumerationsnamn: Ange ditt Azure-prenumerationsnamn.

7. I avsnittet Autentisering fyller du i följande fält:

   • Tjänstens huvudnamns-ID: Ange det appId värde som returneras av az ad sp create-for-rbac kommandot.
   • Autentiseringsuppgifter: Välj tjänstens huvudnyckel.
   • Tjänstens huvudnyckel: Ange det password värde som returneras av az ad sp create-for-rbac kommandot.
   • Klientorganisations-ID: Ange det tenant värde som returneras av az ad sp create-for-rbac kommandot.
   • Välj Verifiera för att verifiera anslutningen.

8. I avsnittet Information under Tjänstanslutningsnamn anger du ett namn för tjänstanslutningen.

9. Markera kryssrutan för Bevilja åtkomstbehörigheter till alla pipelines.

10. Välj Verifiera och spara.

    

1. På den vänstra navigeringsmenyn för projektet väljer du Pipelines.

2. På sidan Pipelines väljer du Ny pipeline eller Skapa pipeline om den här pipelinen är den första i projektet.

   

3. På skärmen 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 din förgrenade exempellagringsplats. GitHub kan uppmana dig att ange ditt GitHub-lösenord igen eller att installera GitHub-appen Azure Pipelines . Följ anvisningarna på skärmen för att installera appen. Mer information finns i GitHub-appautentisering.

   

5. På sidan Konfigurera din pipeline väljer du Python till Linux-webbapp i Azure.

6. På nästa skärm väljer du din Azure-prenumeration och väljer Fortsätt.

7. På nästa skärm väljer du din Azure-webbapp och väljer Verifiera och konfigurera.

Azure Pipelines skapar en azure-pipelines.yml-fil och visar den i YAML-pipelineredigeraren.

1. På den vänstra navigeringsmenyn för projektet väljer du Pipelines.

2. På sidan Pipelines väljer du Ny pipeline eller Skapa pipeline om den här pipelinen är den första i projektet.

   

3. På sidan 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 din förgrenade exempellagringsplats. GitHub kan uppmana dig att ange ditt GitHub-lösenord igen eller installera GitHub-tillägget eller appen Azure Pipelines . Följ anvisningarna på skärmen för att installera appen. Mer information finns i Åtkomst till GitHub-lagringsplatser.

   

5. På sidan Konfigurera pipeline väljer du Startpipeline.

6. På sidan Granska yaml-pipelinen ersätter du innehållet i filen starter azure-pipelines.yml med följande YAML-pipelinefil. I YAML-filen:

   • <your-service-connection-name> Ersätt platshållarna och <your-web-app-name> med dina egna värden.

   • Ersätt <your-pool-name> med namnet på den agentpool som du vill använda och ersätt <your-python-version> med den version av Python som körs på din agent. Den här versionen ska matcha runtime_version från JSON-utdata för az webapp up kommandot.

I följande fullständiga exempel definierar YAML-pipelinefilen din CI/CD-pipeline som en serie steg, jobb och steg, där varje steg innehåller information om olika uppgifter och skript. Den genererade YAML-koden fyller automatiskt platshållarna med värden för din app och anslutning.

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'

Byggsteget innehåller ett enda jobb som körs på det operativsystem som definierats i variabeln vmImageName , i det här fallet ubuntu-latest.

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

Byggsteget innehåller ett enda jobb som körs på en agent i parametern poolname som identifieras.

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 demands: Agent.Name -equals <agent-name>.

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

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

• Nyckelordet deployment anger att jobbet är ett distributionsjobb som riktar sig till en miljö som ska distribueras till. environment Skapas automatiskt i projektet när jobbet körs.

• Parametern pool anger distributionsagentpoolen och använder standardagentpoolen om en name inte har angetts. Agenten körs på operativsystemet som definierats i variabeln vmImageName , i det här fallet ubuntu-latest.

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

• Nyckelordet deployment anger att jobbet är ett distributionsjobb som riktar sig till en miljö som ska distribueras till. environment Skapas automatiskt i projektet när jobbet körs.

• Parametern pool anger distributionsagentpoolen och måste innehålla en agent med funktionen för att köra Python-versionen som anges i pipelinen.