Kubernetes

Konfigurer en Kubernetes-udrulning - hvor indstillinger, hemmeligheder og filer placeres, og én side pr. funktion.

En Kubernetes-udrulning læser de samme miljøvariabler som Toolkit. Hvor en Toolkit-side siger „tilføj dette til config/variables.env”, skal du lægge værdien i ConfigMap’en overleaf-env eller i Secret’en overleaf-secrets, når det er en adgangskode, nøgle eller token. Genstart derefter:

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

Værdier i config/overleaf.rc er Toolkit-indstillinger, ikke miljøvariabler; spørgsmål og svar sidst på denne side fortæller, hvad der erstatter dem.

​

Funktioner

Hver funktion i Toolkit-konfigurationen har en side her med dens tjenester, indstillinger, netværksstier, baggrundsjob, hvad der ændrer sig med flere replikaer, og hvordan den er testet:

Funktion	Tjenester i poden	Ud over ConfigMap og Secret
Godkendelse: OIDC, SAML, LDAP, Offentlig adgang, reCAPTCHA, Adgangskodekrav	web	klienthemmeligheder, IdP-certifikatet, LDAP-CA’en
Sandboxed Compiles	clsi	Docker Engine og TeX Live-imagesene på hver node
Pandoc-import og -eksport	clsi, web	Pandoc-imaget i Docker på hver node
Git-integration	git-bridge (egen pod), web, history-v1	git-bridge-StatefulSet’et og to Services
GitHub-, GitLab-, Gitea-synkronisering	web	Git-integration
Dropbox-synkronisering	web, third-party-datastore, document-updater	Git-integration, webhooken tilgængelig fra internettet, databaseindekser
Zotero-, Mendeley-integration	web	cipher-adgangskoden i Secret’en
MCP-server	web	Git-integration
AI-integration	web, linked-url-proxy	–
Overleaf Import API	web, linked-url-proxy	–
Skabeloner	web, filestore	S3 ved flere replikaer
Ekstern URL	linked-url-proxy	offentlige nodeadresser i OVERLEAF_LINKED_URL_BLOCKED_NETWORKS
Logning	alle tjenester	en volumen på /var/log/overleaf til at bevare logs
TLS-proxy	din ingress eller load balancer	TLS afsluttes foran podsene
Branding	web	–
Lokalisering	web	ét værtsnavn pr. sprog
Levering af e-mail	web	–
Redis	alle tjenester med live-tilstand	–
S3	history-v1, filestore	en S3-tjeneste, påkrævet ved flere replikaer
Tilføjelse af LaTeX-brugerhjælp	web	podsene skal kunne nå wikien
Horisontal skalering	alle	S3, en load balancer med sticky sessions

​

Certifikater og andre filer

Nogle funktioner tager en filsti i stedet for en værdi: SAML-certifikaterne (OVERLEAF_SAML_IDP_CERT, …), LDAP-CA’en (OVERLEAF_LDAP_TLS_OPTS_CA_PATH) eller en privat CA til en selvhostet GitHub Enterprise, GitLab eller Gitea (NODE_EXTRA_CA_CERTS). Læg filerne i en Secret, og montér den, hvor Toolkit-siderne forventer dem, /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

Henvis derefter til dem via sti i ConfigMap’en, for eksempel NODE_EXTRA_CA_CERTS: /var/lib/overleaf/certs/ca.pem, og genstart.

Cipher-adgangskoder. Angiv alle *_CIPHER_PASSWORD for de funktioner, du bruger, i Secret’en. Ellers genererer nogle funktioner en nøglefil i datavolumen ved første brug: med én replika virker det, indtil volumen går tabt, men med flere replikaer ville hver replika kryptere med en forskellig nøgle.

​

Spørgsmål og svar

Hvilke Toolkit-indstillinger fra config/overleaf.rc har jeg brug for?

Svar: Ingen af dem læses af Ayakaleaf Pro. Deres modstykker i Kubernetes:

config/overleaf.rc	Kubernetes
OVERLEAF_LISTEN_IP, OVERLEAF_PORT	Service’en (NodePort) eller din ingress
SIBLING_CONTAINERS_ENABLED	SANDBOXED_COMPILES* i ConfigMap’en, Docker-socket i poden
GIT_BRIDGE_ENABLED	Git-integration
MONGO_ENABLED, REDIS_ENABLED, MONGO_URL, REDIS_HOST	StatefulSet’ene eller dine administrerede tjenester, OVERLEAF_MONGO_URL og OVERLEAF_REDIS_HOST
REDIS_AOF_PERSISTENCE	--appendonly yes i 20-redis.yaml
NGINX_ENABLED, TLS_*	din ingress eller load balancer