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, c'est-à-dire 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, mais ce 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 est l'endroit où vous configurez les hooks de déploiement à exécuter. 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 livraison, vous ferez référence aux hooks de déploiement définis dans skaffold.yaml pour exécuter ces hooks.

    Ce pipeline ne comporte 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. Affichez les résultats des hooks de pré-déploiement et de post-déploiement dans les journaux Cloud Build, sur la page Détails du déploiement de Cloud Deploy dansGoogle Cloud console.

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.

    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. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

    gcloud init

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

    Go to project selector

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

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

    Enable the APIs

  11. Install the Google Cloud CLI.

  12. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

    gcloud init

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

    gcloud components update

  14. 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 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)")-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 pour le déploiement 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 déployez 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 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 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 sur votre cible.

Dans ce démarrage rapide, vous allez créer un fichier skaffold.yaml, qui identifie le fichier manifeste à utiliser pour déployer l'exemple d'application, et qui identifie également 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 manifeste Kubernetes de base, qui est appliqué au cluster 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

    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 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 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 livraison et la définition de la 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

  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 jobs avant et après le 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 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 une cible listée dans la colonne Cibles.

    Page du pipeline de livraison dans la console Google Cloud , affichant votre pipeline

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.

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

Notez l'option --images=, 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. Google vous recommande de créer des modèles de 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 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:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

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 par SHA. Google vous recommande de créer des modèles pour vos définitions de service et de job de cette manière, et d'utiliser des noms d'image qualifiés par SHA lors de la création de la version.

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

De plus, le job de pré-déploiement s'exécute avant le déploiement de l'application, et le job de post-dé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é-déploiement et de post-déploiement que nous avons configurés (à titre 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 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 indique l'état de déploiement de l'application. Comme le pipeline ne comporte qu'une seule étape, la visualisation n'affiche qu'un seul nœud.

    Visualisation du pipeline de diffusion indiquant 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 Détails du pipeline de diffusion.

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

    Déploiements dans la console Google Cloud

    Prédéploiement et Postdéploiement sont listés en tant que jobs.

  5. Cliquez sur Prédéployer.

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

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

    Journal du job de pré-déploiement

    Remarquez bien textPayload. Cette chaîne correspond à ce qui a été configuré dans predeploy-action de votre configuration Skaffold.

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

    Journal du job Postdeploy

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

Étapes suivantes