tutor 23.0.0.dev3196__tar.gz → 23.0.0.dev3199__tar.gz

{tutor-23.0.0.dev3196 → tutor-23.0.0.dev3199}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tutor
-Version: 23.0.0.dev3196
+Version: 23.0.0.dev3199
 Summary: The Docker-based Open edX distribution designed for peace of mind
 Project-URL: Homepage, https://docs.tutor.edly.io/
 Project-URL: Documentation, https://docs.tutor.edly.io/

{tutor-23.0.0.dev3196 → tutor-23.0.0.dev3199}/tutor/config.py

@@ -252,6 +252,11 @@ def upgrade_obsolete(config: Config) -> None:
         config["ENABLE_WEB_PROXY"] = config.pop("RUN_CADDY")
     if "NGINX_HTTP_PORT" in config:
         config["CADDY_HTTP_PORT"] = config.pop("NGINX_HTTP_PORT")
+    # Replace uwsgi by granian
+    if "OPENEDX_LMS_UWSGI_WORKERS" in config:
+        config["OPENEDX_LMS_GRANIAN_WORKERS"] = config.pop("OPENEDX_LMS_UWSGI_WORKERS")
+    if "OPENEDX_CMS_UWSGI_WORKERS" in config:
+        config["OPENEDX_CMS_GRANIAN_WORKERS"] = config.pop("OPENEDX_CMS_UWSGI_WORKERS")
 
 
 def convert_json2yml(root: str) -> None:

tutor-23.0.0.dev3199/tutor/templates/apps/openedx/granian-config

@@ -0,0 +1,2 @@
+{% include "build/openedx/settings/granian-config" %}
+{{ patch("granian-config") }}

{tutor-23.0.0.dev3196 → tutor-23.0.0.dev3199}/tutor/templates/build/openedx/Dockerfile

@@ -124,13 +124,9 @@ RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared \
     # Use redis as a django cache https://pypi.org/project/django-redis/
     django-redis==5.4.0
 
-# uwsgi server https://pypi.org/project/uWSGI/
-# We don't need xml configuration support in uwsgi so don't install it, as it causes
-# uwsgi to crash
-# https://github.com/xmlsec/python-xmlsec/issues/320
+# granian server https://pypi.org/project/granian/
 RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared \
-    UWSGI_PROFILE_OVERRIDE="xml=no" \
-    $PIP_COMMAND install --no-cache-dir --compile uwsgi==2.0.24
+    $PIP_COMMAND install --no-cache-dir --compile granian==2.7.4
 
 # Install scorm xblock
 RUN $PIP_COMMAND install "openedx-scorm-xblock>=19.0.0,<20.0.0"
@@ -264,6 +260,9 @@ RUN ./manage.py lms collectstatic --noinput --settings=tutor.assets && \
 # Create a data directory, which might be used (or not)
 RUN mkdir /openedx/data
 
+# Create the media directory: granian refuses to start if a static path mount does not exist
+RUN mkdir /openedx/media
+
 # If this "canary" file is missing from a container, then that indicates that a
 # local edx-platform was bind-mounted into that container, thus overwriting the
 # canary. This information is useful during edx-platform initialisation.
@@ -329,14 +328,14 @@ CMD ["./manage.py", "$SERVICE_VARIANT", "runserver", "0.0.0.0:8000"]
 ###### Final image with production cmd
 FROM production AS final
 
-# Default amount of uWSGI processes
-ENV UWSGI_WORKERS=2
+# Default amount of Granian worker processes
+ENV GRANIAN_WORKERS=2
 
-# Copy the default uWSGI configuration
-COPY --chown=app:app settings/uwsgi.ini /openedx
+# Copy granian configuration file
+COPY --chown=app:app settings/granian-config /openedx
 
-# Run server
-CMD ["uwsgi", "/openedx/uwsgi.ini"]
+# Run server: granian has no config file support, so run-granian converts /openedx/granian-config to CLI arguments
+CMD ["run-granian"]
 
 {{ patch("openedx-dockerfile-final") }}
 

tutor-23.0.0.dev3199/tutor/templates/build/openedx/bin/reload-granian

@@ -0,0 +1,4 @@
+#! /bin/bash
+echo "Reloading granian workers..."
+# Granian runs as PID 1 and respawns its workers on SIGHUP
+kill -HUP 1

tutor-23.0.0.dev3199/tutor/templates/build/openedx/bin/run-granian

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+"""
+Start granian with the options listed in /openedx/granian-config.
+
+Granian has no config file support and only accepts command-line options, so
+this wrapper converts the file into an argument list, one option per line,
+with environment variables expanded.
+"""
+
+import os
+import shlex
+
+from granian.cli import cli
+
+if __name__ == "__main__":
+    with open("/openedx/granian-config", encoding="utf-8") as f:
+        args = shlex.split(os.path.expandvars(f.read()), comments=True)
+    cli(args=args)

tutor-23.0.0.dev3199/tutor/templates/build/openedx/settings/granian-config

@@ -0,0 +1,13 @@
+--interface wsgi
+--host 0.0.0.0
+--port 8000
+--workers $GRANIAN_WORKERS
+# Granian defaults to hundreds of threads per wsgi worker
+--blocking-threads 8
+# Respawn crashed workers instead of shutting down the whole server
+--respawn-failed-workers
+--static-path-route /static
+--static-path-mount /openedx/staticfiles/
+--static-path-route /media
+--static-path-mount /openedx/media/
+$SERVICE_VARIANT.wsgi:application

{tutor-23.0.0.dev3196 → tutor-23.0.0.dev3199}/tutor/templates/config/defaults.yml

@@ -56,8 +56,8 @@ OPENEDX_AWS_ACCESS_KEY: ""
 OPENEDX_AWS_SECRET_ACCESS_KEY: ""
 OPENEDX_CACHE_REDIS_DB: 1
 OPENEDX_CELERY_REDIS_DB: 0
-OPENEDX_CMS_UWSGI_WORKERS: 2
-OPENEDX_LMS_UWSGI_WORKERS: 2
+OPENEDX_CMS_GRANIAN_WORKERS: 2
+OPENEDX_LMS_GRANIAN_WORKERS: 2
 OPENEDX_MYSQL_DATABASE: "openedx"
 OPENEDX_MYSQL_USERNAME: "openedx"
 # the common version will be automatically set to "master" in the main branch

{tutor-23.0.0.dev3196 → tutor-23.0.0.dev3199}/tutor/templates/k8s/deployments.yml

@@ -84,8 +84,8 @@ spec:
             value: cms
           - name: DJANGO_SETTINGS_MODULE
             value: cms.envs.tutor.production
-          - name: UWSGI_WORKERS
-            value: "{{ OPENEDX_CMS_UWSGI_WORKERS }}"
+          - name: GRANIAN_WORKERS
+            value: "{{ OPENEDX_CMS_GRANIAN_WORKERS }}"
           ports:
             - containerPort: 8000
           volumeMounts:
@@ -95,9 +95,9 @@ spec:
               name: settings-cms
             - mountPath: /openedx/config
               name: config
-            - mountPath: /openedx/uwsgi.ini
-              name: uwsgi-config
-              subPath: uwsgi.ini
+            - mountPath: /openedx/granian-config
+              name: granian-config
+              subPath: granian-config
           resources:
             requests:
               memory: 2Gi
@@ -113,12 +113,12 @@ spec:
         - name: config
           configMap:
             name: openedx-config
-        - name: uwsgi-config
+        - name: granian-config
           configMap:
-            name: openedx-uwsgi-config
+            name: openedx-granian-config
             items:
-              - key: uwsgi.ini
-                path: uwsgi.ini
+              - key: granian-config
+                path: granian-config
 ---
 apiVersion: apps/v1
 kind: Deployment
@@ -195,8 +195,8 @@ spec:
             value: lms
           - name: DJANGO_SETTINGS_MODULE
             value: lms.envs.tutor.production
-          - name: UWSGI_WORKERS
-            value: "{{ OPENEDX_LMS_UWSGI_WORKERS }}"
+          - name: GRANIAN_WORKERS
+            value: "{{ OPENEDX_LMS_GRANIAN_WORKERS }}"
           ports:
             - containerPort: 8000
           volumeMounts:
@@ -206,9 +206,9 @@ spec:
               name: settings-cms
             - mountPath: /openedx/config
               name: config
-            - mountPath: /openedx/uwsgi.ini
-              name: uwsgi-config
-              subPath: uwsgi.ini
+            - mountPath: /openedx/granian-config
+              name: granian-config
+              subPath: granian-config
           resources:
             requests:
               memory: 2Gi
@@ -224,12 +224,12 @@ spec:
         - name: config
           configMap:
             name: openedx-config
-        - name: uwsgi-config
+        - name: granian-config
           configMap:
-            name: openedx-uwsgi-config
+            name: openedx-granian-config
             items:
-            - key: uwsgi.ini
-              path: uwsgi.ini
+            - key: granian-config
+              path: granian-config
 ---
 apiVersion: apps/v1
 kind: Deployment

{tutor-23.0.0.dev3196 → tutor-23.0.0.dev3199}/tutor/templates/kustomization.yml

@@ -62,9 +62,9 @@ configMapGenerator:
   options:
     labels:
         app.kubernetes.io/name: openedx
-- name: openedx-uwsgi-config
+- name: openedx-granian-config
   files:
-  - apps/openedx/uwsgi.ini
+  - apps/openedx/granian-config
   options:
     labels:
         app.kubernetes.io/name: openedx

{tutor-23.0.0.dev3196 → tutor-23.0.0.dev3199}/tutor/templates/local/docker-compose.yml

@@ -99,13 +99,13 @@ services:
     environment:
       SERVICE_VARIANT: lms
       DJANGO_SETTINGS_MODULE: lms.envs.tutor.production
-      UWSGI_WORKERS: {{ OPENEDX_LMS_UWSGI_WORKERS }}
+      GRANIAN_WORKERS: {{ OPENEDX_LMS_GRANIAN_WORKERS }}
     restart: unless-stopped
     volumes:
       - ../apps/openedx/settings/lms:/openedx/edx-platform/lms/envs/tutor:roz
       - ../apps/openedx/settings/cms:/openedx/edx-platform/cms/envs/tutor:roz
       - ../apps/openedx/config:/openedx/config:roz
-      - ../apps/openedx/uwsgi.ini:/openedx/uwsgi.ini:roz
+      - ../apps/openedx/granian-config:/openedx/granian-config:roz
       - ../../data/lms:/openedx/data:z
       - ../../data/openedx-media:/openedx/media:z
       - ../../data/openedx-media-private:/openedx/media-private:z
@@ -126,13 +126,13 @@ services:
     environment:
       SERVICE_VARIANT: cms
       DJANGO_SETTINGS_MODULE: cms.envs.tutor.production
-      UWSGI_WORKERS: {{ OPENEDX_CMS_UWSGI_WORKERS }}
+      GRANIAN_WORKERS: {{ OPENEDX_CMS_GRANIAN_WORKERS }}
     restart: unless-stopped
     volumes:
       - ../apps/openedx/settings/lms:/openedx/edx-platform/lms/envs/tutor:roz
       - ../apps/openedx/settings/cms:/openedx/edx-platform/cms/envs/tutor:roz
       - ../apps/openedx/config:/openedx/config:roz
-      - ../apps/openedx/uwsgi.ini:/openedx/uwsgi.ini:roz
+      - ../apps/openedx/granian-config:/openedx/granian-config:roz
       - ../../data/cms:/openedx/data:z
       - ../../data/openedx-media:/openedx/media:z
       - ../../data/openedx-media-private:/openedx/media-private:z

tutor-23.0.0.dev3196/tutor/templates/apps/openedx/uwsgi.ini

@@ -1,3 +0,0 @@
-{% include "build/openedx/settings/uwsgi.ini" %}
-{{ patch("uwsgi-config") }}
-

tutor-23.0.0.dev3196/tutor/templates/build/openedx/bin/reload-uwsgi

@@ -1,3 +0,0 @@
-#! /bin/bash
-echo "Reloading uwsgi process..."
-kill -HUP $(pidof /openedx/venv/bin/python3 /openedx/venv/bin/uwsgi)

tutor-23.0.0.dev3196/tutor/templates/build/openedx/settings/uwsgi.ini

@@ -1,23 +0,0 @@
-[uwsgi]
-static-map = /static=/openedx/staticfiles/
-static-map = /media=/openedx/media/
-http = 0.0.0.0:8000
-buffer-size = 8192
-wsgi-file = $(SERVICE_VARIANT)/wsgi.py
-processes = $(UWSGI_WORKERS)
-thunder-lock = true
-single-interpreter = true
-enable-threads = true
-# Fix 502 errors for closed connections
-http-keepalive = 1
-add-header = Connection: Keep-Alive
-# Better startup/shutdown in docker:
-die-on-term = true
-lazy-apps = false
-need-app = true
-no-defer-accept = true
-# Enable the master process for performance
-master = true
-# Clean up settings
-py-call-osafterfork = true
-vacuum = true