Déployer une application sur Cloud Run à l'aide de Cloud Deploy

Cette page explique comment utiliser Cloud Deploy pour diffuser un exemple image de l'application nommée hello vers une séquence de deux instances Cloud Run ou deux jobs Cloud Run.

Dans ce guide de démarrage rapide, vous allez effectuer les opérations suivantes:

  1. Créer une configuration Skaffold

  2. Créez des fichiers de configuration pour deux services Cloud Run ou deux tâches.

    Ces fichiers définissent les services ou les tâches, et spécifient les images de conteneur (précompilées) à déployer.

  3. Définir votre pipeline de livraison et votre déploiement Cloud Deploy cibles, qui pointent vers les deux services ou les deux tâches.

  4. Instancier votre pipeline de diffusion en créant une version qui est automatiquement déployée sur la première cible.

  5. Effectuer la promotion de la version vers la deuxième cible.

  6. Afficher les deux déploiements 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.

    Go to project selector

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

  4. Enable the Cloud Deploy, Cloud Build, 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, 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 :

    gcloud components update
    

  13. 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. Ajoutez 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. Accorder au compte de service d'exécution par défaut actAs autorisation de déployer des charges de travail dans Cloud Run:

      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
      

    3. Ajoutez les autorisations de développeur 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"
      

      Si vous ne parvenez pas à ajouter l'un de ces rôles, contactez l'administrateur de votre projet.

Préparer votre configuration Skaffold

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 correctement pour vos cibles distinctes.

Pour ce guide de démarrage rapide, vous allez créer un fichier skaffold.yaml, qui identifie la définition de service ou de tâche Cloud Run à utiliser pour déployer l'application exemple.

  1. Ouvrez une fenêtre de terminal.

  2. Créez un répertoire nommé deploy-run-quickstart et accédez-y.

    mkdir deploy-run-quickstart
    cd deploy-run-quickstart
    
  3. Créez un fichier nommé skaffold.yaml avec le contenu suivant :

    Services

    apiVersion: skaffold/v4beta7
    kind: Config
    metadata: 
      name: deploy-run-quickstart
    profiles:
    - name: dev
      manifests:
        rawYaml:
        - run-service-dev.yaml
    - name: prod
      manifests:
        rawYaml:
        - run-service-prod.yaml
    deploy:
      cloudrun: {}
    

    Tâches

    apiVersion: skaffold/v4beta7
    kind: Config
    metadata: 
      name: deploy-run-quickstart
    profiles:
    - name: dev
      manifests:
        rawYaml:
        - run-job-dev.yaml
    - name: prod
      manifests:
        rawYaml:
        - run-job-prod.yaml
    deploy:
      cloudrun: {}
    

    Ce fichier est une configuration Skaffold minimale, qui identifie votre services ou jobs Cloud Run. Consultez le Documentation de référence sur skaffold.yaml pour plus d'informations sur ce fichier.

Préparer vos services ou jobs Cloud Run

Pour ce guide de démarrage rapide, vous allez créer services Cloud Run ou deux jobs Cloud Run, dans dans le même projet. Cloud Deploy est aussi compatible avec le déploiement plusieurs projets. Nous utilisons également des profils Skaffold pour pouvoir avoir deux services ou deux jobs dans le même projet. Lorsque vous utilisez différents projets, vous n'aurez peut-être pas besoin d'utiliser des profils Skaffold.

Services

  1. Créez un fichier nommé run-service-dev.yaml avec le contenu suivant :

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

    Ce fichier définit un service Cloud Run. Comme le nom deploy-run-service-dev implique qu'il s'agit de votre service dev, et correspond à la première cible dans la progression de votre pipeline de livraison.

  2. Créez un fichier nommé run-service-prod.yaml avec le contenu suivant :

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

    Ce fichier définit un autre service Cloud Run. Comme le nom deploy-run-service-prod l'indique, il s'agit de votre service prod, qui correspond à la deuxième cible de la progression de votre pipeline de diffusion.

Tâches

  1. Créez un fichier nommé run-job-dev.yaml avec le contenu suivant :

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: deploy-run-job-dev
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: my-app-image
    

    Ce fichier définit une tâche Cloud Run. Comme le nom deploy-run-job-dev implique qu'il s'agit de votre job dev et qu'il correspond à la première cible de la progression de votre pipeline de livraison.

  2. Créez un fichier nommé run-job-prod.yaml avec le contenu suivant :

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: deploy-run-job-prod
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: my-app-image
    

    Ce fichier définit un autre job Cloud Run. Comme le nom deploy-run-job-prod implique qu'il s'agit de votre job prod et correspond à la deuxième cible dans la progression de votre pipeline de livraison.

Créer votre pipeline de diffusion 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. Dans le répertoire deploy-run-quickstart, créez un fichier nommé clouddeploy.yaml contenant les éléments suivants :

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: my-run-demo-app-1
    description: main application pipeline
    serialPipeline:
      stages:
      - targetId: run-qsdev
        profiles: [dev]
      - targetId: run-qsprod
        profiles: [prod]
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-qsdev
    description: Cloud Run development service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-qsprod
    description: Cloud Run production 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 avec des cibles, prêt à déployer votre application sur votre première cible.

  3. Vérifiez votre pipeline et vos cibles :

    Dans la console Google Cloud, accédez à Cloud Deploy Page Pipelines de livraison pour afficher la liste des livraisons disponibles les pipelines de ML.

    Ouvrir la page Pipelines de diffusion

    Le pipeline de diffusion que vous venez de créer s'affiche, et les deux cibles sont listées dans la colonne Cibles.

    Pipeline de diffusion affiché dans la console Google Cloud

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. Voir Architecture du service Cloud Deploy pour en savoir plus sur ce cycle de vie.

Exécutez la commande suivante à partir du répertoire deploy-run-quickstart pour créer une ressource release représentant l'image de conteneur à déployer :

Services

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

Tâches

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/job@sha256:d7c33651fbad911a9a0a0c16f2f9b3a79f0b9e3e89afb205603af706067feac5

Comme pour toutes les versions (sauf si elles incluent --disable-initial-rollout), Cloud Deploy crée automatiquement ressource de déploiement. L'application est automatiquement déployée sur la première cible de la progression.

Promouvoir la version

  1. Sur la page Pipelines de livraison, cliquez sur le pipeline my-run-demo-app-1.

    Ouvrir la page Pipelines de diffusion

    La page "Détails du pipeline de livraison" affiche une représentation graphique de vos la progression du pipeline de livraison. Dans ce cas, il indique que la version a été déployée sur la cible run-qsdev.

    Visualisation du pipeline de diffusion dans la console Google Cloud

  2. Sur la première cible de la visualisation du pipeline de diffusion, cliquez sur Promouvoir.

    La boîte de dialogue Promouvoir la version s'affiche. Il affiche les détails de la cible à laquelle vous faites la promotion.

  3. Cliquez sur Promouvoir.

    La version est désormais mise en file d'attente pour le déploiement dans run-qsprod. Lorsque le déploiement est terminé, la visualisation du pipeline de livraison indique qu'il est déployé:

    Visualisation du pipeline de livraison dans la console Google Cloud, montrant la version déployée en production.

Afficher les résultats dans la console Google Cloud

  1. Dans la console Google Cloud, accédez à Cloud Deploy Pipelines de livraison pour afficher le pipeline de livraison my-run-demo-app-1.

    Ouvrir la page Pipelines de diffusion

  2. Cliquez sur le nom de votre pipeline de livraison "my-run-demo-app-1".

    La visualisation du pipeline indique la progression de l'application dans le pipeline.

    Visualisation du pipeline de livraison dans la console Google Cloud

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

  3. Cliquez sur le nom de la version, test-release-001.

    Vos déploiements s'affichent sous Déploiements. Vous pouvez cliquer sur un déploiement pour afficher ses détails, y compris le journal de déploiement.

    Déploiements dans la console Google Cloud

Accéder à votre service Cloud Run

Par défaut, vous devez être authentifié pour accéder aux services Cloud Run nouvellement créés. Découvrir Cloud Run Présentation de l'authentification pour savoir comment : fournir des identifiants et découvrir la configuration d'Identity and Access Management requis pour accéder au service sans authentification. Cela ne s'applique pas aux tâches Cloud Run.

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 service ou la tâche Cloud Run deploy-qs-dev:

    Services

    gcloud run services delete deploy-run-service-dev --region=us-central1 --project=PROJECT_ID
    

    Tâches

    gcloud run jobs delete deploy-run-job-dev --region=us-central1 --project=PROJECT_ID
    
  2. Supprimez le service deploy-qs-prod :

    Services

    gcloud run services delete deploy-run-service-prod --region=us-central1 --project=PROJECT_ID
    

    Tâches

    gcloud run jobs delete deploy-run-job-prod --region=us-central1 --project=PROJECT_ID
    
  3. Supprimez le pipeline de livraison, les cibles, la version et les déploiements:

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  4. 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