Merge remote-tracking branch 'origin/master' into nightly

overhangio · May 28, 2024 · 5db5e79 · 5db5e79
2 parents 2d4562b + fa5201b
commit 5db5e79
Show file tree

Hide file tree

Showing 9 changed files with 1 addition and 13 deletions.
diff --git a/changelog.d/20240528_110103_jjasonmok1_remove_version_argument.md b/changelog.d/20240528_110103_jjasonmok1_remove_version_argument.md
@@ -0,0 +1 @@
+- [Improvement]  Remove the obsolete `version` property from all Docker Compose files and remove the DOCKER_COMPOSE_VERSION config setting. This addresses the deprecation warning from docker-compose (version 1.27 and above) regarding `version` being obsolete. (by @jasonmokk)
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -117,10 +117,6 @@ You may want to pull/push images from/to a custom docker registry. For instance,
 Compose
 *******
 
-- ``DOCKER_COMPOSE_VERSION`` (default: ``"3.7"``)
-
-This configuration parameter sets the version of Docker Compose to be used to build all containers.
-
 - ``DEV_PROJECT_NAME`` (default: ``"{{ TUTOR_APP }}_dev"``)
 
 This configuration parameter sets the Development version of the Docker Compose project name.

diff --git a/docs/dev.rst b/docs/dev.rst
@@ -238,7 +238,6 @@ Adding items to the ``MOUNTS`` setting effectively adds new bind-mount volumes t
 
 You are then free to bind-mount any directory to any container. For instance, to mount your own edx-platform fork::
 
-    version: "3.7"
     services:
       lms:
         volumes:

diff --git a/tutor/templates/config/defaults.yml b/tutor/templates/config/defaults.yml
@@ -11,7 +11,6 @@ CMS_OAUTH2_KEY_SSO: "cms-sso"
 CMS_OAUTH2_KEY_SSO_DEV: "cms-sso-dev"
 CONTACT_EMAIL: "contact@{{ LMS_HOST }}"
 DEV_PROJECT_NAME: "{{ TUTOR_APP }}_dev"
-DOCKER_COMPOSE_VERSION: "3.7"
 DOCKER_REGISTRY: "docker.io/"
 DOCKER_IMAGE_OPENEDX: "{{ DOCKER_REGISTRY }}overhangio/openedx:{{ TUTOR_VERSION }}"
 DOCKER_IMAGE_OPENEDX_DEV: "openedx-dev:{{ TUTOR_VERSION }}"

diff --git a/tutor/templates/dev/docker-compose.jobs.yml b/tutor/templates/dev/docker-compose.jobs.yml
@@ -1,5 +1,3 @@
-version: "{{ DOCKER_COMPOSE_VERSION }}"
-
 x-openedx-job-service:
   &openedx-job-service
   image: {{ DOCKER_IMAGE_OPENEDX_DEV }}

diff --git a/tutor/templates/dev/docker-compose.yml b/tutor/templates/dev/docker-compose.yml
@@ -1,5 +1,3 @@
-version: "{{ DOCKER_COMPOSE_VERSION }}"
-
 x-openedx-service:
   &openedx-service
   image: {{ DOCKER_IMAGE_OPENEDX_DEV }}

diff --git a/tutor/templates/local/docker-compose.jobs.yml b/tutor/templates/local/docker-compose.jobs.yml
@@ -11,7 +11,6 @@
 # This is because jobs are often used for initialization tasks, which may need to
 # happen before the service can be successfully `start`ed.
 
-version: "{{ DOCKER_COMPOSE_VERSION }}"
 services:
 
     mysql-job:

diff --git a/tutor/templates/local/docker-compose.prod.yml b/tutor/templates/local/docker-compose.prod.yml
@@ -1,4 +1,3 @@
-version: "{{ DOCKER_COMPOSE_VERSION }}"
 services:
   # Web proxy for load balancing and SSL termination
   caddy:

diff --git a/tutor/templates/local/docker-compose.yml b/tutor/templates/local/docker-compose.yml
@@ -1,4 +1,3 @@
-version: "{{ DOCKER_COMPOSE_VERSION }}"
 services:
 
   # Set bind-mounted folder ownership