feat!: Remove support for docker-sync (#836)

Removing the deprecated support for use of docker-sync, as well as all documentation regarding its usage and troubleshooting.  See the deprecation ticket at https://openedx.atlassian.net/browse/DEPR-162 for more details.

BREAKING CHANGE: Removed the dev.sync.* make targets

Author: jmbowman

Makefile

@@ -54,8 +54,7 @@
         dev.shell.registrar dev.shell.studio \
         dev.shell.studio_watcher dev.shell.xqueue dev.shell.xqueue_consumer \
         dev.static dev.static.lms dev.static.studio dev.stats dev.status \
-        dev.stop dev.sync.daemon.start dev.sync.provision \
-        dev.sync.requirements dev.sync.up dev.up dev.up.attach dev.up.shell \
+        dev.stop dev.up dev.up.attach dev.up.shell \
         dev.up.without-deps dev.up.without-deps.shell dev.up.with-programs \
         dev.up.with-watchers dev.validate docs e2e-tests e2e-tests.with-shell \
         help requirements impl-dev.clone.https impl-dev.clone.ssh impl-dev.provision \
@@ -90,17 +89,11 @@ COMPOSE_FILE := $(COMPOSE_FILE):docker-compose-themes-nfs.yml
 COMPOSE_FILE := $(COMPOSE_FILE):docker-compose-watchers-nfs.yml
 endif
 
-# Files for use with Docker Sync.
-ifeq ($(FS_SYNC_STRATEGY),docker-sync)
-COMPOSE_FILE := docker-compose-host.yml
-COMPOSE_FILE := $(COMPOSE_FILE):docker-compose-sync.yml
-endif
-
 ifndef COMPOSE_FILE
-$(error FS_SYNC_STRATEGY is set to $(FS_SYNC_STRATEGY). Must be one of: local-mounts, nfs, docker-sync)
+$(error FS_SYNC_STRATEGY is set to $(FS_SYNC_STRATEGY). Must be one of: local-mounts, nfs)
 endif
 
-# All three filesystem synchronization strategies require the main docker-compose.yml file.
+# Both filesystem synchronization strategies require the main docker-compose.yml file.
 COMPOSE_FILE := docker-compose.yml:$(COMPOSE_FILE)
 
 # Tell Docker Compose that the Compose file list uses a colon as the separator.
@@ -371,14 +364,12 @@ dev.restart-container.%: ## Restart specific services' containers.
 	docker-compose restart $$(echo $* | tr + " ")
 
 dev.stop: ## Stop all running services.
-	(test -d .docker-sync && docker-sync stop) || true ## Ignore failure here
 	docker-compose stop
 
 dev.stop.%: ## Stop specific services.
 	docker-compose stop $$(echo $* | tr + " ")
 
 dev.kill: ## Kill all running services.
-	(test -d .docker-sync && docker-sync stop) || true ## Ignore failure here
 	docker-compose stop
 
 dev.kill.%: ## Kill specific services.
@@ -388,7 +379,6 @@ dev.rm-stopped: ## Remove stopped containers. Does not affect running containers
 	docker-compose rm --force
 
 dev.down: ## Stop and remove containers and networks for all services.
-	(test -d .docker-sync && docker-sync clean) || true ## Ignore failure here
 	docker-compose down
 
 dev.down.%: ## Stop and remove containers for specific services.
@@ -537,21 +527,6 @@ dev.nfs.setup: ## Sets up an NFS server on the /Users folder, allowing NFS mount
 dev.nfs.%: ## Run any 'dev.'-prefixed command, but using NFS configuration.
 	FS_SYNC_STRATEGY=nfs make dev.$*
 
-# TODO: Improve or rip out Docker Sync targets.
-#       They are not well-fleshed-out and it is not clear if anyone uses them.
-
-dev.sync.daemon.start: ## Start the docker-sycn daemon.
-	docker-sync start
-
-dev.sync.provision: dev.sync.daemon.start ## Provision with docker-sync enabled.
-	FS_SYNC_STRATEGY=docker-sync make dev.provision
-
-dev.sync.requirements: ## Install requirements for docker-sync usage.
-	gem install docker-sync
-
-dev.sync.up: dev.sync.daemon.start ## Bring up all services with docker-sync enabled.
-	FS_SYNC_STRATEGY=docker-sync make dev.up
-
 
 ########################################################################################
 # Support for "prefix-form" commands:

README.rst

@@ -180,7 +180,7 @@ The default devstack services can be run by following the steps below.
 
    **NOTE:** This command will bring up both MySQL 5.6 and 5.7 databases until all services are upgraded to 5.7.
 
-   **NOTE:** If you are looking for instructions for NFS or docker-sync, see :ref:`Deprecated MacOS performance improvements`.
+   **NOTE:** If you are looking for instructions for NFS, see :ref:`Deprecated MacOS performance improvements`.
 
 #. Start the desired services. This command will mount the repositories under the
    ``DEVSTACK_WORKSPACE`` directory.
@@ -193,7 +193,7 @@ The default devstack services can be run by following the steps below.
 
        make dev.up.large-and-slow
 
-   **NOTE:** If you are looking for instructions for NFS or docker-sync, see :ref:`Deprecated MacOS performance improvements`.
+   **NOTE:** If you are looking for instructions for NFS, see :ref:`Deprecated MacOS performance improvements`.
 
 To stop a service, use ``make dev.stop.<service>``, and to both stop it
 and remove the container (along with any changes you have made
@@ -396,44 +396,31 @@ As a specific example, if ``OPENEDX_RELEASE`` is set in your environment as ``ju
 Deprecated MacOS performance improvements
 -----------------------------------------
 
-**Warning:** We recommend that new devstack setups on MacOS **no longer use** NFS or docker-sync for MacOS. At this time, these technologies **lead to increased complexity and might cause errors**. Improvements to Docker's default FS have resolved bugs or performance issues that were previously dependent on these workaround technologies.
+**Warning:** We recommend that new devstack setups on MacOS **no longer use** NFS for MacOS. At this time, this technology **leads to increased complexity and might cause errors**. Improvements to Docker's default FS have resolved bugs or performance issues that were previously dependent on this workaround technology.
 
-For further details, read more about the forthcoming `deprecation of NFS`_ and `deprecation of docker-sync`_.
+For further details, read more about the forthcoming `deprecation of NFS`_.
 
-Until these deprecated technologies go through the deprecation and removal process, the following deprecated instructions are left here for legacy purposes:
+Until this deprecated technology goes through the deprecation and removal process, the following deprecated instructions are left here for legacy purposes:
 
 Setup NFS before provisioning:
 
 .. code:: sh
 
     make dev.nfs.setup
 
-Provision using `docker-sync`_:
-
-.. code:: sh
-
-   make dev.sync.provision
-
 Provision using NFS:
 
 .. code:: sh
 
    make dev.nfs.provision
 
-Start using `docker-sync`_:
-
-.. code:: sh
-
-   make dev.sync.up
-
 Start using NFS:
 
 .. code:: sh
 
    make dev.nfs.up
 
 .. _deprecation of NFS: https://openedx.atlassian.net/browse/DEPR-161
-.. _deprecation of docker-sync: https://openedx.atlassian.net/browse/DEPR-162
 
 .. _Docker Compose: https://docs.docker.com/compose/
 .. _Docker for Mac: https://docs.docker.com/docker-for-mac/
@@ -446,7 +433,6 @@ Start using NFS:
 .. _Pycharm Integration documentation: docs/pycharm_integration.rst
 .. _devpi documentation: docs/devpi.rst
 .. _edx-platform testing documentation: https://github.com/edx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
-.. _docker-sync: https://edx.readthedocs.io/projects/open-edx-devstack/en/latest/troubleshoot_general_tips.html#improve-mac-osx-performance-with-docker-sync
 .. |Build Status provisioning| image:: https://github.com/edx/devstack/actions/workflows/provisioning-tests.yml/badge.svg?branch=master
     :target: https://github.com/edx/devstack/actions/workflows/provisioning-tests.yml
     :alt: Provisioning tests

docker-compose-sync.yml

@@ -40,7 +40,7 @@ Switch between your Devstack releases by doing the following:
 #. Check out the appropriate branch in devstack, e.g. ``git checkout open-release/ironwood.master``
 #. Use ``make dev.checkout`` to check out the correct branch in the local
    copy of each service repository
-#. Bring up the containers with ``make dev.up``, ``make dev.nfs.up`` or ``make dev.sync.up``.
+#. Bring up the containers with ``make dev.up`` or ``make dev.nfs.up``.
 
 **NOTE:** Additional instructions on switching releases using ``direnv`` can be found in `How do I switch releases using 'direnv'?`_ section.
 

docker-sync.yml

@@ -189,8 +189,7 @@ To run migrations for all services at once, run:
    make dev.migrate
 
 Alternatively, you can discard and rebuild the entire database for all
-devstack services by re-running ``make dev.provision.<service>`` or
-``make dev.sync.provision`` as appropriate for your configuration.  Note that
+devstack services by re-running ``make dev.provision.<service>``.  Note that
 if your branch has fallen significantly behind master, it may not include all
 of the migrations included in the database dump used by provisioning.  In these
 cases, it's usually best to first rebase the branch onto master to
@@ -261,9 +260,8 @@ database migrations and package updates.
 When switching to a branch which differs greatly from the one you've been
 working on (especially if the new branch is more recent), you may wish to
 halt and remove the existing containers via ``make down``, pull the latest Docker
-images via ``make dev.pull.<service>``, and then re-run ``make dev.provision.<service>`` or
-``make dev.sync.provision`` in order to recreate up-to-date databases,
-static assets, etc.
+images via ``make dev.pull.<service>``, and then re-run ``make dev.provision.<service>``
+in order to recreate up-to-date databases, static assets, etc.
 
 If making a patch to a named release, you should pull and use Docker images
 which were tagged for that release.

docs/developing_on_named_release_branches.rst

@@ -18,17 +18,10 @@ Prerequisites
 Before running Run or Debug in PyCharm
 --------------------------------------
 
-Every time you run/debug a server or test in PyCharm, you must first ensure the
-following:
-
-1. Ensure that all Docker images are stopped outside of PyCharm before starting
-   a server or tests from inside PyCharm. PyCharm will potentially disable the
-   start button with no further error when this problem occurs. See `Jetbrains
-   ticket PY-22893`_.
-
-2. Ensure you are not using docker-sync (i.e. not using any make commands with ``sync`` in their name). Read more about the `deprecation of docker-sync`_.
-
-.. _deprecation of docker-sync: https://openedx.atlassian.net/browse/DEPR-162
+Every time you run/debug a server or test in PyCharm, you must first ensure
+that all Docker images are stopped outside of PyCharm. PyCharm will
+potentially disable the start button with no further error when this problem
+occurs. See `Jetbrains ticket PY-22893`_.
 
 Setup a Remote Interpreter
 --------------------------