Kubernetes

Configureer een Kubernetes-implementatie - waar instellingen, secrets en bestanden terechtkomen, en één pagina per functie.

Een Kubernetes-implementatie leest dezelfde omgevingsvariabelen als de Toolkit. Waar een Toolkit-pagina zegt “voeg dit toe aan config/variables.env”, zet je de waarde in de ConfigMap overleaf-env, of in de Secret overleaf-secrets als het om een wachtwoord, sleutel of token gaat. Herstart daarna:

kubectl -n overleaf apply -f 30-config.yaml        # after editing the ConfigMap
kubectl -n overleaf patch secret overleaf-secrets --type merge \
  -p '{"stringData":{"GITHUB_TOKEN_CIPHER_PASSWORD":"'"$(openssl rand -hex 32)"'"}}'
kubectl -n overleaf rollout restart deployment/overleaf

Waarden in config/overleaf.rc zijn Toolkit-instellingen, geen omgevingsvariabelen; de vragen en antwoorden aan het einde van deze pagina vertellen wat ze vervangt.

​

Functies

Elke functie van de Toolkit-configuratie heeft hier een pagina met de bijbehorende services, instellingen, netwerkpaden, achtergrondtaken, wat er verandert bij meerdere replica’s, en hoe het is getest:

Functie	Services in de pod	Naast de ConfigMap en Secret
Authenticatie: OIDC, SAML, LDAP, Openbare toegang, reCAPTCHA, Wachtwoordbeperkingen	web	client secrets, het IdP-certificaat, de LDAP-CA
Sandboxed Compiles	clsi	Docker Engine en de TeX Live-images op elke node
Pandoc-import en -export	clsi, web	de Pandoc-image in Docker op elke node
Git-integratie	git-bridge (eigen pod), web, history-v1	de git-bridge-StatefulSet en twee Services
GitHub-, GitLab-, Gitea-synchronisatie	web	Git-integratie
Dropbox-synchronisatie	web, third-party-datastore, document-updater	Git-integratie, de webhook bereikbaar vanaf internet, database-indexen
Zotero-, Mendeley-integratie	web	het cipher-wachtwoord in de Secret
MCP-server	web	Git-integratie
AI-integratie	web, linked-url-proxy	–
Overleaf Import API	web, linked-url-proxy	–
Sjablonen	web, filestore	S3 voor meerdere replica’s
Externe URL	linked-url-proxy	openbare node-adressen in OVERLEAF_LINKED_URL_BLOCKED_NETWORKS
Logging	elke service	een volume op /var/log/overleaf om logs te bewaren
TLS-proxy	je ingress of load balancer	TLS eindigt vóór de pods
Huisstijl	web	–
Lokalisatie	web	één hostnaam per taal
E-mailbezorging	web	–
Redis	elke service met live status	–
S3	history-v1, filestore	een S3-service, vereist voor meerdere replica’s
LaTeX-gebruikershulp toevoegen	web	de pods moeten de wiki kunnen bereiken
Horizontaal schalen	alle	S3, een load balancer met sticky sessions

​

Certificaten en andere bestanden

Sommige functies verwachten een bestandspad in plaats van een waarde: de SAML-certificaten (OVERLEAF_SAML_IDP_CERT, …), de LDAP-CA (OVERLEAF_LDAP_TLS_OPTS_CA_PATH), of een privé-CA voor een zelfgehoste GitHub Enterprise, GitLab of Gitea (NODE_EXTRA_CA_CERTS). Zet de bestanden in een Secret en mount die waar de Toolkit-pagina’s ze verwachten, /var/lib/overleaf/certs:

kubectl -n overleaf create secret generic overleaf-certs --from-file=idp_cert.pem --from-file=ca.pem

40-overleaf.yaml (additions)

          volumeMounts:
            # ...
            - name: certs
              mountPath: /var/lib/overleaf/certs
              readOnly: true
      volumes:
        # ...
        - name: certs
          secret:
            secretName: overleaf-certs

Verwijs er daarna in de ConfigMap naar via hun pad, bijvoorbeeld NODE_EXTRA_CA_CERTS: /var/lib/overleaf/certs/ca.pem, en herstart.

Cipher-wachtwoorden. Stel elk *_CIPHER_PASSWORD van de functies die je gebruikt in de Secret in. Sommige functies genereren anders bij het eerste gebruik een sleutelbestand in het datavolume: met één replica werkt dat totdat het volume verloren gaat, met meerdere replica’s zou elke replica met een andere sleutel versleutelen.

​

Vragen en antwoorden

Welke Toolkit-instellingen uit config/overleaf.rc heb ik nodig?

Antwoord: Geen ervan wordt door Ayakaleaf Pro gelezen. Hun tegenhangers in Kubernetes:

config/overleaf.rc	Kubernetes
OVERLEAF_LISTEN_IP, OVERLEAF_PORT	de Service (NodePort) of je ingress
SIBLING_CONTAINERS_ENABLED	SANDBOXED_COMPILES* in de ConfigMap, Docker-socket in de pod
GIT_BRIDGE_ENABLED	Git-integratie
MONGO_ENABLED, REDIS_ENABLED, MONGO_URL, REDIS_HOST	de StatefulSets of je beheerde services, OVERLEAF_MONGO_URL en OVERLEAF_REDIS_HOST
REDIS_AOF_PERSISTENCE	--appendonly yes in 20-redis.yaml
NGINX_ENABLED, TLS_*	je ingress of load balancer