Configurer des bacs à sable pour les jobs

Les bacs à sable Cloud Run fournissent un environnement rapide, sécurisé et isolé pour exécuter le code de l'agent, effectuer des transformations de données et exécuter des scripts de manière sécurisée dans votre job existant. Les bacs à sable sont hautement optimisés pour la latence et s'exécutent dans la même instance que votre conteneur, en partageant le processeur et la mémoire qui lui sont alloués.

Cette page explique comment configurer des bacs à sable sur votre conteneur. Pour savoir comment écrire du code pour interagir avec le bac à sable à l'aide de la CLI, consultez Exécution de code dans Cloud Run.

Avant de commencer

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

    Go to project selector

  2. Verify that billing is enabled for your Google Cloud project.

  3. Installez et initialisez la gcloud CLI.
  4. Créez un job Cloud Run.

Rôles requis

Pour obtenir les autorisations nécessaires pour configurer des jobs Cloud Run, demandez à votre administrateur de vous accorder les rôles IAM suivants :

Pour obtenir la liste des rôles et des autorisations IAM associés à Cloud Run, consultez les sections Rôles IAM Cloud Run et Autorisations IAM Cloud Run. Si votre job Cloud Run communique avec des APIGoogle Cloud , telles que des bibliothèques clientes Cloud, consultez le guide de configuration de l'identité du service. Pour en savoir plus sur l'attribution de rôles, consultez les pages Autorisations de déploiement et Gérer les accès.

Activer les bacs à sable

Pour activer les bacs à sable dans les jobs Cloud Run, utilisez la Google Cloud CLI, une configuration YAML ou Terraform :

gcloud

Pour créer ou mettre à jour le job, spécifiez l'option --sandbox-launcher :

  • Pour créer un job, exécutez la commande suivante :

    gcloud beta run jobs create JOB --image IMAGE_URL --sandbox-launcher

    Remplacez les éléments suivants :

    • JOB par le nom de votre job Cloud Run
    • IMAGE_URL : référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/job:latest
  • Pour mettre à jour un job existant, exécutez la commande suivante :

    gcloud beta run jobs update JOB --sandbox-launcher

YAML

  1. Si vous créez un job, ignorez cette étape. Si vous mettez à jour un job existant, téléchargez sa configuration YAML :

    gcloud run jobs describe JOB --format export > job.yaml
  2. Mettez à jour votre fichier YAML pour inclure l'attribut sandboxLauncher défini sur true dans la configuration de votre conteneur :

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - name: CONTAINER
                image: IMAGE_URL
                sandboxLauncher: true
    

    Remplacez les éléments suivants :

    • JOB par le nom de votre job Cloud Run
    • CONTAINER : nom de votre conteneur.
    • IMAGE_URL : référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/job:latest
  3. Créez ou mettez à jour le job à l'aide de la commande suivante :

    gcloud run jobs replace job.yaml

    Par défaut, la commande gcloud run jobs replace utilise le fichier job.yaml s'il est présent.

Terraform

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.

Ajoutez les éléments suivants à une ressource google_cloud_run_v2_job dans votre configuration Terraform :
resource "google_cloud_run_v2_job" "default" {
  name     = "JOB"
  location = "REGION"

  template {
    template {
      containers {
        image            = "IMAGE_URL"
        sandbox_launcher = true
      }
    }
  }
}

Remplacez les éléments suivants :

  • JOB par le nom de votre job Cloud Run
  • REGION : région Google Cloud . Par exemple, europe-west1.
  • IMAGE_URL : référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/job:latest

Les bacs à sable partagent le processeur et la mémoire alloués au conteneur hôte. Assurez-vous que les limites de processeur et de mémoire de votre conteneur principal peuvent accueillir à la fois votre application et les bacs à sable actifs que vous exécutez en même temps.

Désactiver les bacs à sable

Pour désactiver la possibilité de lancer un bac à sable dans votre job, utilisez la Google Cloud CLI ou une configuration YAML :

gcloud

Mettez à jour le job à l'aide de l'option --no-sandbox-launcher en exécutant la commande suivante :

gcloud beta run jobs update JOB --no-sandbox-launcher

Remplacez JOB par le nom de votre job.

YAML

  1. Si vous créez un job, ignorez cette étape. Si vous mettez à jour un job existant, téléchargez sa configuration YAML :

    gcloud run jobs describe JOB --format export > job.yaml
  2. Mettez à jour votre fichier YAML pour supprimer l'attribut sandboxLauncher de la configuration de votre conteneur :

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - name: CONTAINER
                image: IMAGE_URL
    

    Remplacez les éléments suivants :

    • JOB par le nom de votre job Cloud Run
    • CONTAINER : nom de votre conteneur.
    • IMAGE_URL : référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/job:latest
  3. Créez ou mettez à jour le job à l'aide de la commande suivante :

    gcloud run jobs replace job.yaml

    Par défaut, la commande gcloud run jobs replace utilise le fichier job.yaml s'il est présent.

Afficher les paramètres du bac à sable

Pour afficher les paramètres actuels du bac à sable pour votre job Cloud Run :

Console

  1. Dans la console Google Cloud , accédez à la page Jobs de Cloud Run :

    Accéder aux jobs Cloud Run

  2. Cliquez sur le job pour ouvrir la page Informations sur le job.

  3. Dans l'onglet Historique, cliquez sur l'ID du job exécuté dans la liste.

  4. Dans l'onglet Conteneurs, recherchez le paramètre Lanceur de bac à sable pour voir si les conteneurs en bac à sable sont activés ou désactivés.

gcloud

  1. Exécutez la commande suivante :

    gcloud run jobs executions describe EXECUTION_NAME --format yaml

    Remplacez EXECUTION_NAME par le nom de l'exécution du job.

  2. Pour vérifier que les conteneurs en bac à sable sont activés, recherchez l'attribut sandboxLauncher: true dans la configuration renvoyée.

Pour exécuter du code non fiable dans un bac à sable à partir de votre job, consultez Exécution de code dans Cloud Run.

Configurer des modèles de bac à sable

Les modèles de bac à sable vous permettent de définir des images de conteneurs pour les bacs à sable. Au lieu d'exécuter des sessions de bac à sable dans le conteneur de votre application principale, les commandes sandbox do --template et sandbox run --template lancent de nouveaux conteneurs à l'aide des images que vous avez spécifiées, telles que Python, Node.js ou un environnement d'exécution personnalisé. Ces bacs à sable s'exécutent dans leurs propres conteneurs et partagent les limites de processeur et de mémoire du conteneur principal. Vous ne pouvez pas définir de limites de processeur et de mémoire distinctes pour un modèle. Cloud Run accepte jusqu'à 10 modèles de bac à sable. Les installations de volume doivent référencer un volume en mémoire sur votre ressource Cloud Run. Les modèles de bac à sable offrent les fonctionnalités suivantes :

  • Images de conteneurs dédiées : déclarez des images de conteneurs distinctes, telles que python:3.12-slim ou busybox:latest, en tant que modèles de bac à sable. Vous pouvez également utiliser d'autres environnements d'exécution et outils pour les bacs à sable qui ne sont pas requis sur votre conteneur principal. Cela permet de garder votre conteneur principal léger en isolant les outils et les environnements d'exécution utilisés uniquement pour le bac à sable.

  • Instanciation à la demande : la CLI du bac à sable (/usr/local/gcp/bin/sandbox) génère de nouveaux conteneurs de bac à sable à partir d'un modèle sans provisionner de nouvelles VM ni facturer de nouvelles instances.

  • Partage de fichiers isolé par bac à sable : partagez un volume en mémoire entre votre conteneur principal et plusieurs bacs à sable, tout en limitant chaque bac à sable à son propre sous-répertoire isolé pour empêcher les bacs à sable de consulter ou de modifier d'autres fichiers.

Vous pouvez configurer des modèles de bac à sable à l'aide d'une configuration YAML ou de l'API Cloud Run Admin :

YAML

  1. Si vous créez un job, ignorez cette étape. Si vous mettez à jour un job existant, téléchargez sa configuration YAML :

    gcloud run jobs describe JOB --format export > job.yaml
  2. Mettez à jour votre fichier YAML de job pour inclure la configuration des modèles sandboxes :

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: IMAGE_URL
                sandboxLauncher: true
                volumeMounts:
                - name: VOLUME_NAME
                  mountPath: CONTAINER_MOUNT_PATH
              volumes:
              - name: VOLUME_NAME
                emptyDir:
                  medium: Memory
              sandboxes:
                templates:
                - name: TEMPLATE_NAME
                  image: TEMPLATE_IMAGE_URL
                  volumeMounts:
                  - name: VOLUME_NAME
                    mountPath: SANDBOX_MOUNT_PATH
                    subPath: SUBPATH
    

    Remplacez les éléments suivants :

    • JOB par le nom de votre job Cloud Run

    • IMAGE_URL : URL de l'image de conteneur à utiliser pour le conteneur principal.
    • TEMPLATE_NAME : nom du modèle
    • TEMPLATE_IMAGE_URL : URL de l'image de conteneur à utiliser pour le modèle de bac à sable.
    • VOLUME_NAME (facultatif) : nom du volume à installer.
    • Facultatif : CONTAINER_MOUNT_PATH : chemin d'accès où le volume est installé dans le conteneur principal.
    • Facultatif : SANDBOX_MOUNT_PATH est le chemin d'accès où le volume est installé dans le conteneur de bac à sable.
    • Facultatif : SUBPATH : chemin d'accès relatif au sous-répertoire dans le volume à installer dans le conteneur de bac à sable, par exemple my-subdir. Pour définir un sous-répertoire différent pour chaque bac à sable au moment de l'exécution, utilisez un espace réservé $(VARIABLE_NAME), tel que $(SANDBOX_DIR) :
      • VARIABLE_NAME ne peut contenir que des lettres ASCII et des traits de soulignement. Les chiffres et les traits d'union ne sont pas acceptés.
      • Pour résoudre l'espace réservé au moment de l'exécution, transmettez l'option --template-var=VARIABLE_NAME=VALUE avec --template.
      • subPath ne crée pas de répertoires automatiquement. Créez le répertoire SUBPATH résolu dans le volume à partir du conteneur principal, par exemple à l'aide de mkdir -p, avant d'exécuter sandbox do ou sandbox run.
  3. Créez ou mettez à jour le job à l'aide de la commande suivante :

    gcloud run jobs replace job.yaml

    Par défaut, la commande gcloud run jobs replace utilise le fichier job.yaml s'il est présent.

API REST

Pour configurer des modèles de bac à sable, envoyez une requête PATCH à l'API Cloud Run Admin :

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-X PATCH \
"https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs/JOB" \
-d '{
  "launchStage": "BETA",
  "template": {
    "template": {
      "containers": [
        {
          "image": "IMAGE_URL",
          "sandboxLauncher": true,
          "volumeMounts": [
            {
              "name": "VOLUME_NAME",
              "mountPath": "CONTAINER_MOUNT_PATH"
            }
          ]
        }
      ],
      "sandboxes": {
        "templates": [
          {
            "name": "TEMPLATE_NAME",
            "image": "TEMPLATE_IMAGE_URL",
            "volumeMounts": [
              {
                "name": "VOLUME_NAME",
                "mountPath": "SANDBOX_MOUNT_PATH",
                "subPath": "SUBPATH"
              }
            ]
          }
        ]
      },
      "volumes": [
        {
          "name": "VOLUME_NAME",
          "emptyDir": {
            "medium": "MEMORY"
          }
        }
      ]
    }
  }
}'

Remplacez les éléments suivants :

  • JOB par le nom de votre job Cloud Run

  • PROJECT_ID : ID de votre projet Google Cloud .
  • REGION : région dans laquelle votre ressource Cloud Run est déployée.
  • IMAGE_URL : URL de l'image de conteneur à utiliser pour le conteneur principal.
  • TEMPLATE_NAME : nom du modèle
  • TEMPLATE_IMAGE_URL : URL de l'image de conteneur à utiliser pour le modèle de bac à sable.
  • VOLUME_NAME (facultatif) : nom du volume à installer.
  • Facultatif : CONTAINER_MOUNT_PATH : chemin d'accès où le volume est installé dans le conteneur principal.
  • Facultatif : SANDBOX_MOUNT_PATH est le chemin d'accès où le volume est installé dans le conteneur de bac à sable.
  • Facultatif : SUBPATH : chemin d'accès relatif au sous-répertoire dans le volume à installer dans le conteneur de bac à sable, par exemple my-subdir. Pour définir un sous-répertoire différent pour chaque bac à sable au moment de l'exécution, utilisez un espace réservé $(VARIABLE_NAME), tel que $(SANDBOX_DIR) :
    • VARIABLE_NAME ne peut contenir que des lettres ASCII et des traits de soulignement. Les chiffres et les traits d'union ne sont pas acceptés.
    • Pour résoudre l'espace réservé au moment de l'exécution, transmettez l'option --template-var=VARIABLE_NAME=VALUE avec --template.
    • subPath ne crée pas de répertoires automatiquement. Créez le répertoire SUBPATH résolu dans le volume à partir du conteneur principal, par exemple à l'aide de mkdir -p, avant d'exécuter sandbox do ou sandbox run.

Pour exécuter des modèles à l'aide de la CLI depuis votre conteneur de job, consultez Exécuter des commandes à l'aide de modèles de bac à sable.