depr: RUN_LMS, RUN_CMS settings

These tutor settings are mostly useless and make templates much more
difficult to work with.

changelog.d/20230325_205654_regis_permissions.md

@@ -0,0 +1 @@
+- 💥[Improvement] Deprecate the `RUN_LMS` and `RUN_CMS` tutor settings, which should be mostly unused. (by @regisb)

docs/configuration.rst

@@ -40,8 +40,6 @@ With an up-to-date environment, Tutor is ready to launch an Open edX platform an
 Individual service activation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- ``RUN_LMS`` (default: ``true``)
-- ``RUN_CMS`` (default: ``true``)
 - ``RUN_ELASTICSEARCH`` (default: ``true``)
 - ``RUN_MONGODB`` (default: ``true``)
 - ``RUN_MYSQL`` (default: ``true``)

tutor/commands/compose.py

@@ -306,10 +306,7 @@ def restart(context: BaseComposeContext, services: list[str]) -> None:
     else:
         for service in services:
             if service == "openedx":
-                if config["RUN_LMS"]:
-                    command += ["lms", "lms-worker"]
-                if config["RUN_CMS"]:
-                    command += ["cms", "cms-worker"]
+                command += ["lms", "lms-worker", "cms", "cms-worker"]
             else:
                 command.append(service)
     context.job_runner(config).docker_compose(*command)

tutor/templates/config/defaults.yml

@@ -64,9 +64,7 @@ REDIS_HOST: "redis"
 REDIS_PORT: 6379
 REDIS_USERNAME: ""
 REDIS_PASSWORD: ""
-RUN_CMS: true
 RUN_ELASTICSEARCH: true
-RUN_LMS: true
 RUN_MONGODB: true
 RUN_MYSQL: true
 RUN_REDIS: true

tutor/templates/k8s/deployments.yml

@@ -57,7 +57,6 @@ spec:
           persistentVolumeClaim:
             claimName: caddy
         {%- endif %}
-{% if RUN_CMS %}
 ---
 apiVersion: apps/v1
 kind: Deployment
@@ -167,8 +166,6 @@ spec:
         - name: config
           configMap:
             name: openedx-config
-{% endif %}
-{% if RUN_LMS %}
 ---
 apiVersion: apps/v1
 kind: Deployment
@@ -278,7 +275,6 @@ spec:
         - name: config
           configMap:
             name: openedx-config
-{% endif %}
 {% if RUN_ELASTICSEARCH %}
 ---
 apiVersion: apps/v1

tutor/templates/k8s/services.yml

@@ -34,7 +34,6 @@ spec:
   selector:
     app.kubernetes.io/name: caddy
 {% endif %}
-{% if RUN_CMS %}
 ---
 apiVersion: v1
 kind: Service
@@ -49,8 +48,6 @@ spec:
       protocol: TCP
   selector:
     app.kubernetes.io/name: cms
-{% endif %}
-{% if RUN_LMS %}
 ---
 apiVersion: v1
 kind: Service
@@ -65,7 +62,6 @@ spec:
       protocol: TCP
   selector:
     app.kubernetes.io/name: lms
-{% endif %}
 {% if RUN_ELASTICSEARCH %}
 ---
 apiVersion: v1

tutor/templates/local/docker-compose.yml

@@ -97,7 +97,6 @@ services:
 
   ############# LMS and CMS
 
-  {% if RUN_LMS %}
   lms:
     image: {{ DOCKER_IMAGE_OPENEDX }}
     environment:
@@ -129,7 +128,6 @@ services:
       - ../../data/openedx-media:/openedx/media
   {% endif %}
 
-  {% if RUN_CMS %}
   cms:
     image: {{ DOCKER_IMAGE_OPENEDX }}
     environment:
@@ -151,7 +149,6 @@ services:
       {% if RUN_MONGODB %}- mongodb{% endif %}
       {% if RUN_REDIS %}- redis{% endif %}
       {% if RUN_SMTP %}- smtp{% endif %}
-      {% if RUN_LMS %}- lms{% endif %}
       {{ patch("local-docker-compose-cms-dependencies")|indent(6) }}
   cms-permissions:
     image: {{ DOCKER_IMAGE_PERMISSIONS }}
@@ -160,11 +157,9 @@ services:
     volumes:
       - ../../data/cms:/openedx/data
       - ../../data/openedx-media:/openedx/media
-  {% endif %}
 
   ############# LMS and CMS workers
 
-  {% if RUN_LMS %}
   lms-worker:
     image: {{ DOCKER_IMAGE_OPENEDX }}
     environment:
@@ -180,9 +175,7 @@ services:
       - ../../data/openedx-media:/openedx/media
     depends_on:
       - lms
-  {% endif %}
 
-  {% if RUN_CMS %}
   cms-worker:
     image: {{ DOCKER_IMAGE_OPENEDX }}
     environment:
@@ -198,6 +191,5 @@ services:
       - ../../data/openedx-media:/openedx/media
     depends_on:
       - cms
-  {% endif %}
 
   {{ patch("local-docker-compose-services")|indent(2) }}