Exécuter des hooks avant et après le déploiement

Exécuter des hooks avant et après le déploiement

Ce guide de démarrage rapide explique comment exécuter un hook de déploiement, un programme arbitraire à exécuter avant ou après le déploiement à l'aide de Cloud Deploy.

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

1. Créez un cluster GKE ou un service Cloud Run.

   Vous pouvez également utiliser un cluster GKE Enterprise pour cela, mais ce tutoriel de démarrage rapide n'utilise que GKE et Cloud Run.

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

   Le fichier de configuration Skaffold vous permet de configurer l'exécution des hooks de déploiement. Vous identifiez un conteneur à exécuter avant le déploiement et un conteneur à exécuter après le déploiement.

3. Définissez votre pipeline de diffusion Cloud Deploy et votre cible de déploiement.

   Dans la configuration du pipeline de diffusion, vous allez référencer les hooks de déploiement définis dans skaffold.yaml pour les exécuter.

   Ce pipeline ne comprend qu'une seule étape et n'utilise qu'une seule cible.

4. Créez une version qui est automatiquement déployée sur la cible.

   L'un des hooks est exécuté avant le déploiement de l'application, et l'autre après.

5. Consultez les résultats des hooks avant et après le déploiement dans les journaux Cloud Build à l'aide de la page Détails du déploiement de Cloud Deploy dans la console Google Cloud.

Avant de commencer

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

   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

3. Make sure that billing is enabled for your Google Cloud project.

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

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

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

   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

8. Make sure that billing is enabled for your Google Cloud project.

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

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

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

gcloud components update

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

    Le compte de service dispose peut-être déjà des autorisations nécessaires. Ces étapes sont incluses pour 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 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"
  

3. Ajoutez le rôle iam.serviceAccountUser, qui inclut l'autorisation actAs de déployer 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
   

Créer votre environnement d'exécution

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

Pour GKE, créez un cluster: deploy-hooks-cluster, avec les paramètres par défaut. Le point de terminaison de l'API Kubernetes du cluster doit être accessible sur le réseau depuis l'Internet public. Les clusters GKE sont accessibles en externe par défaut.

gcloud container clusters create-auto deploy-hooks-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

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 sur votre cible.

Dans ce guide de démarrage rapide, vous allez créer un fichier skaffold.yaml, qui identifie le fichier manifeste à utiliser pour déployer l'application exemple, ainsi que les conteneurs à exécuter avant et après le déploiement (les hooks de déploiement).

1. Ouvrez une fenêtre de terminal.

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

   GKE

   mkdir deploy-hooks-gke-quickstart
   cd deploy-hooks-gke-quickstart
   

   Cloud Run

   mkdir deploy-hooks-run-quickstart
   cd deploy-hooks-run-quickstart
   

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

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - k8s-pod.yaml
   deploy:
     kubectl: {}
   customActions:
   - name: predeploy-action
     containers:
     - name: predeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a predeploy action"' ]
   - name: postdeploy-action
     containers:
     - name: postdeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a postdeploy action"' ]
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   customActions:
   - name: predeploy-action
     containers:
     - name: predeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a predeploy action"' ]
   - name: postdeploy-action
     containers:
     - name: postdeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a postdeploy action"' ]
   

   Ce fichier inclut la strophe customActions:. Cela définit les conteneurs à exécuter avant et après le déploiement (les hooks).

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

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

   GKE

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

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-hooks-pod
   spec:
     containers:
     - name: nginx
       image: my-app-image
   

   Ce fichier est un fichier manifeste Kubernetes de base, qui est appliqué au cluster pour déployer l'application. L'image de conteneur à déployer est définie ici comme espace réservé, my-app-image, qui est remplacé par l'image spécifique lorsque vous créez la version.

   Cloud Run

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

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

   Ce fichier est une définition de service Cloud Run simple, qui permet de déployer l'application. L'image de conteneur à déployer est définie ici comme un espace réservé, my-app-image, qui est remplacé par l'image spécifique lorsque vous créez la version.

Remarque :Si vous souhaitez utiliser des fichiers manifestes différents par cible, consultez cet article sur la gestion des fichiers manifestes pour en savoir plus sur l'utilisation des profils Skaffold.

Créer votre pipeline de diffusion et votre cible

Vous pouvez définir votre pipeline et votre cible dans un même fichier ou dans des fichiers distincts. Dans ce guide de démarrage rapide, vous allez créer un seul fichier.

1. Créez votre pipeline de diffusion et votre définition de cible:

   GKE

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-gke-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             actions: ["predeploy-action"]
           postdeploy:
             actions: ["postdeploy-action"]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: hooks staging cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-hooks-cluster
   

   Cloud Run

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-run-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             actions: ["predeploy-action"]
           postdeploy:
             actions: ["postdeploy-action"]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: staging Run service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   Remarque :Dans ce fichier, la cible est incluse dans le pipeline de diffusion, mais vous pouvez la définir 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 de livraison, avec une cible, prêt à déployer votre application et à exécuter vos tâches de prédéploiement et de postdéploiement.

3. Vérifiez votre pipeline et vos cibles:

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

   Ouvrir la page Pipelines de diffusion

   Le pipeline de diffusion que vous venez de créer s'affiche, avec une cible listée dans la colonne Cibles.

   

Créer une version

Une version est la ressource Cloud Deploy centrale qui représente les modifications déployées. Le pipeline de diffusion définit le cycle de vie de cette version. Pour en savoir plus sur ce cycle de vie, consultez la section Architecture du service Cloud Deploy.

GKE

Exécutez la commande suivante à partir du répertoire deploy-hooks-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=deploy-hooks-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Notez l'indicateur --images=, que vous utilisez pour remplacer l'espace réservé (my-app-image) dans le fichier manifeste par l'image spécifique qualifiée SHA. Google vous recommande 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-hooks-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=deploy-hooks-demo-app-run-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

Notez l'option --images=, 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 SHA. Google vous recommande de modéliser vos définitions de service et de tâche de cette manière, et d'utiliser des noms d'images qualifiés par SHA lors de la création de la version.

Comme pour toutes les versions (sauf si elles incluent --disable-initial-rollout), Cloud Deploy crée également automatiquement une ressource de déploiement. L'application est automatiquement déployée dans la seule cible configurée pour ce pipeline de diffusion.

De plus, la tâche de prédéploiement s'exécute avant le déploiement de l'application, et la tâche de postdéploiement s'exécute après.

Afficher les résultats dans la console Google Cloud

Au bout de quelques minutes, votre version est déployée dans votre environnement d'exécution cible.

Les hooks de pré- et post-déploiement que nous avons configurés (à des fins d'exemple) impriment des chaînes dans les journaux Cloud Build. Nous pouvons consulter ces journaux pour vérifier que les hooks ont fonctionné comme prévu.

1. Dans la console Google Cloud, accédez à la page Pipelines de diffusion de Cloud Deploy pour afficher votre pipeline de diffusion ("deploy-hooks-demo-app-gke-1" ou "deploy-hooks-demo-app-run-1").

   Ouvrir la page Pipelines de diffusion

2. Cliquez sur le nom de votre pipeline de livraison ("deploy-hooks-demo-app-gke-1" ou "deploy-hooks-demo-app-run-1").

   La visualisation du pipeline indique l'état de déploiement de l'application. Comme il n'y a qu'une seule étape dans le pipeline, la visualisation n'affiche qu'un seul nœud.

   

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

3. Cliquez sur l'onglet Déploiements sous Détails du pipeline de diffusion.

4. Cliquez sur le nom du déploiement pour afficher ses détails.

   

   Predeploy (Prédéploiement) et Postdeploy (Postdéploiement) sont listés comme tâches.

5. Cliquez sur Prédéploiement.

   Le journal d'exécution de la tâche s'affiche.

6. Faites défiler la liste des entrées de journal pour trouver predeploy-echo, puis cliquez dessus.

   

   Notez textPayload. Cette chaîne est celle qui a été configurée dans predeploy-action dans votre configuration Skaffold.

7. Cliquez sur la tâche Postdeploy (Post-déploiement), puis recherchez l'entrée de journal postdeploy-echo.

   

Effectuer un nettoyage

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

1. Supprimez le cluster GKE ou le service Cloud Run:

   GKE

   gcloud container clusters delete deploy-hooks-cluster --region=us-central1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-hooks-run-service --region=us-central1 --project=PROJECT_ID
   

2. Supprimez le pipeline de diffusion, la cible, la version et le déploiement:

   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 par [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

• Découvrez les principes de base du déploiement d'applications.

• Suivez le tutoriel de Cloud Deploy.

• Découvrez comment combiner les outils CI/CD Google Cloud pour développer et déployer efficacement des logiciels sur GKE.