Azure Pipelines gebruiken om een Python-web-app te bouwen en te implementeren in Azure-app Service

Een zelf-hostende agent configureren

Het downloaden van Python-versies wordt niet ondersteund op zelf-hostende buildagents. Als u uw eigen zelf-hostende agent wilt gebruiken, moet u de agent configureren om Python uit te voeren.

Om compatibiliteitsproblemen te voorkomen, moet u in dit geval overeenkomen met de Python-versie met de runtimeversie in uw Azure App Services-web-app 3.11 . U moet de Python-versie vooraf installeren. Gebruik het volledige installatieprogramma om een pip-compatibele versie van Python op te halen.

De gewenste Python-versie moet worden toegevoegd aan de cache van het hulpprogramma op de zelf-hostende agent, zodat de pijplijntaak deze kan gebruiken. Normaal gesproken bevindt de cache van het hulpprogramma zich onder de map _work/_tool van de agent. U kunt ook het pad overschrijven met de omgevingsvariabele AGENT_TOOLSDIRECTORY. Maak onder de map hulpprogramma's de volgende mapstructuur op basis van uw Python-versie:

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

Het versienummer moet de notatie 1.2.3 volgen. Het platform moet x86 of x64 zijn. De hulpprogrammabestanden moeten de uitgepakte Python-versiebestanden zijn. Het {platform}.complete moet een 0-byte-bestand zijn dat eruitziet als x86.complete of x64.complete en duidt erop dat het hulpprogramma correct is geïnstalleerd in de cache.

Als u bijvoorbeeld Python 3.11 wilt gebruiken op een 64-bits Windows-computer, maakt u de volgende mapstructuur:

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

Als de computer die als host fungeert voor uw agent al de Python-versie heeft die u wilt gebruiken, kunt u de bestanden kopiëren naar de cache van het hulpprogramma. Als u niet over de Python-versie beschikt, kunt u deze downloaden vanaf de Python-website.

Een service-principal maken

Een service-principal is een identiteit die is gemaakt voor toepassingen, gehoste services en geautomatiseerde hulpprogramma's voor toegang tot Azure-resources. Deze toegang is beperkt tot de rollen die zijn toegewezen aan de service-principal, zodat u bepaalt welke resources op welk niveau kunnen worden geopend.

Voer de volgende opdracht uit in Bash Cloud Shell om een service-principal te maken. Vervang <service-principal-name> door een naam voor uw service-principal, <your-subscription-id> door uw Azure-abonnements-id en <your-resource-group> door de resourcegroep voor de web-app.

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

De opdracht retourneert het volgende JSON-object:

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

Noteer de appId, passworden tenantId waarden die u wilt gebruiken voor het maken van een serviceverbinding in de volgende sectie.

1. Selecteer Project-instellingen op uw Azure DevOps-projectpagina.

2. Selecteer in Projectinstellingenpijplijnserviceverbindingen>.

3. Selecteer op de pagina Serviceverbindingen de optie Nieuwe serviceverbinding of Serviceverbinding maken als deze serviceverbinding de eerste is in het project.

   

4. Selecteer Azure Resource Manager in het scherm Nieuwe serviceverbinding en selecteer vervolgens Volgende.

   

5. Selecteer uw identiteitstype in het scherm Nieuwe Azure-serviceverbinding. In dit voorbeeld wordt app-registratie (automatisch) gebruikt. Dit wordt aanbevolen. Zie Verbinding maken met Azure met behulp van een Azure Resource Manager-serviceverbinding voor meer informatie over verificatiemethoden.

6. Selecteer voor Referentiede federatie van workloadidentiteit (automatisch).

7. Vul de volgende velden in:

   • Bereikniveau: Selecteer Abonnement.
   • Abonnement: selecteer uw Azure-abonnement.
   • Resourcegroep: Selecteer de resourcegroep die uw web-app bevat.
   • Serviceverbindingsnaam: voer een beschrijvende naam in voor de verbinding.
   • Toegangsmachtigingen verlenen aan alle pijplijnen: schakel dit selectievakje in om toegang te verlenen tot alle pijplijnen in het project.

8. Selecteer Opslaan.

   

1. Selecteer Project-instellingen op uw Azure DevOps-projectpagina.

2. Selecteer in Projectinstellingenpijplijnserviceverbindingen>.

3. Selecteer op de pagina Serviceverbindingen de optie Nieuwe serviceverbinding of Serviceverbinding maken als deze serviceverbinding de eerste is in het project.

   

4. Selecteer Azure Resource Manager in het scherm Nieuwe serviceverbinding en selecteer vervolgens Volgende.

   

5. Selecteer Service-principal (handmatig) en selecteer vervolgens Volgende.

   

6. Vul in het scherm Verbinding met de nieuwe Azure-service de volgende velden in:

   • Omgeving: Selecteer Azure Cloud.
   • Bereikniveau: Selecteer Abonnement.
   • Abonnements-id: voer uw Azure-abonnements-id in.
   • Abonnementsnaam: voer de naam van uw Azure-abonnement in.

7. Vul in de sectie Verificatie de volgende velden in:

   • Service-principal-id: voer de appId waarde in die wordt geretourneerd door de az ad sp create-for-rbac opdracht.
   • Referentie: selecteer service-principalsleutel.
   • Sleutel van de service-principal: voer de password waarde in die wordt geretourneerd door de az ad sp create-for-rbac opdracht.
   • Tenant-id: voer de tenant waarde in die wordt geretourneerd door de az ad sp create-for-rbac opdracht.
   • Selecteer Verifiëren om de verbinding te verifiëren.

8. Voer in de sectie Details , onder Naam van serviceverbinding, een naam in voor de serviceverbinding.

9. Schakel het selectievakje in voor Het verlenen van toegangsmachtigingen voor alle pijplijnen.

10. Selecteer Verifiëren en opslaan.

    

1. Selecteer Pijplijnen in het linkernavigatiemenu voor uw project.

2. Selecteer op de pagina Pijplijnende optie Nieuwe pijplijn of Pijplijn maken als deze pijplijn de eerste is in het project.

   

3. Selecteer GitHub in het scherm Waar is uw code. Mogelijk wordt u gevraagd u aan te melden bij GitHub.

   

4. Op het scherm Select a repository, selecteert u uw geforkte voorbeeldrepository. GitHub vraagt u mogelijk om uw GitHub-wachtwoord opnieuw in te voeren of om de GitHub-app Azure Pipelines te installeren. Volg de instructies op het scherm om de app te installeren. Zie GitHub-app-verificatie voor meer informatie.

   

5. Selecteer Op de pagina Uw pijplijn configurerenPython naar Linux-web-app in Azure.

6. Selecteer in het volgende scherm uw Azure-abonnement en selecteer Doorgaan.

7. Selecteer in het volgende scherm uw Azure-web-app en selecteer Valideren en configureren.

Azure Pipelines maakt een azure-pipelines.yml bestand en geeft dit weer in de YAML-pijplijneditor.

1. Selecteer Pijplijnen in het linkernavigatiemenu voor uw project.

2. Selecteer op de pagina Pijplijnende optie Nieuwe pijplijn of Pijplijn maken als deze pijplijn de eerste is in het project.

   

3. Selecteer GitHub Enterprise Server op de pagina Waar is de code. Mogelijk wordt u gevraagd u aan te melden bij GitHub.

   

4. Selecteer op het tabblad Een opslagplaats selecteren uw geforkte voorbeeldopslagplaats. GitHub vraagt u mogelijk om uw GitHub-wachtwoord opnieuw in te voeren of de GitHub-extensie of app van Azure Pipelines te installeren. Volg de instructies op het scherm om de app te installeren. Zie Toegang tot GitHub-opslagplaatsen voor meer informatie.

   

5. Selecteer Starter-pijplijn op de pagina Uw pijplijn configureren.

6. Vervang op de pagina Uw pijplijn YAML controleren de inhoud van het startersbestand azure-pipelines.yml door het volgende YAML-pijplijnbestand. In het YAML-bestand:

   • Vervang de <your-service-connection-name> tijdelijke aanduidingen door <your-web-app-name> uw eigen waarden.

   • Vervang <your-pool-name> door de naam van de agentgroep die u wilt gebruiken en vervang door <your-python-version> de versie van Python die wordt uitgevoerd op uw agent. Deze versie moet overeenkomen met de runtime_version JSON-uitvoer van de az webapp up opdracht.

In het volgende volledige voorbeeld van een YAML-pijplijnbestand wordt uw CI/CD-pijplijn gedefinieerd als een reeks fasen, taken en stappen, waarbij elke stap de details voor verschillende taken en scripts bevat. De gegenereerde YAML-code vult automatisch de tijdelijke aanduidingen in met waarden voor uw app en verbinding.

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'

De buildfase bevat één taak die wordt uitgevoerd op het besturingssysteem dat in de vmImageName variabele is gedefinieerd, in dit geval ubuntu-latest.

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

De buildfase bevat één taak die wordt uitgevoerd op een agent in de pool parameter die wordt geïdentificeerd.name

U kunt de agentmogelijkheden opgeven met het demands trefwoord. Hiermee geeft u bijvoorbeeld demands: python op dat de agent Python moet hebben geïnstalleerd. Als u een zelf-hostende agent op naam wilt opgeven, kunt u gebruiken demands: Agent.Name -equals <agent-name>.

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

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

• Het deployment trefwoord geeft aan dat de taak een implementatietaak is die gericht is op een omgeving waarnaar moet worden geïmplementeerd. De environment taak wordt automatisch gemaakt in uw project wanneer de taak wordt uitgevoerd.

• De pool parameter geeft de implementatieagentgroep op en gebruikt de standaardagentgroep als er name geen is opgegeven. De agent wordt uitgevoerd op het besturingssysteem dat is gedefinieerd in de vmImageName variabele, in dit geval ubuntu-latest.

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

• Het deployment trefwoord geeft aan dat de taak een implementatietaak is die gericht is op een omgeving waarnaar moet worden geïmplementeerd. De environment taak wordt automatisch gemaakt in uw project wanneer de taak wordt uitgevoerd.

• De pool parameter geeft de implementatieagentgroep op en moet een agent bevatten met de mogelijkheid om de Python-versie uit te voeren die is opgegeven in de pijplijn.