Spécifier des intervalles de maintenance

Cloud Composer 1 | Cloud Composer 2

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 à effectuer des opérations de maintenance. Par exemple, vous pouvez vous assurer que les exécutions de vos tâches critiques ne sont pas interrompues en spécifiant des intervalles de maintenance en dehors des heures de planification des DAG.

Les intervalles de maintenance vous permettent de contrôler les périodes de maintenance de votre environnement:

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

  • Si vous ne définissez pas d'intervalles de maintenance personnalisés pour votre environnement, 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 accordez au moins 12 heures par semaine aux opérations de maintenance:

  • Votre environnement reste disponible pendant les intervalles de maintenance. Certains composants de votre environnement peuvent devenir temporairement indisponibles lorsque des opérations de maintenance sont en cours.
  • Ces 12 heures sont nécessaires 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 ou ont même lieu chaque semaine.

Vous pouvez toujours exécuter vos DAG pendant les intervalles de maintenance, à condition qu'il soit acceptable que certaines tâches puissent être interrompues et relancées. Si vous exécutez des DAG pendant des 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.

Dans Cloud Composer 2, les tâches dont l'exécution prend moins de 55 minutes ne sont généralement pas affectées par les opérations de maintenance. Toutefois, elles doivent tout de même activer l'activation des nouvelles tentatives pour résister aux redémarrages du planificateur. Le programmeur peut redémarrer pendant les opérations Composer standards, en dehors des intervalles de maintenance.

Cloud Composer informe les nœuds de calcul Airflow qu'une opération de maintenance est sur le point d'avoir lieu. Un nœud de calcul Airflow termine des tâches déjà lancées et ne sélectionne pas de nouvelles tâches. Ces nouvelles tâches sont exécutées par des nœuds de calcul Airflow qui ne subissent aucune opération de maintenance.

Si vous utilisez un environnement hautement résilient, les composants Airflow de votre environnement sont susceptibles d'être redémarrés à différents moments lors d'une opération de maintenance (en fonction du type d'opération de maintenance). Dans l'ensemble, l'utilisation d'un environnement hautement résilient réduit les temps d'arrêt de votre environnement lors des opérations de maintenance.

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

  • Il est possible que vous ne puissiez pas temporairement modifier certains paramètres de votre environnement ou passer à une version plus récente.

  • Les requêtes SQL directes adressées à la base de données Airflow peuvent prendre plus de temps que d'habitude et nécessiter de nouvelles tentatives.

  • L'interface utilisateur d'Airflow peut être temporairement indisponible

  • Certaines tâches Airflow dont l'exécution prend plus de 55 minutes peuvent être interrompues. Une fois l'opération de maintenance terminée, Airflow planifie de nouvelles tentatives pour ces tâches (si elles ne sont pas configurées autrement).

Intervalles de maintenance par défaut

Par défaut, les intervalles de maintenance s'étendent de 00:00:00 à 04:00:00 (GMT) les vendredis, samedis et dimanches de chaque semaine.

Comment utiliser des intervalles de maintenance

Les opérations de maintenance peuvent avoir une incidence sur l'exécution de vos DAG et de vos 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 section 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 six heures entre 01h00 et 7h00 (UTC) les mercredis, samedis et 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 six heures entre 01h00 et 7h00 (UTC) les mercredis, samedis et dimanches. La date du 1er janvier 2023 est ignorée.

  // 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 de 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 six heures entre 01h00 et 7h00 (UTC) les mercredis, samedis et 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"
    }
  }
}

Étapes suivantes