Enregistrer et charger des instantanés d'environnement

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

Cette page explique comment enregistrer et charger l'état de votre environnement à l'aide d'instantanés d'environnement.

Vous pouvez configurer votre environnement pour qu'il enregistre automatiquement des instantanés. Pour en savoir plus, consultez Configurer des snapshots planifiés.

À propos des instantanés d'environnement

Les instantanés d'environnement stockent l'état de votre environnement. Vous pouvez enregistrer et charger des instantanés d'environnement à la demande.

Vous pouvez utiliser des instantanés pour :

Stockage des instantanés

Un instantané d'environnement est un ensemble de fichiers décrivant l'état de votre environnement et stockant la sauvegarde des données de l'environnement.

Vous pouvez créer plusieurs instantanés de votre environnement. Les instantanés d'environnement ne sont pas incrémentaux. Vous pouvez utiliser n'importe quel instantané indépendamment des autres.

Cloud Composer ne supprime pas les instantanés lorsque vous supprimez votre environnement.

Par défaut, Cloud Composer stocke les instantanés dans le dossier snapshots/ du bucket de votre environnement. Vous pouvez également spécifier un emplacement personnalisé lorsque vous créez un instantané.

Bien que l'interface utilisateur Cloud Storage affiche les données sous forme de dossiers pour plus de commodité, les buckets fonctionnent avec une structure de fichiers plats. Cela ne change pas la façon dont vous enregistrez et chargez des instantanés dans la console Google Cloud , mais gardez cela à l'esprit lorsque vous effectuez des opérations directement sur les fichiers de votre bucket. Pour en savoir plus, consultez Espace de noms des objets.

Points à noter concernant la sécurité des instantanés

Pour limiter ce risque de sécurité, vous pouvez stocker les informations sensibles utilisées par les DAG Airflow, telles que les clés ou les mots de passe, dans Secret Manager. Pour en savoir plus, consultez Configurer Secret Manager pour votre environnement.

Veillez à vérifier les autorisations de sécurité pour le bucket de votre environnement. Si vous stockez des instantanés d'environnement dans un bucket personnalisé, assurez-vous que les autorisations d'accès sont correctement configurées dans votre projet. Lorsque vous attribuez des autorisations, assurez-vous que le compte de service de l'environnement dispose des autorisations suffisantes pour enregistrer et charger des instantanés à partir du bucket.

Quelles données sont enregistrées dans les instantanés ?

Cloud Composer enregistre les données suivantes dans les instantanés :

  • Remplacements de configuration Airflow.
  • Variables d'environnement.
  • Liste des packages PyPI personnalisés, en tant qu'exigences.
  • Sauvegarde de la base de données Airflow, y compris les états des tâches exécutées et l'historique des exécutions de DAG.
  • Une sauvegarde des dossiers /dags, /data et /plugins du bucket de l'environnement.
  • Clé Fernet de l'environnement.
  • Autres informations sur la configuration de l'environnement, comme les paramètres d'évolutivité et de performances. Cloud Composer n'utilise pas ces informations lorsqu'il charge des instantanés.

Quelles données sont chargées à partir des instantanés ?

Cloud Composer charge les données suivantes à partir des instantanés :

  • Remplacements de configuration Airflow.
  • Variables d'environnement.

  • Packages PyPI personnalisés (sauf si vous choisissez de ne pas les installer).

  • Le contenu de la base de données Airflow, y compris les états des tâches exécutées et l'historique des exécutions DAG.

  • Le contenu des dossiers /dags, /data et /plugins de l'instantané est chargé dans le bucket de l'environnement.

  • La clé Fernet de l'instantané est utilisée pour rechiffrer les données de l'instantané avec la propre clé Fernet de l'environnement. La clé Fernet de l'environnement reste inchangée.

Bien que Cloud Composer stocke certaines informations sur la configuration de l'environnement dans les instantanés, elles ne sont pas utilisées lors du chargement des instantanés. Les paramètres suivants de votre environnement ne changent pas lorsque vous chargez un instantané :

  • Configuration de l'environnement, comme les paramètres de scaling et de performances de l'environnement.
  • Configuration réseau de l'environnement.
  • Contenu du bucket de l'environnement en dehors des dossiers /dags, /data et /plugins.
  • Libellés d'environnement.

Tous les paramètres que vous avez appliqués dans l'infrastructure Cloud Composer sans utiliser l'API Cloud Composer peuvent être perdus lorsque vous chargez un instantané.

À propos des opérations partiellement terminées

Lorsque vous chargez un instantané, l'opération peut aboutir, échouer ou être partiellement terminée :

  • Les opérations réussies chargent toutes les données de l'instantané.
  • Les opérations ayant échoué n'entraînent aucune modification.
  • Les opérations partiellement effectuées chargent un sous-ensemble de données à partir de l'instantané. Ces opérations sont signalées comme ayant échoué, mais le message d'erreur indique les données qui ont été chargées avec succès. Par exemple, si des packages PyPI sont installés, mais que les remplacements d'options de configuration Airflow n'ont pas fonctionné, le message d'erreur l'indique.

Pour une opération partiellement terminée, vous pouvez essayer de charger à nouveau le même instantané. Cloud Composer ignore les étapes qui ont réussi lors de la tentative précédente. Par exemple, si une opération a échoué en raison d'un délai d'attente, mais que la base de données a été chargée avec succès, la tentative suivante ne chargera pas à nouveau la base de données.

Avant de commencer

  • Dans Cloud Composer 1, vous ne pouvez enregistrer que des instantanés, mais pas les charger. Vous pouvez charger des instantanés d'un environnement Cloud Composer 1 vers des environnements Cloud Composer 2.

  • Les instantanés sont compatibles avec Cloud Composer 2 version 2.0.9 et ultérieure. Cloud Composer 1 est compatible avec l'enregistrement des instantanés d'environnement dans les versions 1.18.5 et ultérieures.

  • Les instantanés ne créent pas d'environnement. Si vous souhaitez charger un instantané d'un environnement vers un autre, vous devez d'abord créer un environnement, puis y charger l'instantané.

  • Vous ne pouvez pas charger d'instantanés dans des environnements qui sont en état d'erreur. Il n'est pas possible de corriger ces environnements en chargeant un instantané. Vous pouvez toujours charger un instantané existant dans un nouvel environnement.

  • La taille maximale de la base de données Airflow compatible avec les instantanés est de 20 Go. Si la base de données de votre environnement occupe plus de 20 Go, réduisez la taille de la base de données Airflow avant d'enregistrer un instantané.

  • Le nombre total d'objets dans les dossiers /dags, /plugins et /data du bucket de l'environnement doit être inférieur à 100 000 pour que vous puissiez créer des instantanés.

  • Si vous utilisez le mécanisme XCom pour transférer des fichiers, assurez-vous de l'utiliser conformément aux consignes d'Airflow. Le transfert de fichiers volumineux ou d'un grand nombre de fichiers à l'aide de XCom a un impact sur les performances de la base de données Airflow et peut entraîner des échecs lors du chargement d'instantanés ou de la mise à niveau de votre environnement. Pensez à utiliser des alternatives telles que Cloud Storage pour transférer de grands volumes de données.

  • La longueur maximale du nom d'un objet dans le bucket de l'environnement ne doit pas dépasser 1 024 symboles. Sinon, il est impossible de créer des instantanés.

  • Si vous enregistrez des instantanés dans un emplacement en dehors du bucket de votre environnement, le compte de service de votre environnement doit disposer des autorisations de lecture et d'écriture pour l'emplacement spécifié. Par exemple, le rôle Administrateur des objets de l'espace de stockage dispose de ces autorisations. Vous pouvez l'appliquer à un projet ou à un bucket spécifique.

  • La création et le stockage d'instantanés entraînent des coûts supplémentaires liés à Cloud Storage. Pour en savoir plus, reportez-vous à la page Tarifs.

Enregistrer un instantané d'environnement

Cloud Composer enregistre les instantanés d'environnement dans un sous-dossier, par rapport au dossier que vous spécifiez. Le nom du dossier contient l'ID du projet, l'emplacement de l'environnement, le nom de l'environnement et le code temporel de l'enregistrement de l'instantané. Exemple : /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

Console

Pour créer un instantané de votre environnement :

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

    Accéder à la page Environnements

  2. Dans la liste des environnements, cliquez sur le nom de votre environnement. La page Détails de l'environnement s'ouvre.

  3. Cliquez sur Enregistrer le snapshot.

  4. Dans la boîte de dialogue Enregistrer l'instantané, sélectionnez l'emplacement de stockage de l'instantané :

    • Pour stocker l'instantané dans le dossier /snapshots du bucket de l'environnement, sélectionnez Utiliser le dossier d'instantanés dans le bucket de l'environnement (par défaut).

    • Pour stocker l'instantané dans le dossier personnalisé, sélectionnez Utiliser un dossier personnalisé dans un autre bucket, puis spécifiez un emplacement.

  5. Cliquez sur Enregistrer.

gcloud

La commande gcloud composer environments snapshots save enregistre un instantané de votre environnement.

  • L'argument snapshot-location spécifie un dossier dans lequel l'instantané est enregistré. Par défaut, les instantanés sont enregistrés dans le dossier /snapshots du bucket de votre environnement. Exemple : gs://us-central1-example-916807e1-bucket/snapshots. Vous pouvez également spécifier un autre dossier.

Pour enregistrer un instantané de votre environnement, exécutez la commande suivante :

gcloud composer environments snapshots save \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-location "SNAPSHOTS_FOLDER"

Remplacez :

  • ENVIRONMENT_NAME par le nom de l'environnement.
  • LOCATION par la région dans laquelle se trouve l'environnement.
  • (Facultatif) SNAPSHOTS_FOLDER avec l'URI d'un dossier de bucket dans lequel stocker l'instantané. Si vous omettez cet argument, Cloud Composer enregistre l'instantané dans le dossier /snapshots du bucket de votre environnement.

L'exemple suivant utilise l'emplacement par défaut :

gcloud composer environments snapshots save \
  example-environment \
  --location us-central1

L'exemple suivant enregistre le fichier dans un dossier personnalisé :

gcloud composer environments snapshots save \
  example-environment \
  --location us-central1 \
  --snapshot-location "gs://example-bucket/environment_snapshots"

API

  1. Envoyez une requête API environments.saveSnapshot.

  2. Dans le corps de la requête, dans le champ snapshotLocation, spécifiez le dossier dans lequel vous souhaitez enregistrer l'instantané.

{
  "snapshotLocation": "SNAPSHOTS_FOLDER"
}

Remplacez :

  • SNAPSHOTS_FOLDER par l'URI d'un dossier de bucket dans lequel enregistrer l'instantané.

Exemple :

// POST https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment:saveSnapshot

{
  "snapshotLocation": "gs://us-central1-example-916807e1-bucket/snapshots"
}

Terraform

Il n'est pas possible d'enregistrer ni de charger des instantanés d'environnement à partir de Terraform.

L'enregistrement et le chargement d'instantanés sont des actions effectuées sur un environnement. Les instantanés obtenus ne font pas partie de la définition d'un environnement. Étant donné que Terraform ne gère que la configuration de l'environnement Cloud Composer, vous ne pouvez pas enregistrer ni charger d'instantanés d'environnement à partir de celui-ci.

Charger un instantané d'environnement

Dans Cloud Composer 1, vous ne pouvez enregistrer que des instantanés, mais pas les charger. Vous pouvez charger des instantanés d'un environnement Cloud Composer 1 vers des environnements Cloud Composer 2. Par exemple, lorsque vous migrez vos environnements vers Cloud Composer 2.

Étapes suivantes