Usar o Azure Pipelines para criar e implantar um aplicativo Web Python no Serviço de Aplicativo do Azure

• Uma assinatura do Azure. Crie uma conta gratuita se ainda não tiver a sua.
• Uma conta do GitHub. Caso não tenha uma, crie uma gratuitamente.
• Uma organização do Azure DevOps Services. Crie um gratuitamente.

• Uma assinatura do Azure. Crie uma conta gratuita se ainda não tiver a sua.
• Uma conta do GitHub. Caso não tenha uma, crie uma gratuitamente.
• Um Azure DevOps Server.
• Um agente auto-hospedado. Se você precisar criar um agente auto-hospedado, consulte Agentes auto-hospedados.

1. Em um navegador, acesse dev.azure.com e entre.
2. Selecione sua organização.
3. Crie um novo projeto selecionando Novo projeto ou Criar projeto se estiver criando o primeiro projeto na organização.
4. Insira um Nome de projeto.
5. Selecione a Visibilidade do seu projeto.
6. Selecione Criar.

1. Em um navegador, acesse Azure DevOps Server.
2. Selecione sua coleção.
3. Crie um novo projeto selecionando Novo projeto ou Criar projeto se estiver criando o primeiro projeto da coleção.
4. Insira um Nome de projeto.
5. Selecione a Visibilidade do seu projeto.
6. Selecione Criar.

Criar uma entidade de serviço

Uma entidade de serviço é uma identidade criada para uso com aplicativos, serviços hospedados e ferramentas automatizadas a fim de acessar recursos do Azure. Esse acesso é restrito para funções atribuídas à entidade de serviço, oferecendo a você o controle sobre quais recursos poderão ser acessados e em qual nível.

Para criar uma entidade de serviço, vá para o Cloud Shell (bash) e execute o comando a seguir. Substitua <service-principal-name> por um nome para sua entidade de serviço, <your-subscription-id> pela sua ID de assinatura e <your-resource-group> pelo grupo de recursos para o aplicativo Web.

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

O comando retorna um objeto JSON semelhantes ao seguinte exemplo:

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

Anote os valores clientId, clientSecret, subscriptionId e tenantId. Você precisa deles para criar uma conexão de serviço na próxima seção.

1. Na página do projeto, selecione Configurações do projeto.

   

2. Selecione Conexões de serviço na seção Pipelines do menu.

3. Selecione Criar conexão de serviço.

4. Selecione Azure Resource Manager e selecione Avançar.

   

5. Selecione seu método de autenticação e selecione Avançar.

6. Na caixa de diálogo Nova conexão de serviço do Azure, insira as informações específicas do método de autenticação selecionado. Para obter mais informações sobre métodos de autenticação, consulte Conectar-se ao Azure usando uma conexão de serviço do Azure Resource Manager.

   Por exemplo, se você estiver usando um método de autenticação Federação de identidade de carga de trabalho (automático) ou Entidade de serviço (automático) insira as informações necessárias.

   

   Campo	Descrição
   Scope level	Selecione a Assinatura.
   Assinatura	Seu nome da assinatura do Azure.
   Grupo de recursos	O nome do grupo de recursos que contém o seu aplicativo Web.
   Service connection name	Um nome descritivo para a conexão.
   Conceder permissões de acesso a todos os pipelines	Selecione essa opção para conceder acesso a todos os pipelines.

7. Selecione Salvar.

A nova conexão aparece na lista Conexões de serviço e está pronta para uso no seu pipeline do Azure.

1. Na página do projeto, selecione Configurações do projeto.

   

2. Selecione Conexões de serviço na seção Pipelines do menu.

3. Selecione Criar conexão de serviço.

4. Selecione Azure Resource Manager e selecione Avançar.

   

5. Em Nova conexão de serviço do Azure, selecione Entidade de serviço (manual) e selecione Avançar

6. Na próxima caixa de diálogo, preencha as informações necessárias.

   

   Campo	Descrição
   Ambiente	Selecione Azure Cloud.
   Scope level	Selecione a Assinatura.
   ID da assinatura	A ID de sua assinatura.
   Nome da assinatura	Seu nome da assinatura do Azure.
   Service Principal (ID da Entidade de Serviço)	O valor appId do objeto JSON retornado pelo comando az ad sp create-for-rbac.
   Chave da Entidade de Serviço	O valor password do objeto JSON retornado pelo comando az ad sp create-for-rbac.
   ID do locatário	O valor tenant do objeto JSON retornado pelo comando az ad sp create-for-rbac.

7. Selecione Verificar para verificar a conexão.

8. Insira o nome de uma conexão de serviço.

9. Verifique se a opção Conceder permissões de acesso a todos os pipelines está selecionada.

10. Selecione Verificar e salvar.

A nova conexão será exibida na lista Conexões de serviço e estará pronta para o Azure Pipelines usar no projeto.

Configurar um agente auto-hospedado

Se estiver usando seu próprio agente auto-hospedado, você precisará configurar o agente para executar o Python. O download de versões do Python não é suportado em agentes auto-hospedados. Você deve pré-instalar a versão do Python. Use o instalador completo para obter uma versão compatível com pip do Python.

Para evitar problemas de incompatibilidade, você deve corresponder a versão do Python com a versão de runtime em seu aplicativo Web dos Serviços de Aplicativo do Azure. A versão de runtime é mostrada na saída JSON do comando az webapp up.

A versão desejada do Python precisa ser adicionada ao cache de ferramentas no agente auto-hospedado para que a tarefa possa usá-la. Normalmente, o cache da ferramenta está localizado no diretório _work/_tool do agente. Como alternativa, o caminho pode ser substituído pela variável de ambiente AGENT_TOOLSDIRECTORY. No diretório de ferramentas, crie a seguinte estrutura de diretórios com base na sua versão do Python:

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

O número de versão deve seguir o formato 1.2.3. A plataforma deve ser x86 ou x64. Os arquivos de ferramenta devem ser os arquivos de versão Python descompactados. {platform}.complete deve ser um arquivo de 0 byte que se parece com x86.complete ou com x64.complete, significando apenas que a ferramenta está instalada corretamente no cache.

Por exemplo, se você estiver usando o Python 3.11 em um computador Windows de 64 bits, a estrutura de diretórios terá a seguinte aparência:

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

Se já tiver a versão do Python que deseja usar no computador que hospeda seu agente, você poderá copiar os arquivos para o cache da ferramenta. Se não tiver a versão do Python, você poderá baixá-la no site do Python.

1. No menu de navegação esquerdo, selecione Pipelines.

   

2. Selecione Criar pipeline.

   

3. Na caixa de diálogo Onde está o código?, selecione GitHub. Talvez você receba uma solicitação para entrar no GitHub.

   

4. Na tela Selecionar um repositório, selecione o repositório de amostra bifurcado.

   

5. Pode ser solicitado que você insira sua senha do GitHub novamente como uma confirmação.

6. Se a extensão do Azure Pipelines não estiver instalada no GitHub, este solicitará que você instale a extensão do Azure Pipelines.

   

   Nessa página, role para baixo até a seção Acesso ao repositório, escolha se deseja instalar a extensão em todos os repositórios ou apenas nos selecionados e selecione Aprovar e instalar.

   

7. Na caixa de diálogo Configurar seu pipeline, selecione Aplicativo Web Python para Linux no Azure.

8. Escolha sua assinatura do Azure e selecione Continuar.

9. Se você estiver usando seu nome de usuário e senha para autenticar, um navegador será aberto para você entrar na sua conta da Microsoft.

10. Escolha o nome do aplicativo Web na lista suspensa e selecione Validar e configurar.

O Azure Pipelines cria um arquivo azure-pipelines.yml e o exibe no editor de pipelines YAML. O arquivo de pipeline define seu pipeline de CI/CD como uma série de fases, Trabalhos e etapas, e cada etapa contém os detalhes de diferentes tarefas e scripts. Dê uma olhada no pipeline para compreender o que ele faz. Verifique se todas as entradas padrão são apropriadas para seu código.

1. No menu de navegação, selecione Pipelines.

   

2. Selecione Criar pipeline.

   

3. Na caixa de diálogo Onde está o código?, selecione GitHub Enterprise Server. Talvez você receba uma solicitação para entrar no GitHub.

   

4. Na guia Selecionar um repositório, selecione o repositório de amostra bifurcado.

   

5. Pode ser solicitado que você insira sua senha do GitHub novamente como uma confirmação.

6. Se a extensão do Azure Pipelines não estiver instalada no GitHub, este solicitará que você instale a extensão do Azure Pipelines.

   

   Nessa página, role para baixo até a seção Acesso ao repositório, escolha se deseja instalar a extensão em todos os repositórios ou apenas nos selecionados e selecione Aprovar e instalar.

   

7. Na caixa de diálogo Configurar seu pipeline, selecione Pipeline inicial.

8. Substitua o conteúdo do arquivo azure-pipelines.yml pelo código a seguir.

   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. Substitua os espaços reservados a seguir pelos seus próprios valores:

   Espaço reservado	Descrição
   <your-service-connection-name>	O nome da conexão de serviço que você criou.
   <your-web-app-name>	O nome do seu aplicativo Web do Serviço de Aplicativo do Azure.
   <your-pool-name>	O nome do pool de agentes que você deseja usar.
   <your-python-version>	A versão do Python em execução no seu agente. É uma boa ideia combinar essa versão com a versão do Python em execução no seu aplicativo Web. A versão de aplicativo Web é mostrada na saída JSON do comando az webapp up.

O arquivo YAML de pipeline de exemplo completo é mostrado abaixo:

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

A seção variables contém as seguintes variáveis:

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'

A seção variables contém as seguintes variáveis:

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'

O estágio de compilação contém um único trabalho que é executado no sistema operacional definido na variável vmImageName.

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

O estágio de compilação contém um único trabalho que é executado em um agente no pool identificado pelo parâmetro de nome. Você pode especificar os recursos do agente com a palavra-chave demands. Por exemplo, demands: python especifica que o agente deve ter o Python instalado. Para especificar um agente auto-hospedado pelo nome, você pode usar a palavra-chave 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)

As steps no pipeline são:

1. Usar a tarefa UsePythonVersion para especificar a versão do Python a ser usada no agente. A versão é definida na variável pythonVersion.

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

2. Implantar o aplicativo Web usando AzureWebApp@1. Essa tarefa implanta o artefato de pipeline drop em seu aplicativo Web.

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

   Parâmetro	Descrição
   azureSubscription	A ID ou nome a ser usado pela conexão de serviço do Azure Resource Manager.
   appName	O nome do aplicativo Web.
   package	O local do arquivo .zip a ser implantado.

   Além disso, como o repositório python-vscode-flask-tutorial contém o mesmo comando de inicialização em um arquivo chamado startup.txt, você pode especificar esse arquivo adicionando o parâmetro: startUpCommand: 'startup.txt'.

As steps no pipeline são:

1. Usar a tarefa UsePythonVersion para especificar a versão do Python a ser usada no agente. A versão é definida na variável pythonVersion.

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

2. Implantar o aplicativo Web usando AzureWebApp@1. Essa tarefa implanta o artefato de pipeline drop em seu aplicativo Web.

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

   Parâmetro	Descrição
   azureSubscription	A ID ou nome a ser usado pela conexão de serviço do Azure Resource Manager.
   appName	O nome do aplicativo Web.
   package	O local do arquivo .zip a ser implantado.

   Além disso, como o repositório python-vscode-flask-tutorial contém o mesmo comando de inicialização em um arquivo chamado startup.txt, você pode especificar esse arquivo adicionando o parâmetro: 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'
   

   Parâmetro	Descrição
   azureSubscription	A ID ou nome a ser usado pela conexão de serviço do Azure Resource Manager.
   appName	O nome do aplicativo Web.
   package	O local do arquivo .zip a ser implantado.
   startUpCommand	O comando a ser executado após a implantação do aplicativo. O aplicativo de exemplo usa startup.txt.