fix: switch to gunicorn WSGI server

.github/workflows/release.yml

@@ -48,7 +48,7 @@ jobs:
     env:
       REPOSITORY_URL: registry.hub.docker.com
       IMAGE_NAME: alerta/alerta-web
-      PLATFORM: 3.9-buster-uwsgi
+      PLATFORM: 3.9-buster-gunicorn
 
     steps:
       - uses: actions/checkout@v4

Dockerfile

@@ -15,11 +15,7 @@ ENV WEBUI_VERSION=8.7.1
 ENV NGINX_WORKER_PROCESSES=1
 ENV NGINX_WORKER_CONNECTIONS=1024
 
-ENV UWSGI_PROCESSES=5
-ENV UWSGI_LISTEN=100
-ENV UWSGI_BUFFER_SIZE=8192
-ENV UWSGI_MAX_WORKER_LIFETIME=30
-ENV UWSGI_WORKER_LIFETIME_DELTA=3
+ENV GUNICORN_WORKERS=5
 
 ENV HEARTBEAT_SEVERITY=major
 ENV HK_EXPIRED_DELETE_HRS=2

README.md

@@ -126,20 +126,8 @@ API to ease deployment more generally:
 `NGINX_WORKER_CONNECTIONS`
     - maximum number of simultaneous connections that can be opened by a worker process (default:`1024`)
 
-`UWSGI_PROCESSES`
-    - number of processes for uWSGI (default:`5`)
-
-`UWSGI_LISTEN`
-    - max number of concurrent connections (default:`100`)
-
-`UWSGI_BUFFER_SIZE`
-    - size of the unix socket buffer (default:`8192`)
-
-`UWSGI_MAX_WORKER_LIFETIME`
-    - reload worker after this many seconds (default:`30`)
-
-`UWSGI_WORKER_LIFETIME_DELTA`
-    - time in seconds to stagger UWSGI worker respawns (default:`3`)
+`GUNICORN_WORKERS`
+    - number of worker processes for Gunicorn (default:`5`)
 
 Configuration Files
 -------------------

config/templates/app/gunicorn.conf.py.j2

@@ -0,0 +1,14 @@
+
+bind = '127.0.0.1:29000'
+
+chdir = '/app'
+daemon = False
+raw_env = [
+    'SCRIPT_NAME=/api',
+]
+worker_tmp_dir = '/dev/shm'
+workers = {{ env.GUNICORN_WORKERS }}
+
+{%- if env.DEBUG %}
+loglevel = 'debug'
+{%- endif %}

config/templates/app/nginx.conf.j2

@@ -47,13 +47,14 @@ http {
         access_log /dev/stdout main;
 
         location /api {
-            include /etc/nginx/uwsgi_params;
-            uwsgi_pass backend;
+            proxy_pass http://backend;
 
-            uwsgi_param Host $host;
-            uwsgi_param X-Real-IP $remote_addr;
-            uwsgi_param X-Forwarded-For $proxy_add_x_forwarded_for;
-            uwsgi_param X-Forwarded-Proto $http_x_forwarded_proto;
+            proxy_http_version 1.1;
+            proxy_set_header Host $host;
+            proxy_set_header X-Real-IP $remote_addr;
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
+            proxy_set_header Connection "";
         }
 
         root /web;

config/templates/app/supervisord.conf.j2

@@ -4,8 +4,10 @@ logfile=/tmp/supervisord.log
 loglevel={{ env.SUPERVISORD_LOG_LEVEL|lower or 'debug' }}
 pidfile=/tmp/supervisord.pid
 
-[program:uwsgi]
-command=/venv/bin/uwsgi --ini /app/uwsgi.ini
+[program:gunicorn]
+command=/venv/bin/gunicorn wsgi:app -c /app/gunicorn.conf.py
+autostart=true
+autorestart=true
 redirect_stderr=true
 
 [program:nginx]

contrib/kubernetes/backend/Dockerfile

@@ -10,7 +10,7 @@ RUN apt-get update && apt-get install -y \
 
 RUN pip install --no-cache-dir virtualenv && \
     virtualenv --python=python3 /venv && \
-    /venv/bin/pip install uwsgi alerta alerta-server==$VERSION
+    /venv/bin/pip install gunicorn alerta alerta-server==$VERSION
 
 ENV PATH $PATH:/venv/bin
 

docker-entrypoint.sh

@@ -7,7 +7,7 @@ ALERTA_CONF_FILE=${ALERTA_CONF_FILE:-/app/alerta.conf}
 ALERTA_SVR_CONF_FILE=${ALERTA_SVR_CONF_FILE:-/app/alertad.conf}
 ALERTA_WEB_CONF_FILE=${ALERTA_WEB_CONF_FILE:-/web/config.json}
 NGINX_CONF_FILE=/app/nginx.conf
-UWSGI_CONF_FILE=/app/uwsgi.ini
+GUNICORN_CONF_FILE=/app/gunicorn.conf.py
 SUPERVISORD_CONF_FILE=/app/supervisord.conf
 
 ADMIN_USER=${ADMIN_USERS%%,*}
@@ -69,10 +69,10 @@ if [ ! -f "${NGINX_CONF_FILE}" ]; then
 fi
 nginx -t -c ${NGINX_CONF_FILE}
 
-# Generate uWSGI config, if not supplied.
-if [ ! -f "${UWSGI_CONF_FILE}" ]; then
-  echo "# Create uWSGI configuration file."
-  python3 -c "${JINJA2}" < ${UWSGI_CONF_FILE}.j2 >${UWSGI_CONF_FILE}
+# Generate Gunicorn config, if not supplied.
+if [ ! -f "${GUNICORN_CONF_FILE}" ]; then
+  echo "# Create Gunicorn configuration file."
+  python3 -c "${JINJA2}" < ${GUNICORN_CONF_FILE}.j2 >${GUNICORN_CONF_FILE}
 fi
 
 # Generate web config, if not supplied.
@@ -88,7 +88,7 @@ echo Alerta Client ${CLIENT_VERSION}
 echo Alerta WebUI  ${WEBUI_VERSION}
 
 nginx -v
-echo uwsgi $(uwsgi --version)
+gunicorn --version
 mongo --version | grep MongoDB
 psql --version
 python3 --version

requirements-docker.txt

@@ -1,4 +1,4 @@
 lxml==5.2.1
 pysaml2==7.2.1
 python-ldap==3.4.4
-uWSGI==2.0.21
+gunicorn==21.2.0

requirements.txt

@@ -1,7 +1,7 @@
 bcrypt==4.1.2
 blinker==1.7.0
 cryptography==42.0.5
-Flask==3.0.2
+Flask==3.0.3
 Flask-Compress==1.14
 Flask-Cors==4.0.0
 mohawk==1.1.0
@@ -13,7 +13,7 @@ python-dateutil==2.9.0.post0
 pytz==2024.1
 PyYAML==6.0.1
 requests==2.31.0
-requests_hawk==1.2.1
-sentry-sdk[flask]==1.43.0
+requests-hawk==1.2.1
+sentry-sdk[flask]==1.45.0
 StrEnum==0.4.15
-werkzeug==3.0.1
+werkzeug==3.0.2

tests/spec/api_spec.rb

@@ -39,8 +39,8 @@
       it "return 200" do
         expect(result.code).to eq(200)
       end
-      it "X-Forwarded-For header is set" do
-        expect(result.body).to include("X-Forwarded-For")
+      it "HTTP_X_FORWARDED_FOR envvar is set" do
+        expect(result.body).to include("HTTP_X_FORWARDED_FOR")
       end
     end
     context "get healthcheck" do