Branding

Modificare il titolo del sito, il logo, i link dell’intestazione, i piè di pagina e il messaggio di manutenzione in un deployment Kubernetes.

Il servizio web genera il titolo, il logo, i link dell’intestazione, i piè di pagina e la pagina di manutenzione a partire dalle variabili d’ambiente. Ogni impostazione e il relativo formato sono descritti in Branding; su Kubernetes vanno nella ConfigMap.

Servizio	web, in ogni pod di Ayakaleaf Pro; letto all’avvio di web
Rete	nessuna: i loghi sono URL caricati dal browser
Job periodici	nessuno (web controlla il file di manutenzione ogni 5 secondi, vedi sotto)

​

Configurazione

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

Racchiudi i valori JSON tra virgolette singole, come sopra, in modo che YAML li mantenga come un’unica stringa. Un JSON non valido in OVERLEAF_HEADER_EXTRAS o nei piè di pagina viene ignorato e solo registrato nel log all’avvio.

​

Modalità di manutenzione

La pagina di manutenzione viene mostrata finché il file /etc/overleaf/site_status nel container contiene closed. Ogni pod ha la propria copia di questo file, e un pod nuovo o riavviato parte aperto. Per chiudere il sito, scrivi il file in ogni 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

Scrivi open allo stesso modo per terminarla. I pod recepiscono la modifica entro 5 secondi.

La funzione Close Editor del pannello di amministrazione funziona diversamente: chiude l’editor solo nella replica che ha gestito la richiesta dell’amministratore, e quella replica lo riapre al riavvio. Con più repliche, usa invece il file come descritto sopra.

​

Testato su Kubernetes

Su Kubernetes 1.37: con le impostazioni sopra nella ConfigMap, le pagine hanno mostrato OVERLEAF_NAV_TITLE, il piè di pagina sinistro e, dopo l’accesso, il link da OVERLEAF_HEADER_EXTRAS (le pagine di accesso nascondono i link dell’intestazione). Scrivere closed in /etc/overleaf/site_status di un pod ha mostrato la pagina di manutenzione con OVERLEAF_MAINTENANCE_MESSAGE solo su quel pod, e open l’ha terminata in pochi secondi. Con tre repliche, Close Editor del pannello di amministrazione ha chiuso l’editor solo sulla replica che ha servito l’amministratore, mentre le altre due sono rimaste aperte.