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

Ce guide de démarrage rapide explique comment utiliser Cloud Deploy pour vérifier votre déploiement dans le pipeline de livraison.

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

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

    Vous pouvez également utiliser la validation du déploiement sur un cluster GKE Enterprise, mais ce tutoriel utilise uniquement GKE et Cloud Run.

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

    C'est dans le fichier de configuration Skaffold que vous configurez le déploiement de validation à exécuter après le déploiement.

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

    Dans la configuration du pipeline de livraison, vous devez référencer le fichier de validation définie dans skaffold.yaml pour exécuter cette validation.

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

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

    Une fois l'application déployée, verification est exécutée phase déploiement.

  5. Affichez les résultats de la vérification dans les journaux Cloud Build. à l'aide de la page Détails du déploiement de Cloud Deploy dans 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.

    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

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud 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

    12. Si la CLI est déjà installée, assurez-vous d'exécuter la dernière version 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)")-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 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 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

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

Cloud Deploy utilise Skaffold pour fournir les éléments à déployer et la façon de le faire target.

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 le conteneur à exécuter après le déploiement (vérification du déploiement).

  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 un fichier nommé skaffold.yaml avec le contenu suivant :

    GKE 

    apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - k8s-pod.yaml
deploy:
  kubectl: {}
verify:
- name: verification-test
  container:
    name: verification-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "Your test or tests would go here."' ]

    Cloud Run 

    apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}
verify:
- name: verification-test
  container:
    name: verification-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "Your test or tests would go here."' ]

    Ce fichier inclut le bloc verify:, qui définit le conteneur et la commande après avoir déployé l'application. Dans cet exemple, nous déployons conteneur Ubuntu en exécutant une simple commande echo. Vous pouvez consulter 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.

    Consultez la documentation de référence sur skaffold.yaml. pour en savoir plus sur ce fichier de configuration.

  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-verification-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-verification-run-service
spec:
  template:
    spec:
      containers:
      - image: my-app-image

    Ce fichier est une définition de service Cloud Run simple, qui est utilisée au moment du déploiement pour créer votre service Cloud Run.

Créer votre pipeline de livraison et vos cibles

Vous pouvez définir votre pipeline et vos cibles 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 diffusion 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: true
---

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

    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: true
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: verify-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 diffusion, avec une cible, prêt à déployer votre application et à valider ce dé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 livraison que vous venez de créer s'affiche, avec une cible répertoriée dans la colonne Cibles.

    page du pipeline de livraison dans la console Google Cloud, montrant 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 sortie. Pour en savoir plus sur ce cycle de vie, consultez la section Architecture du service Cloud Deploy.

GKE

Exécutez la commande suivante à partir de deploy-verification-gke-quickstart. pour créer une ressource release qui représente le 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

Cloud Run

Exécutez la commande suivante à partir de deploy-verification-run-quickstart. pour créer une ressource release qui représente le 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:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

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.

La tâche de validation que nous avons spécifiée dans notre configuration Skaffold s'exécute dans le cadre de ce déploiement, après le déploiement de l'application.

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.

Le job de validation que nous avons configuré (par exemple) imprime une chaîne dans le journal Cloud Build. Nous pouvons consulter ce journal pour vérifier la vérification s'est déroulée 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-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 montre l'état du 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.

    Visualisation du pipeline de livraison 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 livraison.

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

    déploiements dans la console Google Cloud

    Vérifier est listé en tant que tâche.

  5. Cliquez sur Valider.

    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 verification-test, puis cliquez sur pour l'activer.

    Entrée de journal affichant le résultat du job de vérification

    Notez textPayload. Cette chaîne est celle qui a été configurée dans la strophe Verify de votre configuration Skaffold.

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