Vérifier votre application après son déploiement

Vérifier votre application après son déploiement

Ce guide de démarrage rapide explique comment utiliser Cloud Deploy pour vérifier votre application déployée dans le cadre du pipeline de livraison.

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

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

   Vous pouvez également utiliser la validation du déploiement sur les clusters GKE associés, mais ce guide de démarrage rapide n'utilise que GKE et Cloud Run.

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

   Le pipeline de livraison ne comprend qu'une seule étape et n'utilise qu'une seule cible. Vous définissez la configuration de la validation du déploiement dans la section stage.

3. Créer une configuration Skaffold requise par la version, ainsi qu'un fichier manifeste Kubernetes ou une définition de service Cloud Run.

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

   Une fois l'application déployée, la validation est exécutée en tant que phase du déploiement.

5. Afficher les résultats de la validation dans les journaux Cloud Build, à l'aide de la page Détails du déploiement de Cloud Deploy dans Google Cloud la console.

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 Google gcloud CLI dans la Google Cloud console sans l'installer. 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 Google gcloud CLI dans la Google Cloud console sans l'installer. Pour exécuter la gcloud CLI dans la Google Cloud console, utilisez Cloud Shell.

Si vous avez déjà installé la CLI, 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 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 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)")[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-verification-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-verification-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

Créer votre pipeline de livraison et vos cibles

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

1. Ouvrez une fenêtre de terminal.

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

   GKE

   mkdir deploy-verification-gke-quickstart
   cd deploy-verification-gke-quickstart
   

   Cloud Run

   mkdir deploy-verification-run-quickstart
   cd deploy-verification-run-quickstart
   

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

   GKE

   Dans le répertoire deploy-verification-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-verification-demo-app-gke-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: verify-staging
       profiles: []
       strategy:
         standard:
           verify:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "Your test or tests would go here."' ]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: verify-staging
   description: verification staging cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-verification-cluster
   

   Cloud Run

   Dans le répertoire deploy-verification-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-verification-demo-app-run-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: verify-staging
       profiles: []
       strategy:
         standard:
           verify:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "Your test or tests would go here."' ]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: verify-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 livraison, mais vous pouvez la définir dans un ou plusieurs fichiers distincts.

   Ce fichier inclut la section verify dans la définition strategy du pipeline de livraison. Il définit le conteneur et la commande à exécuter après le déploiement de l'application. Dans ce cas, nous déployons un conteneur Ubuntu et exécutons une simple commande echo. Vous pouvez consulter les résultats de cette commande dans les journaux. Dans un scénario plus réaliste, vous exécuterez des tests sur votre application déployée.

4. 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 à vérifier ce déploiement.

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

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

   

Créer votre fichier de configuration Skaffold et votre fichier manifeste d'application

Cloud Deploy utilise Skaffold pour identifier le fichier manifeste à utiliser afin de déployer l'application exemple sur votre cible.

1. Créez un fichier nommé skaffold.yaml contenant les éléments suivants :

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - k8s-pod.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   

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

2. 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 contenant les éléments suivants :

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-verification-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 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 contenant les éléments suivants :

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

   Ce fichier est une définition de service Cloud Run de base, qui est 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 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-verification-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-verification-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Notez l' --images= option, 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-verification-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-verification-demo-app-run-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

Notez l' --images= option, 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 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 sur la seule cible configurée pour ce pipeline de livraison.

La tâche de validation que nous avons spécifiée dans notre pipeline de livraison s'exécute dans le cadre de ce déploiement, une fois l'application déployée.

Afficher les résultats dans la Google Cloud console

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

La tâche de validation que nous avons configurée (à titre d'exemple) affiche une chaîne dans le journal Cloud Build. Nous pouvons consulter ce journal pour vérifier que la validation a fonctionné comme prévu.

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

   Ouvrir la page Pipelines de diffusion

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

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

   

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

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

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

   

   Vérifier est répertorié en tant que tâche.

5. Cliquez sur Vérifier.

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

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

   

   Notez le textPayload. Cette chaîne est celle qui a été configurée dans la Verify section de votre pipeline de livraison.

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 le cluster GKE ou le service Cloud Run :

   GKE

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

   Cloud Run

   gcloud run services delete my-verification-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.

Étape suivante

• En savoir plus sur Cloud Deploy.

• En savoir plus sur la validation du déploiement.