Automatiser la promotion de version et l'avancement du déploiement dans Cloud Deploy

Automatiser la promotion de version et l'avancement du déploiement dans Cloud Deploy

Cette page explique comment utiliser Cloud Deploy pour promouvoir automatiquement une version vers une cible et faire passer un déploiement à sa phase suivante.

Dans ce guide de démarrage rapide, vous allez :

1. Créer deux clusters GKE ou deux services Cloud Run.

2. Créer une configuration Skaffold et un fichier manifeste Kubernetes ou une définition de service Cloud Run.

3. Définir votre pipeline de livraison Cloud Deploy et vos cibles de déploiement.

   Le pipeline sera déployé sur deux cibles : dev et staging. Et la cible staging utilise une stratégie de déploiement Canary .

4. Définir deux règles d'automatisation :

   • Une automatisation pour promouvoir la version dans la cible staging en cas de déploiement réussi sur dev.

   • Une automatisation pour faire passer le déploiement à la phase stable une fois la phase canary-25 terminée.

5. Instancier votre pipeline de livraison en créant une version qui est automatiquement déployée sur la cible dev.

6. Afficher le pipeline de livraison et la version dans la Google Cloud console.

   Grâce à la promotion automatisée, cette version est automatiquement promue dans staging.

   Étant donné que la cible staging utilise une stratégie de déploiement Canary et qu'il s'agit du premier déploiement dans cet environnement d'exécution, la phase canary-25 est ignorée. Pour en savoir plus sur les raisons pour lesquelles la phase Canary est ignorée la première fois, consultez Pourquoi les phases sont parfois ignorées.

   Grâce à l'avancement automatisé des phases, le déploiement passe à la phase stable.

Avant de commencer

Connectez-vous à votre Google Cloud compte. Si vous n'avez jamais utilisé Google Cloud, créez un compte pour évaluer les performances de nos produits dans des scénarios réels. Les nouveaux clients bénéficient également de 300 $ de crédits sans frais pour exécuter, tester et déployer des charges de travail.
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.
Go to project selector
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
Enable the APIs
Installez la Google Cloud CLI.
Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.
Pour initialiser la gcloud CLI, exécutez la commande suivante :
gcloud init
Remarque : Vous pouvez exécuter la gcloud CLI dans la Google Cloud console sans installer la Google Cloud CLI. Pour exécuter la gcloud CLI dans la Google Cloud console, utilisez Cloud Shell.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Installez la Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Remarque : Vous pouvez exécuter la gcloud CLI dans la Google Cloud console sans installer la Google Cloud CLI. Pour exécuter la gcloud CLI dans la Google Cloud console, utilisez Cloud Shell.

Si la CLI est déjà installée, assurez-vous d'exécuter la dernière version :

gcloud components update

1. Assurez-vous que le compte de service Compute Engine par défaut dispose des autorisations suffisantes.

   Le compte de service peut déjà disposer des autorisations nécessaires. Ces étapes concernent les projets qui désactivent les attributions automatiques de rôles pour les comptes de service par défaut.

   1. Commencez par ajouter le rôle clouddeploy.jobRunner :

      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")[e-mail] \
          --role="roles/clouddeploy.jobRunner"
      

   2. Ajoutez le rôle clouddeploy.releaser :

      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")[e-mail] \
          --role="roles/clouddeploy.releaser"
      

   3. Ajoutez le rôle de développeur pour votre environnement d'exécution spécifique.
   • Pour GKE :

     gcloud projects add-iam-policy-binding PROJECT_ID \
         --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
         --format="value(projectNumber)")[e-mail] \
         --role="roles/container.developer"
     

   • Pour Cloud Run :

     gcloud projects add-iam-policy-binding PROJECT_ID \
         --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
         --format="value(projectNumber)")[e-mail] \
         --role="roles/run.developer"
     

   4. Ajoutez le rôle iam.serviceAccountUser, qui inclut l'autorisation actAs pour que le compte de service par défaut puisse effectuer un déploiement dans l'environnement d'exécution :

      gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")[e-mail] \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")[e-mail] \
          --role="roles/iam.serviceAccountUser" \
          --project=PROJECT_ID
      

   5. Ajoutez le rôle iam.serviceAccountUser, y compris l'autorisation actAs pour vous-même, afin d'utiliser le compte de service par défaut :

      gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")[e-mail] \
          --member=user:YOUR_EMAIL_ADDRESS \
          --role="roles/iam.serviceAccountUser" \
          --project=PROJECT_ID
      

      Dans ce cas, YOUR_EMAIL_ADDRESS correspond à l'adresse e-mail que vous utilisez pour accéder à Google Cloud.

Créer vos environnements d'exécution

Si vous effectuez un déploiement sur Cloud Run, vous pouvez ignorer cette commande.

Pour GKE, créez deux clusters : automation-quickstart-cluster-dev et automation-quickstart-cluster-staging, avec les paramètres par défaut. Les points de terminaison de l'API Kubernetes des clusters doivent être accessibles sur le réseau depuis l'Internet public. Les clusters GKE sont accessibles de l'extérieur par défaut.

gcloud container clusters create-auto automation-quickstart-cluster-dev \
                 --project=PROJECT_ID \
                 --region=us-central1 \
                 && gcloud container clusters create-auto automation-quickstart-cluster-staging \
                 --project=PROJECT_ID \
                 --region=us-central1

Obtenir le numéro de votre projet

Vous avez besoin du numéro de votre projet pour identifier le compte de service par défaut. Cela est nécessaire pour configurer la ressource d'automatisation.

1. Exécutez la commande suivante pour obtenir le numéro de votre projet :

   gcloud projects describe PROJECT_ID --format="value(projectNumber)"
   

2. Copiez le numéro du projet à partir de la sortie de la ligne de commande, puis collez-le ici.

   Vous n'avez pas besoin d'exécuter cette commande. Le fait de la coller ici renseigne la référence du compte de service dans la configuration d'automatisation plus loin dans ce guide de démarrage rapide.

   PROJECT_NUMBER
   

Préparer votre configuration Skaffold et votre fichier manifeste d'application

Cloud Deploy utilise Skaffold pour fournir les détails de ce que vous devez déployer et de la manière de le déployer correctement pour vos cibles distinctes .

Dans ce guide de démarrage rapide, vous allez créer un fichier skaffold.yaml, qui identifie le fichier manifeste d'application à utiliser pour déployer l'application exemple.

1. Ouvrez une fenêtre de terminal.

2. Créez un répertoire et accédez-y.

   GKE

   mkdir deploy-automation-gke-quickstart
   cd deploy-automation-gke-quickstart
   

   Cloud Run

   mkdir deploy-automation-run-quickstart
   cd deploy-automation-run-quickstart
   

3. Créez un fichier nommé skaffold.yaml avec le contenu suivant :

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata:
     name: gke-automation
   manifests:
     rawYaml:
     - k8s-deployment.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata:
     name: run-automation
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-dev.yaml
   - name: staging
     manifests:
       rawYaml:
       - run-staging.yaml
   deploy:
     cloudrun: {}
   

   Il s'agit d'une configuration Skaffold minimale. Pour ce guide de démarrage rapide, vous allez créer le fichier. Toutefois, vous pouvez également demander à Cloud Deploy de le créer pour vous, pour les applications simples hors production.

   Pour en savoir plus sur ce fichier, consultez la référence skaffold.yaml.

4. Créez la définition de votre application : une paire de définitions de service pour Cloud Run ou un fichier manifeste Kubernetes pour GKE.

   GKE

   Créez un fichier nommé k8s-deployment.yaml avec le contenu suivant :

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
     labels:
       app: my-app
     namespace: default
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
       spec:
         containers:
         - name: nginx
           image: my-app-image
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: my-service
     namespace: default
   spec:
     selector:
       app: my-app
     ports:
       - protocol: TCP
         port: 80
   

   Il s'agit d'un fichier manifeste Kubernetes simple, utilisé pour déployer l' application. L'image de conteneur à déployer est définie ici en tant qu'espace réservé, my-app-image, qui est remplacé par l'image spécifique lorsque vous créez la version.

   Cloud Run

   1. Créez un fichier nommé run-dev.yaml avec le contenu suivant :

      apiVersion: serving.knative.dev/v1
      kind: Service
      metadata:
        name: my-automation-run-service-dev
      spec:
        template:
          spec:
            containers:
            - image: my-app-image
      

   2. Créez un fichier nommé run-staging.yaml avec le contenu suivant :

      apiVersion: serving.knative.dev/v1
      kind: Service
      metadata:
        name: my-automation-run-service-staging
      spec:
        template:
          spec:
            containers:
            - image: my-app-image
      

   Il s'agit de définitions de service Cloud Run simples, utilisées pour déployer l'application. L'image de conteneur à déployer est définie ici en tant qu'espace réservé, my-app-image, qui est remplacé par l'image spécifique lorsque vous créez la version.

Créer votre pipeline de livraison, vos cibles et votre automatisation

Vous pouvez définir votre pipeline de livraison et vos cibles dans un seul fichier ou dans des fichiers distincts. Vous pouvez également définir une action d'automatisation dans un fichier distinct. Ce guide de démarrage rapide utilise un seul fichier pour le pipeline, les cibles et l'automatisation.

1. Créez votre pipeline de livraison, vos définitions de cibles et votre action d'automatisation :

   GKE

   Dans le répertoire deploy-automation-gke-quickstart, créez un fichier : clouddeploy.yaml, avec le contenu suivant :

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-automation-demo-app-1
   description: Automation demonstration pipeline
   serialPipeline:
     stages:
     - targetId: automation-quickstart-dev
     - targetId: automation-quickstart-staging
       profiles: []
       strategy:
         canary:
           runtimeConfig:
             kubernetes:
               serviceNetworking:
                 service: "my-service"
                 deployment: "my-deployment"
           canaryDeployment:
             percentages: [25]
             verify: false
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-dev
   description: Dev cluster to demonstrate deploy automation
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-dev
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-staging
   description: Staging cluster to demonstrate deploy automation
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-staging
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/promote
   description: promotes a release
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-dev
   rules:
   - promoteReleaseRule:
       id: "promote-release"
       wait: 1m
       destinationTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       id: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Remarque : Dans ce fichier, les cibles et la configuration des automatisations sont incluses dans le pipeline de livraison, mais vous pouvez définir les cibles dans un ou plusieurs fichiers distincts, et les automatisations dans un ou plusieurs fichiers distincts.

   Cloud Run

   Dans le répertoire deploy-automation-run-quickstart, créez un fichier : clouddeploy.yaml, avec le contenu suivant :

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-automation-demo-app-1
   description: Automation demonstration pipeline
   serialPipeline:
     stages:
     - targetId: automation-quickstart-dev
       profiles: [dev]
     - targetId: automation-quickstart-staging
       profiles: [staging]
       strategy:
         canary:
           runtimeConfig:
             cloudRun:
               automaticTrafficControl: true
           canaryDeployment:
             percentages: [25]
             verify: false
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-dev
   description: Dev cluster to demonstrate deploy automation
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-staging
   description: Staging cluster to demonstrate deploy automation
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/promote
   description: Promotes a release to the next target
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-dev
   rules:
   - promoteReleaseRule:
       id: "promote-release"
       wait: 1m
       destinationTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       id: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Remarque : Dans ce fichier, les cibles et la configuration des automatisations sont incluses dans le pipeline de livraison, mais vous pouvez définir les cibles dans un ou plusieurs fichiers distincts, et les automatisations dans un ou plusieurs fichiers distincts.

2. Enregistrez votre pipeline et vos cibles auprès du service Cloud Deploy :

   gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
   

   Vous disposez désormais d'un pipeline avec une cible multiple comprenant deux cibles GKE ou Cloud Run, prêt à déployer votre application.

3. Confirmez votre pipeline et vos cibles :

   Dans la Google Cloud console, accédez à la page Pipelines de livraison de Cloud Deploy pour afficher la liste de vos pipelines de livraison disponibles.

   Ouvrir la page Pipelines de livraison

   Le pipeline de livraison que vous venez de créer s'affiche, avec deux cibles listées dans la colonne Cibles.

   

4. Cliquez sur le nom du pipeline pour ouvrir la visualisation et les détails du pipeline de livraison.

5. Sélectionnez l'onglet Automatisations sous Détails du pipeline de livraison.

   Les deux automatisations que vous avez créées s'affichent.

   

Créer une version

Une version est la ressource Cloud Deploy centrale représentant les modifications en cours de déploiement. Le pipeline de livraison définit le cycle de vie de cette version. Pour en savoir plus sur ce cycle de vie, consultez Architecture du service Cloud Deploy.

GKE

Exécutez la commande suivante à partir du répertoire deploy-automation-gke-quickstart pour créer une ressource release représentant l'image de conteneur à déployer :

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-automation-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Notez l'indicateur --images= flag, que vous utilisez pour remplacer l'espace réservé (my-app-image) dans le fichier manifeste par l'image spécifique qualifiée par SHA. Nous vous recommandons de créer des modèles pour vos fichiers manifestes de cette manière et d'utiliser des noms d'images qualifiés par SHA lors de la création de la version.

Cloud Run

Exécutez la commande suivante à partir du répertoire deploy-automation-run-quickstart pour créer une ressource release représentant l'image de conteneur à déployer :

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-automation-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

Notez l' --images= indicateur, que vous utilisez pour remplacer l'espace réservé (my-app-image) dans la définition de service par l'image spécifique qualifiée par SHA. Nous vous recommandons de créer des modèles pour vos définitions de service et de tâches de cette manière et d'utiliser des noms d'images qualifiés par SHA lors de la création de la version.

Par défaut, lorsque vous créez une version, un déploiement est créé automatiquement pour la première cible de votre pipeline.

Étant donné que ce guide de démarrage rapide inclut deux automatisations, deux événements se produisent automatiquement :

• Une fois le déploiement réussi sur la première cible, la version est automatiquement promue vers la deuxième cible.

  L'automatisation de la promotion est soumise à un délai d'une minute.

• Dans la deuxième cible, où un déploiement Canary à 25% est configuré, la deuxième automatisation fait passer le déploiement de canary-25 à stable.

  Pour cette première version, la phase canary-25 est ignorée, car il n'existe aucune version préexistante de l'application à comparer. Le déploiement passe automatiquement à stable.

  L'automatisation de l'avancement est soumise à un délai d'une minute.

Une fois toutes les opérations terminées, l'application est déployée avec succès sur les deux cibles sans que vous ayez à faire quoi que ce soit.

Si vous souhaitez en savoir plus sur l'exécution d'une stratégie de déploiement Canary, vous pouvez essayer le guide de démarrage rapide Canary.

Afficher les résultats dans la Google Cloud console

Vous pouvez afficher les résultats, y compris les exécutions d'automatisation, dans la Google Cloud console.

1. Accédez à la page Pipelines de livraison de Cloud Deploy pour afficher votre pipeline de livraison.

   Ouvrir la page Pipelines de livraison

2. Cliquez sur le nom de votre pipeline de livraison "my-automation-demo-app-1".

   La visualisation du pipeline affiche l'état de déploiement de l'application. Si suffisamment de temps s'est écoulé, les deux cibles s'affichent en vert.

   

   Votre version est répertoriée dans l'onglet Versions sous Détails du pipeline de livraison.

3. Cliquez sur l'onglet Exécutions d'automatisation.

   Deux entrées s'affichent, une pour chacune des deux automatisations que vous avez créées. Vous pouvez cliquer sur l'une ou l'autre pour afficher les détails de cette exécution d'automatisation.

   

Libérer de l'espace

Pour éviter que les ressources utilisées dans cette démonstration soient facturées sur votre Google Cloud compte pour les ressources utilisées sur cette page, procédez comme suit :

1. Supprimez les clusters GKE ou les services Cloud Run :

   GKE

   gcloud container clusters delete automation-quickstart-cluster-dev --region=us-central1 --project=PROJECT_ID \
   && gcloud container clusters delete automation-quickstart-cluster-staging --region=us-west1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-automation-run-service-dev --region=us-central1 --project=PROJECT_ID \
   && gcloud run services delete my-automation-run-service-staging --region=us-central1 --project=PROJECT_ID
   

2. Supprimez le pipeline de livraison, les cibles, les automatisations, la version et les déploiements :

   gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
   

3. Supprimez les buckets Cloud Storage créés par Cloud Deploy.

   L'un se termine par _clouddeploy, et l'autre est [region].deploy-artifacts.[project].appspot.com.

   uvrez la page du navigateur Cloud Storage

Voilà ! Vous avez terminé le guide de démarrage rapide.

Étape suivante

• En savoir plus sur Cloud Deploy.

• Essayer d'autres automatisations.

• Découvrir les bases du déploiement d'applications.

• Découvrir comment combiner Google Cloud des outils CI/CD pour développer et fournir efficacement des logiciels à GKE.