> ## 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. # S3 > Зберігайте файли проєктів та їхню історію в S3-сумісному сховищі в розгортанні на Kubernetes. Файли проєктів та їхню історію зберігає служба **history-v1**, файли шаблонів — служба **filestore**; обидві працюють у кожному поді Ayakaleaf Pro. За замовчуванням вони записують на том даних; з S3 вони записують у бакети. Які бакети та дозволи потрібні, описано в розділі [S3](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/s3.md). | | | | - | - | | Служби | history-v1 (файли проєктів та історія), filestore (файли шаблонів) у кожному поді Ayakaleaf Pro | | Под → S3 | кінцева точка S3 — для кожного читання чи запису файлу | | Обов'язково | для [кількох реплік](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/kubernetes/horizontal-scaling.md): їхні томи даних не спільні, а бакети — спільні | | Періодичні завдання | немає | > [!WARNING] > > Оберіть S3 до того, як користувачі створять проєкти. Екземпляр, який уже зберігає файли на своєму томі, спершу потребує [міграції на S3](https://ayakaleaf-pro.mintlify.site/uk/on-premises/maintenance/s3-migration.md). ### Налаштування **1. Бакети та ключі** Створіть три бакети `overleaf-template-files`, `overleaf-project-blobs` і `overleaf-chunks` та двох користувачів з обмеженими правами у вашому сервісі S3, як описано в розділі [Налаштування S3](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/s3.md#s3-setup), або запустіть Garage у кластері, як показано нижче. Помістіть чотири ключі в Secret: ```bash wrap theme={null} kubectl -n overleaf create secret generic overleaf-s3 \ --from-literal=OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID= \ --from-literal=OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY= \ --from-literal=OVERLEAF_HISTORY_S3_ACCESS_KEY_ID= \ --from-literal=OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY= ``` **2. ConfigMap** ```yaml title="30-config.yaml (additions)" wrap theme={null} OVERLEAF_FILESTORE_BACKEND: s3 OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME: overleaf-template-files OVERLEAF_FILESTORE_S3_REGION: eu-west-1 OVERLEAF_HISTORY_BACKEND: s3 OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET: overleaf-project-blobs OVERLEAF_HISTORY_CHUNKS_BUCKET: overleaf-chunks OVERLEAF_HISTORY_S3_REGION: eu-west-1 # a self-hosted S3 service also needs its endpoint and path-style addressing # OVERLEAF_FILESTORE_S3_ENDPOINT: http://garage:3900 # OVERLEAF_FILESTORE_S3_PATH_STYLE: "true" # OVERLEAF_HISTORY_S3_ENDPOINT: http://garage:3900 # OVERLEAF_HISTORY_S3_PATH_STYLE: "true" ``` **3. Додайте Secret до пода й перезапустіть** У Deployment (або StatefulSet) додайте Secret поруч з іншими: ```yaml theme={null} envFrom: - configMapRef: {name: overleaf-env} - secretRef: {name: overleaf-secrets} - secretRef: {name: overleaf-s3} ``` ```bash theme={null} kubectl apply -f 30-config.yaml -f 40-overleaf.yaml kubectl -n overleaf rollout restart deployment/overleaf # or statefulset/overleaf ``` ### Garage у кластері Якщо сервісу S3 немає, [Garage](https://garagehq.deuxfleurs.fr/) — це невеликий сервер S3, що працює в кластері. Конфігурацію з розділу [Горизонтальне масштабування](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/kubernetes/horizontal-scaling.md) перевірено саме з ним. Наведені нижче команди самі генерують ключі та створюють Secret `overleaf-s3`, тож використовуйте їх замість команди створення Secret із кроку 1. > [!NOTE] > > MinIO, який використовується в прикладі Overleaf, більше не публікує образи контейнерів: `minio/minio` зник із Docker Hub і quay.io. ```yaml title="50-garage.yaml" wrap theme={null} apiVersion: v1 kind: ConfigMap metadata: name: garage-config namespace: overleaf data: garage.toml: | metadata_dir = "/var/lib/garage/meta" data_dir = "/var/lib/garage/data" db_engine = "lmdb" replication_factor = 1 rpc_bind_addr = "[::]:3901" rpc_public_addr = "127.0.0.1:3901" # rpc_secret and admin_token come from GARAGE_RPC_SECRET / GARAGE_ADMIN_TOKEN [s3_api] s3_region = "garage" # Overleaf's OVERLEAF_*_S3_REGION must match api_bind_addr = "[::]:3900" [admin] api_bind_addr = "[::]:3903" --- apiVersion: v1 kind: Service metadata: name: garage namespace: overleaf spec: selector: app: garage ports: - name: s3 port: 3900 --- apiVersion: apps/v1 kind: StatefulSet metadata: name: garage namespace: overleaf spec: serviceName: garage replicas: 1 selector: matchLabels: app: garage template: metadata: labels: app: garage spec: containers: - name: garage image: dxflrs/garage:v2.5.0 env: - name: GARAGE_RPC_SECRET valueFrom: {secretKeyRef: {name: garage-secrets, key: rpc_secret}} - name: GARAGE_ADMIN_TOKEN valueFrom: {secretKeyRef: {name: garage-secrets, key: admin_token}} ports: - containerPort: 3900 readinessProbe: tcpSocket: port: 3900 resources: requests: {cpu: 50m, memory: 64Mi} limits: {memory: 512Mi} volumeMounts: - {name: config, mountPath: /etc/garage.toml, subPath: garage.toml} - {name: data, mountPath: /var/lib/garage} volumes: - name: config configMap: name: garage-config volumeClaimTemplates: - metadata: name: data spec: accessModes: [ReadWriteOnce] resources: requests: storage: 10Gi ``` Згенеруйте секрети, запустіть Garage, а потім створіть схему розміщення, бакети та два ключі з обмеженими правами. ID ключів Garage — це `GK` плюс 24 шістнадцяткові символи, секрети — 64 шістнадцяткові символи: ```bash wrap theme={null} kubectl -n overleaf create secret generic garage-secrets \ --from-literal=rpc_secret="$(openssl rand -hex 32)" \ --from-literal=admin_token="$(openssl rand -base64 32)" kubectl -n overleaf create secret generic overleaf-s3 \ --from-literal=OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID="GK$(openssl rand -hex 12)" \ --from-literal=OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY="$(openssl rand -hex 32)" \ --from-literal=OVERLEAF_HISTORY_S3_ACCESS_KEY_ID="GK$(openssl rand -hex 12)" \ --from-literal=OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY="$(openssl rand -hex 32)" kubectl apply -f 50-garage.yaml kubectl -n overleaf rollout status statefulset/garage g() { kubectl -n overleaf exec garage-0 -- /garage "$@"; } s() { kubectl -n overleaf get secret overleaf-s3 -o jsonpath="{.data.$1}" | base64 -d; } g layout assign -z dc1 -c 8G "$(g status 2>/dev/null | awk '/^[0-9a-f]{16}/{print $1; exit}')" g layout apply --version 1 for b in overleaf-template-files overleaf-project-blobs overleaf-chunks; do g bucket create "$b"; done g key import --yes -n overleaf-filestore "$(s OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID)" "$(s OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY)" g key import --yes -n overleaf-history "$(s OVERLEAF_HISTORY_S3_ACCESS_KEY_ID)" "$(s OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY)" g bucket allow --read --write overleaf-template-files --key overleaf-filestore g bucket allow --read overleaf-project-blobs --key overleaf-filestore g bucket allow --read --write overleaf-project-blobs --key overleaf-history g bucket allow --read --write overleaf-chunks --key overleaf-history ``` Дозволи відповідають політикам у розділі [S3](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/s3.md#access-policies). Garage перевіряє регіон: тут це `garage`, і `OVERLEAF_*_S3_REGION` має бути таким самим. З Garage задайте в ConfigMap кінцеву точку, `PATH_STYLE: "true"` і регіон `garage` для обох служб, як у `60-config.yaml` з розділу [Горизонтальне масштабування](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/kubernetes/horizontal-scaling.md). ### Кілька реплік Усі репліки мають використовувати ті самі бакети та ключі. Створюйте резервні копії бакетів інструментами вашого постачальника S3; тоді власні диски реплік не містять даних, які потребують резервного копіювання. ### Перевірено на Kubernetes На Kubernetes 1.37 з трьома репліками та Garage, як описано вище, усі наскрізні тести на цих сторінках, які створюють проєкти, завантажують файли, використовують історію чи публікують шаблони, пройшли, і після цього бакети `overleaf-project-blobs`, `overleaf-chunks` і `overleaf-template-files` містили об'єкти, тоді як власні `/var/lib/overleaf/data/history` реплік залишалися порожніми. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.