Tutoriel : Utiliser une stratégie de déploiement canary pour Kubernetes

1. Dans votre projet Azure DevOps, allez dans Pipelines>Environnements puis sélectionnez Créer un environnement ou Nouvel environnement.
2. Sur le premier écran Nouvel environnement, entrez akscanary sous Nom, sélectionnez Kubernetes sous Ressource, puis sélectionnez Suivant.
3. Remplissez l’écran Ressource Kubernetes comme suit :
   • Fournisseur : Sélectionnez Azure Kubernetes Service.
   • Abonnement Azure : Sélectionnez votre abonnement Azure.
   • Cluster : sélectionnez votre cluster AKS.
   • Espace de noms : Sélectionnez Nouveau et entrez canarydemo.
4. Sélectionnez Valider et créer.

Ajouter la phase canary

1. Allez dans Pipelines, sélectionnez le pipeline que vous avez créé, et sélectionnez Modifier.

2. Remplacez l’intégralité du fichier YAML du pipeline par le code suivant.

   Ce code modifie l’étape Docker@2 que vous avez exécutée précédemment pour utiliser une phase, et ajoute deux étapes supplémentaires pour copier les répertoires manifests et misc en tant qu’artefacts pour les étapes consécutives.

   Le code déplace également certaines valeurs vers des variables pour une utilisation plus facile ultérieurement dans le pipeline. Dans la variable containerRegistry, remplacez <example> par le nom de votre référentiel de conteneurs.

   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. Ajoutez une autre phase à la fin du fichier YAML pour déployer la version canary. Remplacez les valeurs my-resource-group et my-aks-cluster par votre groupe de ressources et le nom de votre cluster Azure Kubernetes Service.

   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. Sélectionnez Valider et enregistrer, et enregistrez le pipeline directement dans la branche principale.

1. Accédez à Pipelines>Mises en production>Nouveau>Nouveau pipeline de mise en production. Nommez-le CanaryK8sDemo.
2. Dans le modèle suivant pour la sélection d’un modèle pour la Phase 1, choisissez Travail vide. Nommez la phase Déployer canary.
3. Sélectionnez Ajouter un artefact, puis choisissez GitHub.
   • Choisissez une connexion de service Git existante ou créez-en une par le biais de laquelle le dépôt dupliqué est accessible. Choisissez ensuite la même chose dans la liste déroulante Source (dépôt).
   • Branche par défaut : main
   • Version par défaut : choisissez la dernière version dans la branche par défaut.
   • Alias source : azure-pipelines-canary-k8s
   • Confirmez vos entrées en choisissant Ajouter.
4. Sélectionnez Ajouter un artefact, puis choisissez Registre de conteneurs Azure ou Docker Hub, en fonction du registre de conteneurs que vous avez choisi précédemment, dans la section « Prérequis ». Fournissez les valeurs appropriées pour les listes déroulantes d’entrée afin de localiser votre registre de conteneurs. Fournissez image comme alias pour cet artefact et confirmez les entrées en choisissant Ajouter. Une fois l’artefact ajouté, sélectionnez l’icône d’éclair sur la carte de l’artefact pour activer le déclencheur de déploiement continu.
5. Dans la phase Déployer canary que vous avez créée, sélectionnez le lien 1 travail, 0 tâche pour accéder à la fenêtre d’ajout de travaux et de phases.
6. Sélectionnez Travail de l’agent. Dans la fenêtre de configuration, dans la liste déroulante Pool d’agents, choisissez Ubuntu 22.04 hébergé.
7. Sélectionnez le signe + sur la ligne de travail de l’agent pour ajouter une nouvelle tâche. Ajoutez la tâche Déployer des manifestes Kubernetes, avec la configuration suivante :
   • Nom d’affichage : Créer un secret
   • Action : Créer un secret
   • Connexion au service Kubernetes : azure-pipelines-canary-k8s
   • Espace de noms : espace de noms au sein du cluster sur lequel vous souhaitez effectuer le déploiement.
   • Type de secret : dockerRegistry
   • Nom du secret : azure-pipelines-canary-k8s
   • Connexion au service de Registre Docker : azure-pipelines-canary-k8s
8. Ajoutez une autre tâche Déployer des manifestes Kubernetes, avec la configuration suivante :
   • Nom d’affichage : Déployer canary
   • Action : Déployer
   • Connexion au service Kubernetes : azure-pipelines-canary-k8s
   • Espace de noms : espace de noms au sein du cluster sur lequel vous souhaitez effectuer le déploiement.
   • Stratégie : Canary
   • Pourcentage : 25
   • Manifestes : azure-pipelines-canary-k8s/manifests/*
   • Conteneurs : <example>/azure-pipelines-canary-k8s:$(Release.Artifacts.image.BuildId), où <example> doit être remplacé par l’URL du registre de conteneurs.
   • ImagePullSecrets : azure-pipelines-canary-k8s
9. Ajoutez une autre tâche Déployer des manifestes Kubernetes, avec la configuration suivante :
   • Nom d’affichage : Déployer Fortio et ServiceMonitor
   • Action : Déployer
   • Connexion au service Kubernetes : azure-pipelines-canary-k8s
   • Espace de noms : espace de noms au sein du cluster sur lequel vous souhaitez effectuer le déploiement.
   • Stratégie : Aucune
   • Manifestes : azure-pipelines-canary-k8s/misc/*

1. Créez un nouvel environnement Kubernetes appelé akspromote.
2. Ouvrez le nouvel environnement akspromote depuis la liste des environnements, et sélectionnez Approbations dans l’onglet Approbations et vérifications.
3. Sur l’écran Approbations, ajoutez votre propre compte utilisateur sous Approbateurs.
4. Développez Avancé, et assurez-vous que Autoriser les approbateurs à approuver leurs propres exécutions est sélectionné.
5. Sélectionnez Créer.

Ajouter des phases de promotion et de rejet au pipeline

1. Allez dans Pipelines, sélectionnez le pipeline que vous avez créé, et sélectionnez Modifier.

2. Ajoutez la phase PromoteRejectCanary suivante à la fin de votre fichier YAML qui promeut les modifications.

   - 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. Ajoutez la phase RejectCanary suivante à la fin du fichier qui annule les modifications.

   - 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. Sélectionnez Valider et enregistrer, et enregistrez le pipeline directement dans la branche principale.

1. Sélectionnez l’onglet Pipeline pour revenir à la vue du pipeline. Ajoutez une nouvelle phase nommée Promouvoir/rejeter canary, basée sur le modèle de travail vide.
2. Ajoutez un travail sans agent à cette phase et réorganisez ce travail pour qu’il soit le premier travail de cette phase. Nommez cette tâche sans agent Promouvoir/rejeter canary.
3. Ajoutez une tâche d’intervention manuelle à ce travail et remplacez le nom d’affichage de la tâche par Promouvoir ou rejeter canary.
4. Configurez le travail d’agent actuellement vide placé après le travail sans agent Promouvoir/rejeter l’entrée.
   • Nom d’affichage : Promouvoir canary
   • Pool d’agents : Ubuntu hébergé 22.04
   • Exécuter ce travail : choisissez de ne l’exécuter que lorsque tous les travaux précédents ont réussi.
5. Ajoutez la tâche Déployer des manifestes Kubernetes, avec la configuration suivante, au travail Promouvoir canary.
   • Nom d’affichage : Promouvoir canary
   • Action : Promouvoir
   • Connexion au service Kubernetes : azure-pipelines-canary-k8s
   • Espace de noms : espace de noms au sein du cluster sur lequel vous souhaitez effectuer le déploiement.
   • Stratégie : Canary
   • Pourcentage : 25
   • Manifestes : azure-pipelines-canary-k8s/manifests/*
   • Conteneurs : <example>/azure-pipelines-canary-k8s:$(Release.Artifacts.image.BuildId), où vous remplacez <example> par l’URL du registre de conteneurs.
   • ImagePullSecrets : azure-pipelines-canary-k8s
6. Ajoutez un autre travail d’agent avec la configuration suivante, après le travail d’agent Promouvoir canary.
   • Nom d’affichage : Rejeter canary
   • Pool d’agents : Ubuntu hébergé 22.04
   • Exécuter ce travail : choisissez de ne s’exécuter qu’en cas d’échec d’un travail précédent.
7. Ajoutez la tâche Déployer des manifestes Kubernetes, avec la configuration suivante au travail Rejeter canary.
   • Nom d’affichage : Rejeter canary
   • Action : Rejeter
   • Connexion au service Kubernetes : azure-pipelines-canary-k8s
   • Espace de noms : espace de noms au sein du cluster sur lequel vous souhaitez effectuer le déploiement.
   • Stratégie : Canary
   • Pourcentage : 25
   • Manifestes : azure-pipelines-canary-k8s/manifests/*

1. Dans app/app.py, remplacez success_rate = 50 par success_rate = 100. Ce changement déclenche le pipeline, construit et pousse l’image vers le référentiel de conteneurs, et déclenche également la phase DeployCanary.
2. Étant donné que vous avez configuré une approbation sur l’environnement akspromote, la publication attend avant d’exécuter cette phase. Sur la page de résumé de l’exécution du build, sélectionnez Revue puis sélectionnez Approuver.

Une fois approuvé, le pipeline déploie la version stable de la charge de travail sampleapp dans manifests/deployment.yml vers l’espace de noms.

1. Dans app/app.py, remplacez success_rate = 50 par success_rate = 100. Cette modification déclenche le pipeline, ce qui entraîne une build et un envoi de l’image vers le registre de conteneurs. Le déclencheur de déploiement continu, configuré précédemment sur l’événement d’envoi d’image, déclenche le pipeline de mise en production.
2. Dans le pipeline de mise en production CanaryK8sDemo, sélectionnez la phase Promouvoir/rejeter canary de la mise en production, où elle est en attente d’une intervention manuelle.
3. Sélectionnez Reprendre/Rejeter, puis Reprendre dans la boîte de dialogue suivante. Cette opération déploie la version stable des charges de travail (le déploiement sampleapp dans manifests/deployment.yml) sur l’espace de noms.

1. Dans app/app.py, remplacez success_rate = 50 par success_rate = 100. Ce changement déclenche le pipeline, construit et pousse l’image vers le référentiel de conteneurs, et déclenche également la phase DeployCanary.
2. Étant donné que vous avez configuré une approbation sur l’environnement akspromote, la publication attend avant d’exécuter cette phase.
3. Sur la page de résumé de l'exécution de la construction, sélectionnez Examiner, puis Rejeter dans la boîte de dialogue qui s'affiche. Cela rejette le déploiement.

Une fois rejeté, le pipeline empêche le déploiement du code.

1. Dans app/app.py, remplacez success_rate = 50 par success_rate = 100. Cette modification déclenche le pipeline, ce qui entraîne une build et un envoi de l’image vers le registre de conteneurs. Le déclencheur de déploiement continu, configuré précédemment sur l’événement d’envoi d’image, déclenche le pipeline de mise en production.
2. Dans le pipeline de mise en production CanaryK8sDemo, sélectionnez la phase Promouvoir/rejeter canary de la mise en production, où elle est en attente d’une intervention manuelle.
3. Sélectionnez Reprendre/Rejeter, puis Rejeter dans la boîte de dialogue suivante. Cela rejette le déploiement.