Comments for proddev changes

Author: clay53

backend/docker-compose.yaml

@@ -15,6 +15,7 @@ services:
     image: redis:4.0
     ports:
       - "6379:6379"
+  # api, dashboard, and admin requests for proddev
   proddev-backend-wsgi:
     depends_on:
       - db
@@ -30,6 +31,7 @@ services:
       - DATABASE_URL=postgres://postgres:postgres@db:5432/postgres
       - DJANGO_SETTINGS_MODULE=officehoursqueue.settings.proddev
     command: sh -c "python manage.py migrate && { DJANGO_SUPERUSER_PASSWORD=root python manage.py createsuperuser --no-input --username root --email root@pennlabs.org; /usr/local/bin/django-run; }"
+  # Web socket requests for proddev
   proddev-backend-asgi:
     depends_on:
       - db
@@ -45,6 +47,7 @@ services:
       - DATABASE_URL=postgres://postgres:postgres@db:5432/postgres
       - DJANGO_SETTINGS_MODULE=officehoursqueue.settings.proddev
     command: sh -c "python manage.py migrate && { DJANGO_SUPERUSER_PASSWORD=root python manage.py createsuperuser --no-input --username root --email root@pennlabs.org; /usr/local/bin/asgi-run; }"
+  # frontend for proddev
   proddev-frontend:
     profiles:
       - proddev
@@ -53,6 +56,7 @@ services:
       dockerfile: ../frontend/Dockerfile
     ports:
       - "8003:80"
+  # Reverse proxy for routing requests to the various proddev servers based on the path
   nginx:
     image: nginx:latest
     depends_on:

backend/nginx-proddev.conf

@@ -1,23 +1,28 @@
+# Reverse proxy configuration for emulating what will actually be run in production as described in /k8s/main.ts
+
 events { }
 
 http {
     server {
         listen 80;
 
+        # Frontend is served unless overridden by other locations
         location / {
             proxy_pass http://proddev-frontend:3000;
             proxy_set_header Host $host;
             proxy_set_header X-Real-IP $remote_addr;
             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         }
 
+        # The wsgi backend is used on routes starting with '/api', '/admin', or '/assets'
         location ~ ^/(api|admin|assets) {
             proxy_pass http://proddev-backend-wsgi:80;
             proxy_set_header Host $host;
             proxy_set_header X-Real-IP $remote_addr;
             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         }
 
+        # The asgi backend is used for websocket requests on routes starting with '/api/ws'
         location /api/ws {
             proxy_pass http://proddev-backend-asgi:80;
             proxy_set_header Host $host;

backend/officehoursqueue/settings/proddev.py

@@ -1,13 +1,19 @@
+# Django config based off of production config, but with minor changes to ensure it works on dev machines
+
 from officehoursqueue.settings.production import *
 
 import officehoursqueue.settings.base as base
 
+# Turning debug logs shouldn't introduce major differences, but will help with debugging
 DEBUG = True
 
+# No https on dev machines
 SECURE_PROXY_SSL_HEADER = ()
 
+# Prevents request rejection on dev machines
 ALLOWED_HOSTS = ["*"]
 
+# Use local login instead of UPenn's
 PLATFORM_ACCOUNTS = base.PLATFORM_ACCOUNTS
 
 # Allow http callback for DLA