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

Ce guide de démarrage rapide vous 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 effectuer les opérations suivantes:

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

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

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

    C'est dans le fichier de configuration Skaffold que vous configurez les hooks de déploiement à exécuter. Vous devez identifier un conteneur à exécuter avant le déploiement et un conteneur à exécuter après le déploiement.

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

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

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

  4. Créez une version qui se déploie automatiquement sur la cible.

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

  5. Affichez les résultats des hooks de pré- et post-déploiement dans les journaux Cloud Build, à l'aide de la page Informations sur le déploiement de Cloud Deploy dans la console Google Cloud.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

  2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  4. Activer les API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

    Activer les API

  5. Installez Google Cloud CLI.

  6. Pour initialiser gcloudCLI, exécutez la commande suivante : 

    gcloud init
    7.

  7. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  8. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  9. Activer les API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

    Activer les API

  10. Installez Google Cloud CLI.

  11. Pour initialiser gcloudCLI, exécutez la commande suivante : 

    gcloud init
    12.

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

    gcloud components update

  12. Assurez-vous que le compte de service Compute Engine par défaut dispose des 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)")-compute@developer.gserviceaccount.com \
    --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)")-compute@developer.gserviceaccount.com \
    --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)")-compute@developer.gserviceaccount.com \
    --role="roles/run.developer"

    3. Ajoutez le rôle iam.serviceAccountUser, qui inclut l'autorisation actAs permettant 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)")-compute@developer.gserviceaccount.com \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/iam.serviceAccountUser" \
    --project=PROJECT_ID

Créer votre environnement d'exécution

Si vous effectuez le 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 via le réseau depuis l'Internet public. Par défaut, les clusters GKE sont accessibles en externe.

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

Préparer la configuration Skaffold et le fichier manifeste de l'application

Cloud Deploy utilise Skaffold pour fournir les détails des éléments à déployer et comment les 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'exemple d'application, 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 le stanza 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, à savoir 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 simple, qui est appliqué au cluster pour déployer l'application.

    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, utilisée au moment du déploiement pour créer votre service Cloud Run.

Créer votre pipeline de livraison et votre cible

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

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

    GKE

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

    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 clouddeploy.yaml avec le contenu suivant :

    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

  2. Enregistrez votre pipeline et vos cibles avec le service Cloud Deploy:

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

    Vous disposez maintenant 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 post-déploiement.

  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 des pipelines de livraison disponibles.

    Ouvrir la page Pipelines de diffusion

    Le pipeline de livraison que vous venez de créer s'affiche, et une cible est répertoriée dans la colonne Cibles.

    La page "Pipeline de livraison" de la console Google Cloud, qui montre votre pipeline

Créer une version

Une version est la ressource Cloud Deploy centrale qui représente 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 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 qui représente 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

Cloud Run

Exécutez la commande suivante à partir du répertoire deploy-hooks-run-quickstart pour créer une ressource release qui représente 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:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc

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 cible configurée pour ce pipeline de livraison.

En outre, la tâche de prédéploiement s'exécute avant le déploiement de l'application, puis la tâche de post-déploiement.

Afficher les résultats dans la console Google Cloud

Après 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 (par 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 livraison de Cloud Deploy pour afficher votre pipeline de livraison ("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 montre l'état du déploiement de l'application. Étant donné qu'il n'y a qu'une seule étape dans le pipeline, la visualisation ne montre qu'un seul nœud.

    Visualisation du pipeline de livraison montrant la réussite

    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 Informations sur le pipeline de livraison.

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

    déploiements dans la console Google Cloud

    Les tâches Predeploy et Postdeploy sont répertoriées en tant que tâches.

  5. Cliquez sur Prédéploiement.

    Le journal d'exécution du job s'affiche.

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

    Journal du job de prédéploiement

    Notez la présence de textPayload. Cette chaîne correspond à celle qui a été configurée dans le fichier predeploy-action de votre configuration Skaffold.

  7. Cliquez sur le job Postdeploy et recherchez l'entrée de journal postdeploy-echo.

    Journal du job de post-déploiement

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 livraison, 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'une se termine par _clouddeploy, l'autre se termine par [region].deploy-artifacts.[project].appspot.com.

    uvrez la page du navigateur Cloud Storage

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

Étapes suivantes