Självstudie: Använda en kanariedistributionsstrategi för Kubernetes

Azure DevOps Services | Azure DevOps Server 2022

Den här stegvisa guiden beskriver hur du använder Kubernetes-manifestuppgiften canary med strategin. En kanariedistributionsstrategi distribuerar nya versioner av ett program bredvid stabila produktionsversioner.

Du använder det associerade arbetsflödet för att distribuera koden och jämföra baslinje- och kanarieappdistributioner. Baserat på utvärderingen bestämmer du om du vill höja upp eller avvisa kanariedistributionen.

I den här självstudien används Docker Registry- och Azure Resource Manager-tjänstanslutningar för att ansluta till Azure-resurser. För ett privat Azure Kubernetes Service-kluster (AKS) eller ett kluster som har lokala konton inaktiverade är en Azure Resource Manager-tjänstanslutning ett bättre sätt att ansluta.

Förutsättningar

• Ett Azure DevOps-projekt med minst användarbehörighet .

• Ett Azure-konto. Skapa ett konto utan kostnad.

• En Azure Container Registry-instans med push-behörigheter.

• Ett AKS-kluster (Azure Kubernetes Service) distribuerat. Du kan koppla AKS-klustret till ditt Azure Container-registerkluster när du distribuerar AKS-klustret eller efteråt.

• Ett GitHub-konto. Skapa ett kostnadsfritt GitHub-konto.

• En förgrening av https://github.com/MicrosoftDocs/azure-pipelines-canary-k8s GitHub-lagringsplatsen.

  Viktigt!

  Under följande procedurer kan du uppmanas att skapa en GitHub-tjänstanslutning eller omdirigeras till GitHub för att logga in, installera Azure Pipelines eller auktorisera Azure Pipelines. Följ anvisningarna på skärmen för att slutföra processen. Mer information finns i Åtkomst till GitHub-lagringsplatser.

GitHub-lagringsplatsfiler

GitHub-lagringsplatsen innehåller följande filer:

Fil	beskrivning
./app/app.py	En enkel Flask-baserad webbserver . Filen konfigurerar en anpassad räknare för antalet bra och dåliga svar baserat på variabelns success_rate värde.
./app/Dockerfile	Används för att skapa avbildningen med varje ändring i app.py. Varje ändring utlöser bygg-pipelinen för att skapa avbildningen och push-överföra den till containerregistret.
./manifest/deployment.yml	Innehåller specifikationen för distributionsarbetsbelastningen sampleapp som motsvarar den publicerade avbildningen. Du använder den här manifestfilen för den stabila versionen av distributionsobjektet och för att härleda baslinje- och kanarievarianterna för arbetsbelastningarna.
./manifest/service.yml	Skapar tjänsten sampleapp . Den här tjänsten dirigerar begäranden till poddarna som spunnits upp av stabila distributioner, baslinje- och kanariedistributioner.
./misc/fortio.yml	Konfigurerar en fortio-distribution. Den här distributionen är ett belastningstestverktyg som skickar en dataström med begäranden till den distribuerade sampleapp tjänsten. Begärandeströmmen dirigerar till poddar under de tre distributionerna: stabil, baslinje och kanariefågel.

Skapa tjänstanslutningar

1. I ditt Azure DevOps-projekt går du till Project settings>Pipelines Service connections (Pipelines>Service-anslutningar).
2. Skapa en Docker Registry-tjänstanslutning med namnet azure-pipelines-canary-acr som är associerad med din Azure Container Registry-instans.
3. Skapa en Azure Resource Manager-tjänstanslutning med arbetsbelastningsidentiteten azure-pipelines-canary-k8s för resursgruppen.

Lägg till byggsteget

1. I ditt Azure DevOps-projekt går du till Pipelines>Skapa pipeline eller Ny pipeline.

2. Välj GitHub för din kodplats och välj din förgrenade azure-pipelines-canary-k8s-lagringsplats .

3. På fliken Konfigurera väljer du Startpipeline.

4. På fliken Granska ersätter du YAML-pipelinen med följande kod.

   trigger:
   - main
   
   pool:
     vmImage: ubuntu-latest
   
   variables:
     imageName: azure-pipelines-canary-k8s # name of ACR image
     dockerRegistryServiceConnection: azure-pipelines-canary-acr # name of ACR service connection
     imageRepository: 'azure-pipelines-canary-k8s' # name of image repository
     containerRegistry: example.azurecr.io # name of Azure container registry
     tag: '$(Build.BuildId)'
   
   stages:
   - stage: Build
     displayName: Build stage
     jobs:  
     - job: Build
       displayName: Build
       pool:
         vmImage: ubuntu-latest
       steps:
       - task: Docker@2
         displayName: Build and push image
         inputs:
           containerRegistry: $(dockerRegistryServiceConnection)
           repository: $(imageName)
           command: buildAndPush
           Dockerfile: app/Dockerfile
           tags: |
             $(tag)
   

   Om Docker-registertjänstanslutningen som du skapade är associerad med ett containerregister med namnet example.azurecr.ioär avbildningen inställd på example.azurecr.io/azure-pipelines-canary-k8s:$(Build.BuildId).

5. Välj Spara och kör och se till att jobbet körs korrekt.

Redigera manifestfilen

I lagringsplatsens förgrening redigerar du manifest/deployment.yml för att ersätta <foobar> med containerregistrets URL, till exempel example.azurecr.io/azure-pipelines-canary-k8s.

Konfigurera kontinuerlig distribution

Nu konfigurerar du kontinuerlig distribution, distribuerar kanariefasen och höjer upp eller avvisar kanariefågeln genom manuellt godkännande.

Skapa en miljö

Du kan distribuera med YAML eller Klassisk.

YAML

1. I ditt Azure DevOps-projekt går du till Pipelines-miljöer> och väljer sedan Skapa miljö eller Ny miljö.
2. På den första skärmen Ny miljö anger du akscanary under Namn, väljer Kubernetes under Resurs och väljer Nästa.
3. Fyll i Kubernetes-resursskärmen på följande sätt:
   • Provider: Välj Azure Kubernetes Service.
   • Azure-prenumeration: Välj din Azure-prenumeration.
   • Kluster: Välj ditt AKS-kluster.
   • Namnområde: Välj Ny och ange canarydemo.
4. Välj Verifiera och skapa.

Lägg till kanariesteget

1. Gå till Pipelines, välj den pipeline som du skapade och välj Redigera.

2. Ersätt hela YAML-pipelinen med följande kod.

   Den här koden ändrar det Docker@2 steg som du körde tidigare för att använda en fas och lägger till ytterligare två steg för att kopiera manifesten och felkatalogerna som artefakter för efterföljande faser som ska användas.

   Koden flyttar även vissa värden till variabler för enklare användning senare i pipelinen. I variabeln containerRegistry ersätter du <example> med namnet på ditt containerregister.

   trigger:
   - main
   
   pool:
     vmImage: ubuntu-latest
   
   variables:
     imageName: azure-pipelines-canary-k8s
     dockerRegistryServiceConnection: azure-pipelines-canary-acr
     imageRepository: 'azure-pipelines-canary-k8s'
     containerRegistry: <example>.azurecr.io
     tag: '$(Build.BuildId)'
   
   stages:
   - stage: Build
     displayName: Build stage
     jobs:  
     - job: Build
       displayName: Build
       pool:
         vmImage: ubuntu-latest
       steps:
       - task: Docker@2
         displayName: Build and push image
         inputs:
           containerRegistry: $(dockerRegistryServiceConnection)
           repository: $(imageName)
           command: buildAndPush
           Dockerfile: app/Dockerfile
           tags: |
             $(tag)
   
       - publish: manifests
         artifact: manifests
   
       - publish: misc
         artifact: misc
   

3. Lägg till ytterligare en fas i slutet av YAML-filen för att distribuera kanarieversionen. Ersätt värdena my-resource-group och my-aks-cluster med resursgruppen och Azure Kubernetes Service-klusternamnet.

   trigger:
   - main
   
   pool:
     vmImage: ubuntu-latest
   
   variables:
     imageName: azure-pipelines-canary-k8s
     dockerRegistryServiceConnection: azure-pipelines-canary-acr
     imageRepository: 'azure-pipelines-canary-k8s'
     containerRegistry: yourcontainerregistry.azurecr.io #update with container registry
     tag: '$(Build.BuildId)'
   
   stages:
   - stage: Build
     displayName: Build stage
     jobs:  
     - job: Build
       displayName: Build
       pool:
         vmImage: ubuntu-latest
       steps:
       - task: Docker@2
         displayName: Build and push image
         inputs:
           containerRegistry: $(dockerRegistryServiceConnection)
           repository: $(imageName)
           command: buildAndPush
           Dockerfile: app/Dockerfile
           tags: |
             $(tag)
   
       - publish: manifests
         artifact: manifests
   
       - publish: misc
         artifact: misc
   
   - stage: DeployCanary
     displayName: Deploy canary
     dependsOn: Build
     condition: succeeded()
   
     jobs:
     - deployment: Deploycanary
       displayName: Deploy canary
       pool:
         vmImage: ubuntu-latest
       environment: 'akscanary'
       strategy:
         runOnce:
           deploy:
             steps:
             - task: KubernetesManifest@1
               displayName: Create Docker Registry Secret
               inputs:
                 action: 'createSecret'
                 connectionType: 'azureResourceManager'
                 azureSubscriptionConnection: 'azure-pipelines-canary-sc'
                 azureResourceGroup: 'my-resource-group'
                 kubernetesCluster: 'my-aks-cluster'
                 secretType: 'dockerRegistry'
                 secretName: 'my-acr-secret'
                 dockerRegistryEndpoint: 'azure-pipelines-canary-acr'
   
             - task: KubernetesManifest@1
               displayName: Deploy to Kubernetes cluster
               inputs:
                 action: 'deploy'
                 connectionType: 'azureResourceManager'
                 azureSubscriptionConnection: 'azure-pipelines-canary-sc'
                 azureResourceGroup: 'my-resource-group'
                 kubernetesCluster: 'my-aks-cluster'
                 strategy: 'canary'
                 percentage: '25'
                 manifests: |
                   $(Pipeline.Workspace)/manifests/deployment.yml
                   $(Pipeline.Workspace)/manifests/service.yml
                 containers: '$(containerRegistry)/$(imageRepository):$(tag)'
                 imagePullSecrets: 'my-acr-secret'
   
             - task: KubernetesManifest@1
               displayName: Deploy Forbio to Kubernetes cluster
               inputs:
                 action: 'deploy'
                 connectionType: 'azureResourceManager'
                 azureSubscriptionConnection: 'azure-pipelines-canary-sc'
                 azureResourceGroup: 'my-resource-group'
                 kubernetesCluster: 'my-aks-cluster'
                 manifests: '$(Pipeline.Workspace)/misc/*'
   

4. Välj Verifiera och spara och spara pipelinen direkt till huvudgrenen.

Klassisk

1. Gå till Pipelines-versioner>>Ny>ny versionspipeline. Ge den namnet CanaryK8sDemo.
2. I den efterföljande modellen för att välja en mall för steg 1 väljer du Tomt jobb. Namnge fasen som Distribuera kanariefågel.
3. Välj Lägg till en artefakt och välj GitHub.
   • Välj en befintlig Git-tjänstanslutning eller skapa en ny via vilken den förgrenade lagringsplatsen kan nås. Välj sedan samma i listrutan Källa (lagringsplats ).
   • Standardgren: main
   • Standardversion: Välj den senaste från standardgrenen.
   • Källalias: azure-pipelines-canary-k8s
   • Bekräfta dina indata genom att välja Lägg till.
4. Välj Lägg till en artefakt och välj Azure Container Registry eller Docker Hub, beroende på vilket containerregister du valde tidigare, i avsnittet "Förutsättningar". Ange lämpliga värden för listrutorna för indata för att hitta containerregistret. Ange avbildningen som alias för den här artefakten och bekräfta indata genom att välja Lägg till. När artefakten har lagts till väljer du blixtikonen på artefaktkortet för att aktivera utlösaren för kontinuerlig distribution.
5. I fasen Distribuera kanariefågel som du skapade väljer du länken 1 jobb, 0 aktivitet för att gå till fönstret för att lägga till jobb och faser.
6. Välj Agentjobb. I listrutan Agentpool i konfigurationsfönstret väljer du Värdbaserad Ubuntu 22.04.
7. Välj inloggningen + på agentjobbraden för att lägga till en ny aktivitet. Lägg till uppgiften Distribuera Kubernetes-manifest med följande konfiguration:
   • Visningsnamn: Skapa hemlighet
   • Åtgärd: Skapa hemlighet
   • Kubernetes-tjänstanslutning: azure-pipelines-canary-k8s
   • Namnområde: Namnområdet i klustret som du vill distribuera till.
   • Typ av hemlighet: dockerRegistry
   • Hemligt namn: azure-pipelines-canary-k8s
   • Docker-registertjänstanslutning: azure-pipelines-canary-k8s
8. Lägg till ytterligare en Aktivitet för Att distribuera Kubernetes-manifest med följande konfiguration:
   • Visningsnamn: Distribuera kanariefågel
   • Åtgärd: Distribuera
   • Kubernetes-tjänstanslutning: azure-pipelines-canary-k8s
   • Namnområde: Namnområdet i klustret som du vill distribuera till.
   • Strategi: Kanariefågel
   • Procent: 25
   • Manifest: azure-pipelines-canary-k8s/manifest/*
   • Containrar: <example>/azure-pipelines-canary-k8s:$(Release.Artifacts.image.BuildId), var <example> ska ersättas med containerregistrets URL.
   • ImagePullSecrets: azure-pipelines-canary-k8s
9. Lägg till ytterligare en Aktivitet för Att distribuera Kubernetes-manifest med följande konfiguration:
   • Visningsnamn: Distribuera Fortio och ServiceMonitor
   • Åtgärd: Distribuera
   • Kubernetes-tjänstanslutning: azure-pipelines-canary-k8s
   • Namnområde: Namnområdet i klustret som du vill distribuera till.
   • Strategi: Ingen
   • Manifest: azure-pipelines-canary-k8s/misc/*

Lägga till manuellt godkännande för att främja eller avvisa kanariedistribution

Du kan ingripa manuellt med YAML eller Klassisk.

YAML

1. Skapa en ny Kubernetes-miljö med namnet akspromote.
2. Öppna den nya akspromote-miljön från listan över miljöer och välj Godkännanden på fliken Godkännanden och kontroller .
3. På skärmen Godkännanden lägger du till ditt eget användarkonto under Godkännare.
4. Expandera Avancerat och se till att Tillåt godkännare att godkänna sina egna körningar har valts.
5. Välj Skapa.

Lägga till steg för att höja upp och avvisa i pipelinen

1. Gå till Pipelines, välj den pipeline som du skapade och välj Redigera.

2. Lägg till följande PromoteRejectCanary steg i slutet av YAML-filen som höjer upp ändringarna.

   - stage: PromoteRejectCanary
     displayName: Promote or Reject canary
     dependsOn: DeployCanary
     condition: succeeded()
   
     jobs:
     - deployment: PromoteCanary
       displayName: Promote Canary
       pool: 
         vmImage: ubuntu-latest
       environment: 'akspromote'
       strategy:
         runOnce:
           deploy:
             steps:      
             - task: KubernetesManifest@1
               displayName: Create Docker Registry Secret for akspromote
               inputs:
                 action: 'createSecret'
                 connectionType: 'azureResourceManager'
                 azureSubscriptionConnection: 'azure-pipelines-canary-sc'
                 azureResourceGroup: 'my-resource-group'
                 kubernetesCluster: 'my-aks-cluster'
                 secretType: 'dockerRegistry'
                 secretName: 'my-acr-secret'
                 dockerRegistryEndpoint: 'azure-pipelines-canary-acr'
   
             - task: KubernetesManifest@1
               displayName: promote canary
               inputs:
                 action: 'promote'
                 connectionType: 'azureResourceManager'
                 azureSubscriptionConnection: 'azure-pipelines-canary-sc'
                 azureResourceGroup: 'my-resource-group'
                 kubernetesCluster: 'my-aks-cluster'
                 strategy: 'canary'
                 manifests: '$(Pipeline.Workspace)/manifests/*'
                 containers: '$(containerRegistry)/$(imageRepository):$(tag)'
                 imagePullSecrets: 'my-acr-secret'
       ```
   
   

3. Lägg till följande RejectCanarysteg i slutet av filen som återställer ändringarna.

   - stage: RejectCanary
     displayName: Reject canary
     dependsOn: PromoteRejectCanary
     condition: failed()
   
     jobs:
     - deployment: RejectCanary
       displayName: Reject Canary
       pool: 
         vmImage: ubuntu-latest
       environment: 'akscanary'
       strategy:
         runOnce:
           deploy:
             steps:        
             - task: KubernetesManifest@1
               displayName: Create Docker Registry Secret for reject canary
               inputs:
                 action: 'createSecret'
                 connectionType: 'azureResourceManager'
                 azureSubscriptionConnection: 'azure-pipelines-canary-sc'
                 azureResourceGroup: 'kubernetes-testing'
                 kubernetesCluster: 'my-aks-cluster'
                 secretType: 'dockerRegistry'
                 secretName: 'my-acr-secret'
                 dockerRegistryEndpoint: 'azure-pipelines-canary-acr'    
             - task: KubernetesManifest@1
               displayName: Reject canary deployment
               inputs:
                 action: 'reject'
                 connectionType: 'azureResourceManager'
                 azureSubscriptionConnection: 'azure-pipelines-canary-sc'
                 azureResourceGroup: 'my-resource-group'
                 kubernetesCluster: 'my-aks-cluster'
                 namespace: 'default'
                 strategy: 'canary'
                 manifests: '$(Pipeline.Workspace)/manifests/*'
       ```
   

4. Välj Verifiera och spara och spara pipelinen direkt till huvudgrenen.

Klassisk

1. Välj fliken Pipeline för att gå tillbaka till pipelinevyn. Lägg till en ny fas med namnet Promote/reject canary, baserat på den tomma jobbmallen.
2. Lägg till ett agentlöst jobb i den här fasen och ordna om det här jobbet så att det blir det första jobbet i den här fasen. Ge det här agentlösa jobbet namnet Höj upp/avvisa indata.
3. Lägg till en manuell åtgärdsaktivitet i det här jobbet och ändra visningsnamnet för aktiviteten till Flytta upp eller avvisa kanariefågel.
4. Konfigurera det för närvarande tomma agentjobbet som har placerats efter jobbet Befordra/avvisa indata utan agent.
   • Visningsnamn: Höj upp kanariefågel
   • Agentpool: Värdbaserad Ubuntu 22.04
   • Kör det här jobbet: Välj att endast köra när alla tidigare jobb har slutförts.
5. Lägg till uppgiften Deploy Kubernetes manifests (Distribuera Kubernetes-manifest) med följande konfiguration i kanariejobbet Förhöja.
   • Visningsnamn: Höj upp kanariefågel
   • Åtgärd: Höj upp
   • Kubernetes-tjänstanslutning: azure-pipelines-canary-k8s
   • Namnområde: Namnområdet i klustret som du vill distribuera till.
   • Strategi: Kanariefågel
   • Procent: 25
   • Manifest: azure-pipelines-canary-k8s/manifest/*
   • Containrar: <example>/azure-pipelines-canary-k8s:$(Release.Artifacts.image.BuildId), där du ersätter <example> med containerregistrets URL.
   • ImagePullSecrets: azure-pipelines-canary-k8s
6. Lägg till ytterligare ett agentjobb med följande konfiguration efter jobbet Befordra kanarieagent .
   • Visningsnamn: Avvisa kanarielista
   • Agentpool: Värdbaserad Ubuntu 22.04
   • Kör det här jobbet: Välj att endast köra när ett tidigare jobb har misslyckats.
7. Lägg till uppgiften Distribuera Kubernetes-manifest med följande konfiguration till canary-jobbet Avvisa.
   • Visningsnamn: Avvisa kanarielista
   • Åtgärd: Avvisa
   • Kubernetes-tjänstanslutning: azure-pipelines-canary-k8s
   • Namnområde: Namnområdet i klustret som du vill distribuera till.
   • Strategi: Kanariefågel
   • Procent: 25
   • Manifest: azure-pipelines-canary-k8s/manifest/*

Distribuera en stabil version

För den första körningen av pipelinen finns inte den stabila versionen av arbetsbelastningarna och deras baslinje- eller kanarieversioner i klustret. Distribuera en stabil version av arbetsbelastningen enligt sampleapp följande.

Du kan distribuera en stabil version med YAML eller Klassisk.

YAML

1. I app/app.py ändrar du success_rate = 50 till success_rate = 100. Den här ändringen utlöser pipelinen, skapar och push-överför avbildningen till containerregistret och utlöser DeployCanary även fasen.
2. Eftersom du har konfigurerat ett godkännande för akspromote miljön väntar versionen innan du kör den fasen. På sammanfattningssidan för byggkörning väljer du Granska och sedan Godkänn.

När den har godkänts distribuerar pipelinen den stabila versionen av arbetsbelastningen sampleapp i manifest/deployment.yml till namnområdet.

Klassisk

1. I app/app.py ändrar du success_rate = 50 till success_rate = 100. Den här ändringen utlöser pipelinen, vilket leder till en version och push-överföring av avbildningen till containerregistret. Den kontinuerliga distributionsutlösaren, som konfigurerats tidigare på avbildningens push-händelse, utlöser versionspipelinen.
2. I canaryK8sDemo-versionspipelinen väljer du canary-fasen Förhöjer/avvisar i versionen, där den väntar på manuella åtgärder.
3. Välj Återuppta/avvisa och välj sedan Återuppta i den efterföljande dialogrutan. Detta distribuerar den stabila versionen av arbetsbelastningarna (distributionen sampleapp i manifest/deployment.yml) till namnområdet.

Initiera kanariearbetsflödet och avvisa godkännandet

Den stabila versionen av arbetsbelastningen sampleapp finns nu i klustret. Gör sedan följande ändring i simuleringsprogrammet.

YAML

1. I app/app.py ändrar du success_rate = 50 till success_rate = 100. Den här ändringen utlöser pipelinen, skapar och push-överför avbildningen till containerregistret och utlöser DeployCanary även fasen.
2. Eftersom du har konfigurerat ett godkännande för akspromote miljön väntar versionen innan du kör den fasen.
3. På sammanfattningssidan för byggkörning väljer du Granska och sedan Avvisa i den efterföljande dialogrutan. Detta avvisar distributionen.

När den har avvisats förhindrar pipelinen koddistributionen.

Klassisk

1. I app/app.py ändrar du success_rate = 50 till success_rate = 100. Den här ändringen utlöser pipelinen, vilket leder till en version och push-överföring av avbildningen till containerregistret. Den kontinuerliga distributionsutlösaren, som konfigurerats tidigare på avbildningens push-händelse, utlöser versionspipelinen.
2. I canaryK8sDemo-versionspipelinen väljer du canary-fasen Förhöjer/avvisar i versionen, där den väntar på manuella åtgärder.
3. Välj Återuppta/avvisa och välj sedan Avvisa i den efterföljande dialogrutan. Detta avvisar distributionen.

Rensa

Om du inte fortsätter att använda det här programmet tar du bort resursgruppen i Azure Portal och projektet i Azure DevOps.