LaTeX-Benutzerhilfe hinzufügen

LaTeX-Hilfeseiten von einer MediaWiki-Site unter /learn in einem Kubernetes-Deployment bereitstellen.

Die /learn-Seiten werden vom web-Dienst (dem learn-Modul) jedes Ayakaleaf-Pro-Pods bereitgestellt, und zwar aus einem Cache des in WIKI_URL festgelegten Wikis. Was das Modul tut und welche Wikis funktionieren, ist unter LaTeX-Benutzerhilfe hinzufügen beschrieben.

Dienst	web (learn-Modul), in jedem Ayakaleaf-Pro-Pod
Pod → außen	WIKI_URL (Standard https://learnwiki.overleaf.com): beim ersten Start jede Seite, danach eine Seite erneut, wenn ein Benutzer sie nach Ablauf von WIKI_MAX_CACHE_AGE öffnet
Browser → außen	Bilder der Seiten, direkt von WIKI_URL
Gespeicherte Daten	der Seiten-Cache in /var/lib/overleaf/data/learnPages auf dem Daten-Volume
Periodische Jobs	keine: Seiten werden aktualisiert, wenn Benutzer sie öffnen

​

Konfiguration

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

Beim ersten Start mit aktiviertem Modul lädt der web-Dienst das gesamte Wiki herunter, bevor er Anfragen annimmt, was mehrere Minuten dauert. Bis dahin bleibt der Pod nicht bereit; berücksichtigen Sie dies daher bei rollout status --timeout und bei allen Startup- oder Liveness-Probes, die Sie hinzufügen. Spätere Starts verwenden den Cache auf dem Daten-Volume wieder.

Beim ersten Start, bevor ein Cache existiert, müssen die Pods WIKI_URL erreichen: Andernfalls schlägt der web-Dienst beim Start fehl und wird innerhalb des Pods immer wieder neu gestartet, sodass der Pod nie bereit wird. Deaktivieren Sie das Modul oder erlauben Sie den Pods den Zugriff nach außen auf das Wiki. Sobald der Cache existiert, starten die Pods und stellen die zwischengespeicherten Seiten auch dann bereit, wenn das Wiki nicht erreichbar ist.

​

Mehrere Replikate

Jedes Replikat hält seinen eigenen Cache auf der Festplatte seines Knotens, daher lädt jedes beim ersten Start das Wiki herunter; mit podManagementPolicy: OrderedReady geschieht dies nacheinander. Ein Benutzer sieht eine Seite auf einem anderen Replikat möglicherweise in einer leicht abweichenden Version, bis sie dort aktualisiert wird.

​

Getestet auf Kubernetes

Auf Kubernetes 1.37 mit drei Replikaten hinter HAProxy, die jeweils beim ersten Start https://learnwiki.overleaf.com in den Cache ihres eigenen Knotens herunterladen, bestehen unsere End-to-End-Tests für /learn (12 Fälle): der Documentation-Link in der Kopfzeile, die Willkommensnachricht und das Hilfe-Menü des Editors, die Inhalts-Seitenleiste, Seiten, Links und Weiterleitungen innerhalb des Wikis, aus dem Wiki geladene Bilder, 404 für unbekannte Seiten, die erforderliche Anmeldung ohne öffentlichen Zugriff sowie eine veraltete Seite, die aus dem Cache bereitgestellt wird, nachdem WIKI_URL auf eine nicht erreichbare Adresse geändert wurde. Beim Start mit leerem Cache und einer WIKI_URL, die auf eine Adresse zeigt, die Verbindungen ablehnt, blieb der Pod ohne Neustart nicht bereit, während der web-Dienst darin in drei Minuten 77-mal startete und fehlschlug.