Tutorial: Configure continuous deployment for a Python web app in Azure Container Apps

Questo articolo fa parte di una serie di esercitazioni su come inserire e distribuire un'app Web Python in App Azure Container. Container Apps consente di distribuire app in contenitori senza la necessità di gestire un'infrastruttura complessa.

In this tutorial, you:

• Configure continuous deployment for a container app by using a GitHub Actions workflow.
• Apportare una modifica a una copia del repository di esempio per attivare il flusso di lavoro di GitHub Actions.
• Troubleshoot problems that you might encounter with configuring continuous deployment.
• Rimuovere le risorse non necessarie al termine della serie di esercitazioni.

La distribuzione continua è correlata alla pratica DevOps dell'integrazione continua e della consegna continua (CI/CD), che automatizza il flusso di lavoro di sviluppo delle app.

Il diagramma seguente illustra le attività in questa esercitazione.

Prerequisiti

Per configurare la distribuzione continua, è necessario:

• The resources (and their configuration) that you created in the previous tutorial, which includes an instance of Azure Container Registry and a container app in Azure Container Apps.

• Un account GitHub in cui hai fatto un fork del codice di esempio (Django o Flask) al quale puoi connetterti da Azure Container Apps. (If you downloaded the sample code instead of forking, be sure to push your local repo to your GitHub account.)

• Optionally, Git installed in your development environment to make code changes and push to your repo in GitHub. In alternativa, è possibile apportare le modifiche direttamente in GitHub.

Configure continuous deployment for a container

Nell'esercitazione precedente, hai creato e configurato un'applicazione contenitore in Azure Container Apps. Parte della configurazione consisteva nel recuperare un'immagine Docker da un'istanza di Azure Container Registry. L'immagine del contenitore viene estratta dal Registro di sistema quando si crea un contenitore revisione, ad esempio quando si configura per la prima volta l'app contenitore.

In questa sezione viene configurata la distribuzione continua usando un flusso di lavoro di GitHub Actions. Con la distribuzione continua, viene creata una nuova immagine Docker e una nuova revisione del contenitore in base a un trigger. The trigger in this tutorial is any change to the main branch of your repository, such as with a pull request. Quando il flusso di lavoro viene attivato, crea una nuova immagine Docker, la inserisce nell'istanza di Registro Azure Container e aggiorna l'app contenitore a una nuova revisione usando la nuova immagine.

Azure CLI

You can run Azure CLI commands in Azure Cloud Shell or on a workstation where Azure CLI is installed.

Se si eseguono comandi in una shell Git Bash in un computer Windows, immettere il comando seguente prima di procedere:

export MSYS_NO_PATHCONV=1

1. Create a service principal by using the az ad sp create-for-rbac command:

   az ad sp create-for-rbac \
   --name <app-name> \
   --role Contributor \
   --scopes "/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>"
   

   Nel comando :

   • <app-name> is an optional display name for the service principal. If you leave off the --name option, a GUID is generated as the display name.
   • <subscription-ID> is the GUID that uniquely identifies your subscription in Azure. If you don't know your subscription ID, you can run the az account show command and copy it from the id property in the output.
   • <resource-group-name> is the name of a resource group that contains the Azure Container Apps container. Il controllo degli accessi in base al ruolo è a livello di gruppo di risorse. Se sono stati seguiti i passaggi dell'esercitazione precedente, il nome del gruppo di risorse è pythoncontainer-rg.

   Salvare l'output di questo comando per il passaggio successivo. In particolare, salvare l'ID client (proprietàappId), il segreto client ( proprietàpassword) e l'ID tenant ( proprietàtenant).

2. Configure GitHub Actions by using the az containerapp github-action add command:

   az containerapp github-action add \
   --resource-group <resource-group-name> \
   --name python-container-app \
   --repo-url <https://github.com/userid/repo> \
   --branch main \
   --registry-url <registry-name>.azurecr.io \
   --service-principal-client-id <client-id> \
   --service-principal-tenant-id <tenant-id> \
   --service-principal-client-secret <client-secret> \
   --login-with-github
   

   Nel comando :

   • <resource-group-name> is the name of the resource group. In this tutorial, it's pythoncontainer-rg.
   • <https://github.com/userid/repo> è l'URL del tuo repository GitHub. In this tutorial, it's either https://github.com/userid/msdocs-python-django-azure-container-apps or https://github.com/userid/msdocs-python-flask-azure-container-apps. In questi URL userid è l'ID utente di GitHub.
   • <registry-name> is the existing Azure Container Registry instance that you created in the previous tutorial, or one that you can use.
   • <client-id> is the value of the appId property from the previous az ad sp create-for-rbac command. The ID is a GUID of the form 00000000-0000-0000-0000-00000000.
   • <tenant-id> is the value of the tenant property from the previous az ad sp create-for-rbac command. The ID is also a GUID that's similar to the client ID.
   • <client-secret> is the value of the password property from the previous az ad sp create-for-rbac command.

Azure portal

1. Nel portale di Azure , passare all'applicazione contenitore per la quale si vuole configurare la distribuzione continua. On the service menu, select Continuous deployment.

   

2. Autorizzare le Azure Container Apps ad accedere all'account GitHub:

   1. Select Sign in with GitHub.
   2. Nella finestra di dialogo di autorizzazione selezionare Autorizzare AzureAppService.

   

   Tip

   È possibile revocare l'accesso di Container Apps all'account GitHub nella sezione Sicurezza del tuo account.

3. Configure the details of the continuous deployment:

   • Organization: Use your GitHub username.
   • Repository: Select the fork of the sample app. (If you originally downloaded the sample code to your developer environment, push the repo to GitHub.)
   • Branch: Select main.
   • Repository source: Select Azure Container Registry.
   • Registry: Select the Azure Container Registry instance that you created in the previous tutorial.
   • Image: Select the Docker image name. In this tutorial, it's python-container-app.
   • Service principal: Leave Create new and let the creation process create a new service principal.

   Selezionare Avviare la distribuzione continua per completare la configurazione.

   

4. Review the information about the continuous deployment.

   Le informazioni includono un collegamento al file del flusso di lavoro GitHub Actions creato. Azure Container Apps checked in the file to your repo.

   

In the configuration of continuous deployment, a service principal enables GitHub Actions to access and modify Azure resources. The roles assigned to the service principal restrict access to resources. The service principal was assigned the built-in Contributor role on the resource group that contains the container app.

If you followed the steps for the portal, the service principal was automatically created for you. If you followed the steps for the Azure CLI, you explicitly created the service principal before you configured continuous deployment.

Ridistribuire l'app Web con GitHub Actions

In this section, you make a change to your forked copy of the sample repository. Successivamente, è possibile verificare che la modifica venga distribuita automaticamente nel sito Web.

If you haven't already, make a fork of the sample repository (Django or Flask). È possibile apportare la modifica del codice direttamente in GitHub o nell'ambiente di sviluppo da una riga di comando con Git.

GitHub

1. Go to your fork of the sample repository and start in the main branch.

   

2. Apportare una modifica:

   1. Passare al file /templates/base.html. (For Django, the path is restaurant_review/templates/restaurant_review/base.html.)
   2. Seleziona Modifica e modifica la frase Azure Restaurant Review in Azure Restaurant Review - Redeployed.

   

3. On the bottom of the page you're editing, make sure that Commit directly to the main branch is selected. Then select the Commit changes button.

   

Il commit avvia il flusso di lavoro di GitHub Actions.

Command line

If you haven't already, use git clone to pull your forked repository to your development environment and change directory to the repository. Seguire quindi questa procedura:

1. Start in main:

   git checkout main
   git pull
   

2. Make a change.

   Vai al file ./templates/base.html (./restaurant_review/templates/restaurant_review/base.html per Django) e cambia la frase Azure Restaurant Review in Azure Restaurant Review - Redeployed.

3. Eseguire il commit e il push della modifica in GitHub:

   git commit -a -m "Redeploy with title change."
   git push
   

La prima volta che si usa Git, potrebbe essere necessario impostare le variabili globali user.name e user.email. Per ulteriori informazioni, consultare l'aiuto per git-config.

The push of changes to the main branch kicks off the GitHub Actions workflow.

Nota

Questa esercitazione illustra come apportare una modifica direttamente nel ramo principale. Nei flussi di lavoro software tipici, si apporta una modifica in un ramo diverso da main e quindi si crea una pull request per unire la modifica nel main. Le pull request avviano anche il flusso di lavoro.

Understand GitHub Actions

Visualizzazione della cronologia del flusso di lavoro

Se è necessario visualizzare la cronologia del flusso di lavoro, utilizzare una delle procedure seguenti.

GitHub

On GitHub, go to your fork of the sample repository and open the Actions tab.

Command line

Questi passaggi usano la CLI di GitHub .

1. Ottenere un riepilogo del flusso di lavoro. Eseguire il comando seguente nella cartella che contiene il clone:

   gh workflow view
   

   Questo comando richiede di selezionare un flusso di lavoro e quindi offre una panoramica delle esecuzioni recenti del flusso di lavoro.

   Nota

   La prima volta che si usa gh, potrebbe essere richiesto di eseguire l'autenticazione. Seguire i prompt di GitHub CLI per l'autenticazione.

   If you have more than one remote configured, you might be asked to run gh repo set-default to select a default remote repository. Select your fork from the presented options.

   È possibile eseguire il comando gh workflow view da qualsiasi cartella senza la necessità di impostare un repository predefinito aggiungendo il parametro --repo [HOST/]OWNER/REPO.

2. Passare a GitHub per informazioni dettagliate sull'esecuzione di un flusso di lavoro:

   gh workflow view --web
   

Segreti del flusso di lavoro

The .github/workflows/<workflow-name>.yml workflow file that was added to the repo includes placeholders for credentials that are needed for the build and container app update jobs of the workflow. The credential information is stored encrypted in the repository's Settings area, under Security>Secrets and variables>Actions.

Se le informazioni sulle credenziali cambiano, è possibile aggiornarla qui. Ad esempio, se le password del Registro Azure Container vengono rigenerate, è necessario aggiornare il valore REGISTRY_PASSWORD. Per altre informazioni, vedere Encrypted secrets nella documentazione di GitHub.

App autorizzate OAuth

When you set up continuous deployment, you designate Azure Container Apps as an authorized OAuth app for your GitHub account. Container Apps utilizza l'accesso autorizzato per creare un file YAML di GitHub Actions in .github/workflows/<nome-flusso-di-lavoro>.yml. È possibile visualizzare le app autorizzate e revocare le autorizzazioni nell'account in Integrations>Applications.

Troubleshoot

Si verificano errori durante la configurazione di un principale di servizio tramite la CLI di Azure

This section can help you troubleshoot errors that you get while setting up a service principal by using the Azure CLI az ad sp create-for-rba command.

Se ricevi un errore contenente "InvalidSchema: non sono stati trovati adattatori di connessione":

• Check the shell that you're running in. Se stai usando una shell Bash, imposta le variabili MSYS_NO_PATHCONV come export MSYS_NO_PATHCONV=1.

  For more information, see the GitHub issue Unable to create service principal with Azure CLI from Git Bash shell.

Se viene visualizzato un errore che contiene "Più applicazioni hanno lo stesso nome visualizzato":

• The name is already taken for the service principal. Scegli un altro nome oppure elimina l'argomento --name. A GUID will be automatically generated as a display name.

Flusso di lavoro di GitHub Actions non riuscito

Per controllare lo stato di un flusso di lavoro, passare alla scheda Azioni del repository:

• If there's a failed workflow, drill into the workflow file. There should be two jobs: build and deploy. For a failed job, check the output of the job's tasks to look for problems.
• If there's an error message that contains "TLS handshake timeout," run the workflow manually. In the repo, on the Actions tab, select Trigger auto deployment to see if the timeout is a temporary issue.
• Se si configura la distribuzione continua per l'app contenitore come illustrato in questa esercitazione, il file del flusso di lavoro (.github/workflows/<nome del flusso di lavoro>.yml) viene creato automaticamente. Non è necessario modificare questo file per questa esercitazione. Se lo hai fatto, annulla le modifiche e prova il flusso di lavoro.

Website doesn't show changes that you merged in the main branch

In GitHub:

• Verificare che il flusso di lavoro di GitHub Actions sia stato eseguito e che sia stata verificata la modifica nel ramo che attiva il flusso di lavoro.

Nel portale di Azure:

• Check the Azure Container Registry instance to see if a new Docker image was created with a time stamp after your change to the branch.

• Controllare i log dell'app contenitore per verificare se si verifica un errore di programmazione:

  1. Go to the container app, and then go to Revision Management><active container>>Revision details>Console logs.
  2. Choose the order of the columns to show Time Generated, Stream_s, and Log_s.
  3. Sort the logs by most recent and look for Python stderr and stdout messages in the Stream_s column. Python print output is stdout messages.

Nella CLI di Azure:

• Use the az containerapp logs show command.

You want to stop continuous deployment

Stopping continuous deployment means disconnecting your container app from your repo.

Nel portale di Azure:

• Go to the container app. On the service menu, select Continuous deployment, and then select Disconnect.

Nella CLI di Azure:

• Use the az container app github-action remove command.

Dopo la disconnessione:

• Il file .github/workflows/<nome del flusso di lavoro>.yml viene rimosso dal tuo repository.
• Le chiavi segrete non vengono rimosse dal repository.
• Azure Container Apps rimangono un'app OAuth autorizzata per il tuo account GitHub.
• In Azure, the container is left with the last deployed container. You can reconnect the container app with the Azure Container Registry instance, so that new container revisions pick up the latest image.
• In Azure, service principals that you created and used for continuous deployment aren't deleted.

Rimuovere le risorse

Se hai finito con la serie di esercitazioni e non vuoi sostenere costi aggiuntivi, rimuovi le risorse usate.

La rimozione di un gruppo di risorse rimuove tutte le risorse nel gruppo ed è il modo più rapido per rimuovere le risorse. For an example of how to remove resource groups, see Containerize tutorial cleanup.

Contenuto correlato

Se si prevede di eseguire questa esercitazione, ecco alcuni passaggi successivi che è possibile eseguire:

• Impostare le regole di ridimensionamento nelle app Azure Container
• Associare nomi di dominio e certificati personalizzati in App Azure Container
• Monitor an app in Azure Container Apps