feat: move all forum-related code to a dedicated plugin

Forum is an optional feature, and as such it deserves its own plugin. Starting
from Maple, users will be able to install the forum from
https://github.com/overhangio/tutor-forum/

Close #450.

CHANGELOG.md

@@ -4,6 +4,10 @@ Note: Breaking changes between versions are indicated by "💥".
 
 ## Unreleased
 
+- 💥[Improvement] Move the Open edX forum to a [dedicated plugin](https://github.com/overhangio/tutor-forum/) (#450).
+
+## v12.1.5 (2021-10-25)
+
 - 💥[Improvement] Change the `settheme` command such that, by default, a custom theme is assigned to the LMS and the CMS, both in production and development mode.
 
 ## v12.1.4 (2021-10-11)

Makefile

@@ -98,7 +98,7 @@ ci-test-bundle: ## Run basic tests on bundle
 	yes "" | ./dist/tutor config save --interactive
 	./dist/tutor config save
 	./dist/tutor plugins list
-	./dist/tutor plugins enable android discovery ecommerce license mfe minio notes webui xqueue
+	./dist/tutor plugins enable android discovery ecommerce forum license mfe minio notes webui xqueue
 	./dist/tutor plugins list
 	./dist/tutor license --help
 

bin/main.py

@@ -6,6 +6,7 @@
     "android",
     "discovery",
     "ecommerce",
+    "forum",
     "license",
     "mfe",
     "minio",

docs/configuration.rst

@@ -42,7 +42,6 @@ Individual service activation
 
 - ``RUN_LMS`` (default: ``true``)
 - ``RUN_CMS`` (default: ``true``)
-- ``RUN_FORUM`` (default: ``true``)
 - ``RUN_ELASTICSEARCH`` (default: ``true``)
 - ``RUN_MONGODB`` (default: ``true``)
 - ``RUN_MYSQL`` (default: ``true``)
@@ -61,9 +60,8 @@ Custom images
 *************
 
 - ``DOCKER_IMAGE_OPENEDX`` (default: ``"{{ DOCKER_REGISTRY }}overhangio/openedx:{{ TUTOR_VERSION }}"``)
-- ``DOCKER_IMAGE_FORUM`` (default: ``"{{ DOCKER_REGISTRY }}overhangio/openedx-forum:{{ TUTOR_VERSION }}"``)
 
-These configuration parameters define which image to run for each service. By default, the docker image tag matches the Tutor version it was built with.
+Theis configuration parameter defines the name of the Docker image to run for the lms and cms containers. By default, the Docker image tag matches the Tutor version it was built with.
 
 Custom registry
 ***************
@@ -165,13 +163,6 @@ SMTP
 
 Note that the SMTP server shipped with Tutor by default does not implement TLS. With external servers, only one of SSL or TLS should be enabled, at most.
 
-Forum
-*****
-
-- ``RUN_FORUM`` (default: ``true``)
-- ``FORUM_HOST`` (default: ``"forum"``)
-- ``FORUM_MONGODB_DATABASE`` (default: ``"cs_comments_service"``)
-
 SSL/TLS certificates for HTTPS access
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/plugins/api.rst

@@ -83,7 +83,7 @@ Example::
 
 During initialisation, "myservice1" and "myservice2" will be run in sequence with the commands defined in the templates ``myplugin/hooks/myservice1/init`` and ``myplugin/hooks/myservice2/init``.
 
-To initialise a "foo" service, Tutor runs the "foo-job" service that is found in the ``env/local/docker-compose.jobs.yml`` file. By default, Tutor comes with a few services in this file: mysql-job, lms-job, cms-job, forum-job. If your plugin requires running custom services during initialisation, you will need to add them to the ``docker-compose.jobs.yml`` template. To do so, just use the "local-docker-compose-jobs-services" patch.
+To initialise a "foo" service, Tutor runs the "foo-job" service that is found in the ``env/local/docker-compose.jobs.yml`` file. By default, Tutor comes with a few services in this file: mysql-job, lms-job, cms-job. If your plugin requires running custom services during initialisation, you will need to add them to the ``docker-compose.jobs.yml`` template. To do so, just use the "local-docker-compose-jobs-services" patch.
 
 In Kubernetes, the approach is the same, except that jobs are implemented as actual job objects in the ``k8s/jobs.yml`` template. To add your own services there, your plugin should implement the "k8s-jobs" patch.
 

requirements/plugins.txt

@@ -2,6 +2,7 @@
 tutor-android>=12.0.0,<13.0.0
 tutor-discovery>=12.0.0,<13.0.0
 tutor-ecommerce>=12.0.0,<13.0.0
+tutor-forum>=12.0.0,<13.0.0
 tutor-license>=12.0.0,<13.0.0
 tutor-mfe>=12.0.0,<13.0.0
 tutor-minio>=12.0.0,<13.0.0

tutor/commands/images.py

@@ -10,7 +10,7 @@
 from ..types import Config
 from .context import Context
 
-BASE_IMAGE_NAMES = ["openedx", "forum", "permissions"]
+BASE_IMAGE_NAMES = ["openedx", "permissions"]
 VENDOR_IMAGES = [
     "caddy",
     "elasticsearch",

tutor/config.py

@@ -165,7 +165,6 @@ def upgrade_obsolete(config: Config) -> None:
     for name in [
         "ACTIVATE_LMS",
         "ACTIVATE_CMS",
-        "ACTIVATE_FORUM",
         "ACTIVATE_ELASTICSEARCH",
         "ACTIVATE_MONGODB",
         "ACTIVATE_MYSQL",

tutor/jobs.py

@@ -49,7 +49,7 @@ def initialise(runner: BaseJobRunner, limit_to: Optional[str] = None) -> None:
                 runner.run_job_from_template(
                     service, plugin_name, "hooks", service, "pre-init"
                 )
-    for service in ["lms", "cms", "forum"]:
+    for service in ["lms", "cms"]:
         if limit_to is None or limit_to == service:
             fmt.echo_info("Initialising {}...".format(service))
             runner.run_job_from_template(service, "hooks", service, "init")

tutor/templates/apps/openedx/config/lms.env.json

@@ -35,8 +35,6 @@
   "CELERY_BROKER_USER": "{{ REDIS_USERNAME }}",
   "CELERY_BROKER_PASSWORD": "{{ REDIS_PASSWORD }}",
   "ALTERNATE_WORKER_QUEUES": "cms",
-  "COMMENTS_SERVICE_URL": "http://{{ FORUM_HOST }}:4567",
-  "COMMENTS_SERVICE_KEY": "forumapikey",
   "ENABLE_COMPREHENSIVE_THEMING": true,
   "COMPREHENSIVE_THEME_DIRS": ["/openedx/themes"],
   "STATIC_ROOT_BASE": "/openedx/staticfiles",

tutor/templates/apps/openedx/settings/lms/development.py

@@ -18,7 +18,6 @@
 LOGIN_REDIRECT_WHITELIST.append(CMS_BASE)
 
 FEATURES['ENABLE_COURSEWARE_MICROFRONTEND'] = False
-COMMENTS_SERVICE_URL = "http://{{ FORUM_HOST }}:4567"
 
 LOGGING["loggers"]["oauth2_provider"] = {
     "handlers": ["console"],

tutor/templates/config.yml

@@ -11,7 +11,6 @@ LMS_HOST: "www.myopenedx.com"
 # The following are default values
 RUN_LMS: true
 RUN_CMS: true
-RUN_FORUM: true
 RUN_ELASTICSEARCH: true
 RUN_MONGODB: true
 RUN_MYSQL: true
@@ -29,7 +28,6 @@ DOCKER_IMAGE_OPENEDX: "{{ DOCKER_REGISTRY }}overhangio/openedx:{{ TUTOR_VERSION
 DOCKER_IMAGE_OPENEDX_DEV: "openedx-dev"
 DOCKER_IMAGE_CADDY: "{{ DOCKER_REGISTRY }}caddy:2.3.0"
 DOCKER_IMAGE_ELASTICSEARCH: "{{ DOCKER_REGISTRY }}elasticsearch:7.10.1"
-DOCKER_IMAGE_FORUM: "{{ DOCKER_REGISTRY }}overhangio/openedx-forum:{{ TUTOR_VERSION }}"
 DOCKER_IMAGE_MONGODB: "{{ DOCKER_REGISTRY }}mongo:4.2.17"
 DOCKER_IMAGE_MYSQL: "{{ DOCKER_REGISTRY }}mysql:5.7.35"
 DOCKER_IMAGE_ELASTICSEARCH: "{{ DOCKER_REGISTRY }}elasticsearch:7.10.1"
@@ -44,8 +42,6 @@ ELASTICSEARCH_SCHEME: "http"
 ELASTICSEARCH_HEAP_SIZE: 1g
 ENABLE_HTTPS: false
 ENABLE_WEB_PROXY: true
-FORUM_HOST: "forum"
-FORUM_MONGODB_DATABASE: "cs_comments_service"
 JWT_COMMON_AUDIENCE: "openedx"
 JWT_COMMON_ISSUER: "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/oauth2"
 JWT_COMMON_SECRET_KEY: "{{ OPENEDX_SECRET_KEY }}"

tutor/templates/k8s/deployments.yml

@@ -130,45 +130,6 @@ spec:
           configMap:
             name: openedx-config
 {% endif %}
-{% if RUN_FORUM %}
----
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: forum
-  labels:
-    app.kubernetes.io/name: forum
-spec:
-  selector:
-    matchLabels:
-      app.kubernetes.io/name: forum
-  template:
-    metadata:
-      labels:
-        app.kubernetes.io/name: forum
-    spec:
-      securityContext:
-        runAsUser: 1000
-        runAsGroup: 1000
-      containers:
-        - name: forum
-          image: {{ DOCKER_IMAGE_FORUM }}
-          ports:
-            - containerPort: 4567
-          env:
-            - name: SEARCH_SERVER
-              value: "{{ ELASTICSEARCH_SCHEME }}://{{ ELASTICSEARCH_HOST }}:{{ ELASTICSEARCH_PORT }}"
-            - name: MONGODB_AUTH
-              value: "{% if MONGODB_USERNAME and MONGODB_PASSWORD %}{{ MONGODB_USERNAME}}:{{ MONGODB_PASSWORD }}@{% endif %}"
-            - name: MONGODB_HOST
-              value: "{{ MONGODB_HOST }}"
-            - name: MONGODB_PORT
-              value: "{{ MONGODB_PORT }}"
-            - name: MONGODB_DATABASE
-              value: "{{ FORUM_MONGODB_DATABASE }}"
-          securityContext:
-            allowPrivilegeEscalation: false
-{% endif %}
 {% if RUN_LMS %}
 ---
 apiVersion: apps/v1

tutor/templates/k8s/jobs.yml

@@ -77,30 +77,5 @@ spec:
       containers:
       - name: mysql
         image: {{ DOCKER_IMAGE_MYSQL }}
----
-apiVersion: batch/v1
-kind: Job
-metadata:
-  name: forum-job
-  labels:
-    app.kubernetes.io/component: job
-spec:
-  template:
-    spec:
-      restartPolicy: Never
-      containers:
-      - name: forum
-        image: {{ DOCKER_IMAGE_FORUM }}
-        env:
-          - name: SEARCH_SERVER
-            value: "{{ ELASTICSEARCH_SCHEME }}://{{ ELASTICSEARCH_HOST }}:{{ ELASTICSEARCH_PORT }}"
-          - name: MONGODB_AUTH
-            value: "{% if MONGODB_USERNAME and MONGODB_PASSWORD %}{{ MONGODB_USERNAME}}:{{ MONGODB_PASSWORD }}@{% endif %}"
-          - name: MONGODB_HOST
-            value: "{{ MONGODB_HOST }}"
-          - name: MONGODB_PORT
-            value: "{{ MONGODB_PORT }}"
-          - name: MONGODB_DATABASE
-            value: "{{ FORUM_MONGODB_DATABASE }}"
 
 {{ patch("k8s-jobs") }}

tutor/templates/k8s/services.yml

@@ -28,20 +28,6 @@ spec:
   selector:
     app.kubernetes.io/name: cms
 {% endif %}
-{% if RUN_FORUM %}
----
-apiVersion: v1
-kind: Service
-metadata:
-  name: forum
-spec:
-  type: NodePort
-  ports:
-    - port: 4567
-      protocol: TCP
-  selector:
-    app.kubernetes.io/name: forum
-{% endif %}
 {% if RUN_LMS %}
 ---
 apiVersion: v1

tutor/templates/local/docker-compose.jobs.yml

@@ -27,14 +27,4 @@ services:
         - ../apps/openedx/config/:/openedx/config/:ro
       depends_on: {{ [("mysql", RUN_MYSQL)]|list_if }}
 
-    forum-job:
-      image: {{ DOCKER_IMAGE_FORUM }}
-      environment:
-        SEARCH_SERVER: "{{ ELASTICSEARCH_SCHEME }}://{{ ELASTICSEARCH_HOST }}:{{ ELASTICSEARCH_PORT }}"
-        MONGODB_AUTH: "{% if MONGODB_USERNAME and MONGODB_PASSWORD %}{{ MONGODB_USERNAME}}:{{ MONGODB_PASSWORD }}@{% endif %}"
-        MONGODB_HOST: "{{ MONGODB_HOST }}"
-        MONGODB_PORT: "{{ MONGODB_PORT }}"
-        MONGODB_DATABASE: "{{ FORUM_MONGODB_DATABASE }}"
-      depends_on: {{ [("elasticsearch", RUN_ELASTICSEARCH), ("mongodb", RUN_MONGODB)]|list_if }}
-
     {{ patch("local-docker-compose-jobs-services")|indent(4) }}

tutor/templates/local/docker-compose.yml

@@ -97,21 +97,6 @@ services:
       HOSTNAME: "{{ LMS_HOST }}"
   {% endif %}
 
-  ############# Forum
-
-  {% if RUN_FORUM %}
-  forum:
-    image: {{ DOCKER_IMAGE_FORUM }}
-    environment:
-      SEARCH_SERVER: "{{ ELASTICSEARCH_SCHEME }}://{{ ELASTICSEARCH_HOST }}:{{ ELASTICSEARCH_PORT }}"
-      MONGODB_AUTH: "{% if MONGODB_USERNAME and MONGODB_PASSWORD %}{{ MONGODB_USERNAME}}:{{ MONGODB_PASSWORD }}@{% endif %}"
-      MONGODB_HOST: "{{ MONGODB_HOST }}"
-      MONGODB_PORT: "{{ MONGODB_PORT }}"
-      MONGODB_DATABASE: "{{ FORUM_MONGODB_DATABASE }}"
-    restart: unless-stopped
-    depends_on: {{ [("elasticsearch", RUN_ELASTICSEARCH), ("mongodb", RUN_MONGODB)]|list_if }}
-  {% endif %}
-
   ############# LMS and CMS
 
   {% if RUN_LMS %}
@@ -132,7 +117,6 @@ services:
       - lms-permissions
       {% if RUN_MYSQL %}- mysql{% endif %}
       {% if RUN_ELASTICSEARCH %}- elasticsearch{% endif %}
-      {% if RUN_FORUM %}- forum{% endif %}
       {% if RUN_MONGODB %}- mongodb{% endif %}
       {% if RUN_REDIS %}- redis{% endif %}
       {% if RUN_SMTP %}- smtp{% endif %}