Branding

Skift webstedets titel, logo, header-links, sidefødder og vedligeholdelsesbesked på en Kubernetes-udrulning.

web-tjenesten gengiver titel, logo, header-links, sidefødder og vedligeholdelsessiden ud fra miljøvariabler. Alle indstillinger og deres format er beskrevet i Branding; på Kubernetes lægges de i ConfigMap’en.

Tjeneste	web, i hver Ayakaleaf Pro-pod; læses, når web starter
Netværk	intet: logoer er URL’er, som browseren indlæser
Periodiske job	ingen (web tjekker vedligeholdelsesfilen hvert 5. sekund, se nedenfor)

​

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

Sæt JSON-værdier i enkelte anførselstegn som ovenfor, så YAML bevarer dem som én streng. Ugyldig JSON i OVERLEAF_HEADER_EXTRAS eller sidefødderne ignoreres og logges kun ved opstart.

​

Vedligeholdelsestilstand

Vedligeholdelsessiden vises, mens filen /etc/overleaf/site_status i containeren indeholder closed. Hver pod har sin egen kopi af denne fil, og en ny eller genstartet pod starter åben. For at lukke webstedet skal du skrive filen i hver 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

Skriv open på samme måde for at afslutte den. Podsene opfanger ændringen inden for 5 sekunder.

Administrationspanelets Close Editor fungerer anderledes: den lukker kun editoren i den replika, der håndterede administratorens forespørgsel, og den replika åbner den igen, når den genstarter. Ved flere replikaer skal du i stedet bruge filen som ovenfor.

​

Testet på Kubernetes

På Kubernetes 1.37: med indstillingerne ovenfor i ConfigMap’en viste siderne OVERLEAF_NAV_TITLE, den venstre sidefod og, efter login, linket fra OVERLEAF_HEADER_EXTRAS (loginsiderne skjuler header-linkene). Når closed blev skrevet i /etc/overleaf/site_status i én pod, blev vedligeholdelsessiden med OVERLEAF_MAINTENANCE_MESSAGE kun vist på den pod, og open afsluttede den inden for få sekunder. Med tre replikaer lukkede administrationspanelets Close Editor kun editoren på den replika, der håndterede administratoren, mens de to andre forblev åbne.