Branding

Seitentitel, Logo, Header-Links, Fußzeilen und Wartungsmeldung in einem Kubernetes-Deployment ändern.

Der web-Dienst rendert Titel, Logo, Header-Links, Fußzeilen und die Wartungsseite anhand von Umgebungsvariablen. Jede Einstellung und ihr Format sind unter Branding beschrieben; auf Kubernetes gehören sie in die ConfigMap.

Dienst	web, in jedem Ayakaleaf-Pro-Pod; beim Start von web gelesen
Netzwerk	keines: Logos sind URLs, die der Browser lädt
Periodische Jobs	keine (web prüft die Wartungsdatei alle 5 Sekunden, siehe unten)

​

Konfiguration

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

Setzen Sie JSON-Werte wie oben in einfache Anführungszeichen, damit YAML sie als eine Zeichenkette behält. Ungültiges JSON in OVERLEAF_HEADER_EXTRAS oder in den Fußzeilen wird ignoriert und nur beim Start protokolliert.

​

Wartungsmodus

Die Wartungsseite wird angezeigt, solange die Datei /etc/overleaf/site_status im Container closed enthält. Jeder Pod hat seine eigene Kopie dieser Datei, und ein neuer oder neu gestarteter Pod startet geöffnet. Um die Site zu schließen, schreiben Sie die Datei in jedem Pod:

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

Schreiben Sie auf dieselbe Weise open, um den Wartungsmodus zu beenden. Die Pods übernehmen die Änderung innerhalb von 5 Sekunden.

Close Editor im Admin-Bereich funktioniert anders: Es schließt den Editor nur auf dem Replikat, das die Anfrage des Administrators bearbeitet hat, und dieses Replikat öffnet ihn beim Neustart wieder. Verwenden Sie bei mehreren Replikaten stattdessen die Datei wie oben beschrieben.

​

Getestet auf Kubernetes

Auf Kubernetes 1.37: Mit den obigen Einstellungen in der ConfigMap zeigten die Seiten OVERLEAF_NAV_TITLE, die linke Fußzeile und nach der Anmeldung den Link aus OVERLEAF_HEADER_EXTRAS (die Anmeldeseiten blenden die Header-Links aus). Das Schreiben von closed in /etc/overleaf/site_status eines Pods zeigte die Wartungsseite mit OVERLEAF_MAINTENANCE_MESSAGE nur auf diesem Pod, und open beendete sie innerhalb von Sekunden. Mit drei Replikaten schloss Close Editor im Admin-Bereich den Editor nur auf dem Replikat, das den Administrator bediente, während die anderen beiden geöffnet blieben.