From a81593f6a895699bb7321f3cfd993df078f525dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Wed, 26 Dec 2018 18:20:53 +0100 Subject: [PATCH] Rename "singleserver" with "local" deployment --- Makefile | 8 ++++---- README.rst | 2 +- deploy/{singleserver => local}/.gitignore | 0 deploy/{singleserver => local}/Makefile | 0 deploy/{singleserver => local}/scripts.yml | 0 .../{singleserver => local}/templates/Makefile.env | 0 .../templates/docker-compose.yml | 0 docs/customise.rst | 2 +- docs/index.rst | 3 ++- docs/{step.rst => local.rst} | 14 +++++++++----- docs/quickstart.rst | 2 +- 11 files changed, 18 insertions(+), 13 deletions(-) rename deploy/{singleserver => local}/.gitignore (100%) rename deploy/{singleserver => local}/Makefile (100%) rename deploy/{singleserver => local}/scripts.yml (100%) rename deploy/{singleserver => local}/templates/Makefile.env (100%) rename deploy/{singleserver => local}/templates/docker-compose.yml (100%) rename docs/{step.rst => local.rst} (88%) diff --git a/Makefile b/Makefile index 72c8101..db99aa0 100644 --- a/Makefile +++ b/Makefile @@ -23,18 +23,18 @@ substitute: config.json regis/openedx-configurator:hawthorn \ configurator substitute /openedx/templates/ /openedx/output/ -singleserver: upgrade-to-tutor ## Configure and run a ready-to-go Open edX platform - $(MAKE) -C deploy/singleserver all +local: upgrade-to-tutor ## Configure and run a ready-to-go Open edX platform + $(MAKE) -C deploy/local all stop: ## Stop all single server services - $(MAKE) -C deploy/singleserver stop + $(MAKE) -C deploy/local stop android: upgrade-to-tutor ## Configure and build a development Android app cd android/ && make all travis: upgrade-to-tutor cd build && make build - cd deploy/singleserver \ + cd deploy/local \ && make configure SILENT=1 CONFIGURE_OPTS="-e SETTING_ACTIVATE_NOTES=1 -e SETTING_ACTIVATE_XQUEUE=1" \ && make databases \ && make assets diff --git a/README.rst b/README.rst index 68256aa..fc69a1b 100644 --- a/README.rst +++ b/README.rst @@ -26,7 +26,7 @@ Quickstart git clone https://github.com/regisb/openedx-docker cd openedx-docker/ - make singleserver + make local Documentation ------------- diff --git a/deploy/singleserver/.gitignore b/deploy/local/.gitignore similarity index 100% rename from deploy/singleserver/.gitignore rename to deploy/local/.gitignore diff --git a/deploy/singleserver/Makefile b/deploy/local/Makefile similarity index 100% rename from deploy/singleserver/Makefile rename to deploy/local/Makefile diff --git a/deploy/singleserver/scripts.yml b/deploy/local/scripts.yml similarity index 100% rename from deploy/singleserver/scripts.yml rename to deploy/local/scripts.yml diff --git a/deploy/singleserver/templates/Makefile.env b/deploy/local/templates/Makefile.env similarity index 100% rename from deploy/singleserver/templates/Makefile.env rename to deploy/local/templates/Makefile.env diff --git a/deploy/singleserver/templates/docker-compose.yml b/deploy/local/templates/docker-compose.yml similarity index 100% rename from deploy/singleserver/templates/docker-compose.yml rename to deploy/local/templates/docker-compose.yml diff --git a/docs/customise.rst b/docs/customise.rst index 559baf7..b2bf0a3 100644 --- a/docs/customise.rst +++ b/docs/customise.rst @@ -79,7 +79,7 @@ Note that your release must be a fork of Hawthorn in order to work. Otherwise, y Running a different ``openedx`` Docker image -------------------------------------------- -By default, Tutor runs the `regis/openedx `_ docker image from Docker Hub. If you have an account on `hub.docker.com `_ or you have a private image registry, you can build your image and push it to your registry. Then add the following content to the ``deploy/singleserver/.env`` file:: +By default, Tutor runs the `regis/openedx `_ docker image from Docker Hub. If you have an account on `hub.docker.com `_ or you have a private image registry, you can build your image and push it to your registry. Then add the following content to the ``deploy/local/.env`` file:: OPENEDX_DOCKER_IMAGE=myusername/myimage:mytag diff --git a/docs/index.rst b/docs/index.rst index 8b57f3c..6d9dcb6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,7 +37,8 @@ For more advanced usage of Tutor, please refer to the following sections. quickstart requirements - step + local + k8s options customise dev diff --git a/docs/step.rst b/docs/local.rst similarity index 88% rename from docs/step.rst rename to docs/local.rst index 1eca28d..1d3e5af 100644 --- a/docs/step.rst +++ b/docs/local.rst @@ -1,11 +1,15 @@ -Step-by-step install -==================== +.. _local: -The following commands should be run inside the ``deploy/singlerver`` folder:: +Local deployment +================ - cd deploy/singleserver +This method is for deploying Open edX locally on a single server. Docker images are orchestrated with `docker-compose `_. -You can use these individual commands instead of running the full installation with ``make all``. +The following commands should be run inside the ``deploy/local`` folder:: + + cd deploy/local + +You can use these commands individually instead of running the full installation with ``make all``. Configure --------- diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 96b02eb..90f0d68 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -7,7 +7,7 @@ Quickstart git clone https://github.com/regisb/openedx-docker cd openedx-docker/ - make singleserver + make local **That's it?**