Legge til LaTeX-brukerhjelp

Server LaTeX-hjelpesider fra et MediaWiki-nettsted under /learn i en Kubernetes-distribusjon.

/learn-sidene serveres av web-tjenesten (learn-modulen) i hver Ayakaleaf Pro-pod, fra en hurtigbuffer av wikien som er angitt i WIKI_URL. Hva modulen gjør og hvilke wikier som fungerer, er beskrevet i Legge til LaTeX-brukerhjelp.

Tjeneste	web (learn-modulen), i hver Ayakaleaf Pro-pod
Pod → utsiden	WIKI_URL (standard https://learnwiki.overleaf.com): alle sider ved første oppstart, deretter en side på nytt når en bruker åpner den etter WIKI_MAX_CACHE_AGE
Nettleser → utsiden	bildene på sidene, direkte fra WIKI_URL
Lagrede data	sidehurtigbufferen i /var/lib/overleaf/data/learnPages på datavolumet
Periodiske jobber	ingen: sidene oppdateres når brukere åpner dem

​

Konfigurasjon

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

Ved første oppstart med modulen aktivert laster web-tjenesten ned hele wikien før den tar imot forespørsler, noe som tar flere minutter. Poden forblir ikke klar frem til da, så ta høyde for dette i rollout status --timeout og i eventuelle startup- eller liveness-prober du legger til. Senere oppstarter gjenbruker hurtigbufferen på datavolumet.

Ved første oppstart, før det finnes en hurtigbuffer, må podene kunne nå WIKI_URL: uten det feiler web-tjenesten under oppstart og startes på nytt inne i poden igjen og igjen, slik at poden aldri blir klar. Slå av modulen, eller gi podene tilgang ut til wikien. Når hurtigbufferen finnes, starter podene og serverer de hurtigbufrede sidene også mens wikien ikke kan nås.

​

Flere replikaer

Hver replika har sin egen hurtigbuffer på nodens disk, så hver av dem laster ned wikien ved sin første oppstart; med podManagementPolicy: OrderedReady gjør de det etter tur. En bruker kan se en side i en litt annen versjon på en annen replika til den er oppdatert der.

​

Testet på Kubernetes

På Kubernetes 1.37 med tre replikaer bak HAProxy, der hver lastet ned https://learnwiki.overleaf.com til hurtigbufferen på sin egen node ved første oppstart, består ende-til-ende-testene våre for /learn (12 tilfeller): Documentation-lenken i toppteksten, velkomstmeldingen og Help-menyen i editoren, innholdssidepanelet, sider, lenker og omdirigeringer i wikien, bilder lastet fra wikien, 404 for ukjente sider, krav om innlogging uten offentlig tilgang, og en utdatert side servert fra hurtigbufferen etter at WIKI_URL ble endret til en adresse som ikke kan nås. Ved oppstart med tom hurtigbuffer og WIKI_URL pekende mot en adresse som avviser tilkoblinger, forble poden ikke klar uten å starte på nytt, mens web-tjenesten inne i den startet og feilet 77 ganger på tre minutter.