> ## 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/ru/on-premises/configuration/overleaf-toolkit/s3.md).

| | |
| - | - |
| Сервисы | history-v1 (файлы проектов и история), filestore (файлы шаблонов), в каждом поде Ayakaleaf Pro |
| Под → S3 | конечная точка S3, при каждом чтении или записи файла |
| Обязательно | для [нескольких реплик](https://ayakaleaf-pro.mintlify.site/ru/on-premises/configuration/kubernetes/horizontal-scaling.md): их тома данных не общие, а бакеты — общие |
| Периодические задачи | нет |

> [!WARNING]
>
> Выберите S3 до того, как пользователи начнут создавать проекты. Экземпляру, который уже хранит файлы на своём томе, сначала нужна [миграция на S3](https://ayakaleaf-pro.mintlify.site/ru/on-premises/maintenance/s3-migration.md).

### Настройка

**1. Бакеты и ключи**

Создайте три бакета `overleaf-template-files`, `overleaf-project-blobs` и `overleaf-chunks` и двух пользователей с ограниченными правами в вашем сервисе S3, как описано в разделе [Настройка S3](https://ayakaleaf-pro.mintlify.site/ru/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=<filestore key> \
  --from-literal=OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY=<filestore secret> \
  --from-literal=OVERLEAF_HISTORY_S3_ACCESS_KEY_ID=<history key> \
  --from-literal=OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY=<history secret>
```

**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/ru/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, затем создайте схему размещения (layout), бакеты и два ключа с ограниченными правами. Идентификаторы ключей 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/ru/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/ru/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.