Automatiser la promotion de versions et l'avancement des déploiements dans Cloud Deploy

Obtenez votre numéro de 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
   

2. Copiez le numéro du projet à partir du résultat de la ligne de commande et collez-le ici.

   Vous n'avez pas besoin d'exécuter cette commande. En le collant ici, vous renseignez la référence du compte de service dans la configuration de l'automatisation plus loin dans ce guide de démarrage rapide.

   PROJECT_NUMBER
   

Préparer votre configuration Skaffold et le fichier manifeste de votre 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 de l'application à utiliser pour déployer l'exemple d'application.

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: {}
   

   Ce fichier est 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 et non destinées à la production.

   Pour en savoir plus sur ce fichier, consultez la documentation de référence sur 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
   

   Ce fichier est un simple manifeste Kubernetes, qui est 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
      

   Ces fichiers sont des définitions de service Cloud Run simples, qui sont 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 diffusion 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 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 nommé clouddeploy.yaml contenant les éléments suivants :

   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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
   selector:
     targets:
     - id: automation-quickstart-dev
   rules:
   - promoteReleaseRule:
       name: "promote-release"
       wait: 1m
       toTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       name: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Cloud Run

   Dans le répertoire deploy-automation-run-quickstart, créez un fichier nommé clouddeploy.yaml contenant les éléments suivants :

   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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
   selector:
     targets:
     - id: automation-quickstart-dev
   rules:
   - promoteReleaseRule:
       name: "promote-release"
       wait: 1m
       toTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       name: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

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 maintenant d'un pipeline avec une multicible comprenant deux cibles GKE ou Cloud Run, prêt à déployer votre application.

3. Confirmez votre pipeline et vos cibles :

   Dans la console Google Cloud , 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 diffusion

   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 diffusion.

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

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

   

Créer une version

Une version est la ressource Cloud Deploy centrale qui représente les modifications déployées. 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.

 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

 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

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

Comme ce guide de démarrage rapide inclut deux automatisations, deux choses se produisent automatiquement :

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

  Le délai d'attente pour la promotion automatique est d'une minute.

• Dans la deuxième cible, où un canary de 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 à tester. Le déploiement est automatiquement avancé à stable.

  L'automatisation avancée est différée d'une minute.

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

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

Afficher les résultats dans la console Google Cloud

Vous pouvez consulter les résultats, y compris les exécutions d'automatisation, dans la consoleGoogle Cloud .

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

   Ouvrir la page Pipelines de diffusion

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

   La visualisation du pipeline indique 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 diffusion.

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

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