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 environnement sans serveur. Avec Cloud Build, vous pouvez 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.

Avant de commencer

  • Activer les API Cloud Build, Cloud Run, Container Registry, and Resource Manager.

    Activer les API

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

Autorisations IAM requises

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

Pour déployer sur Cloud Run, attribuez les rôles Administrateur Cloud Run et Utilisateur du compte de service au compte de service Cloud 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 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É) :

    Capture d'écran de la page des autorisations de compte de service

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

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:

     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 les étapes à suivre pour compiler l'image, la transférer vers Container Registry, puis appeler 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 à l'aide du fichier de configuration créé à l'étape précédente :

    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.

    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 Fichier de configuration 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.

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 PROJECT_NUMBER-compute@developer.gserviceaccount.com).

  3. Cliquez sur l'onglet Autorisations.

  4. Cliquez sur Accorder l'accès.

  5. Saisissez le compte de service Cloud Build (PROJECT_NUMBER@cloudbuild.gserviceaccount.com).

  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 \
  PROJECT_NUMBER-compute@developer.gserviceaccount.com \
  --member="serviceAccount:PROJECT_NUMBER@cloudbuild.gserviceaccount.com" \
  --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 PROJECT_NUMBER-compute@developer.gserviceaccount.com 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.

Étapes suivantes