Skip to main content

Implementando o Python no Azure App Service

Você pode fazer a implantação do seu projeto Python no Azure App Service como parte de seus fluxos de trabalho de implantação contínua (CD).

Observação: no momento, não há suporte para os executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.

Introdução

Este guia explica como usar o GitHub Actions para criar e implantar um projeto do Python no Serviço de Aplicativo do Azure.

Observação: Se os seus fluxos de trabalho de GitHub Actions tiverem de acessar recursos de um provedor de nuvem compatível com o OpenID Connect (OIDC), você poderá configurar seus fluxos de trabalho para efetuar a autenticção diretamente no provedor de nuvem. Isso permitirá que você pare de armazenar essas credenciais como segredos de longa duração e proporcione outros benefícios de segurança. Para obter mais informações, confira "Sobre o enrijecimento de segurança com o OpenID Connect". e "Configurando o OpenID Connect no Azure".

Pré-requisitos

Antes de criar seu fluxo de trabalho de GitHub Actions, primeiro você precisa concluir as etapas de configuração a seguir:

  1. Criar um Plano do Serviço de Aplicativo do Azure.

    Por exemplo, você pode usar o CLI do Azure para criar um novo plano de App Service:

    Bash
    az appservice plan create \
       --resource-group MY_RESOURCE_GROUP \
       --name MY_APP_SERVICE_PLAN \
       --is-linux
    

    No comando acima, substitua MY_RESOURCE_GROUP pelo grupo de recursos preexistente do Azure e MY_APP_SERVICE_PLAN por um novo nome para o Plano do Serviço de Aplicativo.

    Confira a documentação do Azure para obter mais informações sobre como usar a CLI do Azure:

  2. Crie um aplicativo Web.

    Por exemplo, você pode usar o CLI do Azure para criar um aplicativo web do com o tempo de execução do Python:

    Bash
    az webapp create \
        --name MY_WEBAPP_NAME \
        --plan MY_APP_SERVICE_PLAN \
        --resource-group MY_RESOURCE_GROUP \
        --runtime "python|3.8"
    

    No comando acima, substitua os parâmetros por valores próprios, em que MY_WEBAPP_NAME é um novo nome para o aplicativo Web.

  3. Configure um perfil de publicação do Azure e crie um segredo AZURE_WEBAPP_PUBLISH_PROFILE.

    Gere suas credenciais de implantação do Azure usando um perfil de publicação. Para obter mais informações, confira "Gerar credenciais de implantação" na documentação do Azure.

    No repositório do GitHub, crie um segredo chamado AZURE_WEBAPP_PUBLISH_PROFILE que inclua o conteúdo do perfil de publicação. Para obter mais informações sobre como criar segredos, veja "Usar segredos em ações do GitHub".

  4. Adicione uma configuração de aplicativo chamada SCM_DO_BUILD_DURING_DEPLOYMENT e defina o valor como 1.

  5. Opcionalmente, configure um ambiente de implantação. Os ambientes são usados para descrever um destino de implantação geral, como production, staging ou development. Quando um fluxo de trabalho de GitHub Actions é implantado em um ambiente, o ambiente é exibido na página principal do repositório. Você pode usar ambientes para exigir aprovação para um trabalho prosseguir, restringir quais ramificações podem acionar um fluxo de trabalho , bloquear implantações com regras de proteção de implantação personalizadas ou limitar o acesso a segredos. Para saber mais sobre como criar ambientes, confira "Usando ambientes para implantação".

Criar o fluxo de trabalho

Depois de preencher os pré-requisitos, você pode prosseguir com a criação do fluxo de trabalho.

O exemplo de fluxo de trabalho a seguir demonstra como compilar e implantar um projeto do Python no Serviço de Aplicativo do Azure quando houver um push para o branch main.

Defina AZURE_WEBAPP_NAME na chave env de fluxo de trabalho como o nome do aplicativo Web que você criou. Se você usar uma versão do Python diferente de 3.8, altere PYTHON_VERSION para a versão usada.

Se você configurou um ambiente de implantação, altere o valor de environment para que ele seja o nome do seu ambiente. Se você não tiver configurado um ambiente, exclua a chave environment.

YAML
# Esse fluxo de trabalho usa ações que não são certificadas pelo GitHub.
# São fornecidas por terceiros e regidas por
# termos de serviço, política de privacidade e suporte separados
# online.

# O GitHub recomenda fixar ações em um SHA de commit.
# Para obter uma versão mais recente, você precisará atualizar o SHA.
# Você também pode fazer referência a uma marca ou branch, mas a ação pode ser alterada sem aviso.

name: Build and deploy Python app to Azure Web App

env:
  AZURE_WEBAPP_NAME: MY_WEBAPP_NAME   # set this to your application's name
  PYTHON_VERSION: '3.8'               # set this to the Python version to use

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python version
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Create and start virtual environment
        run: |
          python -m venv venv
          source venv/bin/activate

      - name: Set up dependency caching for faster installs
        uses: actions/cache@v3
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - name: Install dependencies
        run: pip install -r requirements.txt

      # Optional: Add a step to run tests here (PyTest, Django test suites, etc.)

      - name: Upload artifact for deployment jobs
        uses: actions/upload-artifact@v3
        with:
          name: python-app
          path: |
            .
            !venv/
  deploy:
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: 'production'
      url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}

    steps:
      - name: Download artifact from build job
        uses: actions/download-artifact@v3
        with:
          name: python-app
          path: .

      - name: 'Deploy to Azure Web App'
        id: deploy-to-webapp
        uses: azure/webapps-deploy@85270a1854658d167ab239bce43949edb336fa7c
        with:
          app-name: ${{ env.AZURE_WEBAPP_NAME }}
          publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}

Recursos adicionais

Os seguintes recursos também podem ser úteis:

  • Para o fluxo de trabalho inicial original, confira azure-webapps-python.yml no repositório starter-workflows do GitHub Actions.
  • A ação usada para implantar o aplicativo Web é a ação Azure/webapps-deploy oficial do Azure.
  • Para ver mais exemplos de fluxos de trabalho do GitHub Action que são implantados no Azure, confira o repositório actions-workflow-samples.