Añadir ayuda de LaTeX para los usuarios

Sirve páginas de ayuda de LaTeX desde un sitio MediaWiki bajo /learn en un despliegue de Kubernetes.

Las páginas de /learn las sirve el servicio web (el módulo learn) de cada pod de Ayakaleaf Pro, a partir de una caché de la wiki definida en WIKI_URL. Qué hace el módulo y qué wikis son compatibles se describe en Añadir ayuda de LaTeX para los usuarios.

Servicio	web (módulo learn), en cada pod de Ayakaleaf Pro
Pod → exterior	WIKI_URL (por defecto https://learnwiki.overleaf.com): todas las páginas en el primer arranque y, después, una página de nuevo cuando un usuario la abre pasado WIKI_MAX_CACHE_AGE
Navegador → exterior	imágenes de las páginas, directamente desde WIKI_URL
Datos almacenados	la caché de páginas en /var/lib/overleaf/data/learnPages en el volumen de datos
Tareas periódicas	ninguna: las páginas se actualizan cuando los usuarios las abren

​

Configuración

30-config.yaml (additions)

  OVERLEAF_PROXY_LEARN: "true"
  # optional: your own MediaWiki
  # WIKI_URL: https://wiki.example.com

kubectl apply -f 30-config.yaml
kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf
kubectl -n overleaf rollout status deployment/overleaf --timeout=30m

En su primer arranque con el módulo activado, el servicio web descarga la wiki completa antes de aceptar peticiones, lo que tarda varios minutos. Hasta entonces el pod no está listo, así que tenlo en cuenta en rollout status --timeout y en cualquier sonda de arranque o de actividad (liveness) que añadas. Los arranques posteriores reutilizan la caché del volumen de datos.

En el primer arranque, antes de que exista una caché, los pods deben poder llegar a WIKI_URL: sin ello, el servicio web falla al arrancar y se reinicia dentro del pod una y otra vez, de modo que el pod nunca llega a estar listo. Desactiva el módulo o permite que los pods salgan hacia la wiki. Una vez que existe la caché, los pods arrancan y sirven las páginas en caché aunque no se pueda acceder a la wiki.

​

Varias réplicas

Cada réplica mantiene su propia caché en el disco de su nodo, por lo que cada una descarga la wiki en su primer arranque; con podManagementPolicy: OrderedReady lo hacen una detrás de otra. Un usuario puede ver una página en una versión ligeramente distinta en otra réplica hasta que se actualice allí.

​

Probado en Kubernetes

En Kubernetes 1.37 con tres réplicas detrás de HAProxy, cada una descargando https://learnwiki.overleaf.com en la caché de su propio nodo en su primer arranque, nuestras pruebas de extremo a extremo para /learn se superan (12 casos): el enlace Documentation de la cabecera, el mensaje de bienvenida y el menú Help del editor, la barra lateral de contenidos, las páginas, los enlaces y las redirecciones dentro de la wiki, las imágenes cargadas desde la wiki, el 404 para páginas desconocidas, el inicio de sesión obligatorio sin acceso público y una página obsoleta servida desde la caché después de cambiar WIKI_URL a una dirección inaccesible. Al arrancar con la caché vacía y WIKI_URL apuntando a una dirección que rechaza las conexiones, el pod siguió sin estar listo sin reiniciarse, mientras que el servicio web en su interior arrancó y falló 77 veces en tres minutos.