chore: add portal-designer to devstack

.github/workflows/provisioning-tests.yml

@@ -30,7 +30,7 @@ jobs:
         os:
           - ubuntu-20.04 # Ubuntu 20.04 "Focal Fossa"
         python-version: [ '3.11' ]
-        services: [ discovery+lms+forum ,registrar+lms, ecommerce+lms, edx_notes_api+lms, credentials+lms, xqueue, analyticsapi+insights+lms]
+        services: [ discovery+lms+forum ,registrar+lms, ecommerce+lms, edx_notes_api+lms, credentials+lms, xqueue, analyticsapi+insights+lms, designer+lms]
       fail-fast: false # some services can be flaky; let others run to completion even if one fails
 
     steps:

Makefile

@@ -407,6 +407,9 @@ dev.shell.analyticsapi:
 dev.shell.insights:
 	docker compose exec insights env TERM=$(TERM) bash -c 'eval $$(source /edx/app/insights/insights_env; echo PATH="$$PATH";) && /bin/bash'
 
+dev.shell.designer:
+	docker exec -it edx.devstack.designer env TERM=$(TERM) bash -c '/bin/bash'
+
 dev.shell.%: ## Run a shell on the specified service's container.
 	docker compose exec $* /bin/bash
 

docker-compose-host.yml

@@ -45,6 +45,10 @@ services:
     volumes:
       - ${DEVSTACK_WORKSPACE}/registrar:/edx/app/registrar
       - ${PWD}/py_configuration_files/registrar.py:/edx/app/registrar/registrar/registrar/settings/devstack.py
+  designer:
+    volumes:
+      - ${DEVSTACK_WORKSPACE}/portal-designer:/edx/app/designer
+      - ${PWD}/py_configuration_files/portal_designer.py:/edx/app/designer/designer/settings/devstack.py
   registrar-worker:
     volumes:
       - ${DEVSTACK_WORKSPACE}/registrar:/edx/app/registrar

docker-compose.yml

@@ -693,6 +693,32 @@ services:
         aliases:
           - edx.devstack.xqueue_consumer
 
+  designer:
+    image: edxops/designer-dev:latest # this image doesn't exist on dockerhub yet
+    container_name: edx.devstack.designer
+    volumes:
+      - .:/edx/app/designer
+    command: bash -c 'while true; do python /edx/app/designer/manage.py runserver 0.0.0.0:18808; sleep 2; done'
+    ports:
+      - "18809:18808"
+    depends_on:
+      - mysql80
+    networks:
+      default:
+        aliases:
+          - edx.devstack.designer
+    # Allows attachment to this container using 'docker attach <containerID>'.
+    stdin_open: true
+    tty: true
+    environment:
+      DJANGO_SETTINGS_MODULE: designer.settings.devstack
+      ENABLE_DJANGO_TOOLBAR: 1
+      DB_HOST: edx.devstack.mysql80
+      DB_NAME: designer
+      DB_PORT: 3306
+      DB_USER: designer001
+      DB_PASSWORD: password
+
   # ==========================================================================
   # edX Microfrontends
   #
@@ -910,3 +936,4 @@ volumes:
   mysql57_data:
   mysql80_data:
   redis_data:
+  designer_mysql:

docs/service_list.rst

@@ -63,6 +63,8 @@ Instead of a service name or list, you can also run commands like ``make dev.pro
 +------------------------------------+-------------------------------------+----------------+--------------+
 | `frontend-app-ora-grading`_        | http://localhost:1993               | MFE (React.js) | Extra        |
 +------------------------------------+-------------------------------------+----------------+--------------+
+| `designer`_                        | http://localhost:3307               | Python/Django  | Extra        |
++------------------------------------+-------------------------------------+----------------+--------------+
 
 Some common service combinations include:
 
@@ -95,3 +97,4 @@ Some common service combinations include:
 .. _frontend-app-ora-grading: https://github.com/edx/frontend-app-ora-grading
 .. _insights: https://github.com/edx/edx-analytics-dashboard
 .. _analyticsapi: https://github.com/edx/edx-analytics-data-api
+.. _designer: https://github.com/edx/portal-designer

options.mk

@@ -61,7 +61,7 @@ ALWAYS_CACHE_PROGRAMS ?= false
 #       The current value was chosen such that it would not change the existing
 #       Devstack behavior.
 DEFAULT_SERVICES ?= \
-credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-authn+frontend-app-gradebook+frontend-app-payment+frontend-app-publisher+frontend-app-learning+lms+cms
+credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-authn+frontend-app-gradebook+frontend-app-payment+frontend-app-publisher+frontend-app-learning+lms+cms+designer
 
 # All edX services, whether or not they are run by default.
 # Separated by plus signs.

provision-designer.sh

@@ -0,0 +1,39 @@
+name="designer"
+port="18808"
+
+docker compose up -d $name --build
+docker compose up -d lms
+
+# Install requirements
+# Can be skipped right now because we're using the --build flag on docker compose. This will need to be changed once we move to devstack.
+
+# Wait for MySQL
+echo "Waiting for MySQL"
+until docker exec -i edx.devstack.mysql80 mysql -u root -se "SELECT EXISTS(SELECT 1 FROM mysql.user WHERE user = 'root')" &> /dev/null
+do
+  printf "."
+  sleep 1
+done
+sleep 5
+
+echo -e "${GREEN}Installing requirements for ${name}...${NC}"
+docker compose exec -T ${name}  bash -e -c 'cd /edx/app/designer/ && make requirements' -- f"$name"
+
+# Run migrations
+echo -e "${GREEN}Running migrations for ${name}...${NC}"
+docker exec -t edx.devstack.designer bash -c "cd /edx/app/${name}/ && make migrate"
+
+# Create superuser
+echo -e "${GREEN}Creating super-user for ${name}...${NC}"
+docker exec -t edx.devstack.designer bash -c "echo 'from django.contrib.auth import get_user_model; User = get_user_model(); User.objects.create_superuser(\"edx\", \"[email protected]\", \"edx\") if not User.objects.filter(username=\"edx\").exists() else None' | python /edx/app/${name}/manage.py shell"
+
+# Provision IDA User in LMS
+echo -e "${GREEN}Provisioning ${name}_worker in LMS...${NC}"
+docker exec -t edx.devstack.lms  bash -c "source /edx/app/edxapp/edxapp_env && python /edx/app/edxapp/edx-platform/manage.py lms --settings=devstack_docker manage_user ${name}_worker ${name}[email protected] --staff --superuser"
+
+# Create the DOT applications - one for single sign-on and one for backend service IDA-to-IDA authentication.
+docker exec -t edx.devstack.lms  bash -c "source /edx/app/edxapp/edxapp_env && python /edx/app/edxapp/edx-platform/manage.py lms --settings=devstack_docker create_dot_application --grant-type authorization-code --skip-authorization --redirect-uris 'http://localhost:${port}/complete/edx-oauth2/' --client-id '${name}-sso-key' --client-secret '${name}-sso-secret' --scopes 'user_id' ${name}-sso ${name}_worker"
+docker exec -t edx.devstack.lms bash -c "source /edx/app/edxapp/edxapp_env && python /edx/app/edxapp/edx-platform/manage.py lms --settings=devstack_docker create_dot_application --grant-type client-credentials --client-id '${name}-backend-service-key' --client-secret '${name}-backend-service-secret' ${name}-backend-service ${name}_worker"
+
+# Restart designer app
+docker compose stop designer

provision-mysql80.sql

@@ -10,6 +10,10 @@ CREATE DATABASE IF NOT EXISTS discovery;
 CREATE USER IF NOT EXISTS 'discov001'@'%' IDENTIFIED BY 'password';
 GRANT ALL ON discovery.* TO 'discov001'@'%';
 
+CREATE DATABASE IF NOT EXISTS designer;
+CREATE USER IF NOT EXISTS 'designer001'@'%' IDENTIFIED BY 'password';
+GRANT ALL ON designer.* TO 'designer001'@'%';
+
 CREATE DATABASE IF NOT EXISTS ecommerce;
 CREATE USER IF NOT EXISTS 'ecomm001'@'%' IDENTIFIED BY 'password';
 GRANT ALL ON ecommerce.* TO 'ecomm001'@'%';

provision.sh

@@ -49,6 +49,7 @@ xqueue \
 coursegraph \
 insights \
 analyticsapi \
+designer \
  "
 
 # What should we provision?

provision.sql

@@ -33,5 +33,8 @@ GRANT ALL ON `reports`.* TO 'analytics001'@'%' IDENTIFIED BY 'password';
 CREATE DATABASE IF NOT EXISTS `reports_v1`;
 GRANT ALL ON `reports_v1`.* TO 'analytics001'@'%' IDENTIFIED BY 'password';
 
+CREATE DATABASE IF NOT EXISTS designer;
+GRANT ALL ON discovery.* TO 'designer001'@'%' IDENTIFIED BY 'password';
+
 
 FLUSH PRIVILEGES;

repo.sh

@@ -36,6 +36,7 @@ repos=(
     "https://github.com/openedx/frontend-app-publisher.git"
     "https://github.com/edx/edx-analytics-dashboard.git"
     "https://github.com/edx/edx-analytics-data-api.git"
+    "https://github.com/edx/portal-designer.git"
 )
 
 non_release_repos=(
@@ -66,6 +67,7 @@ ssh_repos=(
     "[email protected]:openedx/frontend-app-publisher.git"
     "[email protected]:edx/edx-analytics-dashboard.git"
     "[email protected]:edx/edx-analytics-data-api.git"
+    "[email protected]:edx/portal-designer.git"
 )
 
 non_release_ssh_repos=(