6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-09-28 20:29:02 +00:00
tutor/docs
Régis Behmo 18ce1f2fe4 feat: persistent bind-mounts
This is an important change, where we get remove the previous `--mount`
option, and instead opt for persistent bind-mounts.

Persistent bind mounts have several advantages:
- They make it easier to remember which folders need to be bind-mounted.
- Code is *much* less clunky, as we no longer need to generate temporary
  docker-compose files.
- They allow us to bind-mount host directories *at build time* using the
  buildx `--build-context` option.
- The transition from development to production becomes much easier, as
  images will automatically be built using the host repo.

The only drawback is that persistent bind-mounts are slightly less
portable: when a config.yml file is moved to a different folder, many
things will break if the repo is not checked out in the same path.

For instance, this is how to start working on a local fork of
edx-platform:

    tutor config save --append MOUNTS=/path/to/edx-platform

And that's all there is to it. No, this fork will be used whenever we
run:

    tutor images build openedx
    tutor local start
    tutor dev start

This change is made possible by huge improvements in the build time
performance. These improvements make it convenient to re-build Docker
images often.

Related issues:
https://github.com/openedx/wg-developer-experience/issues/71
https://github.com/openedx/wg-developer-experience/issues/66
https://github.com/openedx/wg-developer-experience/issues/166
2023-06-14 21:08:49 +02:00
..
_ext feat: migrate to plugins.v1 with filters & actions 2022-04-15 15:30:54 +02:00
download docs: wrap tutor[full] in quotes for zsh compatibility 2022-04-15 09:20:21 +02:00
img feat: upgrade to olive 2022-12-12 16:55:07 +01:00
plugins docs: Update Google Analytics example to GA4 2023-05-26 16:04:04 +02:00
reference feat: simplify docker-compose permissions 2023-06-14 19:40:58 +02:00
tutorials feat: persistent bind-mounts 2023-06-14 21:08:49 +02:00
.gitignore Migrate openedx-docker project to Tutor 👩‍🏫 2018-12-26 19:27:08 +01:00
conf.py depr: halt compatibility with python 3.7 2023-06-14 19:40:58 +02:00
configuration.rst feat: config save --append/--remove KEY=VAL options 2023-06-14 19:40:58 +02:00
dev.rst feat: persistent bind-mounts 2023-06-14 21:08:49 +02:00
faq.rst feat: upgrade to Palm 2023-06-14 19:40:58 +02:00
gettingstarted.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
index.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
install.rst docs: fix nutmeg-related instructions 2023-04-12 10:36:18 +02:00
intro.rst feat: deprecate "quickstart" and rename to "launch" 2022-09-30 12:05:35 +02:00
k8s.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
local.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
Makefile feat: strongly typed hooks 2022-11-15 14:58:36 +01:00
quickstart.rst feat: upgrade to Palm 2023-06-14 19:40:58 +02:00
run.rst docs: build docs in CI (and be nitpicky about it) 2021-10-14 12:59:57 +02:00
testimonials.rst v10.0.0 Upgrade to Juniper (2020-06-15) 2020-06-15 10:19:07 +02:00
troubleshooting.rst docs: troubleshoot high memory usage (#810) 2023-03-10 11:20:21 +01:00
tutor.rst ci: simplify release process 2022-11-29 16:46:06 +01:00
whatnext.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00