christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-05 04:48:00 +00:00
Code Issues Releases Activity
b0f2adb931
tutor/Makefile

181 lines
6.8 KiB
Makefile
Raw Normal View History

Rename up & daemon make commands The new commands are "run" and "daemonize". Older commands are preserved, although they are undocumented.
2018-09-15 10:20:35 +00:00
.PHONY: all android configure build update migrate assets run daemonize
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
Get PWD to work with "sudo" The PWD environment variable is not available in the Makefile when a "make" command is run with "sudo". Close #50 Close #60
2018-09-04 10:13:18 +00:00
PWD ?= $$(pwd)
USER_ID -> USERID for coherence
2018-04-30 07:01:40 +00:00
USERID ?= $$(id -u)
Download, don't build Images are no longer built locally, Instead, they are downloaded from docker hub. This completely changes config file organisation. In particular, we no longer copy configuration files to the original docker image.
2018-05-16 17:02:44 +00:00
EDX_PLATFORM_SETTINGS ?= universal.production
Make Xqueue an optional feature Xqueue is no longer run by default. Instead, add the ACTIVATE_XQUEUE environment variable to add it to the platform.
2018-08-19 12:40:38 +00:00
DOCKER_COMPOSE = docker-compose -f docker-compose.yml
post_configure_targets =
ifeq ($(ACTIVATE_HTTPS), 1)
post_configure_targets += https-certificate
endif
extra_migrate_targets =
ifeq ($(ACTIVATE_XQUEUE), 1)
extra_migrate_targets += migrate-xqueue
DOCKER_COMPOSE += -f docker-compose-xqueue.yml
endif
DOCKER_COMPOSE_RUN = $(DOCKER_COMPOSE) run --rm
:clown_face: Activate discussion forums
2018-05-27 11:30:23 +00:00
DOCKER_COMPOSE_RUN_OPENEDX = $(DOCKER_COMPOSE_RUN) -e USERID=$(USERID) -e SETTINGS=$(EDX_PLATFORM_SETTINGS)
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
ifneq ($(EDX_PLATFORM_PATH),)
:clown_face: Activate discussion forums
2018-05-27 11:30:23 +00:00
DOCKER_COMPOSE_RUN_OPENEDX += --volume="$(EDX_PLATFORM_PATH):/openedx/edx-platform"
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
endif
:clown_face: Activate discussion forums
2018-05-27 11:30:23 +00:00
DOCKER_COMPOSE_RUN_LMS = $(DOCKER_COMPOSE_RUN_OPENEDX) -p 8000:8000 lms
DOCKER_COMPOSE_RUN_CMS = $(DOCKER_COMPOSE_RUN_OPENEDX) -p 8001:8001 cms
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
Rename up & daemon make commands The new commands are "run" and "daemonize". Older commands are preserved, although they are undocumented.
2018-09-15 10:20:35 +00:00
all: configure $(post_configure_targets) update migrate assets daemonize
Document the LMS/CMS urls This closes issue #42.
2018-07-16 17:42:39 +00:00
@echo "All set \o/ You can access the LMS at http://localhost and the CMS at http://studio.localhost"
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
##################### Bootstrapping
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
Enable course search and discovery Also, improved openedx logging, so that logs are not emitted twice.
2018-09-15 09:55:42 +00:00
configure: build-configurator
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
docker run --rm -it --volume="$(PWD)/config:/openedx/config" \
Read default settings from environment variables Moreover, ACTIVATE_* variables are now made permanent. It is no longer necessary to re-declare them at each call of `make configure`.
2018-09-15 13:51:41 +00:00
-e USERID=$(USERID) -e SILENT=$(SILENT) -e SETTING_ACTIVATE_HTTPS=$(ACTIVATE_HTTPS) -e SETTING_ACTIVATE_XQUEUE=$(ACTIVATE_XQUEUE) \
Enable course search and discovery Also, improved openedx logging, so that logs are not emitted twice.
2018-09-15 09:55:42 +00:00
regis/openedx-configurator:hawthorn bash -c "./configure.py interactive && \
./configure.py substitute ./config/openedx/templates/lms.env.json.templ ./config/openedx/lms.env.json && \
./configure.py substitute ./config/openedx/templates/cms.env.json.templ ./config/openedx/cms.env.json && \
./configure.py substitute ./config/openedx/templates/lms.auth.json.templ ./config/openedx/lms.auth.json && \
./configure.py substitute ./config/openedx/templates/cms.auth.json.templ ./config/openedx/cms.auth.json && \
./configure.py substitute ./config/openedx/templates/provision.sh.templ ./config/openedx/provision.sh && \
./configure.py substitute ./config/mysql/templates/auth.env.templ ./config/mysql/auth.env && \
./configure.py substitute ./config/nginx/templates/lms.conf.templ ./config/nginx/lms.conf && \
./configure.py substitute ./config/nginx/templates/cms.conf.templ ./config/nginx/cms.conf && \
./configure.py substitute ./config/android/templates/universal.yaml.templ ./config/android/universal.yaml && \
./configure.py substitute ./config/letsencrypt/templates/certonly.sh.templ ./config/letsencrypt/certonly.sh && \
./configure.py substitute ./config/xqueue/templates/universal.py.templ ./config/xqueue/universal.py"
update:
Make Xqueue an optional feature Xqueue is no longer run by default. Instead, add the ACTIVATE_XQUEUE environment variable to add it to the platform.
2018-08-19 12:40:38 +00:00
$(DOCKER_COMPOSE) pull
Make sure configurator is pushed on 'make push' Close #61.
2018-09-06 05:35:26 +00:00
Add xqueue services Xqueue containers consist of two services: a gunicorn service, that receives requests from LMS/CMS, and a worker service. I guess the worker service receives orders from the gunicorn service, through rabbitmq. (but I'm less than certain about that). While adding xqueue containers, we refactored the way mysql databases are created, and how the root password is loaded. Also, we silenced some options from the configure script.
2018-06-02 01:29:53 +00:00
provision:
Give mysql more time On Travis CI, provisioning may fail if mysql hass less than 10s to bootstrap.
2018-06-08 23:18:17 +00:00
$(DOCKER_COMPOSE_RUN) lms bash -c "dockerize -wait tcp://mysql:3306 -timeout 20s && bash /openedx/config/provision.sh"
Add xqueue services Xqueue containers consist of two services: a gunicorn service, that receives requests from LMS/CMS, and a worker service. I guess the worker service receives orders from the gunicorn service, through rabbitmq. (but I'm less than certain about that). While adding xqueue containers, we refactored the way mysql databases are created, and how the root password is loaded. Also, we silenced some options from the configure script.
2018-06-02 01:29:53 +00:00
Make Xqueue an optional feature Xqueue is no longer run by default. Instead, add the ACTIVATE_XQUEUE environment variable to add it to the platform.
2018-08-19 12:40:38 +00:00
migrate: provision migrate-openedx migrate-forum $(extra_migrate_targets)
Add xqueue services Xqueue containers consist of two services: a gunicorn service, that receives requests from LMS/CMS, and a worker service. I guess the worker service receives orders from the gunicorn service, through rabbitmq. (but I'm less than certain about that). While adding xqueue containers, we refactored the way mysql databases are created, and how the root password is loaded. Also, we silenced some options from the configure script.
2018-06-02 01:29:53 +00:00
migrate-openedx:
Enable course search and discovery Also, improved openedx logging, so that logs are not emitted twice.
2018-09-15 09:55:42 +00:00
$(DOCKER_COMPOSE_RUN) lms bash -c "dockerize -wait tcp://mysql:3306 -timeout 20s && ./manage.py lms migrate"
$(DOCKER_COMPOSE_RUN) cms bash -c "dockerize -wait tcp://mysql:3306 -timeout 20s && ./manage.py cms migrate"
$(MAKE) reindex-courses
:clown_face: Activate discussion forums
2018-05-27 11:30:23 +00:00
migrate-forum:
$(DOCKER_COMPOSE_RUN) forum bash -c "bundle exec rake search:initialize && \
bundle exec rake search:rebuild_index"
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
Add xqueue services Xqueue containers consist of two services: a gunicorn service, that receives requests from LMS/CMS, and a worker service. I guess the worker service receives orders from the gunicorn service, through rabbitmq. (but I'm less than certain about that). While adding xqueue containers, we refactored the way mysql databases are created, and how the root password is loaded. Also, we silenced some options from the configure script.
2018-06-02 01:29:53 +00:00
migrate-xqueue:
Enable course search and discovery Also, improved openedx logging, so that logs are not emitted twice.
2018-09-15 09:55:42 +00:00
$(DOCKER_COMPOSE_RUN) xqueue ./manage.py migrate
reindex-courses:
$(DOCKER_COMPOSE_RUN) cms ./manage.py cms reindex_course --all --setup
Add xqueue services Xqueue containers consist of two services: a gunicorn service, that receives requests from LMS/CMS, and a worker service. I guess the worker service receives orders from the gunicorn service, through rabbitmq. (but I'm less than certain about that). While adding xqueue containers, we refactored the way mysql databases are created, and how the root password is loaded. Also, we silenced some options from the configure script.
2018-06-02 01:29:53 +00:00
Split make assets command in two
2018-09-15 13:13:37 +00:00
assets: assets-lms assets-cms
assets-lms:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
$(DOCKER_COMPOSE_RUN_OPENEDX) -e NO_PREREQ_INSTALL=True lms paver update_assets lms --settings=$(EDX_PLATFORM_SETTINGS)
Split make assets command in two
2018-09-15 13:13:37 +00:00
assets-cms:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
$(DOCKER_COMPOSE_RUN_OPENEDX) -e NO_PREREQ_INSTALL=True cms paver update_assets cms --settings=$(EDX_PLATFORM_SETTINGS)
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
##################### Running
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
Rename up & daemon make commands The new commands are "run" and "daemonize". Older commands are preserved, although they are undocumented.
2018-09-15 10:20:35 +00:00
run:
Make Xqueue an optional feature Xqueue is no longer run by default. Instead, add the ACTIVATE_XQUEUE environment variable to add it to the platform.
2018-08-19 12:40:38 +00:00
$(DOCKER_COMPOSE) up
Rename up & daemon make commands The new commands are "run" and "daemonize". Older commands are preserved, although they are undocumented.
2018-09-15 10:20:35 +00:00
up: run
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
Rename up & daemon make commands The new commands are "run" and "daemonize". Older commands are preserved, although they are undocumented.
2018-09-15 10:20:35 +00:00
daemonize:
Make Xqueue an optional feature Xqueue is no longer run by default. Instead, add the ACTIVATE_XQUEUE environment variable to add it to the platform.
2018-08-19 12:40:38 +00:00
$(DOCKER_COMPOSE) up -d && \
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
echo "Daemon is up and running"
Rename up & daemon make commands The new commands are "run" and "daemonize". Older commands are preserved, although they are undocumented.
2018-09-15 10:20:35 +00:00
daemon: daemonize
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
stop:
Make Xqueue an optional feature Xqueue is no longer run by default. Instead, add the ACTIVATE_XQUEUE environment variable to add it to the platform.
2018-08-19 12:40:38 +00:00
$(DOCKER_COMPOSE) rm --stop --force
Working stack: still some bugs to fix
2017-12-26 00:16:35 +00:00
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
##################### Extra
Improve docs regarding opening issues
2018-06-18 12:58:34 +00:00
info:
Add convenient `make debug` command This command will certainly be used for github issue templating.
2018-06-18 12:20:08 +00:00
uname -a
@echo "-------------------------"
Print out git version in "make info"
2018-09-03 05:53:34 +00:00
git rev-parse HEAD
@echo "-------------------------"
Add convenient `make debug` command This command will certainly be used for github issue templating.
2018-06-18 12:20:08 +00:00
docker version
@echo "-------------------------"
docker-compose --version
@echo "-------------------------"
echo $$EDX_PLATFORM_PATH
echo $$EDX_PLATFORM_SETTINGS
Add import-demo-course make command
2017-09-19 08:54:45 +00:00
import-demo-course:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
$(DOCKER_COMPOSE_RUN_OPENEDX) cms /bin/bash -c "git clone https://github.com/edx/edx-demo-course ../edx-demo-course && git -C ../edx-demo-course checkout open-release/hawthorn.beta1 && python ./manage.py cms import ../data ../edx-demo-course"
Create staff user, fix studio nginx static assets
2018-01-29 16:18:37 +00:00
create-staff-user:
:clown_face: Activate discussion forums
2018-05-27 11:30:23 +00:00
$(DOCKER_COMPOSE_RUN_OPENEDX) lms /bin/bash -c "./manage.py lms manage_user --superuser --staff ${USERNAME} ${EMAIL} && ./manage.py lms changepassword ${USERNAME}"
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
Add HTTPS support HTTPS is now fully supported. The ACTIVATE_HTTPS feature flag needs to be set. Required domain names are LMS_HOST, preview.LMS_HOST and CMS_HOST. Close #46.
2018-08-16 13:59:31 +00:00
##################### HTTPS
https_command = docker run --rm -it \
--volume="$(PWD)/config/letsencrypt/:/openedx/letsencrypt/config/" \
--volume="$(PWD)/data/letsencrypt/:/etc/letsencrypt/" \
Fix "pull access denied for certbot_image" Close #52
2018-08-28 13:53:26 +00:00
-p "80:80"
Add HTTPS support HTTPS is now fully supported. The ACTIVATE_HTTPS feature flag needs to be set. Required domain names are LMS_HOST, preview.LMS_HOST and CMS_HOST. Close #46.
2018-08-16 13:59:31 +00:00
certbot_image = certbot/certbot:latest
https-certificate:
$(https_command) --entrypoint "/openedx/letsencrypt/config/certonly.sh" $(certbot_image)
https-certificate-renew:
$(https_command) $(certbot_image) renew
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
##################### Development
lms:
$(DOCKER_COMPOSE_RUN_LMS) bash
cms:
$(DOCKER_COMPOSE_RUN_CMS) bash
lms-shell:
:clown_face: Activate discussion forums
2018-05-27 11:30:23 +00:00
$(DOCKER_COMPOSE_RUN_OPENEDX) lms ./manage.py lms shell
Working devstack This allows the user to run their own devstack inside the containers. Yay! Also, we handle file permissions cleanly: in docker-entrypoint.sh we chmod the data and edx-platform files to the same UID of the user on the host machine. No more permission headaches!
2018-04-09 17:16:58 +00:00
cms-shell:
:clown_face: Activate discussion forums
2018-05-27 11:30:23 +00:00
$(DOCKER_COMPOSE_RUN_OPENEDX) cms ./manage.py cms shell
Download, don't build Images are no longer built locally, Instead, they are downloaded from docker hub. This completely changes config file organisation. In particular, we no longer copy configuration files to the original docker image.
2018-05-16 17:02:44 +00:00
:robot: 1-click android app building TODO: README
2018-05-27 19:29:14 +00:00
#################### Android app
android:
docker-compose -f docker-compose-android.yml run --rm android
@echo "Your APK file is ready: ./data/android/edx-prod-debuggable-2.14.0.apk"
android-release:
# Note that this requires that you edit ./config/android/gradle.properties
docker-compose -f docker-compose-android.yml run --rm android ./gradlew assembleProdRelease
android-build:
docker build -t regis/openedx-android:latest android/
android-push:
docker push regis/openedx-android:latest
android-dockerhub: android-build android-push
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
#################### Build images
Make Xqueue an optional feature Xqueue is no longer run by default. Instead, add the ACTIVATE_XQUEUE environment variable to add it to the platform.
2018-08-19 12:40:38 +00:00
build: build-openedx build-configurator build-forum build-xqueue
:robot: 1-click android app building TODO: README
2018-05-27 19:29:14 +00:00
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
build-openedx:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
docker build -t regis/openedx:latest -t regis/openedx:hawthorn openedx/
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
build-configurator:
docker build -t regis/openedx-configurator:latest -t regis/openedx-configurator:hawthorn configurator/
build-forum:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
docker build -t regis/openedx-forum:latest -t regis/openedx-forum:hawthorn forum/
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
build-xqueue:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
docker build -t regis/openedx-xqueue:latest -t regis/openedx-xqueue:hawthorn xqueue/
Download, don't build Images are no longer built locally, Instead, they are downloaded from docker hub. This completely changes config file organisation. In particular, we no longer copy configuration files to the original docker image.
2018-05-16 17:02:44 +00:00
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
#################### Deploying to docker hub
Make sure configurator is pushed on 'make push' Close #61.
2018-09-06 05:35:26 +00:00
push: push-openedx push-forum push-xqueue push-configurator
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
push-openedx:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
docker push regis/openedx:hawthorn
Switch docker hub username
2018-05-16 17:35:18 +00:00
docker push regis/openedx:latest
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
push-configurator:
docker push regis/openedx-configurator:hawthorn
docker push regis/openedx-configurator:latest
push-forum:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
docker push regis/openedx-forum:hawthorn
:clown_face: Activate discussion forums
2018-05-27 11:30:23 +00:00
docker push regis/openedx-forum:latest
Migrate templating to jinja2 In the future, jinja2 templates will allow us to create more complex configuration templates.
2018-08-05 14:40:51 +00:00
push-xqueue:
hawthorn.1 release From a deployment perspective, this release comes with an upgrade of the cs_comments_service (forums) and a change to the logging configuration.
2018-04-21 10:41:04 +00:00
docker push regis/openedx-xqueue:hawthorn
Add xqueue services Xqueue containers consist of two services: a gunicorn service, that receives requests from LMS/CMS, and a worker service. I guess the worker service receives orders from the gunicorn service, through rabbitmq. (but I'm less than certain about that). While adding xqueue containers, we refactored the way mysql databases are created, and how the root password is loaded. Also, we silenced some options from the configure script.
2018-06-02 01:29:53 +00:00
docker push regis/openedx-xqueue:latest
Download, don't build Images are no longer built locally, Instead, they are downloaded from docker hub. This completely changes config file organisation. In particular, we no longer copy configuration files to the original docker image.
2018-05-16 17:02:44 +00:00
Build images with docker and not docker-compose Otherwise, for some reason, it is not the right image that is uploaded to dockerhub.
2018-05-24 13:56:27 +00:00
dockerhub: build push
Copy Permalink