OpenConceptLab/ocl_issues#965 Using Gunicorn for Swagger and disabling DEBUG mode

Author: rkorytkowski

Dockerfile

@@ -23,10 +23,9 @@ RUN addgroup -S ocl && adduser -S ocl -G ocl
 
 ENV APP_HOME=/code
 
-RUN mkdir -p $APP_HOME
-RUN mkdir -p /temp
+RUN mkdir -p $APP_HOME /temp /staticfiles
 
-RUN chown -R ocl:ocl /code /temp
+RUN chown -R ocl:ocl $APP_HOME /temp /staticfiles
 
 WORKDIR $APP_HOME
 

core/orgs/models.py

@@ -1,4 +1,3 @@
-from django.contrib import admin
 from django.contrib.contenttypes.fields import GenericRelation
 from django.core.validators import RegexValidator
 from django.db import models, transaction
@@ -93,6 +92,3 @@ def delete_pins(self):
         Pin.objects.filter(resource_type__model='organization', resource_id=self.id).delete()
         # deletes pins for this org
         self.pins.all().delete()
-
-
-admin.site.register(Organization)

core/settings.py

@@ -31,7 +31,7 @@
 SECRET_KEY = '=q1%fd62$x!35xzzlc3lix3g!s&!2%-1d@5a=rm!n4lu74&6)p'
 
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = os.environ.get('DEBUG', True)
+DEBUG = os.environ.get('DEBUG') == 'TRUE'
 
 ALLOWED_HOSTS = ['*']
 
@@ -125,8 +125,8 @@
 }
 
 MIDDLEWARE = [
-    'django.middleware.gzip.GZipMiddleware',
     'django.middleware.security.SecurityMiddleware',
+    'django.middleware.gzip.GZipMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'corsheaders.middleware.CorsMiddleware',
     'django.middleware.common.CommonMiddleware',
@@ -263,9 +263,10 @@
 USE_TZ = True
 
 # Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/3.0/howto/static-files/
-
 STATIC_URL = '/static/'
+STATIC_ROOT = '/staticfiles'
+STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
+
 AUTH_USER_MODEL = 'users.UserProfile'
 TEST_RUNNER = 'core.common.tests.CustomTestRunner'
 DEFAULT_LOCALE = os.environ.get('DEFAULT_LOCALE', 'en')
@@ -353,6 +354,10 @@
     ('Jonathan Payne', 'paynejd@gmail.com'),
 )
 
+if ENV and ENV != 'development':
+    # Serving swagger static files (inserted after SecurityMiddleware)
+    MIDDLEWARE.insert(1, 'whitenoise.middleware.WhiteNoiseMiddleware')
+
 if not ENV or ENV in ['production']:
     EMAIL_SUBJECT_PREFIX = '[Openconceptlab.org] '
 else:

core/urls.py

@@ -14,7 +14,6 @@
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 from django.conf.urls import url
-from django.contrib import admin
 from django.urls import path, include, re_path
 from drf_yasg import openapi
 from drf_yasg.views import get_schema_view
@@ -51,7 +50,6 @@
     url(r'^swagger/$', SchemaView.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
     url(r'^redoc/$', SchemaView.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
     path('healthcheck/', include('core.common.healthcheck.urls')),
-    path('admin/', admin.site.urls, name='admin_urls'),
     path('admin/reports/authored/', report_views.AuthoredView.as_view(), name='authored-report'),
     path('admin/reports/monthly-usage/', report_views.MonthlyUsageView.as_view(), name='monthly-usage-report'),
     path('admin/concepts/locales/duplicate/', ConceptDuplicateLocalesView.as_view(), name='concept-duplicate-locales'),

core/users/models.py

@@ -1,4 +1,3 @@
-from django.contrib import admin
 from django.contrib.auth.models import AbstractUser
 from django.contrib.auth.password_validation import validate_password
 from django.core.exceptions import ValidationError
@@ -149,6 +148,3 @@ def is_valid_auth_group(*names):
     @property
     def auth_groups(self):
         return self.groups.values_list('name', flat=True)
-
-
-admin.site.register(UserProfile)

docker-compose.ci.yml

@@ -1,39 +1,53 @@
 version: '3'
 services:
+  db:
+    restart: "no"
+  redis:
+    restart: "no"
   api:
     build: .
     environment:
       - ENVIRONMENT=ci
     volumes:
       - .:/code
+    restart: "no"
   celery:
     build: .
     volumes:
       - .:/code
     command: ["bash", "-c", "CELERY_WORKER_NAME=default ./start_celery_worker.sh -P prefork -Q default -c 1"]
+    restart: "no"
   celery_indexing:
     build: .
     volumes:
         - .:/code
     command: ["bash", "-c", "CELERY_WORKER_NAME=indexing ./start_celery_worker.sh -P prefork -Q indexing -c 1"]
+    restart: "no"
   celery_concurrent:
     build: .
     volumes:
       - .:/code
     command: ["bash", "-c", "CELERY_WORKER_NAME=concurrent ./start_celery_worker.sh -P prefork -Q concurrent -c 1"]
+    restart: "no"
   celery_bulk_import_0_1:
     build: .
     volumes:
       - .:/code
+    restart: "no"
   celery_bulk_import_0_2:
     build: .
     volumes:
       - .:/code
+    restart: "no"
   celery_bulk_import_root:
     build: .
     volumes:
       - .:/code
+    restart: "no"
   flower:
     build: .
     volumes:
       - .:/code
+    restart: "no"
+  es:
+    restart: "no"

docker-compose.override.yml

@@ -16,6 +16,7 @@ services:
     restart: "no"
     environment:
       - ENVIRONMENT=development
+      - DEBUG=${DEBUG-TRUE}
   celery:
     build: .
     volumes:

docker-compose.yml

@@ -31,7 +31,7 @@ services:
       - ES_HOST=${ES_HOST-es}
       - ES_PORT=${ES_PORT-9200}
       - ENVIRONMENT=${ENVIRONMENT-production}
-      - DEBUG=True #needed to be able to serve staticfiles with Django server
+      - DEBUG=${DEBUG-FALSE}
       - SECRET_KEY
       - SENTRY_DSN_KEY
       - API_SUPERUSER_PASSWORD=${API_SUPERUSER_PASSWORD-Root123}
@@ -47,34 +47,34 @@ services:
       test: "curl --silent --fail http://localhost:8000/version/ || exit 1"
   celery:
     image: openconceptlab/oclapi2:${ENVIRONMENT-production}
-    command: ["bash", "-c", "CELERY_WORKER_NAME=default ./start_celery_worker.sh -P prefork -Q default --autoscale=10,2"]
+    command: ["bash", "-c", "CELERY_WORKER_NAME=default ./start_celery_worker.sh -P prefork -Q default --autoscale=5,1"]
     restart: "always"
     healthcheck:
       test: ["CMD-SHELL", "-c", "CELERY_WORKER_NAME=default ./ping_celery_worker.sh"]
     environment:
       - REDIS_HOST=${REDIS_HOST-redis}
       - REDIS_PORT=${REDIS_PORT-6379}
-      - DEBUG=${DEBUG-False}
+      - DEBUG=${DEBUG-FALSE}
   celery_indexing:
     image: openconceptlab/oclapi2:${ENVIRONMENT-production}
-    command: ["bash", "-c", "CELERY_WORKER_NAME=indexing ./start_celery_worker.sh -P prefork -Q indexing --autoscale=10,2"]
+    command: ["bash", "-c", "CELERY_WORKER_NAME=indexing ./start_celery_worker.sh -P prefork -Q indexing --autoscale=2,1"]
     restart: "always"
     healthcheck:
       test: ["CMD-SHELL", "-c", "CELERY_WORKER_NAME=indexing ./ping_celery_worker.sh"]
     environment:
       - REDIS_HOST=${REDIS_HOST-redis}
       - REDIS_PORT=${REDIS_PORT-6379}
-      - DEBUG=${DEBUG-False}
+      - DEBUG=${DEBUG-FALSE}
   celery_concurrent:
     image: openconceptlab/oclapi2:${ENVIRONMENT-production}
-    command: ["bash", "-c", "CELERY_WORKER_NAME=concurrent ./start_celery_worker.sh -P prefork -Q concurrent -c 10"]
+    command: ["bash", "-c", "CELERY_WORKER_NAME=concurrent ./start_celery_worker.sh -P prefork -Q concurrent -c 5"]
     restart: "always"
     healthcheck:
       test:  ["CMD-SHELL", "-c", "CELERY_WORKER_NAME=concurrent ./ping_celery_worker.sh"]
     environment:
       - REDIS_HOST=${REDIS_HOST-redis}
       - REDIS_PORT=${REDIS_PORT-6379}
-      - DEBUG=${DEBUG-False}
+      - DEBUG=${DEBUG-FALSE}
   celery_bulk_import_0_1:
     image: openconceptlab/oclapi2:${ENVIRONMENT-production}
     command: ["bash", "-c", "CELERY_WORKER_NAME=bulk_import_0_1 ./start_celery_worker.sh -Q bulk_import_0,bulk_import_1 -c 1"]
@@ -84,7 +84,7 @@ services:
     environment:
       - REDIS_HOST=${REDIS_HOST-redis}
       - REDIS_PORT=${REDIS_PORT-6379}
-      - DEBUG=${DEBUG-False}
+      - DEBUG=${DEBUG-FALSE}
   celery_bulk_import_2_3:
     image: openconceptlab/oclapi2:${ENVIRONMENT-production}
     command: ["bash", "-c", "CELERY_WORKER_NAME=bulk_import_2_3 ./start_celery_worker.sh -Q bulk_import_2,bulk_import_3 -c 1"]
@@ -94,7 +94,7 @@ services:
     environment:
       - REDIS_HOST=${REDIS_HOST-redis}
       - REDIS_PORT=${REDIS_PORT-6379}
-      - DEBUG=${DEBUG-False}
+      - DEBUG=${DEBUG-FALSE}
   celery_bulk_import_root:
     image: openconceptlab/oclapi2:${ENVIRONMENT-production}
     command: ["bash", "-c", "CELERY_WORKER_NAME=bulk_import_root ./start_celery_worker.sh -Q bulk_import_root -c 1"]
@@ -104,7 +104,7 @@ services:
     environment:
       - REDIS_HOST=${REDIS_HOST-redis}
       - REDIS_PORT=${REDIS_PORT-6379}
-      - DEBUG=${DEBUG-False}
+      - DEBUG=${DEBUG-FALSE}
   flower:
     image: openconceptlab/oclapi2:${ENVIRONMENT-production}
     command: ["bash", "-c", "./start_flower.sh"]

requirements.txt

@@ -1,6 +1,7 @@
 Django==3.2.7
 psycopg2==2.9.1
-gunicorn==20.1.0
+gunicorn==20.1.0 #production server
+whitenoise==5.3.0 #serving swagger static files
 djangorestframework==3.12.4
 pylint==2.10.2
 pydash==5.0.2

startup.sh

@@ -25,6 +25,8 @@ if [[ "$ENVIRONMENT" = "development" ]]; then
   echo "Starting up the development server"
   python manage.py runserver 0.0.0.0:${API_PORT:-8000}
 else
+  echo "Collect static files"
+  python manage.py collectstatic
   echo "Starting up the production server"
   gunicorn core.wsgi:application --bind 0.0.0.0:${API_PORT:-8000}
 fi