Commit 9b3b738a by Robert Raposa

Deprecate docker-sync.

- Remove sync provisioning to force upgrade.
- Add 17.05 as minimum version
parent fc11ebf5
...@@ -30,8 +30,6 @@ dev.up: ## Bring up all services with host volumes ...@@ -30,8 +30,6 @@ dev.up: ## Bring up all services with host volumes
dev.sync.daemon.start: ## Start the docker-sycn daemon dev.sync.daemon.start: ## Start the docker-sycn daemon
docker-sync start docker-sync start
dev.sync.provision: | dev.sync.daemon.start dev.provision ## Provision with docker-sync enabled
dev.sync.requirements: ## Install requirements dev.sync.requirements: ## Install requirements
gem install docker-sync gem install docker-sync
......
...@@ -16,21 +16,22 @@ from within a VM. ...@@ -16,21 +16,22 @@ from within a VM.
Prerequisites Prerequisites
------------- -------------
This project was developed and tested using **Docker 1.13+**. If you are using This project requires **Docker 17.05+ CE**. Currently, 17.05 is only available
macOS, please use `Docker for Mac`_. Previous Mac-based tools (e.g. through the **Edge** version Docker 17.05 CE Edge.
For macOS users, please use `Docker for Mac`_. Previous Mac-based tools (e.g.
boot2docker) are not supported. boot2docker) are not supported.
`Docker for Windows`_ may work but has not been tested and is *not supported*. `Docker for Windows`_ may work but has not been tested and is *not supported*.
Docker Sync Docker Sync (Deprecated)
~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
Docker for Mac has known filesystem issues that significantly decrease Our use of Docker Sync is now deprecated since Docker for Mac 17.04 introduced
performance. In order to mitigate these issues, we use `Docker Sync`_ to `performance improvements for volume mounts`_.
synchronize file data from the host machine to the containers.
If you are using macOS, please follow the `Docker Sync installation Docker for Mac had known filesystem issues that significantly decreased
instructions`_ before provisioning. performance, and we were previously using `Docker Sync`_ to solve this issue.
Getting Started Getting Started
--------------- ---------------
...@@ -65,31 +66,28 @@ a minimum of 2 CPUs and 4GB of memory works well. ...@@ -65,31 +66,28 @@ a minimum of 2 CPUs and 4GB of memory works well.
the services directly via Django admin at the ``/admin/`` path, or login via the services directly via Django admin at the ``/admin/`` path, or login via
single sign-on at ``/login/``. single sign-on at ``/login/``.
Provision using docker-sync (recommended for macOS users) Default
.. code:: sh
make dev.sync.provision
Default (non-macOS users)
.. code:: sh .. code:: sh
make dev.provision make dev.provision
For macOS users, we will no longer be supporting docker-sync. Ensure you
have a new enough version of Docker for Mac as detailed in `Prerequisites`_.
3. Start the services. This command will mount the repositories under the 3. Start the services. This command will mount the repositories under the
DEVSTACK\_WORKSPACE directory. DEVSTACK\_WORKSPACE directory.
*Note: it may take up to 60 seconds for the LMS to start* *Note: it may take up to 60 seconds for the LMS to start*
Start using docker-sync (recommended for macOS users) Start using docker-sync (Deprecated for macOS users. See `Prerequisites`_.)
.. code:: sh .. code:: sh
make dev.sync.up make dev.sync.up
Default (non-macOS users) Default
.. code:: sh .. code:: sh
...@@ -200,6 +198,8 @@ https://openedx.atlassian.net/wiki/display/OpenDev/Marketing+Site. ...@@ -200,6 +198,8 @@ https://openedx.atlassian.net/wiki/display/OpenDev/Marketing+Site.
How do I build images? How do I build images?
---------------------- ----------------------
**Note:** Building images requires a `feature added in Docker 17.05`_.
We are still working on automated image builds, but generally try to push new We are still working on automated image builds, but generally try to push new
images every 3-7 days. If you want to build the images on your own, the images every 3-7 days. If you want to build the images on your own, the
Dockerfiles are available in the ``edx/configuration`` repo. Dockerfiles are available in the ``edx/configuration`` repo.
...@@ -357,8 +357,9 @@ Or, you can run the following commands to clean up dangling images and volumes: ...@@ -357,8 +357,9 @@ Or, you can run the following commands to clean up dangling images and volumes:
.. _Docker for Mac: https://docs.docker.com/docker-for-mac/ .. _Docker for Mac: https://docs.docker.com/docker-for-mac/
.. _Docker for Windows: https://docs.docker.com/docker-for-windows/ .. _Docker for Windows: https://docs.docker.com/docker-for-windows/
.. _Docker Sync: https://github.com/EugenMayer/docker-sync/wiki .. _Docker Sync: https://github.com/EugenMayer/docker-sync/wiki
.. _Docker Sync installation instructions: https://github.com/EugenMayer/docker-sync/wiki/1.-Installation
.. _configuring Docker for Mac: https://docs.docker.com/docker-for-mac/#/advanced .. _configuring Docker for Mac: https://docs.docker.com/docker-for-mac/#/advanced
.. _feature added in Docker 17.05: https://github.com/edx/configuration/pull/3864
.. _performance improvements for volume mounts: https://docs.docker.com/docker-for-mac/osxfs-caching/
.. _Pycharm Integration documentation: docs/pycharm_integration.rst .. _Pycharm Integration documentation: docs/pycharm_integration.rst
.. |Build Status| image:: https://travis-ci.org/edx/devstack.svg?branch=master .. |Build Status| image:: https://travis-ci.org/edx/devstack.svg?branch=master
:target: https://travis-ci.org/edx/devstack :target: https://travis-ci.org/edx/devstack
...@@ -35,7 +35,7 @@ use the following options: ...@@ -35,7 +35,7 @@ use the following options:
- Configuration files(s) - Configuration files(s)
- Docker Sync (Mac) - Docker Sync (Deprecated for macOS users. See the `README`_.)
- ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml) - ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml)
- ``/LOCAL/PATH/TO/devstack/docker-compose-sync.yml`` - ``/LOCAL/PATH/TO/devstack/docker-compose-sync.yml``
...@@ -68,17 +68,15 @@ use the following options: ...@@ -68,17 +68,15 @@ use the following options:
- PyCharm helpers path: Keep the default. - PyCharm helpers path: Keep the default.
**Important** Docker sync is deprecated. See the `README`_. If you are still
**Important** If you are running with Docker Sync you will also need to first running with Docker Sync you will also need to first run ``docker-sync start``
run ``docker-sync start`` to run sync in the background before running any servers. to run sync in the background before running any servers.
**Note**: For lms and studio (edx-platform), it will take a long time to **Note**: For lms and studio (edx-platform), it will take a long time to
update skeletons (10 or more minutes). If you want to try a different update skeletons (10 or more minutes). If you want to try a different
set of configuration (compose) files, we recommend you create a new one set of configuration (compose) files, we recommend you create a new one
so you can easily switch back to old without this delay. so you can easily switch back to old without this delay.
**Warning**: When you change configuration files, the service dropdown gets **Warning**: When you change configuration files, the service dropdown gets
reset. Remember to restore to the IDA you wish to test. reset. Remember to restore to the IDA you wish to test.
...@@ -163,7 +161,8 @@ Currently not supported for PyCharm Development ...@@ -163,7 +161,8 @@ Currently not supported for PyCharm Development
- Debugging for JavaScript - Debugging for JavaScript
- Cython for fasterdebug - Cython for fasterdebug
.. _Django Server Run/Debug Configuration: https://www.jetbrains.com/help/pycharm/2017.1/run-debug-configuration-django-server.html
.. _PyCharm: https://www.jetbrains.com/pycharm/ .. _PyCharm: https://www.jetbrains.com/pycharm/
.. _PyCharm IDE setup: https://openedx.atlassian.net/wiki/display/ENG/PyCharm .. _PyCharm IDE setup: https://openedx.atlassian.net/wiki/display/ENG/PyCharm
.. _README: ../README.rst
.. _vendor documentation: https://www.jetbrains.com/help/pycharm/2017.1/configuring-remote-interpreters-via-docker-compose.html .. _vendor documentation: https://www.jetbrains.com/help/pycharm/2017.1/configuring-remote-interpreters-via-docker-compose.html
.. _Django Server Run/Debug Configuration: https://www.jetbrains.com/help/pycharm/2017.1/run-debug-configuration-django-server.html
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment