> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Horizontální škálování

> Provoz několika replik Ayakaleaf Pro za load balancerem se sticky sessions.

Jedna replika využívá pro každou kompilaci CPU jednoho uzlu: na našich testovacích uzlech se 2 vCPU trvalo šest souběžných kompilací třikrát déle než jedna, zatímco ostatní uzly zůstaly nevyužité. Více replik rozkládá uživatele a jejich kompilace mezi uzly.

Vychází to z návrhu [horizontálního škálování](https://ayakaleaf-pro.mintlify.site/cs/on-premises/maintenance/horizontal-scaling.md) Overleafu, převedeného na Kubernetes:

| Požadavek | Zde |
| - | - |
| Sdílené MongoDB a Redis | `10-mongo.yaml` a `20-redis.yaml` z instalace |
| Sdílené tajné klíče | Secret `overleaf-secrets` z [kroku 2](https://ayakaleaf-pro.mintlify.site/cs/on-premises/installation/using-kubernetes/2.-create-the-namespace-and-secrets.md) je už obsahuje |
| Soubory projektů a historie v **S3** (ne NFS) | jakákoli služba S3, viz [S3](https://ayakaleaf-pro.mintlify.site/cs/on-premises/configuration/kubernetes/s3.md); tam Garage jako příklad v clusteru |
| Lokální disk pro každou repliku pro kompilace a nahrávání | `hostPath` `/srv/overleaf-ha` na každém uzlu |
| Trvalé směrování, WebSockety, 10min timeouty, nahrávání 50 MB | HAProxy s ukázkovou konfigurací Overleafu |
| git-bridge jako jediná instance vedle jedné repliky | git-bridge s `overleaf-0` jako sourozencem |

> [!WARNING]
>
> S3 plánujte od začátku. Instance, která už uchovává soubory na svém svazku, potřebuje nejprve [migraci na S3](https://ayakaleaf-pro.mintlify.site/cs/on-premises/maintenance/s3-migration.md). Toto nastavení nahrazuje Deployment z kroku 5: před aplikací StatefulSetu ho smažte (`kubectl delete -f 40-overleaf.yaml`).

**1. Úložiště S3**

Nastavte tři buckety a dva uživatele podle stránky [S3](https://ayakaleaf-pro.mintlify.site/cs/on-premises/configuration/kubernetes/s3.md), s vaší službou S3 nebo s Garage v clusteru, a čtyři klíče vložte do Secretu `overleaf-s3`. Konfigurace níže používá příklad s Garage z této stránky.

**2. Konfigurace**

Tato ConfigMapa nahrazuje `30-config.yaml`. Přidává S3 a git-bridge a nasměruje `OVERLEAF_SITE_URL` na load balancer:

```yaml title="60-config.yaml" wrap theme={null}
apiVersion: v1
kind: ConfigMap
metadata:
  name: overleaf-env
  namespace: overleaf
data:
  OVERLEAF_APP_NAME: Ayakaleaf Pro
  OVERLEAF_SITE_URL: http://192.0.2.10:30081      # the load balancer (HAProxy) URL
  OVERLEAF_ADMIN_EMAIL: admin@example.com
  # Emails: add the sender and the SMTP server together, see Email delivery
  OVERLEAF_MONGO_URL: mongodb://mongo-0.mongo:27017,mongo-1.mongo:27017,mongo-2.mongo:27017/sharelatex?replicaSet=overleaf
  OVERLEAF_REDIS_HOST: redis
  REDIS_HOST: redis
  ENABLED_LINKED_FILE_TYPES: project_file,project_output_file,url
  ENABLE_CONVERSIONS: "true"
  EMAIL_CONFIRMATION_DISABLED: "true"
  OVERLEAF_TRUSTED_PROXY_IPS: loopback,10.244.0.0/16   # HAProxy runs in the pod CIDR
  # Sandboxed compiles, node paths: each replica owns /srv/overleaf-ha on its node
  SANDBOXED_COMPILES: "true"
  SANDBOXED_COMPILES_SIBLING_CONTAINERS: "true"
  DOCKER_RUNNER: "true"
  SANDBOXED_COMPILES_HOST_DIR_COMPILES: /srv/overleaf-ha/data/compiles
  SANDBOXED_COMPILES_HOST_DIR_OUTPUT: /srv/overleaf-ha/data/output
  SANDBOXED_COMPILES_HOST_DIR_CACHE: /srv/overleaf-ha/data/cache
  ALL_TEX_LIVE_DOCKER_IMAGES: ghcr.io/ayaka-notes/texlive-full:2026.1
  ALL_TEX_LIVE_DOCKER_IMAGE_NAMES: TeX Live 2026
  TEX_LIVE_DOCKER_IMAGE: ghcr.io/ayaka-notes/texlive-full:2026.1
  # S3 (required for more than one replica); keys are in the Secret overleaf-s3
  OVERLEAF_FILESTORE_BACKEND: s3
  OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME: overleaf-template-files
  OVERLEAF_FILESTORE_S3_ENDPOINT: http://garage:3900
  OVERLEAF_FILESTORE_S3_PATH_STYLE: "true"
  OVERLEAF_FILESTORE_S3_REGION: garage
  OVERLEAF_HISTORY_BACKEND: s3
  OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET: overleaf-project-blobs
  OVERLEAF_HISTORY_CHUNKS_BUCKET: overleaf-chunks
  OVERLEAF_HISTORY_S3_ENDPOINT: http://garage:3900
  OVERLEAF_HISTORY_S3_PATH_STYLE: "true"
  OVERLEAF_HISTORY_S3_REGION: garage
  # Git integration: one git-bridge, its sibling is overleaf-0
  GIT_BRIDGE_ENABLED: "true"
  GIT_BRIDGE_HOST: 10.96.100.80      # the git-bridge Service's fixed ClusterIP, see 75-git-bridge.yaml
  GIT_BRIDGE_PORT: "8000"
```

**3. Repliky**

```yaml title="70-overleaf.yaml" wrap theme={null}
apiVersion: v1
kind: Service
metadata:
  name: overleaf-hl
  namespace: overleaf
spec:
  clusterIP: None            # stable DNS per replica: overleaf-0.overleaf-hl, ...
  selector:
    app: overleaf-ha
  ports:
    - {name: http, port: 80}
    - {name: web, port: 3000}       # git-bridge API (sibling only)
    - {name: history, port: 3100}   # history-v1, used by git-bridge via V1_HISTORY_URL
---
apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: overleaf
  namespace: overleaf
spec:
  serviceName: overleaf-hl
  replicas: 3
  # OrderedReady: overleaf-0 runs the migrations alone before the next replica starts
  podManagementPolicy: OrderedReady
  selector:
    matchLabels:
      app: overleaf-ha
  template:
    metadata:
      labels:
        app: overleaf-ha
    spec:
      terminationGracePeriodSeconds: 60
      # Keep the environment to the ConfigMap and Secrets: no REDIS_PORT=tcp://..., GIT_BRIDGE_PORT=tcp://...
      enableServiceLinks: false
      affinity:
        podAntiAffinity:            # one replica per node: each uses that node's Docker and disk
          requiredDuringSchedulingIgnoredDuringExecution:
            - labelSelector:
                matchLabels:
                  app: overleaf-ha
              topologyKey: kubernetes.io/hostname
      containers:
        - name: sharelatex
          image: ghcr.io/ayaka-notes/overleaf-pro:6.3.2
          env:
            - name: POD_NAME
              valueFrom:
                fieldRef:
                  fieldPath: metadata.name
            # Each replica hands out history URLs with its own stable name, so git-bridge can reach them
            - name: V1_HISTORY_URL
              value: http://$(POD_NAME).overleaf-hl.overleaf.svc.cluster.local:3100/api
          envFrom:
            - configMapRef: {name: overleaf-env}
            - secretRef: {name: overleaf-secrets}
            - secretRef: {name: overleaf-s3}
          ports:
            - containerPort: 80
          readinessProbe:
            httpGet: {path: /status, port: 80}
            periodSeconds: 10
          resources:
            requests: {cpu: 500m, memory: 1536Mi}
            limits: {memory: 3Gi}
          volumeMounts:
            - {name: local, mountPath: /var/lib/overleaf}
            - {name: docker-sock, mountPath: /var/run/docker.sock}
      volumes:
        # Local disk for ephemeral files (compiles, output, uploads); the HOST_DIR_* paths are under it
        - name: local
          hostPath: {path: /srv/overleaf-ha, type: DirectoryOrCreate}
        - name: docker-sock
          hostPath: {path: /var/run/docker.sock, type: Socket}
```

* **StatefulSet, ne Deployment.** Každá replika dostane stabilní název (`overleaf-0`, `overleaf-1`, ...), na který odkazuje cookie load balanceru i git-bridge, a `OrderedReady` nejprve spustí samotný `overleaf-0`, takže migrace databáze provádí pouze jedna replika.
* **Jedna replika na uzel.** Každá replika spouští své kompilace přes Docker svého uzlu a uchovává je v `/srv/overleaf-ha` svého uzlu.
* **`V1_HISTORY_URL` pro každou repliku.** Každá replika rozdává odkazy na historii se svým vlastním názvem, aby na ně git-bridge mohl dosáhnout.

**4. git-bridge**

```yaml title="75-git-bridge.yaml" wrap theme={null}
apiVersion: v1
kind: Service
metadata:
  name: git-bridge
  namespace: overleaf
spec:
  # Fixed ClusterIP (inside the service CIDR): the sharelatex image's nginx proxies /git/ with
  # `resolver 127.0.0.11` (Docker's DNS), which does not exist in Kubernetes, so GIT_BRIDGE_HOST is this IP
  clusterIP: 10.96.100.80
  selector:
    app: git-bridge
  ports:
    - {name: http, port: 8000}
---
apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: git-bridge
  namespace: overleaf
spec:
  serviceName: git-bridge
  replicas: 1
  selector:
    matchLabels:
      app: git-bridge
  template:
    metadata:
      labels:
        app: git-bridge
    spec:
      # Service "git-bridge" would inject GIT_BRIDGE_PORT=tcp://..., which git-bridge reads as its port
      enableServiceLinks: false
      containers:
        - name: git-bridge
          image: ghcr.io/ayaka-notes/overleaf-pro/git-bridge:6.3.2   # same version as the sharelatex image
          command: ["/server-pro-start.sh"]
          securityContext:
            runAsUser: 0
          env:
            - {name: GIT_BRIDGE_API_BASE_URL, value: "http://overleaf-0.overleaf-hl.overleaf.svc.cluster.local:3000/api/v0/"}
            - {name: GIT_BRIDGE_OAUTH2_SERVER, value: "http://overleaf-0.overleaf-hl.overleaf.svc.cluster.local"}
            - {name: GIT_BRIDGE_POSTBACK_BASE_URL, value: "http://git-bridge.overleaf.svc.cluster.local:8000"}
            - {name: GIT_BRIDGE_ROOT_DIR, value: /data/git-bridge}
          ports:
            - containerPort: 8000
          resources:
            requests: {cpu: 100m, memory: 256Mi}
            limits: {memory: 768Mi}
          volumeMounts:
            - {name: data, mountPath: /data/git-bridge}
  volumeClaimTemplates:
    - metadata:
        name: data
      spec:
        accessModes: [ReadWriteOnce]
        resources:
          requests:
            storage: 5Gi
```

Proč je `GIT_BRIDGE_HOST` pevná IP adresa, vysvětluje stránka [Integrace s Gitem](https://ayakaleaf-pro.mintlify.site/cs/on-premises/configuration/kubernetes/integrations/git-integration.md).

**5. Load balancer**

Konfigurace HAProxy je ukázka Overleafu s pěti změnami: `/project/<id>/mcp` směrované na `overleaf-0` stejně jako `/git/` (viz [MCP server](https://ayakaleaf-pro.mintlify.site/cs/on-premises/configuration/kubernetes/integrations/mcp-server.md#several-replicas)), prosté HTTP na portu `8080` (image běží jako uživatel bez práv root, který pod containerd nemůže otevřít port 80), servery nalezené přes DNS clusteru (IP adresy podů se mění při každém restartu), DaemonSet, aby odpovídal každý uzel, a `balance leastconn` místo výchozího `roundrobin` (viz Otázky a odpovědi níže).

```yaml title="80-haproxy.yaml" wrap theme={null}
apiVersion: v1
kind: ConfigMap
metadata:
  name: haproxy-config
  namespace: overleaf
data:
  haproxy.cfg: |
    global
      log stdout format raw local0 info

    resolvers kubedns
      parse-resolv-conf
      hold valid 10s

    defaults
      mode                    http
      # New sessions go to the replica with the fewest open connections (editors keep a WebSocket open)
      balance                 leastconn
      option                  httpchk HEAD /status
      http-check              expect status 200
      default-server          check resolvers kubedns init-addr none
      log                     global
      option                  httplog
      # Reroute to a different backend if the sticky one is down
      option                  redispatch 1
      retries                 3
      # Sticky session for 24h of inactivity -- compile output is deleted after 24h
      cookie                  server-pro-ha insert maxidle 24h
      timeout queue           1m
      timeout connect         15s
      timeout client          1m
      # Allow slow compiles -- hard-coded limit in clsi is 10min
      timeout server          10m
      # Disconnect the editor after 23h
      timeout tunnel          23h
      # Lower than NGINX_KEEPALIVE_TIMEOUT (65s) in the sharelatex container
      timeout http-keep-alive 60s

    listen overleaf
      bind :8080
      option forwardfor
      # When TLS ends in front of HAProxy, also pass:  http-request set-header X-Forwarded-Proto https
      # git requests go to the git-bridge sibling
      use-server overleaf-0 if { path_beg /git/ }
      # MCP clients send no cookie: keep compile, log and PDF download on one replica
      use-server overleaf-0 if { path_reg ^/project/[0-9a-f]{24}/mcp(/|$) }
      http-response add-header X-Served-By %s
      stats enable
      stats uri /haproxy
      server overleaf-0 overleaf-0.overleaf-hl.overleaf.svc.cluster.local:80 cookie overleaf-0
      server overleaf-1 overleaf-1.overleaf-hl.overleaf.svc.cluster.local:80 cookie overleaf-1
      server overleaf-2 overleaf-2.overleaf-hl.overleaf.svc.cluster.local:80 cookie overleaf-2
---
apiVersion: apps/v1
# DaemonSet: one HAProxy per node, so the NodePort answers on every node with externalTrafficPolicy
# Local. The cookie holds the replica name, so stickiness works whichever HAProxy a request hits.
kind: DaemonSet
metadata:
  name: haproxy
  namespace: overleaf
spec:
  selector:
    matchLabels:
      app: haproxy
  template:
    metadata:
      labels:
        app: haproxy
      annotations:
        config-hash: "1"   # bump to restart after editing the ConfigMap
    spec:
      containers:
        - name: haproxy
          image: haproxy:lts-alpine
          ports:
            - containerPort: 8080
          resources:
            requests: {cpu: 50m, memory: 32Mi}
            limits: {memory: 256Mi}
          volumeMounts:
            - {name: config, mountPath: /usr/local/etc/haproxy}
      volumes:
        - name: config
          configMap:
            name: haproxy-config
---
apiVersion: v1
kind: Service
metadata:
  name: haproxy
  namespace: overleaf
spec:
  type: NodePort
  externalTrafficPolicy: Local    # keep the client IP (no SNAT); only nodes running HAProxy answer
  selector:
    app: haproxy
  ports:
    - {name: http, port: 80, targetPort: 8080, nodePort: 30081}
```

```bash theme={null}
kubectl delete -f 40-overleaf.yaml --ignore-not-found
kubectl apply -f 60-config.yaml -f 70-overleaf.yaml -f 75-git-bridge.yaml -f 80-haproxy.yaml
kubectl -n overleaf rollout status statefulset/overleaf --timeout=20m
curl -sI http://192.0.2.10:30081/login | grep -i x-served-by
```

`externalTrafficPolicy: Local` zachovává IP adresy uživatelů v `X-Forwarded-For`.

**6. TLS**

Ukončete HTTPS v HAProxy podle stránky [TLS proxy](https://ayakaleaf-pro.mintlify.site/cs/on-premises/configuration/kubernetes/tls-proxy.md) a poté v `60-config.yaml` nastavte `OVERLEAF_SITE_URL` na adresu `https://` a `OVERLEAF_SECURE_COOKIE: "true"`.

### Co očekávat

Testovali jsme tři repliky na třech uzlech, každý se 2 vCPU a 4 GB, s MongoDB, Redisem, Garage, git-bridge a HAProxy na stejných uzlech:

* 12 uživatelů současně kompilujících 600stránkový dokument: všech 12 zkompilovalo a stáhlo své PDF, 4 uživatelé na repliku; jedno kolo trvalo 8 až 18 sekund. Každému uzlu zůstalo k dispozici nejméně 1,3 GB paměti.
* Každý uživatel zůstává na jedné replice (cookie `server-pro-ha`), včetně stahování PDF, které musí pocházet z repliky, jež ho zkompilovala. Totéž platí přes HTTPS, včetně WebSocketu editoru.
* Když se replika zastaví, její uživatelé dostávají chyby přibližně 15 až 20 sekund, dokud ji HAProxy neoznačí jako nedostupnou; poté přejdou na jinou repliku a zůstanou přihlášeni, protože relace jsou uloženy v Redisu.

### Otázky a odpovědi

> [accordion] Proč `balance leastconn`?
>
> **Odpověď:** S ukázkou Overleafu (`roundrobin`, jedna HAProxy na uzel) se v našem testu 12 nových uživatelů rozdělilo na tři repliky v poměru 8, 3 a 1 a nejvytíženější replika nechala nejpomalejší uživatele čekat 29 sekund. S `leastconn`, který upřednostňuje repliku s nejmenším počtem otevřených spojení (každý editor drží otevřený WebSocket), dal stejný test 4, 4 a 4 a 18 sekund. Přilepení k replice se nemění: zajišťuje ho cookie.

> [accordion] Mohu místo HAProxy použít svůj ingress controller?
>
> **Odpověď:** Ano, pokud směruje podle cookie na stabilní repliku, podporuje WebSockety, povoluje dobu požadavku 10 minut a nahrávání 50 MB, udržuje keep-alive timeout pod 65 sekundami, posílá `X-Forwarded-For` a `X-Forwarded-Proto` a posílá `/git/` a `/project/<id>/mcp` na `overleaf-0`. Směrujte na vlastní názvy replik (`overleaf-N.overleaf-hl`), nikoli na Service, která rozkládá každý požadavek.

> [accordion] Jak přidám čtvrtou repliku?
>
> **Odpověď:** Přidejte uzel s Dockerem a image TeX Live, nastavte `replicas: 4` v `70-overleaf.yaml` a přidejte do konfigurace HAProxy řádek `server overleaf-3 ...` (a zvyšte `config-hash`, aby se HAProxy restartovala).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.