Enregistrer et charger des instantanés d'environnement

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

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 les 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 :

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 des données de l'environnement.

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

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

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

Alors que l'UI de Cloud Storage affiche les données sous forme de dossiers pour plus de commodité, fonctionnent dans une structure de fichier plat. Cela ne change pas votre façon de travailler sur l'enregistrement des instantanés dans la console Google Cloud. Gardez cela à l'esprit effectuer des opérations directement sur les fichiers de votre bucket. Pour plus d'informations, Voir la section Espace de noms des objets.

Remarques concernant la sécurité des instantanés

Pour réduire ce risque de sécurité, vous pouvez stocker des informations sensibles utilisées par les DAG Airflow, tels que les clés ou les mots de passe, Secret Manager. Pour en savoir plus, consultez Configurez Secret Manager pour votre environnement.

Vérifiez 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 correspondantes sont correctement configurées dans votre projet. Lorsque vous attribuez des autorisations, assurez-vous que le service dispose des autorisations nécessaires 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, selon les 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 à partir de 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 des instantanés

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

  • Remplacements de configuration Airflow.
  • Variables d'environnement

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

  • Contenu des dossiers /dags, /data et /plugins de l'instantané sont chargées dans le bucket de l'environnement.

  • La clé Fernet de l'instantané permet de rechiffrer les données de l'instantané avec la clé Fernet de l'environnement. La clé fernet du reste inchangé.

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 de /dags, /data et /plugins dossiers.
  • Étiquettes d'environnement.

Tous les paramètres que vous avez appliqués à l'infrastructure Cloud Composer sans utiliser l'API Cloud Composer peut être perdu lors du chargement d'un un instantané.

À propos des opérations partiellement terminées

Lorsque vous chargez un instantané, l'opération peut être réussie, échouée ou partiellement terminé:

  • Les opérations réussies chargent toutes les données de l'instantané.
  • Les opérations ayant échoué n'apportent 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

  • 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 Cloud Composer 2 ; de l'infrastructure.

  • Les instantanés sont compatibles avec Cloud Composer 2 version 2.0.9 et versions ultérieures. Cloud Composer 1 est compatible avec l'enregistrement d'instantanés d'environnement pour 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 à l'é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 ou une version ultérieure de Cloud Composer ou d'Airflow. Par exemple, vous ne pouvez pas charger un instantané de Cloud Composer 2.0.2 dans un environnement avec Cloud Composer 2.0.1. Par exemple, vous ne pouvez pas charger un instantané d'Airflow 2.2.3 vers Airflow 2.1.4.

  • Les instantanés ne modifient pas la version de Cloud Composer. Si vous mettez à niveau votre environnement vers une version ultérieure de Cloud Composer, puis que vous chargez un instantané à partir d'une version antérieure, votre environnement conserve sa version actuelle de Cloud Composer. Par exemple, le chargement d'un instantané depuis Cloud Composer 2.0.1 vers Cloud Composer 2.0.2 ne permet pas rétablir l'environnement vers Cloud Composer 2.0.1.

  • 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 dans le bucket de l'environnement doit être inférieur à 100 000 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][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. Envisagez d'utiliser des alternatives telles que que Cloud Storage pour transférer d'importants 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, vous ne pourrez pas créer d'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 d'autorisations de lecture et d'écriture pour l'emplacement spécifié. Par exemple, Le rôle Administrateur des objets Storage 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 dans Cloud Storage. Pour en savoir plus, reportez-vous à la section Tarification.

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 l'instantané, sélectionnez l'emplacement où stocker l'instantané:

    • Pour stocker l'instantané dans le dossier /snapshots de l'environnement sélectionnez Utiliser le dossier des instantanés dans le bucket d'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 beta 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 de votre bucket de l'environnement. Exemple : gs://us-central1-example-916807e1-bucket/snapshots. Vous pouvez également spécifier n'importe quel autre dossier.

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

gcloud beta 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 beta composer environments snapshots save \
  example-environment \
  --location us-central1

L'exemple suivant est enregistré dans un dossier personnalisé:

gcloud beta 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/v1beta1/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 depuis Terraform.

L'enregistrement et le chargement d'instantanés sont des actions effectuées au niveau d'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

Dans Cloud Composer 1, vous pouvez uniquement enregistrer 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.

Étape suivante