Tilføjelse af LaTeX-brugerhjælp

Servér LaTeX-hjælpesider fra et MediaWiki-websted under /learn på en Kubernetes-udrulning.

/learn-siderne serveres af web-tjenesten (modulet learn) i hver Ayakaleaf Pro-pod fra en cache af den wiki, der er angivet i WIKI_URL. Hvad modulet gør, og hvilke wikier der virker, er beskrevet i Tilføjelse af LaTeX-brugerhjælp.

Tjeneste	web (modulet learn), i hver Ayakaleaf Pro-pod
Pod → omverdenen	WIKI_URL (standard https://learnwiki.overleaf.com): alle sider ved første start, og derefter en side igen, når en bruger åbner den efter WIKI_MAX_CACHE_AGE
Browser → omverdenen	sidernes billeder, direkte fra WIKI_URL
Lagrede data	sidecachen i /var/lib/overleaf/data/learnPages på datavolumen
Periodiske job	ingen: sider opdateres, når brugerne åbner 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

Ved første start med modulet aktiveret downloader web-tjenesten hele wikien, før den tager imod forespørgsler, hvilket tager flere minutter. Poden forbliver ikke klar indtil da, så tag højde for det i rollout status --timeout og i enhver startup- eller liveness-probe, du tilføjer. Senere starter genbruger cachen på datavolumen.

Ved første start, før der findes en cache, skal podsene kunne nå WIKI_URL: uden det fejler web-tjenesten under opstart og genstartes inde i poden igen og igen, så poden bliver aldrig klar. Slå modulet fra, eller tillad podsene at nå wikien. Når cachen findes, starter podsene og serverer de cachede sider, også mens wikien ikke kan nås.

​

Flere replikaer

Hver replika har sin egen cache på sin nodes disk, så hver af dem downloader wikien ved sin første start; med podManagementPolicy: OrderedReady gør de det én efter én. En bruger kan se en side i en lidt anden version på en anden replika, indtil den er opdateret dér.

​

Testet på Kubernetes

På Kubernetes 1.37 med tre replikaer bag HAProxy, hvor hver downloadede https://learnwiki.overleaf.com til sin egen nodes cache ved første start, består vores end-to-end-test for /learn (12 tilfælde): Documentation-linket i headeren, velkomstbeskeden og editorens Help-menu, indholdssidebjælken, sider, links og omdirigeringer inden for wikien, billeder indlæst fra wikien, 404 for ukendte sider, påkrævet login uden offentlig adgang samt en forældet side serveret fra cachen, efter at WIKI_URL var ændret til en adresse, der ikke kan nås. Ved start med en tom cache og WIKI_URL pegende på en adresse, der afviser forbindelser, forblev poden ikke klar uden at genstarte, mens web-tjenesten inde i den startede og fejlede 77 gange på tre minutter.