b24cb48eb0
* Add and push Dockerfile; add decentralized devstack settings Co-Authored-By: Diana Huang <dkh@edx.org> Co-Authored-By: Kyle McCormick <kmccormick@edx.org> * Remove Python requirements hack Remove the attempted optimization to the installation of Python package dependencies. The dependencies in edx-platform change about three times per day, so this was of dubious value. And because npm is run through nodeenv, which is a Python package, the Python dependencies installation has to happen first. * ARCHBOM-1439: Changing workdir to /edx/app/edxapp/edx-platform (#24835) Context: The Dockerfile tries to stay in sych with legacy stuff. In the ansible we configure the directory structure such that things relating to the app but not in the codebase, such as the env file wind up in /edx/app/edxapp/. And the codebase winds up in /edx/app/edxapp/edx-platform. I think due to accident, the dockerfile does /edx/app/edx-platform/edx-platform instead of /edx/app/edxapp/edx-platform. This commit tries to have Dockerfile more reflect what is currently happening in production * Update ports for decentralized devstack ARCHBOM-1447 (#24841) Switch from the LMS ports we've historically used for NGINX to those used for gunicorn, and fix the Studio ports to match the ones we've historically used for its gunicorn service. Also removed some leftover bits of the requirements hack. Co-authored-by: Adam Blackwell <ablackwell@edx.org> Co-authored-by: Diana Huang <dkh@edx.org> Co-authored-by: jinder1s <msingh@edx.org> Co-authored-by: Jeremy Bowman <jbowman@edx.org> Co-authored-by: Manjinder Singh <49171515+jinder1s@users.noreply.github.com>
130 lines
5.3 KiB
Makefile
130 lines
5.3 KiB
Makefile
# Do things in edx-platform
|
|
.PHONY: clean extract_translations help pull pull_translations push_translations requirements shell upgrade
|
|
.PHONY: api-docs docs guides swagger
|
|
|
|
# Careful with mktemp syntax: it has to work on Mac and Ubuntu, which have differences.
|
|
PRIVATE_FILES := $(shell mktemp -u /tmp/private_files.XXXXXX)
|
|
|
|
help: ## display this help message
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | sort | awk -F ':.*?## ' 'NF==2 {printf "\033[36m %-25s\033[0m %s\n", $$1, $$2}'
|
|
|
|
clean: ## archive and delete most git-ignored files
|
|
# Remove all the git-ignored stuff, but save and restore things marked
|
|
# by start-noclean/end-noclean. Include Makefile in the tarball so that
|
|
# there's always at least one file even if there are no private files.
|
|
sed -n -e '/start-noclean/,/end-noclean/p' < .gitignore > /tmp/private-files
|
|
-tar cf $(PRIVATE_FILES) Makefile `git ls-files --exclude-from=/tmp/private-files --ignored --others`
|
|
-git clean -fdX
|
|
tar xf $(PRIVATE_FILES)
|
|
rm $(PRIVATE_FILES)
|
|
|
|
SWAGGER = docs/swagger.yaml
|
|
|
|
docs: api-docs guides feature-toggles-docs ## build all the developer documentation for this repository
|
|
|
|
swagger: ## generate the swagger.yaml file
|
|
DJANGO_SETTINGS_MODULE=docs.docs_settings python manage.py lms generate_swagger --generator-class=edx_api_doc_tools.ApiSchemaGenerator -o $(SWAGGER)
|
|
|
|
api-docs-sphinx: swagger ## generate the sphinx source files for api-docs
|
|
rm -f docs/api/gen/*
|
|
python docs/sw2sphinxopenapi.py $(SWAGGER) docs/api/gen
|
|
|
|
api-docs: api-docs-sphinx ## build the REST api docs
|
|
cd docs/api; make html
|
|
|
|
feature-toggles-docs:
|
|
$(MAKE) -C docs/featuretoggles html
|
|
|
|
guides: ## build the developer guide docs
|
|
cd docs/guides; make clean html
|
|
|
|
extract_translations: ## extract localizable strings from sources
|
|
i18n_tool extract -v
|
|
|
|
push_translations: ## push source strings to Transifex for translation
|
|
i18n_tool transifex push
|
|
|
|
pull_translations: ## pull translations from Transifex
|
|
git clean -fdX conf/locale
|
|
i18n_tool transifex pull
|
|
i18n_tool extract
|
|
i18n_tool dummy
|
|
i18n_tool generate
|
|
git clean -fdX conf/locale/rtl
|
|
git clean -fdX conf/locale/eo
|
|
i18n_tool validate
|
|
paver i18n_compilejs
|
|
|
|
|
|
detect_changed_source_translations: ## check if translation files are up-to-date
|
|
i18n_tool changed
|
|
|
|
pull: ## update the Docker image used by "make shell"
|
|
docker pull edxops/edxapp:latest
|
|
|
|
requirements: ## install development environment requirements
|
|
pip install -qr requirements/edx/pip-tools.txt
|
|
pip-sync -q requirements/edx/development.txt requirements/edx/private.*
|
|
|
|
shell: ## launch a bash shell in a Docker container with all edx-platform dependencies installed
|
|
docker run -it -e "NO_PYTHON_UNINSTALL=1" -e "PIP_INDEX_URL=https://pypi.python.org/simple" -e TERM \
|
|
-v `pwd`:/edx/app/edxapp/edx-platform:cached \
|
|
-v edxapp_lms_assets:/edx/var/edxapp/staticfiles/ \
|
|
-v edxapp_node_modules:/edx/app/edxapp/edx-platform/node_modules \
|
|
edxops/edxapp:latest /edx/app/edxapp/devstack.sh open
|
|
|
|
# Order is very important in this list: files must appear after everything they include!
|
|
REQ_FILES = \
|
|
requirements/edx/pip-tools \
|
|
requirements/edx/coverage \
|
|
requirements/edx/doc \
|
|
requirements/edx/paver \
|
|
requirements/edx-sandbox/shared \
|
|
requirements/edx-sandbox/py35 \
|
|
requirements/edx/base \
|
|
requirements/edx/testing \
|
|
requirements/edx/development \
|
|
scripts/xblock/requirements
|
|
|
|
upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
|
|
upgrade: ## update the pip requirements files to use the latest releases satisfying our constraints
|
|
pip install -qr requirements/edx/pip-tools.txt
|
|
@ export REBUILD='--rebuild'; \
|
|
for f in $(REQ_FILES); do \
|
|
echo ; \
|
|
echo "== $$f ===============================" ; \
|
|
echo "pip-compile -v --no-emit-trusted-host --no-index $$REBUILD --upgrade -o $$f.txt $$f.in"; \
|
|
pip-compile -v --no-emit-trusted-host --no-index $$REBUILD --upgrade -o $$f.txt $$f.in || exit 1; \
|
|
export REBUILD=''; \
|
|
done
|
|
# Post process all of the files generated above to work around open pip-tools issues
|
|
scripts/post-pip-compile.sh $(REQ_FILES:=.txt)
|
|
# Let tox control the Django version for tests
|
|
grep -e "^django==" requirements/edx/base.txt > requirements/edx/django.txt
|
|
sed '/^[dD]jango==/d' requirements/edx/testing.txt > requirements/edx/testing.tmp
|
|
mv requirements/edx/testing.tmp requirements/edx/testing.txt
|
|
|
|
# These make targets currently only build LMS images.
|
|
docker_build:
|
|
docker build . -f Dockerfile --target lms -t openedx/edx-platform
|
|
docker build . -f Dockerfile --target lms-newrelic -t openedx/edx-platform:latest-newrelic
|
|
docker build . -f Dockerfile --target lms-devstack -t openedx/edx-platform:latest-devstack
|
|
|
|
docker_tag: docker_build
|
|
docker tag openedx/edx-platform openedx/edx-platform:${GITHUB_SHA}
|
|
docker tag openedx/edx-platform:latest-newrelic openedx/edx-platform:${GITHUB_SHA}-newrelic
|
|
docker tag openedx/edx-platform:latest-devstack openedx/edx-platform:${GITHUB_SHA}-devstack
|
|
|
|
docker_auth:
|
|
echo "$$DOCKERHUB_PASSWORD" | docker login -u "$$DOCKERHUB_USERNAME" --password-stdin
|
|
|
|
docker_push: docker_tag docker_auth ## push to docker hub
|
|
docker push 'openedx/edx-platform:latest'
|
|
docker push "openedx/edx-platform:${GITHUB_SHA}"
|
|
docker push 'openedx/edx-platform:latest-newrelic'
|
|
docker push "openedx/edx-platform:${GITHUB_SHA}-newrelic"
|
|
docker push 'openedx/edx-platform:latest-devstack'
|
|
docker push "openedx/edx-platform:${GITHUB_SHA}-devstack"
|
|
|