S3

Säilytä projektitiedostot ja historia S3-yhteensopivassa tallennustilassa Kubernetes-käyttöönotossa.

Projektitiedostot ja niiden historian tallentaa history-v1-palvelu ja mallipohjatiedostot filestore-palvelu, molemmat jokaisen Ayakaleaf Pro -podin sisällä. Oletuksena ne kirjoittavat datataltiolle; S3:n kanssa ne kirjoittavat bucketeihin. Tarvittavat bucketit ja käyttöoikeudet on kuvattu sivulla S3.

Palvelut	history-v1 (projektitiedostot ja historia), filestore (mallipohjatiedostot), jokaisessa Ayakaleaf Pro -podissa
Pod → S3	S3-päätepiste jokaista luettavaa tai kirjoitettavaa tiedostoa varten
Pakollinen	useille replikoille: niiden datataltioita ei jaeta, bucketit jaetaan
Ajastetut tehtävät	ei mitään

Valitse S3 ennen kuin käyttäjät luovat projekteja. Instanssi, joka jo säilyttää tiedostoja taltiollaan, tarvitsee ensin S3-migraation.

​

Konfigurointi

1. Bucketit ja avaimet

   Luo kolme bucketia overleaf-template-files, overleaf-project-blobs ja overleaf-chunks sekä kaksi rajoitettua käyttäjää S3-palvelussasi sivun S3-määritys mukaisesti, tai aja Garagea klusterissa alla esitetyllä tavalla. Tallenna neljä avainta Secretiin:

   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

   30-config.yaml (additions)

     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. Lisää Secret podiin ja käynnistä uudelleen

   Lisää Secret Deploymentissa (tai StatefulSetissä) muiden viereen:

             envFrom:
               - configMapRef: {name: overleaf-env}
               - secretRef: {name: overleaf-secrets}
               - secretRef: {name: overleaf-s3}
   

   kubectl apply -f 30-config.yaml -f 40-overleaf.yaml
   kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf
   

​

Garage klusterissa

Jos sinulla ei ole S3-palvelua, Garage on pieni S3-palvelin, joka toimii klusterissa. Horisontaalisen skaalauksen kokoonpano testattiin sen kanssa. Alla olevat komennot luovat avaimet ja Secretin overleaf-s3 itse, joten käytä niitä vaiheen 1 Secret-komennon sijaan.

MinIO, jota Overleafin esimerkki käyttää, ei enää julkaise konttiimageja: minio/minio on poistunut Docker Hubista ja quay.io:sta.

50-garage.yaml

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

Luo salaisuudet, käynnistä Garage ja luo sitten asettelu (layout), bucketit ja kaksi rajoitettua avainta. Garagen avaintunnukset ovat GK ja 24 heksadesimaalimerkkiä, salaisuudet 64 heksadesimaalimerkkiä:

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

Käyttöoikeudet vastaavat sivun S3 käytäntöjä. Garage tarkistaa alueen: tässä se on garage, ja OVERLEAF_*_S3_REGION-arvon on oltava sama.

Kun käytät Garagea, aseta ConfigMapissa molemmille palveluille päätepiste, PATH_STYLE: "true" ja alue garage, kuten sivun Horisontaalinen skaalaus tiedostossa 60-config.yaml.

​

Useita replikoita

Kaikkien replikoiden on käytettävä samoja bucketeja ja avaimia. Varmuuskopioi bucketit S3-palveluntarjoajasi työkaluilla; replikoiden omilla levyillä ei silloin ole varmuuskopiointia vaativia tietoja.

​

Testattu Kubernetesissa

Kubernetes 1.37:ssä kolmella replikalla ja yllä kuvatulla Garagella jokainen näiden sivujen päästä päähän -testi, joka luo projekteja, lataa tiedostoja, käyttää historiaa tai julkaisee mallipohjia, meni läpi, ja sen jälkeen bucketit overleaf-project-blobs, overleaf-chunks ja overleaf-template-files sisälsivät objektit, kun taas replikoiden oma /var/lib/overleaf/data/history pysyi tyhjänä.