Déployer sur Cloud Run à l'aide de Cloud Build

Cette page explique comment déployer automatiquement des services Cloud Run à l'aide de Cloud Build. Si vous débutez avec Cloud Build, commencez par lire les Guides de démarrage rapide et la Présentation de la configuration des compilations.

Cloud Run vous permet d'exécuter des conteneurs sans état dans un sans serveur. Cloud Build vous permet de déployer des images de conteneurs depuis Container Registry (obsolète) et Artifact Registry vers Cloud Run. Vous pouvez déployer une image existante, créer et déployer une image, ou automatiser le déploiement.

Remarque :Vous pouvez également utiliser Cloud Deploy pour configurer une livraison continue à déployer dans Cloud Run. En savoir plus

Avant de commencer

• Enable the Cloud Build, Cloud Run, Container Registry, and Resource Manager APIs.

  Enable the APIs

• Préparez le code source de votre application. Votre code source doit être stocké dans un dépôt tel que Cloud Source Repositories, GitHub ou Bitbucket.

• Pour exécuter les commandes gcloud sur cette page, installez la Google Cloud CLI.

• Si vous utilisez VPC Service Controls, configurez un pool privé dans le périmètre VPC Service Controls. Vous devez également configurer Cloud Run pour VPC Service Controls

Attention : Container Registry est obsolète et son abandon est planifié. Les organisations n'ayant pas utilisé Container Registry avant le 8 janvier 2024 disposeront par défaut des nouveaux dépôts gcr.io hébergés sur Artifact Registry. Depuis le 15 mai 2024, les projets Google Cloud qui n'utilisaient pas Container Registry précédemment n'accepteront que l'hébergement et la gestion des images dans Artifact Registry pour le domaine gcr.io.

L'arrêt de Container Registry est prévu pour le 18 mars 2025. Pour en savoir plus sur cet arrêt, consultez la page Abandon de Container Registry.

Attention : Depuis le 17 juin 2024, Cloud Source Repositories n'est plus disponible auprès des nouveaux clients. Si votre organisation n'a pas déjà utilisé Cloud Source Repositories, vous ne pouvez pas activer l'API ni utiliser Cloud Source Repositories. Les nouveaux projets qui ne sont pas associés à une organisation ne peuvent pas activer l'API Cloud Source Repositories. Les organisations qui ont utilisé Cloud Source Repositories avant le 17 juin 2024 ne sont pas concernées par ce changement.

Autorisations IAM requises

Si votre image est stockée dans le même projet Google Cloud que celui vers lequel vous souhaitez déployer ou si votre image est publique dans Container Registry, vous devez disposer des autorisations IAM suivantes :

Pour effectuer un déploiement dans Cloud Run, attribuez les rôles "Administrateur Cloud Run" et "Utilisateur du compte de service" au compte de service que vous utilisez pour le build :

1. Ouvrez la page des paramètres Cloud Build dans Google Cloud Console :

   Accéder à la page "Paramètres" de Cloud Build

2. Dans la liste déroulante, sélectionnez le compte de service dont vous souhaitez attribuer les rôles le changement.

   

3. Dans le panneau "Service account permissions" (Autorisations de compte de service), définissez l'état du rôle Cloud Run Admin (Administrateur Cloud Run) sur ENABLED (ACTIVÉ) :

4. Dans le pop-up "Des étapes supplémentaires peuvent être requises", cliquez sur ACCORDER L'ACCÈS À TOUS LES COMPTES DE SERVICE.

Remarque :Pour plus de sécurité, attribuez le rôle Utilisateur du compte de service aux le compte de service de l'environnement d'exécution Cloud Run. Pour obtenir des instructions Pour ce faire, consultez la section Utiliser des autorisations IAM minimales.

Créer et déployer un conteneur

Cloud Build vous permet de créer l'image de conteneur, de la stocker dans Container Registry et de la déployer dans Cloud Run.

Pour créer et déployer une image de conteneur, procédez comme suit :

1. Dans le répertoire racine de votre projet, créez un fichier de configuration nommé cloudbuild.yaml.

2. Dans le fichier de configuration de compilation, ajoutez les étapes de compilation docker pour créer l'image et la transférer dans Container Registry, puis ajoutez une étape de compilation gcloud pour appeler la commande gcloud run deploy permettant de déployer l'image sur Cloud Run :

   steps:
   # Build the container image
   - name: 'gcr.io/cloud-builders/docker'
     args: ['build', '-t', 'gcr.io/PROJECT_ID/IMAGE', '.']
   # Push the container image to Container Registry
   - name: 'gcr.io/cloud-builders/docker'
     args: ['push', 'gcr.io/PROJECT_ID/IMAGE']
   # Deploy container image to Cloud Run
   - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
     entrypoint: gcloud
     args: ['run', 'deploy', 'SERVICE_NAME', '--image', 'gcr.io/PROJECT_ID/IMAGE', '--region', 'SERVICE_REGION']
   images:
   - gcr.io/PROJECT_ID/IMAGE
   

   Où :

   • SERVICE_NAME correspond au nom du service Cloud Run.
   • SERVICE_REGION correspond à la région du service Cloud Run que vous déployez.
   • PROJECT_ID correspond à l'ID de projet Google Cloud dans lequel votre image est stockée.
   • IMAGE correspond au nom de votre image dans Container Registry.

3. Accédez au répertoire racine de votre projet et exécutez la commande suivante, où BUILD_REGION est l'une des régions de compilation compatibles pour exécuter la compilation :

    gcloud builds submit --region=BUILD_REGION
   

Une fois l'opération réussie, un message s'affiche indiquant l'URL du service déployé.

Déploiement continu

Vous pouvez automatiser le déploiement de votre logiciel dans Cloud Run en créant des déclencheurs Cloud Build. Vous pouvez configurer vos déclencheurs pour créer et déployer des images chaque fois que vous mettez à jour votre code source.

Pour automatiser votre déploiement, procédez comme suit :

1. Dans la racine de votre dépôt, ajoutez un fichier de configuration nommé cloudbuild.yaml contenant des étapes permettant de créer l'image, puis transférez-la dans Container Registry et appelez la commande gcloud run deploy :

     steps:
     # Build the container image
     - name: 'gcr.io/cloud-builders/docker'
       args: ['build', '-t', 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA', '.']
     # Push the container image to Container Registry
     - name: 'gcr.io/cloud-builders/docker'
       args: ['push', 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA']
     # Deploy container image to Cloud Run
     - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
       entrypoint: gcloud
       args:
       - 'run'
       - 'deploy'
       - 'SERVICE_NAME'
       - '--image'
       - 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA'
       - '--region'
       - 'SERVICE_REGION'
     images:
     - 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA'
   

   Où :

   • SERVICE_NAME correspond au nom du service Cloud Run.
   • SERVICE_REGION correspond à la région du service Cloud Run que vous déployez.

   L'utilisation de la variable de substitution $COMMIT_SHA est renseignée par Cloud Build lorsqu'elle est déclenchée à partir d'un dépôt Git.

2. Créez un déclencheur de compilation avec le fichier de configuration étape:

   1. Ouvrez la page Déclencheurs :

      Accéder à la page "Déclencheurs"

   2. Cliquez sur Créer un déclencheur.

   3. Dans le champ Nom, saisissez le nom du déclencheur.

   4. Sous Région, sélectionnez la région de votre déclencheur.

      Remarque : La région de votre déclencheur doit correspondre à celle du service Cloud Run que vous déployez.

   5. Sous Événement, sélectionnez l'événement du dépôt pour démarrer le déclencheur.

   6. Sous Source, sélectionnez le dépôt et le nom de la branche ou du tag qui lancera votre déclencheur. Pour en savoir plus sur la spécification des branches à compiler automatiquement, consultez la page Créer un déclencheur de compilation.

   7. Sous Configuration, sélectionnez Cloud Build (YAML ou JSON).

   8. Dans le champ Emplacement du fichier de configuration Cloud Build, saisissez cloudbuild.yaml après la barre oblique (/).

   9. Cliquez sur Créer pour enregistrer le déclencheur de compilation.

3. Vous avez terminé. Désormais, chaque fois que vous effectuez un transfert vers votre dépôt, un build et un déploiement sont automatiquement appelés dans votre service.

Remarque : Pour rendre le service déployé public, effectuez une modification ponctuelle des paramètres du service IAM.

Chaque fois que vous transmettez du nouveau code dans votre dépôt, vous déclenchez automatiquement une compilation et un déploiement dans votre service Cloud Run.

Pour en savoir plus sur la création de déclencheurs Cloud Build, consultez la page Créer et gérer des déclencheurs de compilation.

Utiliser des autorisations IAM minimales

Lorsqu'un conteneur est déployé sur un service Cloud Run, il s'exécute sous l'identité du compte de service d'exécution pour ce service Cloud Run. Comme Cloud Build peut déployer automatiquement de nouveaux conteneurs, il doit pouvoir agir en tant que compte de service d'exécution pour le service Cloud Run.

Pour accorder à Cloud Build un accès limité permettant d'effectuer des déploiements sur un service Cloud Run, procédez comme suit :

Console

1. Accédez à la page Comptes de service de la console Google Cloud :

   Accéder à la page "Comptes de service"

2. Cliquez sur l'adresse e-mail du compte de service d'exécution de votre service Cloud Run (par défaut, il s'agit de [e-mail]).

3. Cliquez sur l'onglet Autorisations.

4. Cliquez sur Accorder l'accès.

5. Saisissez le compte de service Cloud Build ([e-mail]).

6. Dans la liste déroulante Sélectionner un rôle, sélectionnez le rôle Comptes de service > Utilisateur du compte de service.

7. Cliquez sur Enregistrer.

gcloud

Exécutez la commande gcloud iam service-accounts add-iam-policy-binding, où PROJECT_NUMBER est l'ID numérique de votre projet :

gcloud iam service-accounts add-iam-policy-binding \
  [e-mail] \
  --member="serviceAccount:[e-mail]" \
  --role="roles/iam.serviceAccountUser"

Remplacez PROJECT_NUMBER par l'ID numérique de votre projet.

Si vous utilisez Cloud Run avec une identité de service personnalisée, remplacez [e-mail] par l'adresse de votre compte de service.

Consultez la section Autorisations de déploiement pour plus d'informations.

Exemples de code

Voici quelques exemples de dépôts, chacun d'entre eux contenant un exemple d'application et un fichier de configuration de compilation permettant de déployer l'application dans Cloud Run :

• deploy-prebuilt : exemple de code qui montre comment déployer une image prédéfinie sur Cloud Run.
• run-example-builddeploy : exemple de code qui explique comment créer et déployer une image sur Cloud Run.

Étape suivante

• Découvrez comment utiliser Cloud Deploy pour déployer sur Cloud Run.
• Découvrez comment déployer sur GKE
• Découvrez comment déployer sur des fonctions Cloud Run.
• Découvrez comment déployer sur App Engine
• Découvrez comment déployer sur Firebase
• Découvrez comment effectuer des déploiements bleu-vert sur Compute Engine.
• Découvrez comment résoudre les erreurs de compilation.