Додавання довідки LaTeX для користувачів

Відображення сторінок довідки LaTeX із сайту MediaWiki за шляхом /learn у розгортанні Kubernetes.

Сторінки /learn обслуговує служба web (модуль learn) кожного пода Ayakaleaf Pro з кешу wiki, заданої у WIKI_URL. Що робить модуль і які wiki з ним працюють, описано в розділі Додавання довідки LaTeX для користувачів.

Служба	web (модуль learn), у кожному поді Ayakaleaf Pro
Под → зовні	WIKI_URL (за замовчуванням https://learnwiki.overleaf.com): усі сторінки під час першого запуску, а потім сторінка знову, коли користувач відкриває її після спливання WIKI_MAX_CACHE_AGE
Браузер → зовні	зображення сторінок, безпосередньо з WIKI_URL
Збережені дані	кеш сторінок у /var/lib/overleaf/data/learnPages на томі даних
Періодичні завдання	немає: сторінки оновлюються, коли користувачі їх відкривають

​

Конфігурація

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

Під час першого запуску з увімкненим модулем служба web завантажує всю wiki, перш ніж почати приймати запити, і це триває кілька хвилин. До того часу под залишається неготовим, тож урахуйте це в rollout status --timeout і в будь-якій startup- або liveness-пробі, яку ви додаєте. Наступні запуски повторно використовують кеш на томі даних.

Під час першого запуску, поки кешу ще немає, поди мають мати доступ до WIKI_URL: без нього служба web падає під час запуску й раз за разом перезапускається всередині пода, тож под ніколи не стає готовим. Вимкніть модуль або дозвольте подам вихід до wiki. Коли кеш уже існує, поди запускаються й відображають кешовані сторінки також тоді, коли wiki недоступна.

​

Кілька реплік

Кожна репліка зберігає власний кеш на диску свого вузла, тож кожна завантажує wiki під час свого першого запуску; з podManagementPolicy: OrderedReady вони роблять це по черзі. Користувач може бачити сторінку в трохи іншій версії на іншій репліці, доки її там не буде оновлено.

​

Перевірено в Kubernetes

У Kubernetes 1.37 із трьома репліками за HAProxy, кожна з яких під час першого запуску завантажує https://learnwiki.overleaf.com у кеш свого вузла, наші наскрізні тести для /learn проходять (12 випадків): посилання Documentation у заголовку, вітальне повідомлення та меню Help редактора, бічна панель змісту, сторінки, посилання й переспрямування всередині wiki, зображення, завантажені з wiki, 404 для невідомих сторінок, обов’язковий вхід без публічного доступу, а також застаріла сторінка, що відображається з кешу після зміни WIKI_URL на недоступну адресу. Під час запуску з порожнім кешем і WIKI_URL, що вказує на адресу, яка відхиляє з’єднання, под залишався неготовим без перезапусків, тоді як служба web усередині нього запускалася й падала 77 разів за три хвилини.