christianlight
/
tutor
mirror of https://github.com/ChristianLight/tutor.git
7
0
Fork 0
Code Issues Releases Activity

Improve make commands documentation

This commit is contained in:
Régis Behmo 2019-01-07 08:10:30 +01:00
parent 752322e396
commit 3433a7c046
5 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -7,7 +7,7 @@ USERID ?= $$(id -u)
build: ## Build all docker images
cd build/ && make build
config.json:
config.json: ## Generate config.json configuration file interactively
@$(MAKE) -s upgrade-to-tutor
@$(MAKE) -s -C build/ build-configurator 1> /dev/null
@docker run --rm -it \

2
deploy/Makefile
View File

@ -1,5 +1,5 @@
.PHONY: env
PWD = $$(pwd)
env: ## Create the platform environment
env: ## Generate the environment from templates and configuration values
@$(MAKE) -s -C .. substitute TEMPLATES=$(PWD)/templates OUTPUT=$(PWD)/env

16
deploy/k8s/Makefile
View File

@ -6,11 +6,11 @@ podexec = kubectl exec -n openedx -it $$($(call podname,$(1))) -- $(2)
all: configure deploy databases ## Provision a full platform from scratch
configure:
configure: ## Interactive configuration
@$(MAKE) -s -C ../.. --always-make config.json
@$(MAKE) -s env
env:
env: ## Generate the environment from templates and configuration values
@$(MAKE) -s -C .. env
@$(MAKE) -s -C ../.. substitute TEMPLATES=$(PWD)/templates OUTPUT=$(PWD)/env
@ -96,8 +96,14 @@ create-staff-user: ## Create a user with admin rights: make create-staff-user US
##################### Various minikube command
minikube-open:
minikube service nginx --namespace=openedx
minikube-start: ## Start minikube
minikube start
minikube-stop: ## Stop minikube
minikube stop
minikube-dashboard: ## Open the minikube dashboard
minikube dashboard
minikube-ingress: ## Enable the ingress addon
minikube addons enable ingress
##################### Various k8s commands
@ -114,6 +120,6 @@ k8s-admin-token: ## Print the admin token required to log in the dashboard
ESCAPE = 
help: ## Print this help
@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \
@grep -E '^([a-zA-Z0-9_-]+:.*?## .*|######* .+)$$' Makefile \
| sed 's/######* \(.*\)/\n $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' \
| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'

4
deploy/local/Makefile
View File

@ -46,11 +46,11 @@ update: ## Download most recent images
##################### Configuration
configure:
configure: ## Interactive configuration
@$(MAKE) -s -C ../.. --always-make config.json
@$(MAKE) -s env
env:
env: ## Generate the environment from templates and configuration values
@$(MAKE) -s -C .. env
@$(MAKE) -s -C ../.. substitute TEMPLATES=$(PWD)/templates OUTPUT=$(PWD)

2
docs/k8s.rst
View File

@ -23,7 +23,7 @@ In the following, we assume you have a working Kubernetes platform. For a start,
Start Minikube::
minikube start
make minikube-start
When minikube starts, it spawns a virtual machine (VM) which you can configure in your VM manager: on most platforms, this is Virtualbox. You should configure your VM to have at least 4Gb RAM; otherwise, database migrations will crash halfway, and that's a nasty issue...