Planifier une fenêtre de maintenance
Une fenêtre de maintenance couvre une période pendant laquelle les ressources risquent de mal fonctionner : une nuit de correctifs, un test de basculement, une migration. Pendant la fenêtre, Excubius continue de surveiller et d'enregistrer, mais il ne notifie personne. Ce guide présente les trois façons d'en créer une, depuis la console et depuis l'API.
Avant de commencer
- Vous devez disposer du rôle Operator ou d'un rôle supérieur sur l'entité. Les lecteurs peuvent voir les fenêtres, mais pas les créer.
- Décidez de la portée : une entité entière (tout ce qu'elle contient et tout ce qui se trouve en dessous) ou certaines ressources (et tout ce qui est découvert sous elles, comme les groupes de disponibilité et les bases de données d'une instance).
Choisir comment démarrer
| Besoin | À utiliser |
|---|---|
| Les travaux commencent maintenant | Start maintenance now : de 1 minute à 7 jours |
| Une nuit planifiée | Schedule a window › Once : début et fin à l'heure de votre navigateur, jusqu'à un an de durée |
| Un créneau récurrent | Schedule a window › Every week : jours de la semaine, heure locale de début, durée et fuseau horaire |
Planifier une fenêtre hebdomadaire
- Ouvrez Settings › Maintenance windows et choisissez l'entité dans le sélecteur, par exemple Combray SA › Production.
- Sélectionnez Schedule a window.
- Saisissez la Reason. Elle est interne : elle apparaît dans la console, dans les chronologies des alertes et dans le journal d'audit, jamais sur la page d'état.
- Choisissez Every week.
- Sélectionnez les Days, la Local start time, la Duration (minutes) et le Time zone, par exemple le samedi à 23:00 pendant 180 minutes dans
America/Santo_Domingo. - Sous Covers, conservez All of Production, qui porte le nom de l'entité que vous avez choisie, ou choisissez Only some resources et sélectionnez-les.
- Si vous le souhaitez, sélectionnez Announce on the status page et renseignez un Public title et une Public description. Seuls ces deux textes sont publiés.
- Sélectionnez Save window. La fenêtre apparaît sous Next 14 days.
Pour une fenêtre ponctuelle, choisissez Once à l'étape 4 et indiquez quand elle commence (Starts) et quand elle se termine (Ends), à l'heure de votre navigateur.
Démarrer une maintenance immédiatement
- Ouvrez Settings › Maintenance windows et choisissez l'entité.
- Sous Start maintenance now, saisissez For (minutes) et la Reason, par exemple 45 minutes et Correctifs sur sql-ventas-02 (changement CHG-2231).
- Sous Covers, conservez l'entité entière, par exemple All of Production, ou choisissez Only some resources et sélectionnez-les.
- Sélectionnez Start now.
La fenêtre apparaît sous Active now avec son heure de fin. Si les travaux se terminent plus tôt, sélectionnez End now sur la fenêtre.
Ce que couvre une fenêtre
| Portée | Couvre |
|---|---|
| L'entité | Toutes les ressources de l'entité et de chaque entité située en dessous, selon l'arborescence à chaque instant : les ressources ajoutées plus tard à la branche ou déplacées dans celle-ci sont également couvertes |
| Certaines ressources | Les ressources choisies, de l'entité ou en dessous, et tout ce qui est découvert sous elles : les groupes de disponibilité, les bases de données et les serveurs liés d'une instance |
Une alerte levée sur une instance au sujet de l'une de ses bases de données ou de l'un de ses serveurs liés est couverte lorsque cet enfant est couvert. Une fenêtre sur une seule base de données supprime les notifications des alertes de cette base, pas celles du reste de l'instance.
Ce qui se passe pendant la fenêtre
- Les ressources couvertes affichent l'état En maintenance au lieu de leur état de santé, sur les cartes des tableaux de bord, dans les listes de ressources et sur la page de la ressource.
- Les vérifications continuent de s'exécuter et les métriques continuent d'être stockées ; l'historique reste donc complet et l'état réel réapparaît dès la fin de la fenêtre.
- Une alerte qui s'ouvre est marquée avec la fenêtre et rien n'est envoyé. Sa chronologie indique qu'elle s'est ouverte pendant la maintenance.
- Une alerte qui disparaît avant la fin est résolue silencieusement, puisque rien n'a été annoncé.
- Une alerte encore ouverte à la fin de la fenêtre est annoncée à ce moment-là, comme si elle venait de s'ouvrir, selon le routage habituel, la période de silence et les mises en sourdine.
- La chronologie de la ressource enregistre le début et la fin de chaque fenêtre, et si quelqu'un y a mis fin plus tôt.
Une fenêtre de maintenance n'est pas une mise en sourdine. Une mise en sourdine fait taire une alerte existante pendant un moment ; une fenêtre supprime les notifications de tout ce qui concerne un ensemble de ressources pendant une période, y compris les alertes qui n'existent pas encore.
Fenêtres hebdomadaires et heure d'été
- Lorsque les horloges avancent, une heure de début qui n'existe pas commence juste après le saut.
- Lorsque les horloges reculent, une heure de début qui survient deux fois utilise la première.
- La durée est un temps écoulé ; une fenêtre qui chevauche un changement d'heure se termine donc une heure plus tôt ou plus tard à l'horloge murale.
- Une fenêtre peut franchir minuit ou la fin de la semaine : le dimanche à 23:00 pendant trois heures, elle se termine le lundi à 02:00. Une occurrence dure jusqu'à une semaine.
- End now sur une fenêtre hebdomadaire interrompt uniquement l'occurrence en cours ; les suivantes ont lieu comme prévu. La modification de la planification annule cette interruption.
Modifier ou supprimer une fenêtre
All windows répertorie les fenêtres propres à l'entité, celles des entités situées en dessous et celles héritées de ses ancêtres, marquées From suivi du nom de l'entité. Chacune dispose d'actions de modification et de suppression.
La suppression d'une fenêtre active y met d'abord fin, et sa chronologie conserve le début et la fin. Les alertes qu'elle avait marquées conservent leur entrée de chronologie, mais perdent le lien vers la fenêtre supprimée.
Rôles et audit
| Action | Rôle sur l'entité de la fenêtre |
|---|---|
| Voir les fenêtres, actives et à venir | Viewer |
| Créer, démarrer, modifier, terminer ou supprimer | Operator |
Chaque modification est consignée dans le journal d'audit : maintenance.create, maintenance.start_now, maintenance.update, maintenance.end et maintenance.delete.
Depuis l'API
$BASE vaut https://<your server>/api/v1 et $TOKEN est votre jeton d'accès ; consultez Démarrage rapide : ajouter une instance SQL Server avec l'API.
# a two-hour weekly slot for the whole Production branch
curl -sS -X POST "$BASE/maintenance-windows" -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' -d '{
"entity_id": "'"$PROD"'", "kind": "weekly", "reason": "Weekly index maintenance",
"weekly": {"days": ["sun"], "start_time": "02:00", "duration_minutes": 120,
"timezone": "America/Santo_Domingo"}}'
# sql-ventas-02 is being patched now, for 45 minutes
curl -sS -X POST "$BASE/maintenance-windows/now" -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' -d '{
"entity_id": "'"$PROD"'", "resource_ids": ["'"$SQL02"'"], "minutes": 45,
"reason": "Patching sql-ventas-02 (change CHG-2231)"}'
# done early
curl -sS -X POST "$BASE/maintenance-windows/$WINDOW/end" -H "Authorization: Bearer $TOKEN"
| Requête | Objet |
|---|---|
GET /maintenance-windows?entity={id} | Les fenêtres d'une entité, avec celles situées en dessous et celles héritées ; filtrez avec state=active,scheduled,ended |
GET /maintenance-windows/active et /upcoming | Ce qui est en maintenance maintenant, et ce qui vient ensuite |
POST /maintenance-windows | Créer une fenêtre : kind vaut once (avec starts_at et ends_at) ou weekly (avec weekly) ; scope vaut entity ou resources (avec resource_ids) |
POST /maintenance-windows/now | En démarrer une immédiatement pour minutes, sur l'entité ou sur resource_ids |
PATCH /maintenance-windows/{id} | Modifier n'importe quel champ |
POST /maintenance-windows/{id}/end | Terminer immédiatement l'occurrence active |
DELETE /maintenance-windows/{id} | Supprimer une fenêtre ; une fenêtre active est d'abord terminée |
Pour annoncer une fenêtre sur la page d'état, ajoutez "public": true avec public_title et, si vous le souhaitez, public_description. Une fenêtre hebdomadaire peut être bornée avec starts_at et ends_at, facultatifs : seules comptent les occurrences qui commencent entre ces deux bornes. Une fenêtre ponctuelle peut consigner avec timezone le fuseau horaire dans lequel elle a été planifiée.
Contenu connexe
- Confirmer et traiter une alerte
- Entités, étiquettes et héritage : les fenêtres définies sur une entité couvrent tout ce qui se trouve en dessous
- Configurer la page d'état publique