Kubernetes

Configure uma implantação Kubernetes - onde ficam as configurações, os segredos e os arquivos, e uma página por recurso.

Uma implantação Kubernetes lê as mesmas variáveis de ambiente que o Toolkit. Onde uma página do Toolkit diz “adicione isto a config/variables.env”, coloque o valor no ConfigMap overleaf-env, ou no Secret overleaf-secrets quando for uma senha, chave ou token. Depois, reinicie:

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

Os valores em config/overleaf.rc são configurações do Toolkit, não variáveis de ambiente; o Q&A no final desta página indica o que os substitui.

​

Recursos

Cada recurso da configuração do Toolkit tem aqui uma página com seus serviços, configurações, caminhos de rede, tarefas em segundo plano, o que muda com várias réplicas e como foi testado:

Recurso	Serviços no pod	Além do ConfigMap e do Secret
Autenticação: OIDC, SAML, LDAP, Acesso público, reCAPTCHA, Restrições de senha	web	client secrets, o certificado do IdP, a CA do LDAP
Sandboxed Compiles	clsi	Docker Engine e as imagens do TeX Live em cada nó
Importação e exportação com Pandoc	clsi, web	a imagem do Pandoc no Docker em cada nó
Integração com Git	git-bridge (pod próprio), web, history-v1	o StatefulSet do git-bridge e dois Services
Sincronização com GitHub, GitLab, Gitea	web	Integração com Git
Sincronização com Dropbox	web, third-party-datastore, document-updater	Integração com Git, o webhook acessível pela internet, índices do banco de dados
Integração com Zotero, Mendeley	web	a senha de criptografia no Secret
Servidor MCP	web	Integração com Git
Integração com IA	web, linked-url-proxy	–
API de importação do Overleaf	web, linked-url-proxy	–
Templates	web, filestore	S3 para várias réplicas
URL externa	linked-url-proxy	endereços públicos dos nós em OVERLEAF_LINKED_URL_BLOCKED_NETWORKS
Logs	todos os serviços	um volume em /var/log/overleaf para manter os logs
Proxy TLS	seu ingress ou balanceador de carga	o TLS termina na frente dos pods
Identidade visual	web	–
Localização	web	um nome de host por idioma
Envio de e-mails	web	–
Redis	todos os serviços com estado em tempo real	–
S3	history-v1, filestore	um serviço S3, obrigatório para várias réplicas
Adicionar ajuda de LaTeX para usuários	web	os pods precisam alcançar a wiki
Escalonamento horizontal	todos	S3, um balanceador de carga com sessões persistentes (sticky sessions)

​

Certificados e outros arquivos

Alguns recursos recebem um caminho de arquivo em vez de um valor: os certificados SAML (OVERLEAF_SAML_IDP_CERT, …), a CA do LDAP (OVERLEAF_LDAP_TLS_OPTS_CA_PATH) ou uma CA privada para um GitHub Enterprise, GitLab ou Gitea auto-hospedado (NODE_EXTRA_CA_CERTS). Coloque os arquivos em um Secret e monte-o onde as páginas do Toolkit os esperam, /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

Em seguida, refira-se a eles pelo caminho no ConfigMap, por exemplo NODE_EXTRA_CA_CERTS: /var/lib/overleaf/certs/ca.pem, e reinicie.

Senhas de criptografia. Defina no Secret todas as *_CIPHER_PASSWORD dos recursos que você usa. Caso contrário, alguns recursos geram um arquivo de chave no volume de dados no primeiro uso: com uma réplica, isso funciona até o volume ser perdido; com várias réplicas, cada réplica criptografaria com uma chave diferente.

​

Q&A

De quais configurações do Toolkit em config/overleaf.rc eu preciso?

Resposta: Nenhuma delas é lida pelo Ayakaleaf Pro. Seus equivalentes no Kubernetes:

config/overleaf.rc	Kubernetes
OVERLEAF_LISTEN_IP, OVERLEAF_PORT	o Service (NodePort) ou seu ingress
SIBLING_CONTAINERS_ENABLED	SANDBOXED_COMPILES* no ConfigMap, socket do Docker no pod
GIT_BRIDGE_ENABLED	Integração com Git
MONGO_ENABLED, REDIS_ENABLED, MONGO_URL, REDIS_HOST	os StatefulSets ou seus serviços gerenciados, OVERLEAF_MONGO_URL e OVERLEAF_REDIS_HOST
REDIS_AOF_PERSISTENCE	--appendonly yes em 20-redis.yaml
NGINX_ENABLED, TLS_*	seu ingress ou balanceador de carga