chore: add enterprise-catalog in 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, enterprise-catalog+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.enterprise-catalog:
+	docker exec -it edx.devstack.enterprise-catalog 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

@@ -71,7 +71,16 @@ services:
       - ${DEVSTACK_WORKSPACE}/edx-analytics-data-api:/edx/app/analytics_api/analytics_api
       - ${DEVSTACK_WORKSPACE}/src:/edx/src
       - ${PWD}/py_configuration_files/analytics_data_api.py:/edx/app/analytics_api/analytics_api/analyticsdataserver/settings/devstack.py
-
+  enterprise-catalog:
+    volumes:
+      - ${DEVSTACK_WORKSPACE}/enterprise-catalog:/edx/app/enterprise_catalog/enterprise_catalog
+  enterprise-catalog-worker:
+    volumes:
+      - ${DEVSTACK_WORKSPACE}/enterprise-catalog:/edx/app/enterprise_catalog/enterprise_catalog
+      - ${PWD}/py_configuration_files/enterprise_catalog.py:/edx/app/enterprise_catalog/enterprise_catalog/settings/devstack.py
+  enterprise-catalog-curations-worker:
+    volumes:
+      - ${DEVSTACK_WORKSPACE}/enterprise-catalog:/edx/app/enterprise_catalog/enterprise_catalog
   # Note that frontends mount `src` to /edx/app/src instead of /edx/src.
   # See ADR #5 for rationale.
   frontend-app-account:

docker-compose.yml

@@ -693,6 +693,82 @@ services:
         aliases:
           - edx.devstack.xqueue_consumer
 
+  enterprise-catalog:
+    image: edxops/enterprise-catalog-dev
+    container_name: edx.devstack.enterprise-catalog
+    hostname: enterprise-catalog.devstack.edx
+    command: bash -c 'while true; do python /edx/app/enterprise_catalog/enterprise_catalog/manage.py runserver 0.0.0.0:18160; sleep 2; done'
+    ports:
+      - "18160:18160"
+    depends_on:
+      - memcached
+      - mysql80
+      - enterprise-catalog-worker
+    networks:
+      default:
+          aliases:
+            - edx.devstack.enterprise-catalog
+    # Allows attachment to this container using 'docker attach <containerID>'.
+    stdin_open: true
+    tty: true
+    environment:
+      CELERY_ALWAYS_EAGER: 'false'
+      CELERY_BROKER_TRANSPORT: redis
+      CELERY_BROKER_HOSTNAME: edx.devstack.redis:6379
+      CELERY_BROKER_VHOST: 0
+      CELERY_BROKER_PASSWORD: password
+      DJANGO_SETTINGS_MODULE: enterprise_catalog.settings.devstack
+      ENABLE_DJANGO_TOOLBAR: 1
+      DB_HOST: edx.devstack.mysql80
+      DB_NAME: enterprise_catalog
+      DB_PORT: 3306
+      DB_USER: catalog001
+      DB_PASSWORD: 'password'
+
+  enterprise-catalog-worker:
+    image: edxops/enterprise-catalog-dev
+    command: bash -c 'cd /edx/app/enterprise_catalog/enterprise_catalog && celery -A enterprise_catalog worker -Q enterprise_catalog.default -l DEBUG'
+    container_name: edx.devstack.enterprise.catalog.worker
+    depends_on:
+      - mysql80
+    environment:
+      CELERY_ALWAYS_EAGER: 'false'
+      CELERY_BROKER_TRANSPORT: redis
+      CELERY_BROKER_HOSTNAME: edx.devstack.redis:6379
+      CELERY_BROKER_VHOST: 0
+      CELERY_BROKER_PASSWORD: password
+      DJANGO_SETTINGS_MODULE: enterprise_catalog.settings.devstack
+      COLUMNS: 80
+    hostname: worker.catalog.enterprise
+    ports:
+      - "18161:18161"
+    restart: always
+    # Allows attachment to this container using 'docker attach <containerID>'.
+    stdin_open: true
+    tty: true
+
+  enterprise-catalog-curations-worker:
+    image: edxops/enterprise-catalog-dev
+    command: bash -c 'cd /edx/app/enterprise_catalog/enterprise_catalog && celery -A enterprise_catalog worker -Q enterprise_catalog.curations -l DEBUG'
+    container_name: enterprise.catalog.curations
+    depends_on:
+      - mysql80
+    environment:
+      CELERY_ALWAYS_EAGER: 'false'
+      CELERY_BROKER_TRANSPORT: redis
+      CELERY_BROKER_HOSTNAME: edx.devstack.redis:6379
+      CELERY_BROKER_VHOST: 0
+      CELERY_BROKER_PASSWORD: password
+      DJANGO_SETTINGS_MODULE: enterprise_catalog.settings.devstack
+      COLUMNS: 80
+    hostname: curations.catalog.enterprise
+    ports:
+      - "18162:18162"
+    restart: always
+    # Allows attachment to this container using 'docker attach <containerID>'.
+    stdin_open: true
+    tty: true
+
   # ==========================================================================
   # edX Microfrontends
   #

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        |
 +------------------------------------+-------------------------------------+----------------+--------------+
+| `enterprise-catalog`_              | http://localhost:18160/             | 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
+.. _enterprise-catalog: https://github.com/openedx/enterprise-catalog

options.mk

@@ -67,7 +67,7 @@ credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-authn+frontend-
 # Separated by plus signs.
 # Separated by plus signs. Listed in alphabetical order for clarity.
 EDX_SERVICES ?= \
-analyticsapi+credentials+cms+cms-worker+cms_watcher+discovery+ecommerce+edx_notes_api+forum+frontend-app-account+frontend-app-learner-dashboard+frontend-app-learner-record+frontend-app-profile+frontend-app-authn+frontend-app-course-authoring+frontend-app-gradebook+frontend-app-ora-grading+frontend-app-learning+frontend-app-library-authoring+frontend-app-payment+frontend-app-program-console+frontend-app-publisher+insights+lms+lms-worker+lms_watcher+registrar+registrar-worker+xqueue+xqueue_consumer
+analyticsapi+credentials+cms+cms-worker+cms_watcher+discovery+ecommerce+edx_notes_api+forum+frontend-app-account+frontend-app-learner-dashboard+frontend-app-learner-record+frontend-app-profile+frontend-app-authn+frontend-app-course-authoring+frontend-app-gradebook+frontend-app-ora-grading+frontend-app-learning+frontend-app-library-authoring+frontend-app-payment+frontend-app-program-console+frontend-app-publisher+insights+lms+lms-worker+lms_watcher+registrar+registrar-worker+xqueue+xqueue_consumer+enterprise-catalog
 
 # Services with database migrations.
 # Should be a subset of $(EDX_SERVICES).

provision-enterprise-catalog.sh

@@ -0,0 +1,20 @@
+name="enterprise-catalog"
+port="18160"
+
+docker compose up -d $name
+
+# Run migrations
+echo -e "${GREEN}Running migrations for ${name}...${NC}"
+docker compose exec -T ${name} bash -c "cd /edx/app/${name}/${name}/ && make migrate"
+
+echo -e "${GREEN}Installing requirements for ${name}...${NC}"
+docker compose exec -T ${name}  bash -e -c 'cd /edx/app/enterprise-catalog/ && make requirements' -- "$name"
+
+# Create superuser
+echo -e "${GREEN}Creating super-user for ${name}...${NC}"
+docker compose exec -T ${name} 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}/${name}/manage.py shell"
+
+./provision-ida-user.sh ${name} ${name} ${port}
+
+# Restart enterprise.catalog app and worker containers
+docker compose restart enterprise-catalog enterprise-catalog-worker

provision-mysql80.sql

@@ -6,6 +6,10 @@ CREATE DATABASE IF NOT EXISTS credentials;
 CREATE USER IF NOT EXISTS 'credentials001'@'%' IDENTIFIED BY 'password';
 GRANT ALL ON credentials.* TO 'credentials001'@'%';
 
+CREATE DATABASE IF NOT EXISTS enterprise_catalog;
+CREATE USER IF NOT EXISTS 'catalog001'@'%' IDENTIFIED BY 'password';
+GRANT ALL ON enterprise_catalog.* TO 'catalog001'@'%';
+
 CREATE DATABASE IF NOT EXISTS discovery;
 CREATE USER IF NOT EXISTS 'discov001'@'%' IDENTIFIED BY 'password';
 GRANT ALL ON discovery.* TO 'discov001'@'%';

provision.sh

@@ -3,7 +3,7 @@
 # This script will provision the services specified in the argument list,
 # or all services if no arguments are provided.
 #
-# Non-existant services will be ignored.
+# Non-existent services will be ignored.
 # Specifying services more than once will cause them to be provisioned more
 # than once.
 #
@@ -49,6 +49,7 @@ xqueue \
 coursegraph \
 insights \
 analyticsapi \
+enterprise-catalog \
  "
 
 # What should we provision?

provision.sql

@@ -33,5 +33,7 @@ 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 `enterprise_catalog`;
+GRANT ALL ON `enterprise_catalog`.* TO 'catalog001'@'%' 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/openedx/enterprise-catalog.git"
 )
 
 non_release_repos=(
@@ -56,6 +57,7 @@ ssh_repos=(
     "[email protected]:openedx/cs_comments_service.git"
     "[email protected]:edx/ecommerce.git"
     "[email protected]:openedx/edx-notes-api.git"
+    "[email protected]:openedx/enterprise-catalog.git"
     "[email protected]:openedx/edx-platform.git"
     "[email protected]:openedx/xqueue.git"
     "[email protected]:edx/edx-analytics-dashboard.git"