make everware runnable as a container itself

Dockerfile

@@ -0,0 +1,12 @@
+FROM jupyterhub/jupyterhub:0.7.2
+RUN apt-get update && apt-get install make
+
+COPY . /srv/everware
+WORKDIR /srv/everware/
+RUN make install
+
+EXPOSE 8000
+EXPOSE 8081
+
+ENTRYPOINT ["/srv/everware/scripts/everware-server", "-f"]
+

Makefile

@@ -9,8 +9,6 @@
 SHELL := /bin/bash
 TEST_OPTIONS := -s tests -N 2
 TESTS := test_happy_mp
-LOG := everware.log
-PIDFILE := everware.pid
 IP = $(shell python -c 'from IPython.utils.localinterfaces import public_ips; print (public_ips()[0])' 2>/dev/null)
 OPTIONS = --debug --port 8000 --no-ssl --JupyterHub.hub_ip=${IP}
 UPLOADDIR ?= ~/upload_screens
@@ -27,14 +25,13 @@ else
 	$(error Unable to find python)
 endif
 
-EXECUTOR = everware-server
-
 ifeq ($(shell uname -s),Linux)
 	SPAWNER_IP = "127.0.0.1"
 else
 	SPAWNER_IP = "192.168.99.100"
 endif
 
+include run.makefile
 
 .PHONY: install reload clean run run-daemon stop test tail
 
@@ -56,36 +53,7 @@ install:  ## install everware
 
 	if [ ! -f env.sh ] ; then cp env.sh.orig env.sh ; fi
 
-reload:  ## reload everware whitelist
-	PID=`pgrep '${EXECUTOR}'` ;\
-		if [ -z "$${PID}" ] ; then echo "Cannot find running ${EXECUTOR}" ; exit 1 ; fi
-	pkill -1 '${EXECUTOR}'
-
-clean:  ## clean user base
-	if [ -f ${PIDFILE} ] ; then echo "${PIDFILE} exists, cannot continute" ; exit 1; fi
-	rm -f jupyterhub.sqlite
-
-run-linux: clean  ## run everware server on linux
-	source ./env.sh && \
-		${EXECUTOR} -f etc/local_config.py --no-ssl 2>&1 | tee ${LOG}
-
-run-dockermachine: clean  ## run everware server on MacOS
-	source ./env.sh && \
-		${EXECUTOR} -f etc/local_dockermachine_config.py --no-ssl 2>&1 | tee ${LOG}
-
-run-daemon: clean ## run everware in daemon mode, linux only, SSL required
-	[ -f ${LOG} ] && mv ${LOG} ${LOG}.`date +%Y%m%d-%s`
-	source ./env.sh && \
-		${EXECUTOR} -f etc/local_config.py --debug --no-ssl >> ${LOG}  2>&1 &
-	pgrep ${EXECUTOR} > ${PIDFILE} || ( tail ${LOG} && rm ${PIDFILE} && exit 1 )
-	echo "Started. Log saved to ${LOG}"
-
-stop:
-	-rm ${PIDFILE}
-	-pkill -9 ${EXECUTOR}
-	-pkill -9 node
-
-logs: ${LOG} ## watch log file
+ogs: ${LOG} ## watch log file
 	tail -f ${LOG}
 
 test: ## run all tests

README.md

@@ -71,6 +71,8 @@ In order to deploy your own `everware` instance, you have to:
     everware-server -f etc/local_config.py --debug --no-ssl
 ```
 
+Everware can also be deployed in a Docker container. See [Everware in Docker container](docker.md)
+
 
 ## Development
 

docs/docker.md

@@ -0,0 +1,71 @@
+
+# Run Everware in a Docker container
+
+This section explains how to run Everware in a container, and the different possibilities to run users container
+
+## Build Everware container
+
+[Dockerfile](Dockerfile)
+
+```
+  docker build -t everware .
+```
+
+## Create user containers on same machine as the Everware one
+
+Fill the file which will contains environment variables for Everware.
+```
+  cp env.docker-local.orig env.docker-local
+```
+Define the `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET`, and `OAUTH_CALLBACK_URL`
+
+Edit `etc/container_config.py` file to set `c.DockerSpawner.hub_ip_connect` and `c.DockerSpawner.container_ip` to the IP of your machine running the Everware container.
+
+```
+  docker run -d --name everware \
+      -v /var/run/docker.sock:/var/run/docker.sock \
+      -v $PWD/etc/container_config.py:/srv/everware/etc/container_config.py \
+      --env-file=env.docker-local \
+      -p 8000:8000 \
+      -p 8081:8081 \
+      everware /srv/everware/etc/container_config.py --no-ssl --debug
+```
+
+Note that you can skip `-v $PWD/etc/container_config.py:/srv/everware/etc/container_config.py` part if you build the container after having modified the config file `etc/container_config.py`
+
+## Create user containers on a remote Docker machine
+
+```
+  cp env.docker-remote.orig env.docker-remote
+```
+Same as before, and define `DOCKER_HOST`, the IP of your remote Docker machine.
+
+```
+docker run -d --name everware \
+    -v $PWD/etc/container_config.py:/srv/everware/etc/container_config.py \
+    --env-file=env.docker-remote \
+    -p 8000:8000 \
+    -p 8081:8081 \
+    everware /srv/everware/etc/container_config.py --no-ssl --debug
+```
+
+## Create user containers on a Docker Swarm cluster
+
+This allows to create users container on a Docker Swarm cluster.
+
+```
+  cp env.docker-swarm.orig env.docker-swarm
+```
+Define the variable, and set `DOCKER_HOST` to the IP of your Swarm master.
+
+Edit `etc/container_swarm.py` file to set `c.DockerSpawner.hub_ip_connect` to the IP of your machine hosting Everware container.
+
+```
+  docker run --rm -it --name everware \
+      -v $PWD/etc/container_swarm_config.py:/srv/everware/etc/container_swarm_config.py \
+      -v /home/ubuntu/docker:/etc/docker \
+      --env-file=env.docker-swarm \
+      -p 8000:8000 \
+      -p 8081:8081 \
+      everware /srv/everware/etc/container_swarm_config.py --no-ssl --debug
+```

env.docker-local.orig

@@ -0,0 +1,4 @@
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+OAUTH_CALLBACK_URL=http://xxxxxxxx:8000/hub/oauth_callback
+EVERWARE_WHITELIST=whitelist.txt

env.docker-remote.orig

@@ -0,0 +1,7 @@
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+OAUTH_CALLBACK_URL=http://xxxxxxxx:8000/hub/oauth_callback
+EVERWARE_WHITELIST=whitelist.txt
+DOCKER_HOST=tcp://xxx.xxx.xxx.xxx:2376
+# most likely the same IP as DOCKER_HOST
+DOCKER_PUBLIC_IP=xxx.xxx.xxx.xxx

env.docker-swarm.orig

@@ -0,0 +1,9 @@
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+OAUTH_CALLBACK_URL=http://xxxxxxxx:8000/hub/oauth_callback
+EVERWARE_WHITELIST=whitelist.txt
+DOCKER_CERT_PATH=/etc/docker
+DOCKER_HOST=tcp://xxx.xxx.xxx.xxx:2376
+DOCKER_TLS_VERIFY=1
+# most likely the same IP as DOCKER_HOST
+DOCKER_PUBLIC_IP=xxx.xxx.xxx.xxx

etc/container_config.py

@@ -0,0 +1,17 @@
+# Use this config file to run everware in a container,
+# and create user containers in local or remote Docker service
+#
+# In case of local, don't forget to mount /var/run/docker.sock
+# In case of remote, don't forget the DOCKER_HOST environment variable
+
+c = get_config()
+load_subconfig('etc/base_config.py')
+load_subconfig('etc/github_auth.py')
+
+c.JupyterHub.hub_ip = '0.0.0.0'
+c.JupyterHub.proxy_api_ip = '0.0.0.0'
+
+# IP of the machine where the Everware (run as docker container) can be contacted
+c.DockerSpawner.hub_ip_connect = os.environ['DOCKER_PUBLIC_IP']
+# IP of the machine running Docker service, normally the same as above
+c.DockerSpawner.container_ip = c.DockerSpawner.hub_ip_connect

etc/container_swarm_config.py

@@ -0,0 +1,21 @@
+# Use this config file to run everware in a container,
+# and create the user container on a Docker Swarm cluster
+#
+# No need to mount /var/run/docker.sock,
+# but don't forget to set Docker Swarm environment
+# variables in the env file
+
+c = get_config()
+load_subconfig('etc/base_config.py')
+load_subconfig('etc/github_auth.py')
+
+c.JupyterHub.hub_ip = '0.0.0.0'
+c.JupyterHub.proxy_api_ip = '0.0.0.0'
+
+c.JupyterHub.spawner_class = 'everware.CustomSwarmSpawner'
+c.Spawner.tls = True
+c.DockerSpawner.tls = True
+
+# Change this setting:
+# IP of the machine where the Everware can be contacted
+c.DockerSpawner.hub_ip_connect = os.environ['DOCKER_PUBLIC_IP']

run.makefile

@@ -0,0 +1,67 @@
+HERE=$(shell pwd)
+LOG := everware.log
+PIDFILE := everware.pid
+EXECUTOR = everware-server
+
+reload:  ## reload everware whitelist
+	PID=`pgrep '${EXECUTOR}'` ;\
+		if [ -z "$${PID}" ] ; then echo "Cannot find running ${EXECUTOR}" ; exit 1 ; fi
+	pkill -1 '${EXECUTOR}'
+
+clean:  ## clean user base
+	if [ -f ${PIDFILE} ] ; then echo "${PIDFILE} exists, cannot continute" ; exit 1; fi
+	rm -f jupyterhub.sqlite
+
+run-linux: clean  ## run everware server on linux
+	source ./env.sh && \
+		${EXECUTOR} -f etc/local_config.py --no-ssl 2>&1 | tee ${LOG}
+
+run-dockermachine: clean  ## run everware server on MacOS
+	source ./env.sh && \
+		${EXECUTOR} -f etc/local_dockermachine_config.py --no-ssl 2>&1 | tee ${LOG}
+
+run-daemon: clean ## run everware in daemon mode, linux only, SSL required
+	source ./env.sh && \
+		${EXECUTOR} -f etc/local_config.py >> ${LOG}  2>&1 &
+	pgrep ${EXECUTOR} > ${PIDFILE} || ( tail ${LOG} && exit 1 )
+	echo "Started. Log saved to ${LOG}"
+
+stop:
+	-rm ${PIDFILE}
+	-pkill -9 ${EXECUTOR}
+	-pkill -9 node
+run-docker-local:
+	docker run -d --name everware \
+		-v /var/run/docker.sock:/var/run/docker.sock \
+		-v ${HERE}/etc/container_config.py:/srv/everware/etc/container_config.py \
+		--env-file=env.docker-local \
+		-p 8000:8000 \
+		-p 8081:8081 \
+	everware/everware:latest /srv/everware/etc/container_config.py --no-ssl --debug
+
+run-docker-remote:
+	docker run -d --name everware \
+		-v ${HERE}/etc/container_config.py:/srv/everware/etc/container_config.py \
+		--env-file=env.docker-remote \
+		-p 8000:8000 \
+		-p 8081:8081 \
+	everware/everware:latest /srv/everware/etc/container_config.py --no-ssl --debug
+
+run-docker-swarm:
+	docker run -d --name everware \
+	      	-v ${HERE}/etc/container_swarm_config.py:/srv/everware/etc/container_swarm_config.py \
+     	 	--env-file=env.docker-swarm \
+      		-p 8000:8000 \
+      		-p 8081:8081 \
+      	everware/everware:latest /srv/everware/etc/container_swarm_config.py --no-ssl --debug
+
+stop-docker:
+	docker stop everware
+	docker rm everware
+
+stop-docker-swarm:
+	bash -c "source env.docker-swarm && docker stop everware && docker rm everware"
+
+logs: ${LOG} ## watch log file
+	tail -f ${LOG}
+