Kubernetes

Konfigurace nasazení na Kubernetes – kam patří nastavení, tajné klíče a soubory, a jedna stránka pro každou funkci.

Nasazení na Kubernetes čte stejné proměnné prostředí jako Toolkit. Kde stránka o Toolkitu říká „přidejte to do config/variables.env“, vložte hodnotu do ConfigMapy overleaf-env, nebo do Secretu overleaf-secrets, pokud jde o heslo, klíč nebo token. Poté restartujte:

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

Hodnoty v config/overleaf.rc jsou nastavení Toolkitu, nikoli proměnné prostředí; co je nahrazuje, uvádí část Otázky a odpovědi na konci této stránky.

​

Funkce

Každá funkce z konfigurace Toolkitu zde má stránku s jejími službami, nastaveními, síťovými cestami, úlohami na pozadí, tím, co se mění při více replikách, a tím, jak byla otestována:

Funkce	Služby v podu	Nad rámec ConfigMapy a Secretu
Ověřování: OIDC, SAML, LDAP, Veřejný přístup, reCAPTCHA, Omezení hesel	web	tajné klíče klientů, certifikát IdP, CA serveru LDAP
Sandboxed Compiles	clsi	Docker Engine a image TeX Live na každém uzlu
Import a export přes Pandoc	clsi, web	image Pandoc v Dockeru na každém uzlu
Integrace s Gitem	git-bridge (vlastní pod), web, history-v1	StatefulSet git-bridge a dvě Services
Synchronizace s GitHubem, GitLabem, Gitea	web	Integrace s Gitem
Synchronizace s Dropboxem	web, third-party-datastore, document-updater	Integrace s Gitem, webhook dostupný z internetu, databázové indexy
Integrace Zotero, Mendeley	web	šifrovací heslo v Secretu
MCP server	web	Integrace s Gitem
Integrace AI	web, linked-url-proxy	–
Overleaf Import API	web, linked-url-proxy	–
Šablony	web, filestore	S3 pro více replik
Externí URL	linked-url-proxy	veřejné adresy uzlů v OVERLEAF_LINKED_URL_BLOCKED_NETWORKS
Logování	všechny služby	svazek v /var/log/overleaf pro uchování logů
TLS proxy	váš ingress nebo load balancer	TLS končí před pody
Branding	web	–
Lokalizace	web	jeden název hostitele pro každý jazyk
Doručování e-mailů	web	–
Redis	všechny služby s živým stavem	–
S3	history-v1, filestore	služba S3, vyžadovaná pro více replik
Přidání nápovědy k LaTeXu pro uživatele	web	pody musí dosáhnout na wiki
Horizontální škálování	všechny	S3, load balancer se sticky sessions

​

Certifikáty a další soubory

Některé funkce místo hodnoty přijímají cestu k souboru: certifikáty SAML (OVERLEAF_SAML_IDP_CERT, …), CA serveru LDAP (OVERLEAF_LDAP_TLS_OPTS_CA_PATH) nebo soukromou CA pro self-hosted GitHub Enterprise, GitLab nebo Gitea (NODE_EXTRA_CA_CERTS). Vložte soubory do Secretu a připojte ho tam, kde je stránky o Toolkitu očekávají, do /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

Poté na ně v ConfigMapě odkažte cestou, například NODE_EXTRA_CA_CERTS: /var/lib/overleaf/certs/ca.pem, a restartujte.

Šifrovací hesla. Nastavte v Secretu všechna *_CIPHER_PASSWORD funkcí, které používáte. Některé funkce jinak při prvním použití vygenerují soubor s klíčem v datovém svazku: s jednou replikou to funguje, dokud svazek nepřijde nazmar, s více replikami by každá replika šifrovala jiným klíčem.

​

Otázky a odpovědi

Která nastavení Toolkitu z config/overleaf.rc potřebuji?

Odpověď: Ayakaleaf Pro žádné z nich nečte. Jejich protějšky v Kubernetes:

config/overleaf.rc	Kubernetes
OVERLEAF_LISTEN_IP, OVERLEAF_PORT	Service (NodePort) nebo váš ingress
SIBLING_CONTAINERS_ENABLED	SANDBOXED_COMPILES* v ConfigMapě, socket Dockeru v podu
GIT_BRIDGE_ENABLED	Integrace s Gitem
MONGO_ENABLED, REDIS_ENABLED, MONGO_URL, REDIS_HOST	StatefulSety nebo vaše spravované služby, OVERLEAF_MONGO_URL a OVERLEAF_REDIS_HOST
REDIS_AOF_PERSISTENCE	--appendonly yes v 20-redis.yaml
NGINX_ENABLED, TLS_*	váš ingress nebo load balancer