AzureContainerApps@1 – Azure Container Apps– Distribuera v1-uppgift

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.

Ingångar

Alternativ för aktivitetskontroll

Alla aktiviteter har kontrollalternativ utöver sina uppgiftsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Anmärkningar

Med den här Azure Pipelines-uppgiften kan användarna enkelt distribuera sin programkälla till en Azure Container App i sitt Azure Pipelines-arbetsflöde genom att antingen tillhandahålla en tidigare skapad avbildning, en Dockerfile som en avbildning kan byggas från eller använda en byggare för att skapa en körbar programavbildning för användaren.

Uppgiften har följande två användningsmönster.

• Push-överför en avbildning till ACR – när du skickar en ny avbildning till ACR krävs acrName- och appSourcePath uppgiftsindata.
• Distribuera en tidigare push-överförd avbildning – när du distribuerar en tidigare push-överförd avbildning krävs imageToDeploy uppgiftsindata. Om den här avbildningen hittas i en ACR-instans som kräver autentisering kan argumentet acrName eller argumenten acrUsername och acrPassword anges för att autentisera begäranden till ACR-instansen.

Om ingen Dockerfile hittas eller anges i den angivna programkällan utförs följande steg av den här uppgiften:

• Använder Oryx++ Builder för att skapa programkällan med Oryx- för att skapa en runnable-programbild
• Skickar den här körbara programavbildningen till det angivna Azure Container Registry
• Skapar eller uppdaterar en containerapp baserat på den här avbildningen

Om en Dockerfile hittas eller identifieras i programkällan används inte byggverktyget och avbildningen skapas med ett anrop till docker build och containerappen skapas eller uppdateras baserat på den här avbildningen.

Om en tidigare skapad avbildning redan har push-överförts till ACR-instansen och tillhandahålls till den här uppgiften krävs ingen programkälla och avbildningen används när containerappen skapas eller uppdateras.

Köra den här uppgiften på Microsoft-värdbaserade agenter

Om du kör den här uppgiften på en Microsoft-värdbaserad agentkan det hända att den här uppgiften inte kan köras med följande operativsystem:

• macOS
  • De macOS-löpare som tillhandahålls av Microsoft kommer inte att installeras med Docker (mer information här); Därför kan den här uppgiften inte köra några docker kommandon, till exempel push-överföra de byggda körbara programbilderna till ACR.
• Windows
  • Windows-löpare som tillhandahålls av Microsoft levereras med Docker installerat, men som standard kan Linux-baserade avbildningar inte hämtas. Därför kan den här uppgiften inte hämta Oryx-byggaren för att skapa körbara programbilder från den angivna programkällan.

Mer information finns i avsnittet nedan Docker krav.

Meddelande om insamling av data/telemetri

Som standard samlar den här Azure DevOps-uppgiften in följande data för Microsoft:

• Scenariot för att skapa och distribuera containerappen som användaren riktar in sig på
  • d.v.s., använde Oryx++ Builder, använde en tillhandahållen/hittad Dockerfile eller tillhandahöll en tidigare skapad avbildning
  • Obs: avbildningsnamnet inte samlas in
• Bearbetningstiden för aktiviteten i millisekunder
• Resultatet av uppgiften
  • d.v.s., lyckades eller misslyckades
• Om Oryx++ Builder används, händelser och mått som rör att skapa det angivna programmet med Hjälp av Oryx

Om du vill inaktivera datainsamling anger du argumentet disableTelemetry till true.

Förutsättningar

Innan du kör den här uppgiften är Azure-resurser och en Azure DevOps-tjänstanslutning antingen obligatoriska eller valfria beroende på argumenten för den här uppgiften.

Azure DevOps-tjänstanslutning

För att distribuera till Azure måste en Azure-prenumeration länkas till Team Foundation Server eller till Azure Pipelines med hjälp av fliken Tjänster i avsnittet inställningar. Lägg till den Azure-prenumeration som ska användas i definitionen Skapa eller Versionshantering genom att öppna skärmen Kontoadministration (kugghjulsikonen längst upp till höger på skärmen) och klicka sedan på fliken Tjänster.

Skapa tjänstslutpunkten ARM och använd "Azure Resource Manager" slutpunktstyp. Mer information om hur du skapar tjänstanslutningar finns i det här dokumentet.

Azure CLI

Den här uppgiften kräver att Azure CLI är installerat på Azure Pipelines-agenten för att köra en mängd olika kommandon under hela körningen av uppgiften. Mer information om hur du installerar Azure CLI på agenten finns i det här dokumentet. Om en agent redan körs på den dator där Azure CLI är installerat kontrollerar du att du startar om agenten så att alla relevanta miljövariabler uppdateras.

Stuveriarbetare

Den här uppgiften kräver att Docker är installerat på Azure Pipelines-agenten för att skicka avbildningar till det angivna Azure Container Registry. Mer information om hur du installerar Docker på agenten finns i det här dokumentet.

Dessutom kan användare som kör den här uppgiften med en Windows-agent stöta på ett problem med att inte kunna hämta Linux-baserade avbildningar. Lös problemet genom att gå till den här webbplatsen eller leta upp filen DockerCli.exe på din agent (vanligtvis i mappen Program Files\Docker\Docker) och köra

& `.\DockerCli.exe` -SwitchDaemon

Om Docker inte är installerat på agenten som kör den här uppgiften är följande scenarion fortfarande aktiverade:

• Tillhandahålla en tidigare skapad avbildning till argumentet imageToDeploy som containerappen distribuerar med

Om Docker finns på agenten, men inte kan arbeta med Linux-baserade avbildningar, är följande scenarion fortfarande aktiverade:

• Tillhandahålla en tidigare skapad avbildning till argumentet imageToDeploy som containerappen distribuerar med
• Tillhandahålla en Dockerfile som en del av din programkälla som ska skapas och distribueras med containerappen
  • Obs: Dockerfile kan inte ha några Linux-baserade avbildningslager

pack CLI

CLI- för pack underhålls av projektet Cloud Native Buildpacks och används av den här uppgiften för att skapa körbara programbilder för användaren när programmets källkod tillhandahålls och ingen ytterligare Dockerfile tillhandahålls eller hittas. En builder- skapades av Oryx för att ta in programkällan som tillhandahålls den här uppgiften och skapa en avbildning som sedan kunde skickas till ett avbildningsregister och användas i en containerapp för att skapa och köra programmet.

En stabil version av paketet CLI installeras på Azure Pipelines-agenten som kör uppgiften, och beroende på agentens basoperativsystem används olika verktyg för att hjälpa till med installationen:

• På Windows-löpare:
  • En uppsättning PowerShell-kommandon körs för att göra följande:
    • Skapar en pack mapp i agentens temporära mapp, om mappen pack inte redan finns
    • Laddar ned cli-paketet .zip till den här mappen pack
    • Packa upp innehållet från den här .zip och placerar dem i mappen pack
    • Tar bort .zip
• På andra än Windows-löpare:
  • curl används för att hämta .tgz som innehåller den körbara pack
  • tar används för att packa upp .tgz och placera den körbara pack i /usr/local/bin

Azure Container Registry

En Azure Container Registry- måste finnas som användaren kan skicka containeravbildningar till. Den här uppgiften använder Azure Container Registry för att antingen push-överföra en inbyggd körbar programavbildning till och/eller distribuera en containerapp från.

Namnet på Azure Container Registry krävs via argumentet acrName.

Användaren kan också ange värden för argumenten acrUsername och acrPassword som autentiserar anrop till Azure Container Registry-instansen. Om den inte tillhandahålls genereras en åtkomsttoken via Azure CLI som autentiserar anropen i stället.

Azure Container App-miljö

En Azure Container App-miljö rekommenderas att tidigare ha skapats av användaren för att förbättra aktivitetens prestanda. Om ingen miljö har skapats tidigare, eller om det inte går att hitta en miljö i resursgruppen som används som värd för den skapade containerappen, skapas en miljö som en del av kommandot az containerapp up, vilket kan ta ytterligare tid.

Exempel

I följande exempel beskrivs hur du använder AzureContainerApps i olika scenarier.

Minimal – Skapa programavbildning för Container App

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

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en ny resursgrupp med namnet <container-app-name>-rg. Containerappen baseras på en avbildning som har skapats från den angivna appSourcePath och push-överförts till den angivna ACR-instansen. En åtkomsttoken genereras för att autentisera push-överföringen till den angivna ACR-instansen.

Minimal – Använd tidigare publicerad avbildning för Container App

steps:
- task: AzureContainerApps@1
  displayName: Build and deploy Container App
  inputs:
    connectedServiceNameARM: 'azure-subscription-service-connection'
    imageToDeploy: mcr.microsoft.com/<existing-image>:latest

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en ny resursgrupp med namnet <container-app-name>-rg där ingen ny avbildning skapas, men en befintlig avbildning med namnet mcr.microsoft.com/<existing-image>:latest används för containerappen.

Minimal – Använd YAML-konfigurationsfil med tidigare publicerad avbildning för Container App

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

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en ny resursgrupp med namnet <container-app-name>-rg där ingen ny avbildning skapas, men en befintlig avbildning med namnet mcr.microsoft.com/<existing-image>:latest används för containerappen. Ytterligare egenskaper om containerappen hämtas från filen simple-image-container-app.yaml och åsidosätter eventuella ytterligare värden som skulle ha angetts för uppgiften som argument exklusive resourceGroup.

Filen simple-image-container-app.yaml har följande struktur:

properties:
  managedEnvironmentId: /subscriptions/SUBSCRIPTION_ID/resourceGroups/RESOURCE_GROUP/providers/Microsoft.App/managedEnvironments/CONTAINER_APP_ENVIRONMENT
  configuration:
    ingress:
      external: true
      allowInsecure: false
      targetPort: 80
  template:
    containers:
      - image: mcr.microsoft.com/<existing-image>:latest
        name: mysampleimagecontainer

Värdena för SUBSCRIPTION_ID, RESOURCE_GROUP och CONTAINER_APP_ENVIRONMENT måste uppdateras så att de pekar på det fullständiga resurs-ID:t för den befintliga Container App-miljön som containerappen ska använda.

Använda ACR-autentiseringsuppgifter för att autentisera

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)

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en ny resursgrupp med namnet <container-app-name>-rg. Containerappen baseras på en avbildning som har skapats från den angivna appSourcePath och push-överförts till den angivna ACR-instansen. De angivna ACR-autentiseringsuppgifterna används för att autentisera anrop till ACR-instansen.

Namnet på containerappen har angetts

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'

Då skapas en ny containerapp med namnet my-test-container-app i ett nytt resursgruppsnamn my-test-container-app-rg.

Tillhandahållen resursgrupp

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'

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en resursgrupp med namnet my-test-rg. Om den my-test-rg resursgruppen inte finns skapas den som en del av den här uppgiften.

Namnet på containerappen och resursgruppen tillhandahålls

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'

Då skapas en ny containerapp med namnet my-test-container-app i en resursgrupp med namnet my-test-rg. Om den my-test-rg resursgruppen inte finns skapas den som en del av den här uppgiften.

ContainerApp-miljö tillhandahålls

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'

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en ny resursgrupp med namnet <container-app-name>-rg med en ny Container App-miljö med namnet my-test-container-app-env.

Körningsstacken tillhandahålls

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'

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en ny resursgrupp med namnet <container-app-name>-rg där den körbara programavbildningen använder .NET 7-körningsstacken.

Dockerfile tillhandahålls

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

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en ny resursgrupp med namnet <container-app-name>-rg där den körbara programavbildningen skapades från den test.Dockerfile fil som finns i den angivna sökvägen till programmet.

Obs: för värden som anges i dockerfilePathska inga filprefix inkluderas (t.ex., ./test.Dockerfile bör skickas som bara test.Dockerfile). De angivna argumenten appSourcePath och dockerfilePath sammanfogas i aktiviteten.

Avbildning som ska skapas

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'

Då skapas en ny containerapp med namnet ado-task-app-<build-id>-<build-number> i en ny resursgrupp med namnet <container-app-name>-rg där avbildningen som skapats och push-överförts till ACR heter mytestacr.azurecr.io/app:latest.

Krav

Se även

• Distribuera till Azure Container Apps från Azure Pipelines