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 la page Configurer des instantanés programmé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:

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

• Effectuez des mises à niveau et des environnements de copie côte à côte. Créez un instantané d'un environnement existant, créez un environnement qui utilise la même version ou une version ultérieure de Cloud Composer, 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é, afin d'é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 décrivant l'état de votre environnement et stocke 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émentiels. Vous pouvez utiliser n'importe quel instantané indépendamment des autres instantanés.

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 aussi spécifier un emplacement personnalisé lorsque vous créez un instantané.

Alors que l'interface utilisateur de Cloud Storage affiche les données sous forme de dossiers pour plus de commodité, les buckets fonctionnent dans une structure de fichiers plats. Cela ne change pas votre manière d'enregistrer et de charger 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.

Remarques concernant la sécurité des instantanés

Avertissement :La clé Fernet de votre environnement est stockée avec la sauvegarde de la base de données Airflow. Cela signifie que les informations sensibles, telles que les extras de connexion et les mots de passe Airflow, peuvent être déchiffrées à partir d'un instantané d'environnement.

Pour réduire ce risque de sécurité, vous pouvez stocker des informations sensibles utilisées par les DAG Airflow, telles que des clés ou des mots de passe, dans Secret Manager. Pour en savoir plus, consultez la page Configurer 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 compte de service de cet 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, 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 du DAG.
• Une sauvegarde des dossiers /dags, /data et /plugins à partir du bucket de l'environnement.
• Clé Fernet de l'environnement.
• Autres informations sur la configuration de l'environnement, telles que son échelle et ses paramètres de performances. Cloud Composer n'utilise pas ces informations lors du chargement 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).

  Attention :Cloud Composer installe les packages tels qu'ils sont spécifiés dans les exigences. Par exemple, si un instantané nécessite example_package>=1.0, une version différente du package peut être installée lorsque vous chargez l'instantané.

• Contenu de la base de données Airflow, y compris les états des tâches exécutées et l'historique des exécutions du 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é permet de 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, celles-ci ne sont pas utilisées lors du chargement d'instantanés. Les paramètres suivants de votre environnement ne changent pas lorsque vous chargez un instantané:

• Configuration de l'environnement, par exemple son évolutivité et ses paramètres de performances
• Configuration réseau de l'environnement.
• Contenu du bucket de l'environnement en dehors des dossiers /dags, /data et /plugins.
• Étiquettes 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 lors du chargement d'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ée:

• 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 quelles données ont été chargées avec succès. Par exemple, si les packages PyPI sont installés, mais que les remplacements de l'option de configuration Airflow n'ont pas abouti, le message d'erreur l'indique.

Pour une opération partiellement terminée, vous pouvez réessayer de charger 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 échoue pendant un certain délai, mais que la base de données a bien été chargée, la base de données ne sera pas chargée à nouveau lors de la tentative suivante.

Avant de commencer

• 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 des 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é depuis un environnement vers un autre environnement, vous devez d'abord créer un environnement, puis y charger l'instantané.

• Vous ne pouvez pas charger d'instantanés dans des environnements à l'é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.

• 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é depuis Cloud Composer 2.0.2 dans un environnement avec Cloud Composer 2.0.1. Autre exemple : vous ne pouvez pas charger un instantané depuis 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 rétablit pas 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 prend plus de 20 Go, réduisez la taille de la base de données Airflow avant d'enregistrer un instantané.

• 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 extérieur au 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 à Cloud Storage. Pour en savoir plus, reportez-vous à la section Tarification.

Enregistrer un instantané d'environnement

Cloud Composer enregistre les instantanés d'environnement dans un sous-dossier relatif au dossier que vous spécifiez. Le nom du dossier contient l'ID du projet, l'emplacement et le nom de l'environnement, ainsi que l'horodatage 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 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 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 le 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 le 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 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 dans laquelle se trouve l'environnement.
• (Facultatif) SNAPSHOTS_FOLDER par 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 dans un environnement. Les instantanés qui en résultent ne font donc pas partie de la définition d'un environnement. Étant donné que Terraform gère uniquement 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

Avertissement :Une fois que vous avez chargé un instantané, l'historique d'exécution du DAG est restauré à l'état de l'instantané. Cela peut entraîner des exécutions de DAG en double.

Prenons la situation suivante. Par exemple, la fonctionnalité catch-up est activée, et Airflow exécute un DAG selon une programmation entre la date de création de l'instantané et celle de son chargement. Dans ce cas, une fois l'instantané chargé, Airflow ne dispose d'aucune information sur l'exécution du DAG qui s'est produite. Airflow exécute donc à nouveau le DAG en même temps et avec les mêmes données.

Prenons un autre exemple avec un DAG exécuté selon une programmation quotidienne. Vous prenez un instantané, puis Airflow exécute ce DAG. Ensuite, vous chargez l'instantané le même jour. Dans ce cas, Airflow réexécute le DAG, même si le rattrapage est désactivé.

Console

Pour charger un instantané dans votre environnement Cloud Composer 2, procédez comme suit:

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 l'instantané.

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

5. Sélectionnez un dossier dans lequel stocker l'instantané. Le nom du dossier indique l'ID de votre projet, l'emplacement de l'environnement et le code temporel correspondant à l'enregistrement 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 Skip PyPI packages installation (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 Charger et attendez que Cloud Composer charge l'instantané.

gcloud

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

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

  Le nom du dossier indique l'ID de votre projet, l'emplacement de l'environnement et le code temporel correspondant à l'enregistrement 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 beta 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 dans laquelle se trouve l'environnement.
• SNAPSHOT_PATH par l'URI d'un bucket, suivi du chemin d'accès à l'instantané.

Exemple :

gcloud beta 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'enregistrement 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, spécifiez si Cloud Composer doit ignorer l'installation de packages PyPI personnalisés à partir de l'instantané dans le champ skipPypiPackagesInstallation. 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 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/v1beta1/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 ni de charger des instantanés d'environnement à l'aide de Terraform.

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

Étapes suivantes

• Configurer des instantanés programmés
• Créer des environnements
• Contrôle des accès