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 enregistrer automatiquement des instantanés. Pour en savoir plus, consultez Configurer des instantanés 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:

  • Rétablir l'environnement à un état antérieur. Créez des sauvegardes de votre environnement à l'aide d'instantanés, puis chargez l'un d'eux pour restaurer votre environnement. Par exemple, vous pouvez annuler une opération de mise à jour qui installe des packages PyPI ou remplace des options de configuration Airflow, même après la mise à jour de votre environnement.

  • Effectuez des mises à niveau côte à côte et copiez des environnements. Créez un instantané d'un environnement existant, créez un environnement qui utilise la même version de Cloud Composer ou une version ultérieure, puis appliquez l'instantané à ce nouvel environnement. Cette procédure est semblable à la migration. Veillez à mettre en pause les DAG avant de créer l'instantané pour éviter les exécutions de DAG en double.

Comment les instantanés sont-ils stockés ?

Un instantané d'environnement est un ensemble de fichiers qui décrivent l'état de votre environnement et stockent la sauvegarde de ses données.

Vous pouvez créer plusieurs instantanés de votre environnement. Les instantanés d'environnement ne sont pas incrémentiels. 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 de Cloud Storage affiche les données sous forme de dossiers pour plus de commodité, les buckets fonctionnent selon 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 la section Espace de noms des objets.

Considérations liées à la sécurité des instantanés

Pour atténuer 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 la section Configurer Secret Manager pour votre environnement.

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

Données enregistrées dans les instantanés

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

  • Remplacements de configuration Airflow.
  • Variables d'environnement
  • Liste des packages PyPI personnalisés, en tant qu'exigences.
  • Une 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, telles que les paramètres d'évolutivité et de performances de l'environnement. Cloud Composer n'utilise pas ces informations lorsqu'il charge des instantanés.

Quelles données sont chargées à partir d'instantanés ?

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

  • Remplacements de configuration Airflow.
  • Variables d'environnement

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

  • 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 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 des 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, tels que 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 réussir, é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 terminé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 paquets PyPI sont installés, mais que les forçages d'options de configuration Airflow ont échoué, 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 bien été effectuées lors de la tentative précédente. Par exemple, si une opération a échoué en raison d'un délai avant expiration, mais que la base de données a bien été chargée, la tentative suivante ne la charge pas à nouveau.

Avant de commencer

  • Les instantanés sont compatibles avec Cloud Composer 2 version 2.0.9 et ultérieure. Cloud Composer 1 permet d'enregistrer 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 est impossible de corriger ces environnements en chargeant un instantané. Vous pouvez toujours charger un instantané existant dans un nouvel environnement.

  • Vous ne pouvez charger des instantanés que dans la même version d'Airflow ou une version ultérieure. Par exemple, vous ne pouvez pas charger un instantané d'Airflow 2.9.3 vers Airflow 2.7.3.

  • Vous pouvez charger un instantané à partir d'une version ultérieure d'Airflow de la même version d'Airflow dans un environnement avec une version antérieure. Par exemple, vous pouvez charger airflow-2.9.3-build.6 dans airflow-2.9.3-build.5. Nous vous recommandons de ne charger des instantanés dans des versions antérieures que si cela est nécessaire.

  • 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 sa taille avant d'enregistrer un instantané.

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

  • Si vous utilisez le mécanisme XCom pour transférer des fichiers, assurez-vous de l'[utiliser conformément aux consignes d'Airflow][ext-airflow-xcom-backend]. 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 solutions 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, les instantanés ne peuvent pas être créé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 d'autorisations de lecture et d'écriture pour l'emplacement spécifié. Par exemple, le rôle Storage Object Admin (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 de l'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'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 l'instantané.

  4. Dans la boîte de dialogue Enregistrer un instantané, sélectionnez l'emplacement où stocker l'instantané:

    • Pour stocker l'instantané dans le dossier /snapshots du bucket de l'environnement, sélectionnez Utiliser le dossier d'instantané 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 où 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 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 et 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, et les instantanés qui en résultent ne font pas partie de la définition d'un environnement. Comme 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

Prenons la situation suivante. Par exemple, la mise à jour est activée et Airflow exécute un DAG selon un calendrier entre le moment où l'instantané a été créé et le moment où il a été chargé. Dans ce cas, après avoir chargé l'instantané, Airflow ne dispose d'aucune information sur l'exécution du DAG qui s'est produite. Il exécute donc à nouveau le DAG pour la même heure et les mêmes données.

Prenons un autre exemple : un DAG qui s'exécute selon un calendrier quotidien. Vous prenez un instantané, puis Airflow exécute ce DAG, puis vous chargez l'instantané le même jour. Dans ce cas, Airflow exécute à nouveau le DAG, même si la mise à jour est désactivée.

Console

Pour charger un instantané dans 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 Charger un instantané.

  4. Dans la boîte de dialogue Charger un instantané, cliquez sur Parcourir.

  5. Sélectionnez un dossier qui stocke l'instantané. Le nom du dossier indique l'ID de votre projet, l'emplacement de l'environnement et l'horodatage de l'instantané. Par exemple, /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

  6. (Facultatif) Pour ignorer l'installation des packages PyPI personnalisés à partir de l'instantané, sélectionnez Ignorer l'installation des packages PyPI. Si vous chargez un instantané d'un environnement avec des packages PyPI personnalisés installés, Cloud Composer n'installe pas ces packages personnalisés.

  7. Cliquez sur Load (Charger) et attendez que Cloud Composer charge l'instantané.

gcloud

La commande gcloud composer environments snapshots load charge un instantané dans votre environnement.

  • L'argument --snapshot-path spécifie un dossier dans lequel se trouve l'instantané.

    Le nom du dossier indique l'ID de votre projet, l'emplacement de l'environnement et l'horodatage de l'instantané. Par exemple, gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

  • (Facultatif) L'argument --skip-pypi-packages-installation ignore l'installation des packages PyPI personnalisés à partir de l'instantané. Si vous chargez un instantané d'un environnement avec des packages PyPI personnalisés installés, Cloud Composer n'installe pas ces packages personnalisés.

gcloud composer environments snapshots load \
  DESTINATION_ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-path "SNAPSHOT_PATH"

Remplacez :

  • DESTINATION_ENVIRONMENT_NAME par le nom de l'environnement dans lequel vous souhaitez charger l'instantané.
  • LOCATION par la région où se trouve l'environnement.
  • SNAPSHOT_PATH par l'URI d'un bucket, suivi du chemin d'accès à l'instantané.

Exemple :

gcloud composer environments snapshots load \
  example-environment \
  --location us-central1 \
  --snapshot-path "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00"

API

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

  2. Dans le corps de la requête, dans le champ snapshotPath, spécifiez l'URI d'un bucket, suivi du chemin d'accès à l'instantané. Le nom du dossier indique l'ID de votre projet, l'emplacement de l'environnement et l'horodatage de l'instantané. Exemple : gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

  3. (Facultatif) Dans le corps de la requête, dans le champ skipPypiPackagesInstallation, indiquez si Cloud Composer doit ignorer l'installation des packages PyPI personnalisés à partir de l'instantané. Si vous chargez un instantané d'un environnement avec des packages PyPI personnalisés installés, Cloud Composer n'installe pas ces packages personnalisés.

    Ce champ est facultatif. Si vous omettez de renseigner ce champ, Cloud Composer installe les packages PyPI à partir de l'instantané.

{
  "snapshotPath": "SNAPSHOT_PATH"
}

Remplacez :

  • SNAPSHOT_PATH par l'URI d'un dossier de bucket dans lequel stocker l'instantané.

Exemple :

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

{
  "snapshotPath": "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00",
  "skipPypiPackagesInstallation": "False"
}

Terraform

Il n'est pas possible d'enregistrer et de charger des instantanés d'environnement à l'aide de Terraform.

L'enregistrement et le chargement d'instantanés sont des actions effectuées sur un environnement, et les instantanés qui en résultent ne font pas partie de la définition d'un environnement. Comme 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.

Étape suivante