Configurer un disque éphémère pour les services Cloud Run

Cloud Run fournit un espace disque éphémère qui ne persiste que pendant la durée de votre instance. Cette fonctionnalité vous permet de spécifier la quantité de disque dont vous avez besoin et l'emplacement pour le monter. Cloud Run alloue ensuite cette quantité de disque à votre ressource.

Les disques sont automatiquement provisionnés, préformatés en ext4 et chiffrés avec des clés spécifiques à l'instance au démarrage. L'espace disque éphémère crée votre volume de sorte que n'importe quel utilisateur puisse le lire ou y écrire. Comme le stockage est éphémère, toutes les données sont définitivement supprimées lorsque l'instance s'arrête. Cela inclut les arrêts causés par :

  • Plantages d'instances
  • Scaling de service
  • Migrer le trafic vers une nouvelle révision

Les disques sont dédiés à une instance spécifique et ne sont pas partagés avec d'autres instances ni révisions. Vous contrôlez la structure du système de fichiers avec un point de montage configurable pour chaque volume.

Avant d'arrêter une instance, Cloud Run envoie un signal SIGTERM à tous les conteneurs d'une instance, indiquant le début de la période de 10 secondes avant l'arrêt réel marqué par l'envoi d'un signal SIGKILL par Cloud Run. Vous pouvez utiliser cette fenêtre de 10 secondes pour effectuer des opérations de nettoyage, comme une dernière série de copie du contenu du disque vers le stockage persistant.

Cas d'utilisation

Vous pouvez utiliser un espace disque éphémère pour les opérations suivantes :

  • Charges de travail de traitement des données : lorsque vous traitez de grands fichiers de données dans Cloud Run, vous stockez généralement l'intégralité du fichier en mémoire ou vous orchestrez sa division en plus petits morceaux. Avec le stockage éphémère, vous n'avez pas besoin de payer pour de grandes quantités de mémoire afin de créer une copie locale temporaire de vos données. Vous pourrez également traiter des ensembles de données plus volumineux.
  • Mise en cache : dans les cas d'utilisation de diffusion Web, la mise en cache des données sur le disque plutôt que leur récupération à partir d'un stockage à distance peut optimiser la latence de votre application.

Limites de stockage et d'instances

Les limites suivantes s'appliquent :

  • Limite de taille des volumes : chaque volume doit être compris entre 1Gi et 100Gi.
  • Limite de stockage des instances : par défaut, chaque instance est limitée à 10 Go d'espace total. Si nécessaire, demandez une augmentation de quota.
  • Limite de volume par instance : chaque instance est limitée à 10 volumes maximum.
  • Limite par projet : par défaut, chaque projet est limité à 100 Go par région. Si nécessaire, demandez une augmentation de quota.

Demander une augmentation du quota

Les projets qui utilisent un disque éphémère Cloud Run dans une région pour la première fois se voient automatiquement accorder une limite de 10 Go par instance et par région, et une limite de 100 Go par projet et par région.

Si vous avez besoin de capacité supplémentaire, vous devez demander une augmentation de quota pour votre service Cloud Run. Utilisez les liens fournis dans les boutons suivants pour demander le quota dont vous avez besoin.

Quota actuel Lien vers le quota
10 Go par instance Demander un quota plus important par instance
100 Go par projet Demander un quota plus important par projet

Pour savoir comment demander une augmentation de quota, consultez Augmenter le quota.

Limites

L'espace disque éphémère n'est disponible que dans l'environnement d'exécution de deuxième génération.

Chemins d'accès non autorisés

Cloud Run ne vous permet pas d'installer un volume sur /dev, /proc ou /sys, ni dans leurs sous-répertoires.

Régions où le service est disponible

L'espace disque éphémère est disponible dans toutes les régions de niveau 1. Si vous utilisez des GPU, l'espace disque éphémère est disponible dans toutes les régions compatibles avec les GPU.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud . 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.
  2. 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

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

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

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

  6. Installez et initialisez la gcloud CLI.
  7. Mettez à jour les composants :
    gcloud components update
  8. Consultez la page Tarifs de Cloud Run pour connaître les tarifs associés au processeur, à la mémoire et à la sortie réseau. La taille totale du disque provisionné et la durée de vie de l'instance qui l'utilise contribuent à votre coût.

Rôles requis

Pour obtenir les autorisations nécessaires pour configurer un espace disque éphémère, 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 service Cloud Run communique avec les APIGoogle Cloud , telles que les 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.

Créer et installer un espace disque éphémère

Vous pouvez créer et associer un disque éphémère à l'aide de la console Google Cloud , de la Google Cloud CLI, de YAML ou de Terraform :

Console

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

    Accédez à Cloud Run

  2. Sélectionnez Services dans le menu de navigation Cloud Run, puis cliquez sur Déployer un conteneur pour configurer un nouveau service. Si vous configurez un service existant, cliquez sur celui-ci, puis sur l'onglet Conteneurs.

  3. Si vous configurez un nouveau service, remplissez la page initiale des paramètres du service, puis cliquez sur Conteneurs, mise en réseau, sécurité.

  4. Sélectionnez Espace disque éphémère.

  5. Sélectionnez la taille dans le menu, puis saisissez le chemin de montage dans le champ Chemin de montage.

  6. Cliquez sur Créer pour un nouveau service. Cliquez sur Afficher les différences et redéployer, puis sur Déployer les modifications pour un service existant.

gcloud

Pour ajouter un volume et l'installer, procédez comme suit :

gcloud beta run services update SERVICE \
    --execution-environment=gen2 \
    --add-volume=name=VOLUME_NAME,type=ephemeral-disk,size=SIZE \
    --add-volume-mount=volume=VOLUME_NAME,mount-path=MOUNT_PATH

Remplacez les éléments suivants :

  • SERVICE : nom de votre service.
  • VOLUME_NAME : nom que vous souhaitez attribuer à votre volume.
  • SIZE : taille du disque, par exemple 100Gi. La taille doit être comprise entre 1Gi et 100Gi pour les volumes ephemeral-disk.
  • MOUNT_PATH : chemin relatif où vous installez le volume, par exemple, /mnt/my-volume.

YAML

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

    gcloud run services describe SERVICE --format export > service.yaml
  2. Configurez le fichier YAML :

    apiVersion: serving.knative.dev/v1
    kind: Service
    metadata:
      name: SERVICE
      labels:
        cloud.googleapis.com/location: REGION
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          containers:
          - name: CONTAINER_NAME
            image: IMAGE_URL
            volumeMounts:
            - name: VOLUME_NAME
              mountPath: MOUNT_PATH
          volumes:
          - name: VOLUME_NAME
            emptyDir:
              medium: Disk
              sizeLimit: SIZE
    

    Remplacez les éléments suivants :

    • SERVICE : nom de votre service.
    • REGION : région Google Cloud .
    • CONTAINER_NAME : nom que vous souhaitez attribuer à votre conteneur.
    • IMAGE_URL : référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/hello:latest. Si vous utilisez Artifact Registry, le dépôt REPO_NAME doit déjà être créé. L'URL est au format LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG.
    • VOLUME_NAME : nom que vous souhaitez attribuer à votre volume.
    • MOUNT_PATH : chemin relatif où vous installez le volume, par exemple, /mnt/my-volume.
    • SIZE : taille du disque, par exemple 100Gi. La taille doit être comprise entre 1Gi et 100Gi pour les volumes ephemeral-disk.
  3. Créez ou mettez à jour le service à l'aide de la commande suivante :

    gcloud run services replace service.yaml

    La commande gcloud run services replace utilise par défaut le fichier service.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_service dans votre configuration Terraform :
  resource "google_cloud_run_v2_service" "default" {
    name     = "SERVICE"
    location = "REGION"
    launch_stage = "BETA"
    deletion_protection =  "true"
    ingress = "INGRESS_TRAFFIC_ALL"
  template {
    containers {
      image = "IMAGE_URL"
      volume_mounts {
        name = "VOLUME_NAME"
        mount_path = "MOUNT_PATH"
      }
    }
    volumes {
      name = "VOLUME_NAME"
      empty_dir {
        medium = "DISK"
        size_limit = "SIZE"
      }
    }
  }
  lifecycle {
    ignore_changes = [
      launch_stage,
    ]
  }
}

Remplacez les éléments suivants :

  • SERVICE : nom de votre service.
  • REGION : région Google Cloud .
  • IMAGE_URL : référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/hello:latest. Si vous utilisez Artifact Registry, le dépôt REPO_NAME doit déjà être créé. L'URL est au format LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG.
  • VOLUME_NAME : nom que vous souhaitez attribuer à votre volume.
  • MOUNT_PATH : chemin relatif où vous installez le volume, par exemple, /mnt/my-volume.
  • SIZE : taille du disque, par exemple 100Gi. La taille doit être comprise entre 1Gi et 100Gi pour les volumes ephemeral-disk.

Lire et écrire dans un volume

Si vous utilisez la fonctionnalité d'installation de volume Cloud Run, vous accédez à un volume installé à l'aide des mêmes bibliothèques dans votre langage de programmation que celles que vous utilisez pour lire et écrire des fichiers sur votre système de fichiers local.

Ceci est particulièrement utile si vous utilisez un conteneur existant qui attend que des données soient stockées sur le système de fichiers local et utilise des opérations standards du système de fichiers pour y accéder.

Les extraits suivants supposent une installation de volume avec un mountPath défini sur /mnt/my-volume.

Nodejs

Utilisez le module File System pour créer un fichier ou ajouter des données à un fichier existant dans le volume /mnt/my-volume :

var fs = require('fs');
fs.appendFileSync('/mnt/my-volume/sample-logfile.txt', 'Hello logs!', { flag: 'a+' });

Python

Écrivez les données dans un fichier conservé dans le volume /mnt/my-volume :

f = open("/mnt/my-volume/sample-logfile.txt", "a")

Go

Utilisez le package os pour créer un fichier conservé dans le volume /mnt/my-volume :

f, err := os.Create("/mnt/my-volume/sample-logfile.txt")

Java

Utilisez la classe Java.io.File pour créer un fichier journal dans le volume /mnt/my-volume :

import java.io.File;
File f = new File("/mnt/my-volume/sample-logfile.txt");

Effacer et supprimer des volumes et des montages de volume

Vous pouvez effacer tous les volumes et montages, ou supprimer des volumes et montages de volume individuels.

Effacer tous les volumes et les montages de volume

Pour effacer tous les volumes et montages de volume de votre service à conteneur unique, exécutez la commande suivante :

gcloud run services update SERVICE \
    --clear-volumes \
    --clear-volume-mounts
Si vous avez plusieurs conteneurs, suivez les conventions de la CLI sidecars pour effacer les volumes et les installations de volumes :

gcloud run services update SERVICE \
    --container=container1 \
    --clear-volumes \
    --clear-volume-mounts \
    --container=container2 \
    --clear-volumes \
    --clear-volume-mounts

Supprimer des volumes et des montages de volumes individuels

Pour supprimer un volume, vous devez également supprimer tous les montages de volume qui l'utilisent.

Pour supprimer des volumes ou des montages de volumes individuels, utilisez les indicateurs remove-volume et remove-volume-mount :

gcloud run services update SERVICE \
    --remove-volume VOLUME_NAME \
    --container=container1 \
    --remove-volume-mount MOUNT_PATH \
    --container=container2 \
    --remove-volume-mount MOUNT_PATH

Bonnes pratiques

Suivez les bonnes pratiques ci-dessous pour gérer efficacement les données éphémères et optimiser les performances de stockage.

Copier vers l'espace de stockage persistant

Si vous prévoyez de copier le contenu de l'espace disque éphémère vers un stockage persistant, tel qu'un bucket Cloud Storage, nous vous recommandons de le faire de manière incrémentielle plutôt que de vous fier au délai de grâce de 10 secondes entre SIGTERM et SIGKILL. Pour en savoir plus sur l'arrêt des instances, consultez le contrat d'exécution du conteneur.

Cloud Run peut lire et écrire des données depuis Cloud Storage sans aucune configuration réseau supplémentaire. Pour obtenir des performances optimales, nous vous recommandons d'acheminer le trafic vers et depuis Cloud Storage via un réseau VPC à l'aide du VPC direct.

Cette méthode fonctionne si la ressource Cloud Run n'a pas besoin d'accéder à Internet. Si vous avez besoin d'un accès à Internet, configurez Cloud NAT ou consultez Trafic interne vers une API Google.

Pour configurer la sortie VPC directe avec un service, procédez comme suit :

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

    Accédez à Cloud Run

  2. Cliquez sur Créer un service si vous configurez un nouveau service sur lequel effectuer un déploiement. Si vous configurez et déployez un service existant, cliquez sur ce service.

  3. Si vous configurez un nouveau service, remplissez la page initiale des paramètres du service selon vos besoins, puis cliquez sur Conteneurs, mise en réseau, sécurité pour développer la page de configuration de service.

  4. Cliquez sur l'onglet Réseau.

  5. Cliquez sur Se connecter à un VPC pour le trafic sortant.

  6. Cliquez sur Envoyer le trafic directement à un VPC.

  7. Dans le champ Réseau, sélectionnez le réseau VPC vers lequel vous souhaitez envoyer du trafic.

  8. Dans le champ Sous-réseau, sélectionnez le sous-réseau à partir duquel votre service reçoit des adresses IP. Vous pouvez déployer plusieurs services sur le même sous-réseau.

  9. Pour le Routage du trafic, sélectionnez Acheminer tout le trafic vers le VPC pour envoyer tout le trafic sortant via le réseau VPC.

    1. Cliquez sur Créer pour un nouveau service. Cliquez sur Afficher les différences et redéployer, puis sur Déployer les modifications pour un service existant.

    2. Pour vérifier que votre service se trouve sur votre réseau VPC, cliquez sur le service, puis sur l'onglet Mise en réseau. Le réseau et le sous-réseau sont répertoriés dans la fiche VPC.

      Vous pouvez désormais envoyer des requêtes à partir de votre service Cloud Run vers n'importe quelle ressource du réseau VPC, conformément à vos règles de pare-feu.

    3. Activez l'accès privé à Google sur le sous-réseau auquel vous vous êtes connecté.

Résoudre les problèmes

Si vous rencontrez des problèmes, vérifiez les points suivants :

  • Si votre conteneur manque de mémoire et que vous avez utilisé la console Google Cloud pour déployer une nouvelle révision d'un service avec un disque éphémère associé, il est probable que la console Google Cloud ait converti votre volume de disque en volume en mémoire. Cela entraîne l'écriture de vos données sur disque dans la mémoire, ce qui fait que votre conteneur manque de mémoire. Pour résoudre ce problème, redéployez votre service à l'aide de gcloud CLI et assurez-vous que votre fichier YAML spécifie medium: Disk sous volumes.
  • Si vous constatez une lenteur du réseau lorsque vous téléchargez une grande quantité de données sur votre espace disque éphémère, suivez la procédure pour activer le VPC direct. Si la sortie VPC directe n'est pas activée, la vitesse de transfert réseau sera plus lente.