Kubernetes

Ein Kubernetes-Deployment konfigurieren - wohin Einstellungen, Secrets und Dateien gehören, und eine Seite pro Funktion.

Ein Kubernetes-Deployment liest dieselben Umgebungsvariablen wie das Toolkit. Wenn eine Toolkit-Seite sagt “fügen Sie dies zu config/variables.env hinzu”, tragen Sie den Wert in die ConfigMap overleaf-env ein, oder in das Secret overleaf-secrets, wenn es sich um ein Passwort, einen Schlüssel oder ein Token handelt. Starten Sie dann neu:

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

Werte in config/overleaf.rc sind Toolkit-Einstellungen, keine Umgebungsvariablen; das Q&A am Ende dieser Seite erklärt, was sie ersetzt.

​

Funktionen

Jede Funktion der Toolkit-Konfiguration hat hier eine eigene Seite mit ihren Diensten, Einstellungen, Netzwerkpfaden, Hintergrundjobs, den Änderungen bei mehreren Replikaten und der Art, wie sie getestet wurde:

Funktion	Dienste im Pod	Über die ConfigMap und das Secret hinaus
Authentifizierung: OIDC, SAML, LDAP, Öffentlicher Zugriff, reCAPTCHA, Passwortbeschränkungen	web	Client Secrets, das IdP-Zertifikat, die LDAP-CA
Sandboxed Compiles	clsi	Docker Engine und die TeX-Live-Images auf jedem Knoten
Pandoc-Import und -Export	clsi, web	das Pandoc-Image in Docker auf jedem Knoten
Git-Integration	git-bridge (eigener Pod), web, history-v1	das git-bridge-StatefulSet und zwei Services
GitHub-, GitLab-, Gitea-Synchronisierung	web	Git-Integration
Dropbox-Synchronisierung	web, third-party-datastore, document-updater	Git-Integration, der aus dem Internet erreichbare Webhook, Datenbankindizes
Zotero-, Mendeley-Integration	web	das Cipher-Passwort im Secret
MCP-Server	web	Git-Integration
KI-Integration	web, linked-url-proxy	–
Overleaf Import API	web, linked-url-proxy	–
Vorlagen	web, filestore	S3 für mehrere Replikate
Externe URL	linked-url-proxy	öffentliche Knotenadressen in OVERLEAF_LINKED_URL_BLOCKED_NETWORKS
Logging	jeder Dienst	ein Volume unter /var/log/overleaf, um Logs aufzubewahren
TLS-Proxy	Ihr Ingress oder Load Balancer	TLS endet vor den Pods
Branding	web	–
Lokalisierung	web	ein Hostname pro Sprache
E-Mail-Zustellung	web	–
Redis	jeder Dienst mit Live-Zustand	–
S3	history-v1, filestore	ein S3-Dienst, erforderlich für mehrere Replikate
LaTeX-Benutzerhilfe hinzufügen	web	die Pods müssen das Wiki erreichen
Horizontale Skalierung	alle	S3, ein Load Balancer mit Sticky Sessions

​

Zertifikate und andere Dateien

Einige Funktionen erwarten einen Dateipfad statt eines Werts: die SAML-Zertifikate (OVERLEAF_SAML_IDP_CERT, …), die LDAP-CA (OVERLEAF_LDAP_TLS_OPTS_CA_PATH) oder eine private CA für ein selbst gehostetes GitHub Enterprise, GitLab oder Gitea (NODE_EXTRA_CA_CERTS). Legen Sie die Dateien in ein Secret und hängen Sie es dort ein, wo die Toolkit-Seiten sie erwarten, unter /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

Verweisen Sie dann in der ConfigMap per Pfad darauf, zum Beispiel NODE_EXTRA_CA_CERTS: /var/lib/overleaf/certs/ca.pem, und starten Sie neu.

Cipher-Passwörter. Setzen Sie jedes *_CIPHER_PASSWORD der von Ihnen genutzten Funktionen im Secret. Andernfalls erzeugen einige Funktionen bei der ersten Verwendung eine Schlüsseldatei im Daten-Volume: Mit einem Replikat funktioniert das, bis das Volume verloren geht; mit mehreren Replikaten würde jedes Replikat mit einem anderen Schlüssel verschlüsseln.

​

Q&A

Welche Toolkit-Einstellungen aus config/overleaf.rc benötige ich?

Antwort: Keine davon wird von Ayakaleaf Pro gelesen. Ihre Kubernetes-Entsprechungen:

config/overleaf.rc	Kubernetes
OVERLEAF_LISTEN_IP, OVERLEAF_PORT	der Service (NodePort) oder Ihr Ingress
SIBLING_CONTAINERS_ENABLED	SANDBOXED_COMPILES* in der ConfigMap, Docker-Socket im Pod
GIT_BRIDGE_ENABLED	Git-Integration
MONGO_ENABLED, REDIS_ENABLED, MONGO_URL, REDIS_HOST	die StatefulSets oder Ihre verwalteten Dienste, OVERLEAF_MONGO_URL und OVERLEAF_REDIS_HOST
REDIS_AOF_PERSISTENCE	--appendonly yes in 20-redis.yaml
NGINX_ENABLED, TLS_*	Ihr Ingress oder Load Balancer