AzureContainerApps@1 - Tâche Azure Container Apps Deploy v1

Syntax

# Azure Container Apps Deploy v1
# An Azure DevOps Task to build and deploy Azure Container Apps.
- task: AzureContainerApps@1
  inputs:
  # advanced
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #appSourcePath: # string. Application source path. 
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure Resource Manager connection. 
    #acrName: # string. Azure Container Registry name. 
    #acrUsername: # string. Azure Container Registry username. 
    #acrPassword: # string. Azure Container Registry password. 
    #dockerfilePath: # string. Dockerfile path. 
    #imageToBuild: # string. Docker image to build. 
    #imageToDeploy: # string. Docker image to deploy. 
    #containerAppName: # string. Azure Container App name. 
    #resourceGroup: # string. Azure resource group name. 
    #containerAppEnvironment: # string. Azure Container App environment. 
    #runtimeStack: # string. Application runtime stack. 
    #targetPort: # string. Application target port. 
    #location: # string. Location of the Container App. 
    #environmentVariables: # string. Environment variables. 
    #ingress: # string. Ingress setting. 
    #yamlConfigPath: # string. YAML configuration file path. 
    #disableTelemetry: # boolean. Disable telemetry.

Entrées

Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Notes

Cette tâche Azure Pipelines permet aux utilisateurs de déployer facilement leur source d’application sur une application conteneur Azure dans leur workflow Azure Pipelines en fournissant une image créée précédemment, un fichier Dockerfile à partir duquel une image peut être générée ou en utilisant un générateur pour créer une image d’application exécutable pour l’utilisateur.

La tâche a les deux modèles d’utilisation suivants.

• Envoi (push) d’une image vers ACR : lors de l’envoi (push) d’une nouvelle image vers ACR, les entrées de tâche acrName et sont appSourcePath requises.
• Déploiement d’une image précédemment poussée : lors du déploiement d’une image précédemment poussée, l’entrée de tâche imageToDeploy est requise. Si cette image se trouve dans un instance ACR qui nécessite l’authentification pour tirer (pull), l’argument acrName ou les acrUsername arguments et acrPassword peuvent être fournis pour authentifier les demandes adressées à l’ACR instance.

Si aucun fichier Dockerfile n’est trouvé ou fourni dans la source d’application fournie, cette tâche effectue les étapes suivantes :

• Utilise Le Générateur Oryx++ pour générer la source de l’application à l’aide d’Oryx pour produire une image d’application exécutable
• Envoie (push) cette image d’application exécutable vers le Azure Container Registry fourni
• Crée ou met à jour une application conteneur basée sur cette image

Si un dockerfile est trouvé ou découvert dans la source de l’application, le générateur ne sera pas utilisé et l’image sera générée avec un appel à docker build et l’application conteneur sera créée ou mise à jour en fonction de cette image.

Si une image créée précédemment a déjà été envoyée à l’instance ACR et qu’elle est fournie à cette tâche, aucune source d’application n’est requise et l’image sera utilisée lors de la création ou de la mise à jour de l’application conteneur.

Exécution de cette tâche sur des agents hébergés par Microsoft

Si vous exécutez cette tâche sur un agent hébergé par Microsoft, vous constaterez peut-être que cette tâche ne peut pas s’exécuter correctement avec les systèmes d’exploitation suivants :

• macOS
  • Les exécuteurs macOS fournis par Microsoft ne sont pas installés avec Docker (plus d’informations ici) ; par conséquent, cette tâche n’est pas en mesure d’exécuter docker des commandes, telles que l’envoi (push) des images d’application exécutables générées vers ACR.
• Windows
  • Les exécuteurs Windows fournis par Microsoft sont fournis avec Docker installé, mais par défaut, les images basées sur Linux ne peuvent pas être extraites vers le bas ; par conséquent, cette tâche ne peut pas extraire le générateur Oryx pour créer des images d’application exécutables à partir de la source d’application fournie.

Pour plus d’informations, consultez la section relative aux prérequis Docker ci-dessous.

Avis de collecte de données/télémétrie

Par défaut, cette tâche Azure DevOps collecte les données suivantes pour Microsoft :

• Scénario de génération et de déploiement d’application conteneur ciblé par l’utilisateur
  • c’est-à-dire, utilisé le Générateur Oryx++, utilisé un Fichier Dockerfile fourni/trouvé, ou fourni une image précédemment générée
  • Remarque : le nom de l’image n’est pas collecté
• Durée de traitement de la tâche, en millisecondes
• Résultat de la tâche
  • c’est-à-dire réussi ou échoué
• Si le Générateur Oryx++ est utilisé, événements et métriques relatifs à la génération de l’application fournie à l’aide d’Oryx

Si vous souhaitez désactiver la collecte de données, définissez l’argument disableTelemetry sur true.

Prérequis

Avant d’exécuter cette tâche, les ressources Azure et une connexion au service Azure DevOps sont requises ou facultatives en fonction des arguments fournis à cette tâche.

Connexion au service Azure DevOps

Pour effectuer un déploiement sur Azure, un abonnement Azure doit être lié à Team Foundation Server ou à Azure Pipelines à l’aide de l’onglet Services de la section Paramètres. Ajoutez l’abonnement Azure à utiliser dans la définition Générer ou Release Management en ouvrant l’écran Administration de compte (icône d’engrenage en haut à droite de l’écran), puis cliquez sur l’onglet Services.

Créez le point de terminaison de service ARM et utilisez le type de point de terminaison « Azure Resource Manager ». Pour plus d’informations sur la création de connexions de service, suivez ce document.

Azure CLI

Cette tâche nécessite qu’Azure CLI soit installé sur l’agent Azure Pipelines pour exécuter diverses commandes tout au long de l’exécution de la tâche. Pour plus d’informations sur l’installation d’Azure CLI sur l’agent, consultez ce document. Si un agent est déjà en cours d’exécution sur l’ordinateur sur lequel Azure CLI est installé, veillez à redémarrer l’agent afin que toutes les variables d’environnement pertinentes soient mises à jour.

Docker

Cette tâche nécessite que Docker soit installé sur l’agent Azure Pipelines pour envoyer des images au Azure Container Registry fourni. Pour plus d’informations sur l’installation de Docker sur l’agent, consultez ce document.

En outre, les utilisateurs qui exécutent cette tâche avec un agent Windows peuvent rencontrer un problème de ne pas pouvoir extraire des images linux ; pour résoudre ce problème, visitez ce site ou trouvez le DockerCli.exe fichier sur votre agent (généralement dans le Program Files\Docker\Docker dossier) et exécutez

& `.\DockerCli.exe` -SwitchDaemon

Si Docker n’est pas installé sur l’agent exécutant cette tâche, le ou les scénarios suivants sont toujours activés :

• Fourniture d’une image précédemment générée à l’argument imageToDeploy avec lequel l’application conteneur déploie

Si Docker se trouve sur l’agent, mais ne peut pas fonctionner avec des images Linux, les scénarios suivants sont toujours activés :

• Fourniture d’une image précédemment générée à l’argument imageToDeploy avec lequel l’application conteneur déploie
• Fournir un Dockerfile dans le cadre de votre source d’application qui sera généré et déployé avec l’application conteneur
  • Remarque : le ne peut pas avoir de Dockerfile couches d’image linux

pack CLI

L’interface CLI de pack est gérée par le projet Cloud Native Buildpacks et est utilisée par cette tâche pour créer des images d’application exécutables pour l’utilisateur lorsque le code source de l’application est fourni et qu’aucun fichier Dockerfile supplémentaire n’est fourni ou trouvé. Un générateur a été créé par Oryx pour prendre en charge le code source de l’application fourni à cette tâche et produire une image qui pouvait ensuite être envoyée à un registre d’images et utilisée dans une application conteneur pour générer et exécuter l’application.

Une version stable de l’interface CLI du pack est installée sur l’agent Azure Pipelines exécutant la tâche. En fonction du système d’exploitation de base de cet agent, différents outils seront utilisés pour faciliter l’installation :

• Sur les exécuteurs Windows :
  • Un ensemble de commandes PowerShell est exécuté pour effectuer les opérations suivantes :
    • Crée un pack dossier dans le dossier temporaire de l’agent, si le pack dossier n’existe pas encore
    • Télécharge l’interface CLI .zip du pack dans ce pack dossier
    • Décompresse le contenu de ce .zip fichier et le place dans le pack dossier
    • Supprime le .zip
• Sur les exécuteurs non Windows :
  • curlsera utilisé pour extraire le .tgz contenant l’exécutable pack
  • tar sera utilisé pour décompresser et .tgz placer l’exécutable pack dans /usr/local/bin

Azure Container Registry

Un Azure Container Registry doit exister vers lequel l’utilisateur peut envoyer (push) des images conteneur. Cette tâche tire parti de la Azure Container Registry pour envoyer (push) une image d’application exécutable générée vers et/ou déployer une application conteneur à partir de.

Le nom du Azure Container Registry est requis via l’argument acrName .

L’utilisateur peut également fournir des valeurs pour les acrUsername arguments et acrPassword qui authentifient les appels à l’Azure Container Registry instance ; s’il n’est pas fourni, un jeton d’accès est généré via Azure CLI qui authentifiera les appels à la place.

Environnement Azure Container App

Un environnement Azure Container App est recommandé d’avoir été créé précédemment par l’utilisateur pour améliorer les performances de la tâche. Si aucun environnement n’a été créé auparavant ou si un environnement est introuvable dans le groupe de ressources utilisé pour héberger l’application conteneur créée, un environnement est créé par dans le cadre de la az containerapp up commande, ce qui peut prendre du temps.

Exemples

Les exemples suivants décrivent comment utiliser le AzureContainerApps dans différents scénarios.

Minimal - Générer une image d’application pour l’application conteneur

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un nouveau groupe de ressources nommé <container-app-name>-rg. L’application conteneur sera basée sur une image qui a été créée à partir du fourni appSourcePath et envoyée à la instance ACR fournie. Un jeton d’accès sera généré pour authentifier le push sur le instance ACR fourni.

Minimal - Utiliser une image publiée précédemment pour Container App

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    imageToDeploy: mcr.microsoft.com/azuredocs/containerapps-helloworld:latest

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un nouveau groupe de ressources nommé <container-app-name>-rg où aucune nouvelle image n’est générée, mais une image existante nommée mcr.microsoft.com/azuredocs/containerapps-helloworld:latest sera utilisée pour l’application conteneur.

Minimal - Utiliser le fichier de configuration YAML avec une image publiée précédemment pour Container App

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    yamlConfigPath: simple-image-container-app.yaml

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un nouveau groupe de ressources nommé <container-app-name>-rg où aucune nouvelle image n’est générée, mais une image existante nommée mcr.microsoft.com/azuredocs/containerapps-helloworld:latest sera utilisée pour l’application conteneur. Les propriétés supplémentaires relatives à l’application conteneur sont extraites du simple-image-container-app.yaml fichier et remplacent toutes les valeurs supplémentaires qui auraient été fournies à la tâche en tant qu’arguments à l’exclusion resourceGroupde .

Le simple-image-container-app.yaml fichier a la structure suivante :

properties:
  managedEnvironmentId: /subscriptions/SUBSCRIPTION_ID/resourceGroup/RESOURCE_GROUP/providers/Microsoft.App/managedEnvironments/CONTAINER_APP_ENVIRONMENT
  configuration:
    ingress:
      external: true
      allowInsecure: false
      targetPort: 80
  template:
    containers:
      - image: mcr.microsoft.com/azuredocs/containerapps-helloworld:latest
        name: mysampleimagecontainer

Les valeurs de SUBSCRIPTION_IDet RESOURCE_GROUPCONTAINER_APP_ENVIRONMENT doivent être mises à jour pour pointer vers l’ID de ressource complet de l’environnement Container App existant que l’application conteneur utilisera.

Utilisation des informations d’identification ACR pour l’authentification

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'
    acrUsername: $(ACR_USERNAME_SECRET)
    acrPassword: $(ACR_PASSWORD_SECRET)

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un nouveau groupe de ressources nommé <container-app-name>-rg. L’application conteneur sera basée sur une image qui a été créée à partir du fourni appSourcePath et envoyée à la instance ACR fournie. Les informations d’identification ACR fournies seront utilisées pour authentifier les appels à l’instance ACR.

Nom de l’application conteneur fourni

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'
    containerAppName: 'my-test-container-app'

Cela crée une application conteneur nommée my-test-container-app dans un nouveau nom my-test-container-app-rgde groupe de ressources .

Groupe de ressources fourni

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'
    resourceGroup: 'my-test-rg'

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un groupe de ressources nommé my-test-rg. Si le my-test-rg groupe de ressources n’existe pas, il sera créé dans le cadre de cette tâche.

Nom de l’application conteneur et groupe de ressources fournis

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'
    containerAppName: 'my-test-container-app'
    resourceGroup: 'my-test-rg'

Cela crée une application conteneur nommée my-test-container-app dans un groupe de ressources nommé my-test-rg. Si le my-test-rg groupe de ressources n’existe pas, il sera créé dans le cadre de cette tâche.

Environnement d’application conteneur fourni

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'
    containerAppEnvironment: 'my-test-container-app-env'

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un nouveau groupe de ressources nommé <container-app-name>-rg avec un nouvel environnement Container App nommé my-test-container-app-env.

Pile d’exécution fournie

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'
    runtimeStack: 'dotnetcore:7.0'

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un nouveau groupe de ressources nommé <container-app-name>-rg où l’image d’application exécutable utilise la pile d’exécution .NET 7.

Dockerfile fourni

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'
    dockerfilePath: 'test.Dockerfile'

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un nouveau groupe de ressources nommé <container-app-name>-rg où l’image d’application exécutable a été créée à partir du fichier trouvé dans le test.Dockerfile répertoire de chemin d’accès source de l’application fourni.

Remarque : pour les valeurs fournies à dockerfilePath, aucun préfixe de fichier ne doit être inclus (par exemple, ./test.Dockerfile doit être passé en tant que juste test.Dockerfile). Les arguments et dockerfilePath fournis appSourcePath seront concaténés à l’intérieur de la tâche.

Image à générer fournie

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    appSourcePath: '$(System.DefaultWorkingDirectory)'
    acrName: 'mytestacr'
    imageToBuild: 'mytestacr.azurecr.io/app:latest'

Cela crée une application conteneur nommée ado-task-app-<build-id>-<build-number> dans un nouveau groupe de ressources nommé <container-app-name>-rg où l’image générée et envoyée à ACR est nommée mytestacr.azurecr.io/app:latest.

Configuration requise

Voir aussi

• Déployer sur Azure Container Apps à partir d’Azure Pipelines