Planificar una ventana de mantenimiento
Una ventana de mantenimiento cubre un periodo en el que se espera que los recursos se comporten mal: una noche de parches, una prueba de conmutación por error, una migración. Durante la ventana, Excubius sigue vigilando y registrando, pero no notifica a nadie. Esta guía muestra las tres formas de crear una, desde la consola y desde la API.
Antes de empezar
- Necesitas el rol Operador o uno superior en la entidad. Los lectores pueden ver las ventanas, pero no crearlas.
- Decide el alcance: una entidad completa (todo lo que contiene y lo que está debajo) o algunos recursos (y todo lo descubierto debajo de ellos, como los grupos de disponibilidad y las bases de datos de una instancia).
Elegir cómo empezar
| Necesidad | Usa |
|---|---|
| El trabajo empieza ahora mismo | Iniciar un mantenimiento ahora: de 1 minuto a 7 días |
| Una noche planificada | Programar una ventana › Una vez: inicio y fin en la hora de tu navegador, hasta un año de duración |
| Un horario fijo | Programar una ventana › Cada semana: días de la semana, hora local de inicio, duración y zona horaria |
Programar una ventana semanal
- Abre Configuración › Ventanas de mantenimiento y elige la entidad en el selector, por ejemplo Ciguapa Inc. › Producción.
- Selecciona Programar una ventana.
- Escribe el Motivo. Es interno: aparece en la consola, en las cronologías de las alertas y en el registro de auditoría, nunca en la página de estado.
- Elige Cada semana.
- Elige los Días, la Hora local de inicio, la Duración (minutos) y la Zona horaria, por ejemplo el sábado a las 23:00 durante 180 minutos en
America/Santo_Domingo. - En Cubre, deja Todo Producción, que nombra la entidad que elegiste, o elige Solo algunos recursos y selecciónalos.
- Si quieres, selecciona Anunciar en la página de estado y escribe un Título público y una Descripción pública. Solo se publican esos dos textos.
- Selecciona Guardar la ventana. La ventana aparece en Próximos 14 días.
Para una ventana puntual, elige Una vez en el paso 4 y escribe cuándo Empieza y Termina, en la hora de tu navegador.
Iniciar un mantenimiento ahora
- Abre Configuración › Ventanas de mantenimiento y elige la entidad.
- En Iniciar un mantenimiento ahora, escribe Durante (minutos) y el Motivo, por ejemplo 45 minutos y Parches en sql-ventas-02 (cambio CHG-2231).
- En Cubre, deja la entidad completa, por ejemplo Todo Producción, o elige Solo algunos recursos y selecciónalos.
- Selecciona Iniciar ahora.
La ventana aparece en Activas ahora con su hora de fin. Cuando el trabajo termine antes, selecciona Terminar ahora en ella.
Qué cubre una ventana
| Alcance | Cubre |
|---|---|
| La entidad | Todos los recursos de la entidad y de todas las entidades que están debajo, tal como esté el árbol en cada momento: también se cubren los recursos que se agreguen o se muevan a la rama más adelante |
| Algunos recursos | Los recursos elegidos, de la entidad o de las que están debajo, y todo lo descubierto debajo de ellos: los grupos de disponibilidad, las bases de datos y los servidores vinculados de una instancia |
Una alerta generada en una instancia sobre una de sus bases de datos o servidores vinculados queda cubierta cuando ese hijo está cubierto. Una ventana en una base de datos silencia las alertas de esa base de datos y no las del resto de la instancia.
Qué ocurre durante la ventana
- Los recursos cubiertos muestran el estado En mantenimiento en lugar de su estado de salud, en las tarjetas del tablero, en las listas de recursos y en la página del recurso.
- Las comprobaciones siguen ejecutándose y las métricas se siguen guardando, así que el historial queda completo y el estado real vuelve en el momento en que termina la ventana.
- Una alerta que se abre se marca con la ventana y no se envía nada. Su cronología indica que se abrió durante el mantenimiento.
- Una alerta que desaparece antes del final se resuelve sin aviso, ya que no se anunció nada.
- Una alerta que sigue abierta cuando termina la ventana se anuncia en ese momento, como si acabara de abrirse, mediante el enrutamiento, el periodo de silencio y los silencios habituales.
- La cronología del recurso registra cuándo empezó y terminó cada ventana, y si alguien la terminó antes de tiempo.
Una ventana de mantenimiento no es un silencio. Un silencio acalla una alerta existente durante un tiempo; una ventana acalla todo lo relativo a un conjunto de recursos durante un periodo, incluidas las alertas que todavía no existen.
Ventanas semanales y horario de verano
- Cuando los relojes se adelantan, una hora de inicio que no existe empieza justo después del salto.
- Cuando los relojes se atrasan, una hora de inicio que ocurre dos veces usa la primera.
- La duración es tiempo transcurrido, así que una ventana que abarca un cambio termina una hora antes o después según el reloj de pared.
- Una ventana puede cruzar la medianoche o el final de la semana: el domingo a las 23:00 durante tres horas termina el lunes a las 02:00. Cada repetición dura como máximo una semana.
- Terminar ahora en una ventana semanal corta solo la repetición actual; las siguientes ocurren según lo previsto. Editar la programación anula ese corte.
Cambiar o eliminar una ventana
Todas las ventanas enumera las ventanas propias de la entidad, las de las entidades que están debajo y las heredadas de sus ancestros, marcadas con De y el nombre de la entidad. Cada una tiene acciones para editar y eliminar.
Eliminar una ventana activa la termina primero, y su cronología conserva el inicio y el fin. Las alertas que había marcado conservan su entrada en la cronología, pero pierden el vínculo con la ventana eliminada.
Roles y auditoría
| Acción | Rol en la entidad de la ventana |
|---|---|
| Ver las ventanas, activas y próximas | Lector |
| Crear, iniciar, editar, terminar o eliminar | Operador |
Cada cambio se escribe en el registro de auditoría: maintenance.create, maintenance.start_now, maintenance.update, maintenance.end y maintenance.delete.
Desde la API
$BASE es https://<your server>/api/v1 y $TOKEN es tu token de acceso; consulta Inicio rápido: agregar una instancia de SQL Server con la 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"
| Solicitud | Propósito |
|---|---|
GET /maintenance-windows?entity={id} | Las ventanas de una entidad, con las de las entidades que están debajo y las heredadas; filtra con state=active,scheduled,ended |
GET /maintenance-windows/active y /upcoming | Lo que está en mantenimiento ahora y lo que viene después |
POST /maintenance-windows | Crea una ventana: kind es once (con starts_at y ends_at) o weekly (con weekly); scope es entity o resources (con resource_ids) |
POST /maintenance-windows/now | Inicia una ahora durante minutes, en la entidad o en resource_ids |
PATCH /maintenance-windows/{id} | Cambia cualquier campo |
POST /maintenance-windows/{id}/end | Termina ahora la repetición activa |
DELETE /maintenance-windows/{id} | Elimina una ventana; una activa se termina primero |
Para anunciar una ventana en la página de estado, agrega "public": true con public_title y, opcionalmente, public_description. Una ventana semanal se puede acotar con starts_at y ends_at opcionales: solo cuentan las repeticiones que empiezan entre esas fechas. Una ventana puntual puede registrar con timezone la zona horaria en la que se planificó.
Contenido relacionado
- Confirmar una alerta y atenderla
- Entidades, etiquetas y herencia: las ventanas configuradas en una entidad cubren todo lo que está debajo
- Configurar la página de estado pública