Přidání nápovědy k LaTeXu pro uživatele

Poskytování stránek nápovědy k LaTeXu z webu MediaWiki pod /learn v nasazení na Kubernetes.

Stránky /learn poskytuje služba web (modul learn) každého podu Ayakaleaf Pro, a to z mezipaměti wiki nastavené v WIKI_URL. Co modul dělá a které wiki s ním fungují, popisuje stránka Přidání nápovědy k LaTeXu pro uživatele.

Služba	web (modul learn), v každém podu Ayakaleaf Pro
Pod → ven	WIKI_URL (výchozí https://learnwiki.overleaf.com): při prvním spuštění všechny stránky, poté stránku znovu, když ji uživatel otevře po uplynutí WIKI_MAX_CACHE_AGE
Prohlížeč → ven	obrázky stránek, přímo z WIKI_URL
Uložená data	mezipaměť stránek v /var/lib/overleaf/data/learnPages na datovém svazku
Periodické úlohy	žádné: stránky se obnovují, když je uživatelé otevřou

​

Konfigurace

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

Při prvním spuštění se zapnutým modulem stáhne služba web celou wiki dříve, než začne přijímat požadavky, což trvá několik minut. Do té doby zůstává pod ve stavu not ready, proto s tím počítejte v rollout status --timeout i v každé startup nebo liveness probe, kterou přidáte. Pozdější spuštění znovu využijí mezipaměť na datovém svazku.

Při prvním spuštění, dokud mezipaměť neexistuje, musí pody dosáhnout na WIKI_URL: bez toho služba web při spouštění selže a uvnitř podu se znovu a znovu restartuje, takže pod nikdy nebude ready. Modul vypněte, nebo podům povolte přístup ven k wiki. Jakmile mezipaměť existuje, pody se spustí a poskytují stránky z mezipaměti i tehdy, když wiki není dostupná.

​

Více replik

Každá replika si udržuje vlastní mezipaměť na disku svého uzlu, takže každá stáhne wiki při svém prvním spuštění; s podManagementPolicy: OrderedReady to dělají jedna po druhé. Uživatel může na jiné replice vidět stránku v mírně odlišné verzi, dokud se tam neobnoví.

​

Otestováno na Kubernetes

Na Kubernetes 1.37 se třemi replikami za HAProxy, z nichž každá při prvním spuštění stáhla https://learnwiki.overleaf.com do mezipaměti svého uzlu, procházejí naše end-to-end testy pro /learn (12 případů): odkaz Documentation v záhlaví, uvítací zpráva a nabídka Help v editoru, postranní panel s obsahem, stránky, odkazy a přesměrování uvnitř wiki, obrázky načítané z wiki, 404 pro neznámé stránky, vyžadované přihlášení bez veřejného přístupu a zastaralá stránka poskytnutá z mezipaměti poté, co byla WIKI_URL změněna na nedostupnou adresu. Při spuštění s prázdnou mezipamětí a WIKI_URL ukazující na adresu, která odmítá spojení, zůstal pod ve stavu not ready bez restartu, zatímco služba web uvnitř něj se za tři minuty 77krát spustila a selhala.