Horizontální škálování

Ayakaleaf Pro podporuje horizontální škálování. Otestovali a ověřili jsme, že s více replikami funguje správně.

Tento dokument uvádí technické požadavky a poskytuje pokyny pro provoz Ayakaleaf Pro na více než jednom uzlu.

Počínaje verzí Server CE/Server Pro 5.0.3 byly proměnné prostředí přejmenovány z SHARELATEX_* na OVERLEAF_*.

Pokud používáte verzi 4.x (nebo starší), ujistěte se, že mají proměnné odpovídající předponu (např. SHARELATEX_SITE_URL místo OVERLEAF_SITE_URL)

Nastavení horizontálního škálování vyžaduje značné úsilí. Doporučujeme zvažovat horizontální škálování až po dosažení určitého rozsahu. Například instalace Server Pro pro celkem 1 000 uživatelů byla úspěšně provozována na jediném serveru se dvěma čtyřjádrovými procesory a 32 GB systémové paměti. Doporučení najdete v dokumentaci hardwarových požadavků.

Nasazení Server Pro s horizontálním škálováním zahrnuje sadu externích komponent, jako je nástroj pro vyrovnávání zátěže (load balancer) a úložný backend kompatibilní s S3.

Můžeme pomoci s řešením chyb v kontejnerech Server Pro, které mohou být důsledkem chybné konfigurace, a poskytnout obecné rady na základě tohoto dokumentu. Bohužel nemůžeme poskytnout pomoc s konfigurací aplikací a systémů třetích stran.

Řešení technických problémů specifických pro váš hardware a software, které zajišťují externí komponenty, není součástí našich podmínek podpory.

​

Požadavky

​

Externí centrální úložiště dat

Úložiště dat v Server Pro lze rozdělit do čtyř datových úložišť:

• MongoDB

  • Většina dat je trvale ukládána do MongoDB.
  • Podporujeme lokální instanci i externí instanci, například MongoDB Atlas (plně spravovaná služba MongoDB běžící v infrastruktuře AWS).
    

  Poznámka: Bohužel v současnosti neexistuje oficiální podpora databází kompatibilních s MongoDB, jako jsou CosmoDB/DocumentDB, protože jsme s nimi Server Pro netestovali. Nasazení Server Pro s kompatibilními databázemi může být možné, oficiálně však podporujeme pouze nasazení využívající MongoDB.
  

• Redis

  • Redis ukládá dočasná data, například čekající aktualizace dokumentů předtím, než jsou zapsány do MongoDB.
  • Redis slouží k předávání aktualizací dokumentů mezi různými službami a k upozorňování editoru na změny stavu v daném projektu.
  • Redis slouží k ukládání uživatelských relací.
  • Podporujeme lokální instanci i externí instanci.
    

  Poznámka: Bohužel v současnosti neexistuje oficiální podpora úložišť klíč/hodnota kompatibilních s Redisem, jako jsou KeyDB/Valkey, protože jsme s nimi Server Pro netestovali. Nasazení Server Pro s kompatibilními úložišti může být možné, oficiálně však podporujeme pouze nasazení využívající Redis.
  

• Soubory projektů a soubory historie

  • Neupravitelné soubory projektů jsou uloženy mimo MongoDB.

    Nový systém historie projektů (od Server Pro 3.5) ukládá historii rovněž mimo MongoDB.

  • Pro malé samostatné instance podporujeme buď lokální souborový systém (který může být založen na lokálním SSD, NFS nebo EBS), nebo systém úložiště dat kompatibilní s S3.

  • Pro horizontální škálování podporujeme pouze systémy úložiště dat kompatibilní s S3.
    

  Důležité: NFS/Amazon EFS/Amazon EBS nejsou pro horizontální škálování podporovány. Další podrobnosti o škálování úložiště v Server Pro najdete v části požadavků na hardwarové úložiště.

• Dočasné soubory

  • Kompilace LaTeXu musí pro optimální výkon běžet na rychlých lokálních discích. Výstup kompilace není třeba trvale ukládat ani zálohovat.
  • Lokální disk je přínosný také pro ukládání nově nahrávaných souborů do vyrovnávací paměti a pro vytváření zip souborů projektů.

Důrazně doporučujeme používat lokální disk. Použití jakéhokoli síťového disku (například NFS nebo EBS) může vést k neočekávaným chybám kompilace a dalším problémům s výkonem.

​

Git-bridge

Git-bridge je v Server Pro k dispozici od verze 4.0.1.

Git repozitáře jsou uloženy lokálně na disku. Nejsou k dispozici žádné možnosti replikace. Git-bridge by měl běžet jako singleton (jediná instance). Pro optimální výkon doporučujeme pro data git-bridge používat lokální disk. Datový disk git-bridge by se měl pravidelně zálohovat.

Pro úložiště dat s horizontálním škálováním potřebujete:

• centrální instanci MongoDB, která je přístupná ze všech instancí Server Pro
• centrální instanci Redis, která je přístupná ze všech instancí Server Pro
• centrální úložný backend kompatibilní s S3 pro soubory projektů a historie
• lokální disk na každé instanci pro dočasné soubory
• lokální disk na instanci, která hostuje kontejner git-bridge, pro data git-bridge

​

Požadavky na load balancer

• Trvalé směrování (persistent routing), např. pomocí cookie

  Tento požadavek vyplývá z těchto komponent:

  • Funkce úprav v reálném čase v Server Pro používá WebSockets se záložním řešením v podobě XHR pollingu. Každá relace úprav má na straně serveru lokální stav a požadavky dané relace úprav musí být vždy směrovány na stejnou instanci Server Pro. Funkce spolupráce používá Redis Pub/Sub ke sdílení aktualizací mezi více instancemi Server Pro.
  • Kompilace LaTeXu uchovává výstup a mezipaměť kompilace lokálně kvůli výkonu. Po odeslání požadavku na kompilaci na jednu instanci Server Pro musí být následné požadavky na stažení PDF/protokolu směrovány na stejnou instanci Server Pro.

• Dlouhé časové limity požadavků pro podporu kompilace velkých dokumentů LaTeX

• Podpora WebSocket pro optimální výkon

• Velikost těla požadavku POST 50 MB

• Časový limit keep-alive musí být nižší než časový limit keep-alive v Server Pro

  Časový limit keep-alive v Server Pro lze nastavit pomocí proměnné prostředí NGINX_KEEPALIVE_TIMEOUT. Výchozí hodnota je 65 s.

  Při výchozím nastavení funguje časový limit keep-alive 60 s v load balanceru.

  Při NGINX_KEEPALIVE_TIMEOUT=120 by load balancer mohl zvolit 115 s.

• IP adresy klientů

  Nastavte hlavičku požadavku X-Forwarded-For na IP adresu klienta.

• Při ukončování SSL

  Load balancer musí přidat hlavičku požadavku X-Forwarded-Proto: https.

Ukázková konfigurace HAProxy

global
  group haproxy
  user haproxy

  # Verbose logging
  log stdout format raw local0 debug

defaults
  mode                    http
  option                  httpchk HEAD /status
  http-check              expect status 200
  default-server          check

  # Verbose logging
  log                     global
  option                  httplog

  # Reroute to a different backend if the sticky one is down
  option                  redispatch 1
  # These retries are for TCP connect errors, not on HTTP status 500 responses
  retries                 3

  # Sticky session for 24h of inactivity -- compile output is deleted after 24h
  cookie                  server-pro-ha insert maxidle 24h

  # Try to connect to any backend for 1min, then return 503
  timeout queue           1m
  # Give Server Pro instances 15s to startup
  timeout connect         15s

  # Abort requests from very slow clients (allow 1min of inactivity when reading a request)
  timeout client          1m

  # Allow slow compiles -- hard-coded limit in clsi is 10min
  timeout server          10m

  # Disconnect the editor after 23h -- 1h ahead of their last use yesterday
  timeout tunnel          23h

  # Note: The keepalive behavior in haproxy works great with the default keepalive setup in Server Pro.
  #       Haproxy is cleaning up connections in the background and it will redispatch requests when needed.

listen server-pro-ha-http
  bind :80
  http-request redirect scheme https unless { ssl_fc }

listen server-pro-ha-https
  bind :443 ssl crt /etc/ssl/certs/ssl-key-and-certificate-bundle.pem

  # Tell the application that we are behind https
  http-request set-header X-Forwarded-Proto https

  # Tell the application the actual client ip
  option forwardfor

  # See https://hstspreload.org/#deployment-recommendations
  http-response set-header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload;"

  # Route git traffic to the sibling container of the git-bridge
  use-server server-pro-ha-1 if { path_beg /git/ }

  # Debugging
  http-response add-header X-Served-By %s
  stats enable
  stats uri /haproxy

  server server-pro-ha-1 198.18.1.1:80 cookie server-pro-ha-1
  server server-pro-ha-2 198.18.1.2:80 cookie server-pro-ha-2
  server server-pro-ha-3 198.18.1.3:80 cookie server-pro-ha-3

​

Konfigurace Server Pro

Tajné klíče

Instance Server Pro se musí shodovat na sdílených tajných klíčích:

• WEB_API_PASSWORD (ověřování web api)
• STAGING_PASSWORD a V1_HISTORY_PASSWORD se stejnou hodnotou (ověřování historie)
• CRYPTO_RANDOM (pro cookie relace)
• OT_JWT_AUTH_KEY (ověřování historie)

Každý z těchto tajných klíčů musí být nakonfigurován s vlastní jedinečnou hodnotou a sdílen mezi instancemi.

Pokud nejsou nakonfigurovány a požadavky uživatelů jsou směrovány na různé instance Server Pro, jejich požadavky neprojdou kontrolami ověření a uživatelé budou buď často přesměrováváni na přihlašovací stránku, nebo jejich akce v uživatelském rozhraní budou selhávat neočekávaným způsobem.

Pokud nejsou nakonfigurovány, Server Pro použije pro každý tajný klíč novou náhodnou hodnotu založenou na 32 náhodných bajtech z /dev/urandom (256 náhodných bitů).

# https://github.com/overleaf/overleaf/blob/45ca0f796c679103efd305ddbef28073c4a5de32/server-ce/init_scripts/00_regen_sharelatex_secrets.sh#L14
dd if=/dev/urandom bs=1 count=32 2>/dev/null | base64 -w 0 | rev | cut -b 2- | rev | tr -d '\n+/'

MongoDB

Nasměrujte OVERLEAF_MONGO_URL (SHARELATEX_MONGO_URL pro verze 4.x a starší) na centrální instanci MongoDB.

Redis

Nasměrujte OVERLEAF_REDIS_HOST (SHARELATEX_REDIS_HOST pro verze 4.x a starší) a REDIS_HOST na centrální instanci Redis.

Úložiště kompatibilní s S3 pro soubory projektů a historie

Podrobnosti najdete v dokumentaci k úložišti kompatibilnímu s S3.

Dočasné soubory

Výchozí bind-mount lokálního SSD do /var/lib/overleaf (/var/lib/sharelatex pro verze 4.x a starší) bude dostačující. Nezapomeňte nasměrovat SANDBOXED_COMPILES_HOST_DIR na přípojný bod na hostiteli.

Důrazně doporučujeme používat lokální disk. Použití jakéhokoli síťového disku (například NFS nebo EBS) může vést k neočekávaným chybám kompilace a dalším problémům s výkonem.

Konfigurace proxy

• Nastavte OVERLEAF_BEHIND_PROXY=true (SHARELATEX_BEHIND_PROXY pro verze 4.x a starší), abyste získali přesné IP adresy klientů.
• Nastavte TRUSTED_PROXY_IPS na IP adresu load balanceru (lze zadat více CIDR oddělených čárkou).

Integrace git-bridge

Git-bridge je v Server Pro k dispozici od verze 4.0.1.

Kontejner git-bridge potřebuje sesterský kontejner Server Pro, který obsluhuje příchozí git požadavky. Tento sesterský kontejner může obsluhovat i běžný uživatelský provoz. V ukázkové konfiguraci slouží jako sesterský kontejner pro git-bridge první instance, ve skutečnosti však může tuto roli plnit kterákoli instance.

Proč je potřeba určit jeden kontejner Server Pro jako sesterský pro git-bridge? Server Pro předává git-bridge URL pro stahování ze služby historie. Tyto URL historie je nutné nakonfigurovat tak, aby byly přístupné z kontejneru git-bridge.

Konfigurace kontejneru Server Pro:

• Nastavte GIT_BRIDGE_ENABLED na 'true'

• Nastavte GIT_BRIDGE_HOST na <git-bridge container name>, např. git-bridge

• Nastavte GIT_BRIDGE_PORT na 8000

• Nastavte V1_HISTORY_URL na http://<server-pro sibling container name>:3100/api.

  Poznámka: To je nutné pouze u sesterského kontejneru pro kontejner git-bridge. Ostatní instance mohou používat URL localhost, což je výchozí nastavení.

Konfigurace kontejneru git-bridge:

• Nastavte GIT_BRIDGE_API_BASE_URL na http://<server-pro sibling container name>/api/v0, např. http://server-pro-ha-1/api/v0
• Nastavte GIT_BRIDGE_OAUTH2_SERVER na http://<server-pro sibling container name>, např. http://server-pro-ha-1
• Nastavte GIT_BRIDGE_POSTBACK_BASE_URL na http://<git-bridge container name>:8000, např. http://git-bridge:8000
• Nastavte GIT_BRIDGE_ROOT_DIR na datový disk git-bridge připojený pomocí bind-mount, např. /data/git-bridge

Ukázková konfigurace docker-compose.yml

Následující konfigurace ukazuje samostatné nastavení. Aby ukázka fungovala, musíte poskytnout platný klíč/certifikát SSL a upravit OVERLEAF_SITE_URL (SHARELATEX_SITE_URL pro verze 4.x a starší). Pro skutečné nasazení musíte nahradit fiktivní tajné klíče skutečnými, jak je uvedeno v komentářích. Pro skutečné nasazení musíte jednotlivé kontejnery přesunout na vyhrazené uzly a upravit IP adresy podle nastavení vaší místní sítě.

version: '2.2'

# Actual horizontal scaling setup: pick your own network and replace IPs in config.
networks:
    default:
        ipam:
            config:
                # This subnet is part of a reserved subnet used for benchmarking
                # https://tools.ietf.org/html/rfc2544
                # The full subnet is 198.18.0.0/15
                # Use 198.18.0.0/24 for lb and dbs
                # Use 198.18.1.0/24 for server-pro
                # Use 198.18.0.128/25 for ephemeral container
                - gateway: 198.18.0.1
                  ip_range: 198.18.0.128/25
                  subnet: 198.18.0.0/23

services:
    # Actual horizontal scaling setup: run haproxy outside docker on a separate host.
    lb:
        image: haproxy:2.6
        container_name: lb
        user: root
        logging:
            driver: local
            options:
                max-size: 10g
                max-file: '100'
        volumes:
            - ./haproxy.conf:/usr/local/etc/haproxy/haproxy.cfg
            # $ cat certificate.pem key.pem > ssl-key-and-certificate-bundle.pem
            - /path/to/ssl-key-and-certificate-bundle.pem:/etc/ssl/certs/ssl-key-and-certificate-bundle.pem
        # Alternative to "ports": use host network to avoid docker-proxy overhead
        network_mode: host

        # Alternative to "network_mode: host": use docker-proxy for network isolation
        # ports:
        #     - "80:80"
        #     - "443:443"
        # networks:
        #     default:
        #         ipv4_address: 198.18.0.2

        # Actual horizontal scaling setup: remove these as they run on other hosts.
        depends_on:
            server-pro-ha-1:
                condition: service_started
            server-pro-ha-2:
                condition: service_started
            server-pro-ha-3:
                condition: service_started

    # Actual horizontal scaling setup: run this container next to server-pro-ha-1.
    # For Server Pro 4.0 onwards.
    git-bridge:
        restart: always
        # The tag should match the `server-pro-ha-1` container tag.
        image: quay.io/sharelatex/git-bridge:4.0.1
        volumes:
            # Actual horizontal scaling setup: point /data/git-bridge at a dedicated local ssd.
            - ~/git_bridge_data:/data/git-bridge
        container_name: git-bridge
        environment:
            GIT_BRIDGE_API_BASE_URL: "http://server-pro-ha-1/api/v0"
            GIT_BRIDGE_OAUTH2_SERVER: "http://server-pro-ha-1"
            GIT_BRIDGE_POSTBACK_BASE_URL: "http://198.18.0.6:8000"
            GIT_BRIDGE_ROOT_DIR: "/data/git-bridge"
        user: root
        command: ["/server-pro-start.sh"]

        # Actual horizontal scaling setup: run on host 198.18.0.6 and expose port
        # ports:
        #     - "8000:8000"
        networks:
            default:
                ipv4_address: 198.18.0.6

    # Actual horizontal scaling setup: run this container on a separate host.
    server-pro-ha-1: &server-pro-ha-config
        restart: always
        image: quay.io/sharelatex/sharelatex-pro:4.0.1
        container_name: server-pro-ha-1
        hostname: server-pro-ha-1
        depends_on:
            # Actual horizontal scaling setup: keep this entry.
            git-bridge:
                condition: service_started

            # Actual horizontal scaling setup: remove the ones below as they run on other hosts.
            mongo:
                condition: service_healthy
            redis:
                condition: service_started
            minio:
                condition: service_started
            mongo_replica_set_setup:
                condition: service_completed_successfully
            minio_setup:
                condition: service_completed_successfully
        stop_grace_period: 60s
        volumes:
            - /tmp/scratch-disk1:/var/lib/sharelatex
            - /var/run/docker.sock:/var/run/docker.sock
        environment: &server-pro-ha-environment
            # Actual horizontal scaling setup: provide your own domain/app name.
            OVERLEAF_SITE_URL: 'https://overleaf.example.com'
            OVERLEAF_APP_NAME: Server Pro Horizontal Scaling Demo

            OVERLEAF_MONGO_URL: mongodb://198.18.0.3/sharelatex
            OVERLEAF_REDIS_HOST: 198.18.0.4
            REDIS_HOST: 198.18.0.4

            ENABLED_LINKED_FILE_TYPES: 'project_file,project_output_file'
            EMAIL_CONFIRMATION_DISABLED: 'true'

            SANDBOXED_COMPILES: 'true'
            SANDBOXED_COMPILES_SIBLING_CONTAINERS: 'true'
            SANDBOXED_COMPILES_HOST_DIR: '/tmp/scratch-disk1/data/compiles'

            # S3
            # Actual horizontal scaling setup: pick secure credentials.
            OVERLEAF_FILESTORE_BACKEND: s3
            OVERLEAF_FILESTORE_USER_FILES_BUCKET_NAME: overleaf-user-files
            OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME: overleaf-template-files
            OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID: OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID
            OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY: OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY
            OVERLEAF_FILESTORE_S3_ENDPOINT: http://198.18.0.5:9000
            OVERLEAF_FILESTORE_S3_PATH_STYLE: 'true'
            OVERLEAF_FILESTORE_S3_REGION: ''

            OVERLEAF_HISTORY_BACKEND: "s3"
            OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET: "overleaf-project-blobs"
            OVERLEAF_HISTORY_CHUNKS_BUCKET: "overleaf-chunks"
            OVERLEAF_HISTORY_S3_ACCESS_KEY_ID: "OVERLEAF_HISTORY_S3_ACCESS_KEY_ID"
            OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY: "OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY"
            OVERLEAF_HISTORY_S3_ENDPOINT: http://198.18.0.5:9000
            OVERLEAF_HISTORY_S3_PATH_STYLE: 'true'
            OVERLEAF_HISTORY_S3_REGION: ''
            # /S3

            # git-bridge
            GIT_BRIDGE_ENABLED: 'true'
            GIT_BRIDGE_HOST: 198.18.0.6
            GIT_BRIDGE_PORT: 8000
            # Only needed on the sibling instance of git-bridge
            V1_HISTORY_URL: "http://server-pro-ha-1:3100/api"
            # /git-bridge

            # Horizontal scaling
            # Actual horizontal scaling setup: pick secure credentials.
            WEB_API_PASSWORD: WEB_API_PASSWORD
            STAGING_PASSWORD: V1_HISTORY_PASSWORD
            V1_HISTORY_PASSWORD: V1_HISTORY_PASSWORD
            CRYPTO_RANDOM: CRYPTO_RANDOM
            OT_JWT_AUTH_KEY: OT_JWT_AUTH_KEY
            OVERLEAF_BEHIND_PROXY: 'true'
            # Actual horizontal scaling setup: IPs of load balancers
            TRUSTED_PROXY_IPS: 198.18.0.1,198.18.0.2
            # /Horizontal scaling

        # Actual horizontal scaling setup: run on host 198.18.1.1 and expose ports
        # ports:
        #     - "80:80"
        networks:
            default:
                ipv4_address: 198.18.1.1

    # Actual horizontal scaling setup: run this container on a separate host.
    server-pro-ha-2:
        <<: *server-pro-ha-config
        hostname: server-pro-ha-2
        container_name: server-pro-ha-2
        volumes:
            - /tmp/scratch-disk2:/var/lib/sharelatex
            - /var/run/docker.sock:/var/run/docker.sock
        environment:
            <<: *server-pro-ha-environment
            SANDBOXED_COMPILES_HOST_DIR: '/tmp/scratch-disk2/data/compiles'
            V1_HISTORY_URL: "http://localhost:3100/api"

        # Actual horizontal scaling setup: run on host 198.18.1.2 and expose ports
        # ports:
        #     - "80:80"
        networks:
            default:
                ipv4_address: 198.18.1.2

    # Actual horizontal scaling setup: run this container on a separate host.
    server-pro-ha-3:
        <<: *server-pro-ha-config
        hostname: server-pro-ha-3
        container_name: server-pro-ha-3
        volumes:
            - /tmp/scratch-disk3:/var/lib/sharelatex
            - /var/run/docker.sock:/var/run/docker.sock
        environment:
            <<: *server-pro-ha-environment
            SANDBOXED_COMPILES_HOST_DIR: '/tmp/scratch-disk3/data/compiles'
            V1_HISTORY_URL: "http://localhost:3100/api"

        # Actual horizontal scaling setup: run on host 198.18.1.3 and expose ports
        # ports:
        #     - "80:80"
        networks:
            default:
                ipv4_address: 198.18.1.3

    # Actual horizontal scaling setup: run this container on a separate host.
    minio:
        image: minio/minio:RELEASE.2023-05-18T00-05-36Z
        container_name: minio
        command: server /data
        volumes:
            # Actual horizontal scaling setup: run minio with multiple disks, see minio docs.
            - ~/minio_data:/data
        environment:
            # Actual horizontal scaling setup: pick secure credentials.
            MINIO_ROOT_USER: MINIO_ROOT_USER
            MINIO_ROOT_PASSWORD: MINIO_ROOT_PASSWORD

        # Actual horizontal scaling setup: run on host 198.18.0.5 and expose port
        # ports:
        #     - "9000:9000"
        networks:
            default:
                ipv4_address: 198.18.0.5

    # Actual horizontal scaling setup: run this setup once on a separate host.
    minio_setup:
        depends_on:
            - minio
        image: minio/mc:RELEASE.2023-05-18T16-59-00Z
        entrypoint: sh
        command:
            - '-c'
            # Actual horizontal scaling setup: pick secure credentials.
            - |
                mc alias set s3 http://198.18.0.5:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD \
                || sleep 10 && \
                mc alias set s3 http://198.18.0.5:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD \
                || sleep 10 && \
                mc alias set s3 http://198.18.0.5:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD \
                || sleep 10 && \
                mc alias set s3 http://198.18.0.5:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD

                mc mb --ignore-existing s3/overleaf-user-files
                mc mb --ignore-existing s3/overleaf-template-files
                mc admin user add s3 \
                  OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID \
                  OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY

                mc mb --ignore-existing s3/overleaf-project-blobs
                mc mb --ignore-existing s3/overleaf-chunks
                mc admin user add s3 \
                  OVERLEAF_HISTORY_S3_ACCESS_KEY_ID \
                  OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY

                echo '
                  {
                    "Version": "2012-10-17",
                    "Statement": [
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:ListBucket"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-user-files"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:PutObject",
                          "s3:GetObject",
                          "s3:DeleteObject"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-user-files/*"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:ListBucket"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-template-files"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:PutObject",
                          "s3:GetObject",
                          "s3:DeleteObject"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-template-files/*"
                      }
                    ]
                  }' > policy-filestore.json

                echo '
                  {
                    "Version": "2012-10-17",
                    "Statement": [
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:ListBucket"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-project-blobs"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:PutObject",
                          "s3:GetObject",
                          "s3:DeleteObject"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-project-blobs/*"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:ListBucket"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-chunks"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:PutObject",
                          "s3:GetObject",
                          "s3:DeleteObject"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-chunks/*"
                      }
                    ]
                  }' > policy-history.json

                # Put the contents of the policy from the previous section in policy-filestore.json
                # Reminder: Replace the bucket names accordingly.
                mc admin policy create s3 overleaf-filestore policy-filestore.json
                mc admin policy attach s3 overleaf-filestore \
                  --user=OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID || true

                mc admin policy create s3 overleaf-history policy-history.json
                mc admin policy attach s3 overleaf-history \
                  --user=OVERLEAF_HISTORY_S3_ACCESS_KEY_ID || true

    # Actual horizontal scaling setup: run this container on a separate host.
    mongo:
        restart: always
        image: mongo:4.4
        container_name: mongo
        command: "--replSet overleaf"
        expose:
            - 27017
        volumes:
            - ~/mongo_data:/data/db
        healthcheck:
            test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
            interval: 10s
            timeout: 10s
            retries: 5

        # Actual horizontal scaling setup: run on host 198.18.0.3 and expose port
        # ports:
        #     - "27017:27017"
        networks:
            default:
                ipv4_address: 198.18.0.3

    mongo_replica_set_setup:
        image: mongo:4.4
        entrypoint: sh
        depends_on:
            mongo:
                condition: service_healthy
        command:
            - '-c'
            - |
                mongo 198.18.0.3 --eval "rs.initiate({ _id: \"overleaf\", members: [ { _id: 0, host: \"198.18.0.3:27017\" } ] })"

    # Actual horizontal scaling setup: run this container on a separate host.
    redis:
        restart: always
        image: redis:6.2
        container_name: redis
        expose:
            - 6379
        volumes:
            - ~/redis_data:/data

        # Actual horizontal scaling setup: run on host 198.18.0.4 and expose port
        # ports:
        #     - "6379:6379"
        networks:
            default:
                ipv4_address: 198.18.0.4

​

Hardware

Doporučujeme používat stejné hardwarové specifikace pro všechny instance Server Pro, které se účastní horizontálního škálování.

Pro instance Server Pro platí obecná doporučení k hardwarovým specifikacím.

​

Upgrade Server Pro

V rámci procesu upgradu Server Pro automaticky spouští migrace databáze. Tyto migrace nejsou navrženy pro paralelní spouštění z více instancí.

Migrace musí být dokončeny před spuštěním samotné webové aplikace. Můžete buď v protokolech vyhledat záznam Finished migrations, nebo počkat, až aplikace začne přijímat provoz.

Postup upgradu vypadá takto:

1. Naplánujte okno údržby
2. Zastavte všechny instance Server Pro
3. Pořiďte konzistentní zálohu podle popisu v dokumentaci
4. Spusťte jednu instanci Server Pro s novou verzí
5. Ověřte, že nová instance funguje podle očekávání
6. Spusťte ostatní instance s novou verzí