Huisstijl

Wijzig de sitetitel, het logo, de headerlinks, de footers en het onderhoudsbericht op een Kubernetes-implementatie.

De web-service rendert de titel, het logo, de headerlinks, de footers en de onderhoudspagina op basis van omgevingsvariabelen. Elke instelling en de bijbehorende notatie staan beschreven in Huisstijl; op Kubernetes gaan ze in de ConfigMap.

Service	web, in elke Ayakaleaf Pro-pod; gelezen wanneer web start
Netwerk	geen: logo’s zijn URL’s die de browser laadt
Periodieke taken	geen (web controleert het onderhoudsbestand elke 5 seconden, zie hieronder)

​

Configuratie

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

Zet JSON-waarden tussen enkele aanhalingstekens, zoals hierboven, zodat YAML ze als één string behoudt. Ongeldige JSON in OVERLEAF_HEADER_EXTRAS of de footers wordt genegeerd en alleen bij het opstarten gelogd.

​

Onderhoudsmodus

De onderhoudspagina wordt getoond zolang het bestand /etc/overleaf/site_status in de container closed bevat. Elke pod heeft een eigen kopie van dit bestand, en een nieuwe of herstarte pod start open. Om de site te sluiten, schrijf je het bestand in elke 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

Schrijf op dezelfde manier open om het onderhoud te beëindigen. De pods nemen de wijziging binnen 5 seconden over.

Close Editor in het beheerpaneel werkt anders: het sluit de editor alleen in de replica die het verzoek van de beheerder heeft afgehandeld, en die replica opent hem weer wanneer hij herstart. Gebruik bij meerdere replica’s in plaats daarvan het bestand zoals hierboven.

​

Getest op Kubernetes

Op Kubernetes 1.37: met de bovenstaande instellingen in de ConfigMap toonden de pagina’s OVERLEAF_NAV_TITLE, de linkerfooter en, na het inloggen, de link uit OVERLEAF_HEADER_EXTRAS (de inlogpagina’s verbergen de headerlinks). Het schrijven van closed in /etc/overleaf/site_status van één pod toonde de onderhoudspagina met OVERLEAF_MAINTENANCE_MESSAGE alleen op die pod, en open beëindigde dit binnen enkele seconden. Met drie replica’s sloot Close Editor in het beheerpaneel de editor alleen op de replica die de beheerder bediende, terwijl de andere twee open bleven.