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

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

Cette page explique comment utiliser Cloud Deploy pour diffuser une image d'application exemple nommée hello dans une séquence de deux services Cloud Run, deux jobs Cloud Run ou deux pools de nœuds de calcul Cloud Run. (Les pools de nœuds de calcul Cloud Run sont en version bêta.)

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

1. créer une configuration Skaffold ;

2. créer des fichiers de configuration pour deux services Cloud Run, deux jobs ou deux pools de nœuds de calcul.

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

3. Définir votre pipeline de diffusion Cloud Deploy et des cibles de déploiement, qui pointent vers les deux services, les deux jobs ou les deux pools de nœuds de calcul.

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

Connectez-vous à votre Google Cloud compte. 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 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
If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud Deploy, Cloud Build, 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 gcloud CLI dans la Google Cloud console sans installer la Google Cloud CLI. 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

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

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

Rôles requis

Pour obtenir les autorisations nécessaires pour créer un pipeline de diffusion et une version Cloud Deploy, demandez à votre administrateur de vous accorder le rôle IAM Exécuteur de job Cloud Deploy (roles/clouddeploy.jobrunner) sur votre projet.

Pour vous assurer que le compte de service Cloud Deploy dispose des autorisations nécessaires pour exécuter des opérations Cloud Deploy et effectuer un déploiement sur Cloud Run, demandez à votre administrateur d'accorder les rôles IAM suivants au compte de service Cloud Deploy sur votre projet :

Important : Vous devez accorder ces rôles au compte de service Cloud Deploy, et non à votre compte utilisateur. Si vous ne les accordez pas au bon compte principal, vous risquez de rencontrer des erreurs d'autorisation.

• Développeur Cloud Run (roles/run.developer)
• Utilisateur du compte de service IAM (roles/iam.serviceAccountUser)

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Votre administrateur peut également attribuer au compte de service Cloud Deploy les autorisations requises à l'aide de rôles personnalisés ou d'autres rôles prédéfinis.

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 du service ou du job 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: {}
   

   Jobs

   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: {}
   

   Pools de nœuds de calcul (bêta)

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

   Ce fichier est une configuration Skaffold minimale qui identifie vos services, jobs ou pools de nœuds de calcul Cloud Run. Pour en savoir plus sur ce fichier, consultez la documentation de référence skaffold.yaml pour plus d'informations.

Préparer vos services, jobs ou pools de nœuds de calcul Cloud Run

Pour ce guide de démarrage rapide, vous allez créer deux services Cloud Run, deux jobs Cloud Run ou deux pools de nœuds de calcul Cloud Run différents dans le même projet. Cloud Deploy est également compatible avec le déploiement sur plusieurs projets. De plus, nous utilisons des profils Skaffold pour permettre d'avoir deux services, jobs ou pools de nœuds de calcul dans le même projet. Lorsque vous utilisez différents projets, vous n'avez 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 son nom deploy-run-service-dev l'indique, il s'agit de votre service dev, qui correspond à la première cible de votre progression de pipeline de diffusion.

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 son nom deploy-run-service-prod l'indique, il s'agit de votre prod service, et correspond à la deuxième cible de votre progression de pipeline de diffusion.

Ces fichiers sont des définitions de service Cloud Run, qui sont utilisées pour déployer l'application. L'image de conteneur à déployer est définie ici comme espace réservé, my-app-image, qui est remplacé par l'image spécifique lorsque vous créez la version.

Jobs

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 un job Cloud Run. Comme son nom deploy-run-job-dev l'indique, il s'agit de votre job dev, qui correspond à la première cible de votre progression de pipeline de diffusion.

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 son nom deploy-run-job-prod l'indique, il s'agit de votre prod job, et correspond à la deuxième cible de votre progression de pipeline de diffusion.

Ces fichiers sont des définitions de job Cloud Run, qui sont utilisées pour déployer l'application. L'image de conteneur à déployer est définie ici comme espace réservé, my-app-image, qui est remplacé par l'image spécifique lorsque vous créez la version.

Pools de nœuds de calcul (bêta)

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

   apiVersion: run.googleapis.com/v1
   kind: WorkerPool
   metadata:
     name: deploy-run-worker-pool-dev
     annotations:
       run.googleapis.com/launch-stage: BETA
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   Ce fichier définit un pool de nœuds de calcul Cloud Run. Comme son nom deploy-run-worker-pool-dev l'indique, il s'agit de votre pool de nœuds de calcul dev, qui correspond à la première cible de votre progression de pipeline de diffusion.

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

   apiVersion: run.googleapis.com/v1
   kind: WorkerPool
   metadata:
     name: deploy-run-worker-pool-prod
     annotations:
       run.googleapis.com/launch-stage: BETA
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   Ce fichier définit un autre pool de nœuds de calcul Cloud Run. Comme son nom deploy-run-worker-pool-prod l'indique, il s'agit de votre pool de nœuds de calcul prod et correspond à la deuxième cible de votre progression de pipeline de diffusion.

Ces fichiers sont des définitions de pool de nœuds de calcul Cloud Run, qui sont utilisées pour déployer l'application. L'image de conteneur à déployer est définie ici comme 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 diffusion 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. Dans le répertoire deploy-run-quickstart, créez un fichier clouddeploy.yaml avec le contenu suivant :

   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
   

   Remarque : Dans ce fichier, les cibles sont incluses dans le pipeline de diffusion, mais vous pouvez les définir dans un ou plusieurs fichiers distincts.

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 maintenant d'un pipeline avec des cibles, prêt à déployer votre application sur votre première cible.

3. Confirmez votre pipeline et vos cibles :

   Dans la Google Cloud console, 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 diffusion que vous venez de créer s'affiche, et les deux cibles sont répertoriées dans la colonne Cibles.

   

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 diffusion définit le cycle de vie de cette version. Pour en savoir plus sur ce cycle de vie, consultez Architecture du service Cloud Deploy.

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

Jobs

 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:8eb3f5e72586de6375abe95aa67511c57c61d35fb37d5670e4d68624a68ef916

Pools de nœuds de calcul (bêta)

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

Notez le --images= flag, que vous utilisez pour remplacer l'espace réservé (my-app-image) dans la définition du service, du job ou du pool de nœuds de calcul par l'image spécifique qualifiée par SHA. Nous vous recommandons 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'images qualifiés par SHA lors de la création de la version.

L'option --skaffold-version= flag spécifie la version de Skaffold à utiliser pour le déploiement. Pour la prise en charge des pools de nœuds de calcul Cloud Run, vous devez utiliser la version 2.17 ou une version ultérieure de Skaffold.

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 première cible de la progression.

Promouvoir la version

Remarque : Une fois la version créée, vous devrez peut-être attendre quelques minutes avant de passer à cette étape.

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

   Ouvrir la page Pipelines de diffusion

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

   

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. Elle affiche les détails de la cible vers laquelle vous effectuez la promotion.

3. Cliquez sur Promouvoir.

   La version est maintenant mise en file d'attente pour être déployée dans run-qsprod. Une fois le déploiement terminé, la visualisation du pipeline de diffusion indique qu'il a été déployé :

   

Afficher les résultats dans la Google Cloud console

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

   Ouvrir la page Pipelines de diffusion

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

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

   

   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.

   

Accéder à votre service Cloud Run

Par défaut, vous devez être authentifié pour accéder aux services ou pools de nœuds de calcul Cloud Run nouvellement créés. Consultez la présentation de l'authentification Cloud Run pour découvrir comment fournir des identifiants et quelle configuration Identity and Access Management est requise pour accéder au service sans authentification. Cela ne s'applique pas aux jobs Cloud Run.

Effectuer un nettoyage

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 service, le job ou le pool de nœuds de calcul Cloud Run deploy-qs-dev :

   Services

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

   Jobs

   gcloud run jobs delete deploy-run-job-dev --region=us-central1 --project=PROJECT_ID
   

   Pools de nœuds de calcul (bêta)

   gcloud beta run worker-pools delete deploy-run-worker-pool-dev --region=us-central1 --project=PROJECT_ID

2. Supprimez le service, le job ou le pool de nœuds de calcul deploy-qs-prod :

   Services

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

   Jobs

   gcloud run jobs delete deploy-run-job-prod --region=us-central1 --project=PROJECT_ID
   

   Pools de nœuds de calcul (bêta)

   gcloud beta run worker-pools delete deploy-run-worker-pool-prod --region=us-central1 --project=PROJECT_ID
   

3. Supprimez le pipeline de diffusion, 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 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.

• Découvrez les principes de base du déploiement d'applications.

• Consultez l'article pratique sur le déploiement sur Cloud Run.

• Découvrez comment gérer vos fichiers manifestes.

• Découvrez comment combiner Google Cloud des outils CI/CD pour développer et diffuser efficacement des logiciels sur GKE.