Spécifier des intervalles de maintenance

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Preview — Cloud Composer 3

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" dans la section "Conditions d'utilisation générales" des Conditions spécifiques au service. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une assistance limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Cette page explique comment définir des intervalles de maintenance pour vos environnements.

À propos des intervalles de maintenance

Un intervalle de maintenance est une période pendant laquelle vous autorisez Cloud Composer pour effectuer des opérations de maintenance. Par exemple, vous pouvez vous assurer que les exécutions de tâches critiques ne sont pas interrompues en spécifiant des intervalles de maintenance en dehors des heures de planification du DAG.

Les intervalles de maintenance vous permettent de contrôler les périodes pendant lesquelles peut avoir lieu pour votre environnement:

• Si vous définissez des intervalles de maintenance personnalisés pour votre environnement, Cloud Composer effectue la maintenance pendant ces périodes définies.

• Si vous ne définissez pas d'intervalles de maintenance personnalisés pour votre environnement ou si vous spécifiez une valeur vide, Cloud Composer effectue la maintenance pendant les intervalles de maintenance par défaut.

Que se passe-t-il pendant les intervalles de maintenance ?

Lorsque vous spécifiez des intervalles de maintenance, vous devez prévoir au moins 12 heures par semaine pour les opérations de maintenance :

• Votre environnement reste disponible pendant les intervalles de maintenance. Certains composants de votre environnement peuvent être temporairement indisponibles lorsque des opérations de maintenance sont en cours.

• Ces 12 heures sont requises pour que Cloud Composer dispose de suffisamment de temps pour planifier et effectuer toutes les opérations de maintenance. Cela ne signifie pas que les opérations de maintenance prennent 12 heures complètes ni même qu'elles ont lieu chaque semaine.

Vous pouvez toujours exécuter vos DAG pendant les intervalles de maintenance, à condition qu'ils acceptable que certaines tâches puissent être interrompues et relancées. Si vous exécutez des DAG pendant les intervalles de maintenance, assurez-vous d'activer la répétition des tentatives de tâches. Vous pouvez configurer les nouvelles tentatives au niveau de la configuration Airflow, du DAG ou de la tâche.

Les opérations de maintenance ont les effets suivants sur votre environnement :

• Il est possible que l'interface utilisateur d'Airflow soit temporairement indisponible.

• Cloud Composer peut effectuer une opération de mise à niveau automatique de l'infrastructure si des mises à niveau sont disponibles.

• La modification de certains paramètres de votre environnement peut être temporairement impossible.

• Certaines tâches Airflow peuvent être interrompues. Après l'opération de maintenance est terminée, Airflow planifie de nouvelles tentatives pour ces tâches (si elles ne sont pas sinon).

Intervalles de maintenance par défaut

Dans Cloud Composer 3, les intervalles de maintenance par défaut sont définis dans les éléments suivants : méthode:

• Toutes les heures sont exprimées dans le fuseau horaire local de la région dans laquelle se trouve votre environnement localisé, mais le passage à l'heure d'été est ignoré.
• Les intervalles de maintenance les mardi, mercredi, jeudi et vendredi sont compris entre 00:00:00 et 02:00:00.
• Les intervalles de maintenance sont compris entre 00:00:00 et 04:00:00 le samedi, le dimanche et le lundi.

Comment utiliser des intervalles de maintenance

Les opérations de maintenance peuvent avoir un impact sur l'exécution de vos DAG et des tâches Airflow. Nous vous recommandons donc de procéder comme suit :

1. Définissez des intervalles de maintenance pour vos environnements Cloud Composer.

2. Programmez les exécutions de DAG en dehors des intervalles de maintenance spécifiés en utilisant les paramètres start_date et schedule_interval dans vos DAG.

Spécifier des intervalles de maintenance pour les nouveaux environnements

Vous pouvez spécifier des intervalles de maintenance lorsque vous créez un environnement. Pour en savoir plus, consultez la page Créer des environnements.

Spécifier des intervalles de maintenance pour les environnements existants

Console

Pour définir ou modifier des intervalles de maintenance pour un environnement existant, mettez à jour l'environnement :

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

   Accéder à la page Environnements

2. Sélectionnez votre environnement.

3. Accédez à l'onglet Configuration de l'environnement.

4. À côté de l'entrée Intervalles de maintenance, cliquez sur Modifier.

5. Dans la boîte de dialogue Intervalles de maintenance, cochez la case Définir une heure personnalisée pour les intervalles de maintenance.

6. Définissez l'heure de début, le fuseau horaire, les jours et la durée de manière à obtenir une planification équivalant au minimum à 12 heures sur une période glissante de sept jours. Par exemple, une périodicité de 4 heures tous les lundis, mercredis et vendredis fournit bien la durée requise.

7. Cliquez sur Enregistrer et attendez la mise à jour de votre environnement.

gcloud

Lorsque vous mettez à jour un environnement, les arguments suivants définissent les paramètres des intervalles de maintenance :

• --maintenance-window-start définit l'heure de début d'un intervalle de maintenance.
• --maintenance-window-end définit l'heure de fin d'un intervalle de maintenance.
• --maintenance-window-recurrence définit la récurrence de l'intervalle de maintenance.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --maintenance-window-start 'DATETIME_START' \
    --maintenance-window-end 'DATETIME_END' \
    --maintenance-window-recurrence 'MAINTENANCE_RECURRENCE'

Remplacez :

• ENVIRONMENT_NAME par le nom de l'environnement.
• DATETIME_START par la date et l'heure de début au format "date/heure". Seule l'heure spécifiée est utilisée, la date est ignorée.
• DATETIME_END par la date et l'heure de fin au format "date/heure". Seule l'heure spécifiée est utilisée, la date est ignorée. La date et l'heure spécifiées doivent être postérieures à la date de début.

• MAINTENANCE_RECURRENCE par une expression RRULE RFC 5545 pour la récurrence des intervalles de maintenance. Cloud Composer est compatible avec deux formats :

• Le format FREQ=DAILY indique une récurrence quotidienne.

• Le format FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA indique une récurrence les jours sélectionnés de la semaine.

L'exemple suivant spécifie un intervalle de maintenance de 6 heures entre 01:00 à 7h (UTC) les mercredis, les samedis et les dimanches La date du 1er janvier 2023 est ignorée.

gcloud composer environments update example-environment \
  --location us-central1 \
  --maintenance-window-start '2023-01-01T01:00:00Z' \
  --maintenance-window-end '2023-01-01T07:00:00Z' \
  --maintenance-window-recurrence 'FREQ=WEEKLY;BYDAY=SU,WE,SA'

API

1. Rédigez une requête API environments.patch.

2. Dans cette requête :

   1. Dans le paramètre updateMask, spécifiez le masque config.maintenanceWindow.

   2. Dans le corps de la requête, spécifiez les paramètres des intervalles de maintenance.

{
  "config": {
    "maintenanceWindow": {
      "startTime": "DATETIME_START",
      "endTime": "DATETIME_END",
      "recurrence": "MAINTENANCE_RECURRENCE"
    }
  }
}

Remplacez :

• DATETIME_START par la date et l'heure de début au format "date/heure". Seule l'heure spécifiée est utilisée, la date est ignorée.
• DATETIME_END par la date et l'heure de fin au format "date/heure". Seule l'heure spécifiée est utilisée, la date est ignorée. La date et l'heure spécifiées doivent être postérieures à la date de début.

• MAINTENANCE_RECURRENCE par une expression RRULE RFC 5545 pour la récurrence des intervalles de maintenance. Cloud Composer est compatible avec deux formats :

  • Le format FREQ=DAILY indique une récurrence quotidienne.
  • Le format FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA indique une récurrence les jours sélectionnés de la semaine.

L'exemple suivant spécifie un intervalle de maintenance de 6 heures entre 01:00 à 7h (UTC) les mercredis, les samedis et les dimanches Le 1er janvier 2023 est ignoré.

  // PATCH https://composer.googleapis.com/v1/projects/example-project/
  // locations/us-central1/environments/example-environment?updateMask=
  // config.maintenanceWindow

  {
    "config": {
      "maintenanceWindow": {
        "startTime": "2023-01-01T01:00:00Z",
        "endTime": "2023-01-01T07:00:00Z",
        "recurrence": "FREQ=WEEKLY;BYDAY=SU,WE,SA"
      }
    }
  }

Terraform

Le bloc maintenance_window spécifie les intervalles de maintenance pour votre environnement :

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {
    maintenance_window {
      start_time = "DATETIME_START"
      end_time = "DATETIME_END"
      recurrence = "MAINTENANCE_RECURRENCE"
    }
  }
}

Remplacez :

• ENVIRONMENT_NAME par le nom de l'environnement.
• LOCATION par la région dans laquelle se trouve l'environnement.
• DATETIME_START par la date et l'heure de début au format "date/heure". Seule l'heure spécifiée est utilisée, la date est ignorée.
• DATETIME_END par la date et l'heure de fin au format "date/heure". Seule l'heure spécifiée est utilisée, la date est ignorée. La date et l'heure spécifiées doivent être postérieures à la date de début.

• MAINTENANCE_RECURRENCE par une expression RRULE RFC 5545 pour la récurrence des intervalles de maintenance. Cloud Composer est compatible avec deux formats :

  • Le format FREQ=DAILY indique une récurrence quotidienne.
  • Le format FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA indique une récurrence les jours sélectionnés de la semaine.

L'exemple suivant spécifie un intervalle de maintenance de 6 heures entre 01:00 à 7h (UTC) les mercredis, les samedis et les dimanches La date du 1er janvier 2023 est ignorée.

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {
    maintenance_window {
      start_time = "2023-01-01T01:00:00Z"
      end_time = "2023-01-01T07:00:00Z"
      recurrence = "FREQ=WEEKLY;BYDAY=SU,WE,SA"
    }
  }
}

Étape suivante

• Créer des environnements
• Mettre à jour des environnements
• Nettoyer la base de données Airflow