Branding

Zmiana tytułu witryny, logo, linków w nagłówku, stopek i komunikatu o konserwacji we wdrożeniu Kubernetes.

Usługa web renderuje tytuł, logo, linki w nagłówku, stopki i stronę konserwacji na podstawie zmiennych środowiskowych. Każde ustawienie i jego format opisano w Branding; na Kubernetes trafiają one do ConfigMap.

Usługa	web, w każdym podzie Ayakaleaf Pro; odczytywane przy starcie web
Sieć	brak: logo to adresy URL ładowane przez przeglądarkę
Zadania okresowe	brak (web sprawdza plik konserwacji co 5 sekund, zobacz poniżej)

​

Konfiguracja

30-config.yaml (additions)

  OVERLEAF_NAV_TITLE: Our Overleaf Instance
  OVERLEAF_HEADER_IMAGE_URL: https://example.com/img/logo.png
  OVERLEAF_HEADER_EXTRAS: '[{"text":"Help","url":"https://example.com/help","class":"subdued"}]'
  OVERLEAF_LEFT_FOOTER: '[{"text":"Run by the IT department"}]'
  OVERLEAF_RIGHT_FOOTER: '[{"text":"Imprint","url":"https://example.com/imprint"}]'
  OVERLEAF_MAINTENANCE_MESSAGE: Our Overleaf Instance is down for maintenance and will be back shortly.

kubectl apply -f 30-config.yaml
kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf

Umieszczaj wartości JSON w pojedynczych cudzysłowach, jak powyżej, aby YAML zachował je jako jeden ciąg znaków. Nieprawidłowy JSON w OVERLEAF_HEADER_EXTRAS lub w stopkach jest ignorowany i jedynie zapisywany w logu przy starcie.

​

Tryb konserwacji

Strona konserwacji jest wyświetlana, dopóki plik /etc/overleaf/site_status w kontenerze zawiera closed. Każdy pod ma własną kopię tego pliku, a nowy lub zrestartowany pod startuje jako otwarty. Aby zamknąć witrynę, zapisz plik w każdym podzie:

for p in $(kubectl -n overleaf get pod -l app=overleaf -o name); do   # app=overleaf-ha for several replicas
  kubectl -n overleaf exec "$p" -- sh -c 'echo closed > /etc/overleaf/site_status'
done

Aby zakończyć konserwację, zapisz w ten sam sposób open. Pody wykrywają zmianę w ciągu 5 sekund.

Opcja Close Editor w panelu administracyjnym działa inaczej: zamyka edytor tylko w replice, która obsłużyła żądanie administratora, a ta replika otwiera go ponownie po restarcie. Przy kilku replikach zamiast tego używaj pliku, jak opisano powyżej.

​

Przetestowano na Kubernetes

Na Kubernetes 1.37: przy powyższych ustawieniach w ConfigMap strony wyświetlały OVERLEAF_NAV_TITLE, lewą stopkę oraz, po zalogowaniu, link z OVERLEAF_HEADER_EXTRAS (strony logowania ukrywają linki w nagłówku). Zapisanie closed w /etc/overleaf/site_status jednego poda wyświetliło stronę konserwacji z OVERLEAF_MAINTENANCE_MESSAGE tylko na tym podzie, a open zakończyło ją w ciągu kilku sekund. Przy trzech replikach opcja Close Editor w panelu administracyjnym zamknęła edytor tylko na replice, która obsłużyła administratora, podczas gdy dwie pozostałe pozostały otwarte.