Lägga till LaTeX-hjälp för användare

Servera LaTeX-hjälpsidor från en MediaWiki-webbplats under /learn i en Kubernetes-driftsättning.

Sidorna under /learn serveras av tjänsten web (modulen learn) i varje Ayakaleaf Pro-pod, från en cache av den wiki som anges i WIKI_URL. Vad modulen gör och vilka wikier som fungerar beskrivs i Lägga till LaTeX-hjälp för användare.

Tjänst	web (modulen learn), i varje Ayakaleaf Pro-pod
Pod → utsidan	WIKI_URL (standard https://learnwiki.overleaf.com): varje sida vid första starten, därefter en sida på nytt när en användare öppnar den efter WIKI_MAX_CACHE_AGE
Webbläsare → utsidan	sidornas bilder, direkt från WIKI_URL
Lagrade data	sidcachen i /var/lib/overleaf/data/learnPages på datavolymen
Periodiska jobb	inga: sidor uppdateras när användare öppnar dem

​

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

Vid första starten med modulen aktiverad laddar web-tjänsten ned hela wikin innan den tar emot förfrågningar, vilket tar flera minuter. Podden förblir inte redo fram till dess, så räkna med det i rollout status --timeout och i eventuella startup- eller liveness-prober som du lägger till. Senare starter återanvänder cachen på datavolymen.

Vid första starten, innan någon cache finns, måste poddarna nå WIKI_URL: utan det misslyckas web-tjänsten under starten och startas om inne i podden gång på gång, så podden blir aldrig redo. Stäng av modulen eller tillåt poddarna att nå wikin. När cachen väl finns startar poddarna och serverar de cachade sidorna även när wikin inte går att nå.

​

Flera repliker

Varje replik har sin egen cache på sin nods disk, så var och en laddar ned wikin vid sin första start; med podManagementPolicy: OrderedReady gör de det en i taget. En användare kan se en sida i en något annorlunda version på en annan replik tills den har uppdaterats där.

​

Testat på Kubernetes

På Kubernetes 1.37 med tre repliker bakom HAProxy, där var och en laddade ned https://learnwiki.overleaf.com till sin egen nods cache vid första starten, klarar våra end-to-end-tester för /learn sig (12 fall): länken Documentation i sidhuvudet, välkomstmeddelandet och redigerarens hjälpmeny, innehållsförteckningen i sidofältet, sidor, länkar och omdirigeringar inom wikin, bilder som laddas från wikin, 404 för okända sidor, inloggningskravet utan offentlig åtkomst samt en inaktuell sida som serverades från cachen efter att WIKI_URL ändrats till en adress som inte går att nå. Med en tom cache och WIKI_URL pekande på en adress som vägrar anslutningar förblev podden inte redo utan att startas om, medan web-tjänsten inne i den startade och misslyckades 77 gånger på tre minuter.