Módulo Scheduler
El módulo Scheduler añade una potente herramienta de planificación a tu aplicación
Para activar este módulo, sigue estos pasos:
- Añade las dependencias awe scheduler al descriptor pom.xml.
<dependencies>
...
<dependency>
<groupId>com.almis.awe</groupId>
<artifactId>awe-scheduler-spring-boot-starter</artifactId>
</dependency>
...
</dependencies>
- Añade las pantallas del planificador en tu archivo
private.xml:
<option name="scheduler" label="MENU_SCHEDULER" icon="clock-o">
<option name="scheduler-management" label="MENU_SCHEDULER_MANAGEMENT" screen="scheduler-management" icon="cogs"/>
<option name="scheduler-tasks" label="MENU_SCHEDULER_TASKS" screen="scheduler-tasks" icon="tasks">
<option name="new-scheduler-task" screen="new-scheduler-task" invisible="true" />
<option name="update-scheduler-task" screen="update-scheduler-task" invisible="true" />
<option name="scheduler-flow-graph" screen="scheduler-flow-graph" invisible="true" />
</option>
<option name="scheduler-servers" label="MENU_SCHEDULER_SERVERS" screen="scheduler-server" icon="server">
<option name="new-scheduler-server" screen="new-scheduler-server" invisible="true" />
<option name="update-scheduler-server" screen="update-scheduler-server" invisible="true" />
</option>
<option name="scheduler-calendars" label="MENU_SCHEDULER_CALENDARS" screen="scheduler-calendars" icon="calendar">
<option name="new-scheduler-calendar" screen="new-scheduler-calendar" invisible="true" />
<option name="update-scheduler-calendar" screen="update-scheduler-calendar" invisible="true" />
</option>
</option>
- Configura el valor de la propiedad para añadir
awe-schedulera la lista de módulos.
awe.application.module-list = APP, ..., awe-scheduler, ..., awe
-
Da a los perfiles que usan las pantallas del planificador los permisos
scheduler.read,scheduler.updateyscheduler.execute(solo los tiene el perfil de administrador). Consulta Permisos. -
Por último, si estás usando
flyway, añade las tablas del planificador al módulo de migración:
awe.database.migration-modules=AWE,...,SCHEDULER,...
Ejecuciones de flujo
Toda tarea lanzada por su planificación, de forma manual, por un fichero o por un webhook inicia una ejecución de flujo que agrupa las ejecuciones de sus dependencias, con un estado final y parámetros opcionales. Una tarea con varios padres se lanza una sola vez, cuando han terminado todos sus padres de la ejecución de flujo. La pantalla Ejecuciones de flujo (scheduler-runs, permiso scheduler.read) lista las ejecuciones con su grafo de flujo, sus ejecuciones y sus tareas omitidas. Consulta Dependencias entre tareas.
El botón Grafo de flujo de la pantalla de tareas abre scheduler-flow-graph: las dependencias de la tarea
seleccionada, o de todos los flujos si no hay ninguna seleccionada, dibujadas como un grafo de izquierda a derecha. Cada
nodo muestra la tarea, su tipo de lanzamiento y si está activa; cada arista muestra cuándo lanza el padre a sus hijos
(siempre con OK, también con aviso o con error). En una ejecución, cada nodo muestra su estado: terminada con su estado,
en curso, en espera, omitida o no alcanzada. Al pulsar un nodo se abre la tarea. Los dos motores dibujan el grafo.
Si usas flyway, las tablas de las ejecuciones de flujo (AweSchRun, AweSchRunPar, AweSchRunTsk y la columna IdeRun de AweSchExe) se incluyen en el módulo de migración SCHEDULER, versión 1.0.9.
Lanzamiento por webhook
Una tarea con el tipo de lanzamiento Webhook se lanza cuando un POST firmado llega a la URL de su hook (consulta la guía del planificador). Los webhooks se reciben, se almacenan y se responden de inmediato, y se procesan fuera de la petición. Se configuran con las siguientes propiedades:
| Propiedad | Descripción | Valor por defecto |
|---|---|---|
awe.scheduler.webhooks.max-body-size | Tamaño máximo del cuerpo de un webhook. Uno mayor se responde con 413 | 256KB |
awe.scheduler.webhooks.tolerance | Diferencia máxima entre el webhook-timestamp de un webhook y la hora actual. Un webhook fuera de ella se responde con 401 | 5m |
awe.scheduler.webhooks.inbox-retention | Tiempo que los webhooks procesados, ignorados y fallidos definitivamente permanecen en la bandeja antes de purgarse | 30d |
awe.scheduler.webhooks.process-interval | Intervalo entre las comprobaciones de la bandeja para buscar webhooks que lanzar | 10s |
Una duración sin unidad se lee en la unidad de su valor por defecto (minutos para tolerance, días para inbox-retention, segundos para process-interval).
awe.scheduler.webhooks.max-body-size=256KB
awe.scheduler.webhooks.tolerance=5m
awe.scheduler.webhooks.inbox-retention=30d
awe.scheduler.webhooks.process-interval=10s
Seguridad
La ruta de los webhooks (/scheduler/api/v1/webhooks/**) no necesita token bearer: tiene su propia cadena de seguridad y la firma es la autenticación. Una petición solo se acepta cuando su firma de Standard Webhooks es válida para el secreto del hook y su marca de tiempo está dentro de la tolerancia. El resto de la API del planificador sigue exigiendo el token bearer (consulta Seguridad de la API del planificador).
El secreto nunca se guarda en la base de datos ni se muestra en pantalla: el hook contiene el nombre de una propiedad de la aplicación y la propiedad contiene el secreto. Puede contener varios secretos separados por espacios o comas, y se acepta un webhook firmado con cualquiera de ellos, de modo que un secreto se puede rotar sin interrupción: añade el nuevo, cambia el emisor y después elimina el antiguo.
fit.webhook.secret=whsec_AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8=
# Durante una rotación se aceptan ambos secretos
fit.webhook.secret=whsec_AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8= whsec_BAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8=
Migración
Si usas flyway, las tablas del lanzamiento por webhook (AweSchTskHok, AweSchHokMsg y la columna WhkPtr de AweSchTskPar) se incluyen en el módulo de migración SCHEDULER, versión 1.0.10.
Ejecución remota de comandos por SSH
Las tareas de comando pueden ejecutarse en un host remoto mediante SSH (consulta la guía del planificador). Los clientes SSH usados para la ejecución remota y para la comprobación de archivos por SFTP se configuran con las siguientes propiedades:
| Propiedad | Descripción | Valor por defecto |
|---|---|---|
awe.scheduler.ssh-host-key-policy | Política de verificación de claves de host. Consulta los valores más abajo. | ACCEPT_ON_FIRST_USE |
awe.scheduler.ssh-known-hosts-path | Ruta al archivo known_hosts usado para persistir y leer las claves de host de confianza | ${user.home}/.ssh/known_hosts |
awe.scheduler.ssh-connect-timeout | Tiempo de espera de conexión y autenticación SSH, en segundos | 30s |
awe.scheduler.connection-test-timeout | Tiempo de espera del botón Test connection de las pantallas de servidores (sesión SSH e intercambios de conexión/datos FTP), en segundos | 10s |
La política de claves de host admite tres valores:
| Valor | Comportamiento |
|---|---|
ACCEPT_ON_FIRST_USE | Confianza en el primer uso: un host que aún no está en known_hosts se acepta y se almacena en su primera conexión, y después se valida contra la clave almacenada. |
STRICT | Solo se aceptan los hosts que ya están en known_hosts; los hosts desconocidos se rechazan. |
ACCEPT_ALL | Se acepta cualquier clave de host sin verificación. Inseguro: solo para desarrollo y pruebas. |
awe.scheduler.ssh-host-key-policy=ACCEPT_ON_FIRST_USE
awe.scheduler.ssh-known-hosts-path=/opt/awe/.ssh/known_hosts
awe.scheduler.ssh-connect-timeout=30s
Nota: Para uso en producción prefiere
STRICTcon unknown_hostspreprovisionado, o el valor por defectoACCEPT_ON_FIRST_USE. EvitaACCEPT_ALLfuera del desarrollo.
Ejecuciones diferidas
Una tarea maintain puede responder que ha aceptado el trabajo y que finaliza más tarde (consulta la guía del planificador). El plazo de esas ejecuciones se configura con las siguientes propiedades:
| Propiedad | Descripción | Por defecto |
|---|---|---|
awe.scheduler.deferred.default-timeout | Tiempo que una ejecución diferida puede seguir en marcha cuando su tarea no tiene timeout. Pasado ese tiempo la ejecución se interrumpe | 24h |
awe.scheduler.deferred.timeout-check-interval | Intervalo entre las comprobaciones de las ejecuciones diferidas que han superado su plazo | 60s |
Una duración sin unidad se lee en la unidad de su valor por defecto (horas para la primera propiedad, segundos para la segunda).
awe.scheduler.deferred.default-timeout=12h
awe.scheduler.deferred.timeout-check-interval=30s
Seguridad de la API del planificador
La API del planificador (/scheduler/api/**) exige el token bearer de AWE, validado como lo valida la API REST (local-jwt u oauth2-resource-server, según awe.rest.api.auth.mode). Todas las rutas de la API lo necesitan, incluida la que completa una ejecución diferida.
La validación la hace el starter de AWE REST. El planificador no depende de él, así que la aplicación que aloja la API del planificador debe incluirlo. Sin él ninguna petición puede autenticarse: todas reciben 401 y al arrancar se escribe una advertencia en el log.
Antes, /scheduler/api/** estaba abierta. Una aplicación con el planificador embebido no se ve afectada, porque no llama a esa API. Una aplicación con awe.scheduler.remote-enabled=true ahora debe autenticarse contra la instancia del planificador, y la instancia del planificador debe incluir el starter de AWE REST. Configura en la aplicación principal un usuario de la instancia del planificador, o sus llamadas al planificador recibirán 401:
| Propiedad | Descripción | Por defecto |
|---|---|---|
awe.scheduler.remote-scheduler-user | Usuario de la instancia del planificador. La aplicación principal inicia sesión con él en /api/authenticate de la instancia del planificador (la awe.scheduler.remote-scheduler-url sin su terminación /scheduler/api/v1) y envía el token que obtiene. El token se reutiliza hasta 30 segundos antes de que caduque. Si está vacío, las llamadas se envían sin credenciales y se escribe una advertencia en el log | vacío |
awe.scheduler.remote-scheduler-password | Contraseña de ese usuario | vacío |
awe.scheduler.remote-enabled=true
awe.scheduler.remote-scheduler-url=https://scheduler.example.com/scheduler/api/v1
awe.scheduler.remote-scheduler-user=scheduler-client
awe.scheduler.remote-scheduler-password=ENC(yourEncryptedPassword)
Cuando la instancia del planificador usa awe.rest.api.auth.mode=oauth2-resource-server, su endpoint /api/authenticate está deshabilitado, así que el inicio de sesión de la aplicación principal no puede obtener un token y sus llamadas se rechazan. La API del planificador acepta los tokens del proveedor de identidad, pero el cliente del planificador remoto no los obtiene: usa el modo local-jwt en la instancia del planificador cuando la llama otra aplicación AWE.