Kubernetes

اضبط نشرًا على Kubernetes - أين توضع الإعدادات والأسرار والملفات، وصفحة لكل ميزة.

يقرأ النشر على Kubernetes متغيرات البيئة نفسها التي يقرؤها Toolkit. حيثما تقول صفحة من صفحات Toolkit “أضف هذا إلى config/variables.env”، ضع القيمة في الـ ConfigMap ‏overleaf-env، أو في الـ Secret ‏overleaf-secrets عندما تكون كلمة مرور أو مفتاحًا أو رمزًا مميزًا (token). ثم أعد التشغيل:

kubectl -n overleaf apply -f 30-config.yaml        # after editing the ConfigMap
kubectl -n overleaf patch secret overleaf-secrets --type merge \
  -p '{"stringData":{"GITHUB_TOKEN_CIPHER_PASSWORD":"'"$(openssl rand -hex 32)"'"}}'
kubectl -n overleaf rollout restart deployment/overleaf

القيم الموجودة في config/overleaf.rc هي إعدادات خاصة بـ Toolkit، وليست متغيرات بيئة؛ ويوضح قسم الأسئلة والأجوبة في نهاية هذه الصفحة ما يحلّ محلها.

​

الميزات

لكل ميزة من ميزات إعداد Toolkit صفحة هنا تتناول خدماتها وإعداداتها ومسارات الشبكة الخاصة بها ومهامها في الخلفية، وما يتغير مع عدة نسخ متماثلة، وكيف اختُبرت:

الميزة	الخدمات في الـ Pod	ما يتجاوز الـ ConfigMap والـ Secret
المصادقة: OIDC، SAML، LDAP، الوصول العام، reCAPTCHA، قيود كلمات المرور	web	أسرار العملاء، وشهادة الـ IdP، وجهة شهادات LDAP
الترجمة المعزولة	clsi	Docker Engine وصور TeX Live على كل عقدة
الاستيراد والتصدير باستخدام Pandoc	clsi، web	صورة Pandoc في Docker على كل عقدة
التكامل مع Git	git-bridge (في Pod خاص به)، web، history-v1	الـ StatefulSet الخاص بـ git-bridge وخدمتان (Services)
المزامنة مع GitHub وGitLab وGitea	web	التكامل مع Git
المزامنة مع Dropbox	web، third-party-datastore، document-updater	التكامل مع Git، وإمكانية الوصول إلى الـ webhook من الإنترنت، وفهارس قاعدة البيانات
التكامل مع Zotero وMendeley	web	كلمة مرور التشفير في الـ Secret
خادم MCP	web	التكامل مع Git
التكامل مع الذكاء الاصطناعي	web، linked-url-proxy	–
واجهة استيراد Overleaf البرمجية	web، linked-url-proxy	–
القوالب	web، filestore	S3 في حالة عدة نسخ متماثلة
عنوان URL خارجي	linked-url-proxy	عناوين العقد العامة في OVERLEAF_LINKED_URL_BLOCKED_NETWORKS
السجلات	كل الخدمات	وحدة تخزين على /var/log/overleaf للاحتفاظ بالسجلات
وكيل TLS	الـ Ingress أو موازن الأحمال لديك	ينتهي TLS أمام الـ Pods
العلامة التجارية	web	–
الترجمة والتوطين	web	اسم مضيف واحد لكل لغة
تسليم البريد الإلكتروني	web	–
Redis	كل خدمة ذات حالة حية	–
S3	history-v1، filestore	خدمة S3، مطلوبة في حالة عدة نسخ متماثلة
إضافة مساعدة LaTeX للمستخدمين	web	يجب أن تصل الـ Pods إلى موقع Wiki
التوسع الأفقي	الكل	S3، وموازن أحمال مع جلسات لاصقة (sticky sessions)

​

الشهادات والملفات الأخرى

تأخذ بعض الميزات مسار ملف بدلًا من قيمة: شهادات SAML ‏(OVERLEAF_SAML_IDP_CERT، …)، وجهة شهادات LDAP ‏(OVERLEAF_LDAP_TLS_OPTS_CA_PATH)، أو جهة شهادات خاصة لـ GitHub Enterprise أو GitLab أو Gitea مستضاف ذاتيًا (NODE_EXTRA_CA_CERTS). ضع الملفات في Secret وركّبه حيث تتوقعها صفحات Toolkit، أي /var/lib/overleaf/certs:

kubectl -n overleaf create secret generic overleaf-certs --from-file=idp_cert.pem --from-file=ca.pem

40-overleaf.yaml (additions)

          volumeMounts:
            # ...
            - name: certs
              mountPath: /var/lib/overleaf/certs
              readOnly: true
      volumes:
        # ...
        - name: certs
          secret:
            secretName: overleaf-certs

ثم أشر إليها بمساراتها في الـ ConfigMap، مثل NODE_EXTRA_CA_CERTS: /var/lib/overleaf/certs/ca.pem، وأعد التشغيل.

كلمات مرور التشفير. اضبط في الـ Secret كل *_CIPHER_PASSWORD للميزات التي تستخدمها. وإلا فإن بعض الميزات تولّد ملف مفتاح في وحدة تخزين البيانات عند أول استخدام: مع نسخة متماثلة واحدة ينجح ذلك إلى أن تُفقد وحدة التخزين، ومع عدة نسخ متماثلة ستشفّر كل نسخة بمفتاح مختلف.

​

أسئلة وأجوبة

ما إعدادات Toolkit من config/overleaf.rc التي أحتاجها؟

الإجابة: لا يقرأ Ayakaleaf Pro أيًا منها. ونظائرها في Kubernetes هي:

config/overleaf.rc	Kubernetes
OVERLEAF_LISTEN_IP، OVERLEAF_PORT	الـ Service ‏(NodePort) أو الـ Ingress لديك
SIBLING_CONTAINERS_ENABLED	SANDBOXED_COMPILES* في الـ ConfigMap، ومقبس Docker في الـ Pod
GIT_BRIDGE_ENABLED	التكامل مع Git
MONGO_ENABLED، REDIS_ENABLED، MONGO_URL، REDIS_HOST	الـ StatefulSets أو خدماتك المُدارة، وOVERLEAF_MONGO_URL وOVERLEAF_REDIS_HOST
REDIS_AOF_PERSISTENCE	--appendonly yes في 20-redis.yaml
NGINX_ENABLED، TLS_*	الـ Ingress أو موازن الأحمال لديك