Dodawanie pomocy LaTeX dla użytkowników

Udostępnianie stron pomocy LaTeX z witryny MediaWiki pod /learn we wdrożeniu Kubernetes.

Strony /learn są udostępniane przez usługę web (moduł learn) każdego poda Ayakaleaf Pro, z pamięci podręcznej wiki ustawionego w WIKI_URL. Co robi ten moduł i które wiki działają, opisano w Dodawanie pomocy LaTeX dla użytkowników.

Usługa	web (moduł learn), w każdym podzie Ayakaleaf Pro
Pod → na zewnątrz	WIKI_URL (domyślnie https://learnwiki.overleaf.com): każda strona przy pierwszym uruchomieniu, a następnie ponownie dana strona, gdy użytkownik otworzy ją po upływie WIKI_MAX_CACHE_AGE
Przeglądarka → na zewnątrz	obrazy na stronach, bezpośrednio z WIKI_URL
Przechowywane dane	pamięć podręczna stron w /var/lib/overleaf/data/learnPages na wolumenie danych
Zadania okresowe	brak: strony są odświeżane, gdy użytkownicy je otwierają

​

Konfiguracja

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

Przy pierwszym uruchomieniu z włączonym modułem usługa web pobiera całe wiki, zanim zacznie przyjmować żądania, co trwa kilka minut. Do tego czasu pod pozostaje w stanie niegotowym, więc uwzględnij to w rollout status --timeout oraz w każdej dodanej przez siebie sondzie startowej lub sondzie żywotności (liveness). Kolejne uruchomienia korzystają z pamięci podręcznej na wolumenie danych.

Przy pierwszym uruchomieniu, zanim powstanie pamięć podręczna, pody muszą mieć dostęp do WIKI_URL: bez niego usługa web kończy się błędem podczas uruchamiania i jest wielokrotnie restartowana wewnątrz poda, więc pod nigdy nie staje się gotowy. Wyłącz moduł albo zezwól podom na połączenia wychodzące do wiki. Gdy pamięć podręczna już istnieje, pody uruchamiają się i udostępniają strony z pamięci podręcznej także wtedy, gdy wiki jest nieosiągalne.

​

Kilka replik

Każda replika utrzymuje własną pamięć podręczną na dysku swojego węzła, więc każda pobiera wiki przy swoim pierwszym uruchomieniu; przy podManagementPolicy: OrderedReady robią to jedna po drugiej. Użytkownik może zobaczyć stronę w nieco innej wersji na innej replice, dopóki nie zostanie ona tam odświeżona.

​

Przetestowano na Kubernetes

Na Kubernetes 1.37 z trzema replikami za HAProxy, z których każda przy pierwszym uruchomieniu pobiera https://learnwiki.overleaf.com do pamięci podręcznej własnego węzła, nasze testy end-to-end dla /learn przechodzą pomyślnie (12 przypadków): link Documentation w nagłówku, wiadomość powitalna i menu Help w edytorze, pasek boczny ze spisem treści, strony, linki i przekierowania wewnątrz wiki, obrazy ładowane z wiki, 404 dla nieznanych stron, wymagane logowanie bez dostępu publicznego oraz nieaktualna strona udostępniana z pamięci podręcznej po zmianie WIKI_URL na adres, który jest nieosiągalny. Przy starcie z pustą pamięcią podręczną i WIKI_URL wskazującym na adres odrzucający połączenia pod pozostawał niegotowy bez restartów, podczas gdy usługa web wewnątrz niego uruchomiła się i zakończyła błędem 77 razy w ciągu trzech minut.