make-deploy example: run stacks on docker-machines

(c) Copyright IBM Corp. 2015

examples/make-deploy/Dockerfile

@@ -0,0 +1,15 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+# Pick your favorite docker-stacks image
+FROM jupyter/minimal-notebook:latest
+
+USER jovyan
+
+# Add permanent pip/conda installs, data files, other user libs here
+# e.g., RUN pip install jupyter_dashboards
+
+USER root
+
+# Add permanent apt-get installs and other root commands here
+# e.g., RUN apt-get install npm nodejs

examples/make-deploy/Makefile

@@ -0,0 +1,57 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+.PHONY: help check image notebook secure-notebook
+
+IMAGE:=my-notebook
+
+# OK to re-run volume create, noop if volume already exists
+# Destroy the old notebook container, consider it temporary
+# Show the ports at the end
+define RUN_NOTEBOOK
+@docker volume create --name $(WORK_VOLUME) > /dev/null
+-@docker rm -f $(NAME) 2> /dev/null
+@docker run -d -p $(PORT):8888 \
+		--name $(NAME) \
+		-v $(WORK_VOLUME):/home/jovyan/work \
+		$(DOCKER_ARGS) \
+		$(IMAGE) bash -c "$(PRE_CMD) chown jovyan /home/jovyan/work && start-notebook.sh" > /dev/null
+@echo "DONE: Notebook '$(NAME)' listening on $$(docker-machine ip $$(docker-machine active)):$(PORT)"
+endef
+
+help:
+	@cat README.md
+
+include virtualbox.makefile
+include softlayer.makefile
+
+check:
+	@which docker-machine > /dev/null || (echo "ERROR: docker-machine not found (brew install docker-machine)"; exit 1)
+	@which docker > /dev/null || (echo "ERROR: docker not found (brew install docker)"; exit 1)
+	@docker | grep volume > /dev/null || (echo "ERROR: docker 1.9.0+ required"; exit 1)
+
+image: DOCKER_ARGS?=
+image:
+	@docker build --rm $(DOCKER_ARGS) -t $(IMAGE) .
+
+password-check:
+	@test -n "$(PASSWORD)" || \
+		(echo "ERROR: PASSWORD not defined or blank"; exit 1)
+
+notebook: PORT?=80
+notebook: NAME?=notebook
+notebook: WORK_VOLUME?=$(NAME)-data
+notebook: check
+	$(RUN_NOTEBOOK)
+
+secure-notebook: PORT?=443
+secure-notebook: NAME?=notebook
+secure-notebook: WORK_VOLUME?=$(NAME)-data
+secure-notebook: SECRETS_VOLUME?=$(NAME)-secrets
+secure-notebook: DOCKER_ARGS:=-e USE_HTTPS=yes \
+	-e PASSWORD=$(PASSWORD) \
+	-v $(NAME)-secrets:/home/jovyan/.local/share/jupyter
+secure-notebook: PRE_CMD:=chown jovyan /home/jovyan/.local/share/jupyter;
+secure-notebook: check password-check
+	@docker volume create --name $(SECRETS_VOLUME) > /dev/null
+	$(RUN_NOTEBOOK)

examples/make-deploy/README.md

@@ -0,0 +1,101 @@
+This folder contains a Makefile and a set of supporting files demonstrating how to run a docker-stack notebook container on a docker-machine controlled host.
+
+## Prerequisites
+
+* make 3.81+
+* docker-machine 0.5.0+
+* docker 1.9.0+
+
+## Quickstart
+
+To show what's possible, here's how to run the `jupyter/minimal-notebook` on a brand new local virtualbox.
+
+```
+# create a new VM
+make virtualbox-vm NAME=dev
+# make the new VM the active docker machine
+eval $(docker-machine env dev)
+# pull a docker stack and build a local image from it
+make image
+# start a notebook server in a container
+make notebook
+```
+
+The last command will log the IP address and port to visit in your browser.
+
+## FAQ
+
+### Can I run multiple notebook containers on the same VM?
+
+Yes. Specify a unique name and port on the `make notebook` command.
+
+```
+make notebook NAME=my-notebook PORT=9000
+make notebook NAME=your-notebook PORT=9001
+```
+
+### Can multiple notebook containers share their notebook directory?
+
+Yes.
+
+```
+make notebook NAME=my-notebook PORT=9000 WORK_VOLUME=our-work
+make notebook NAME=your-notebook PORT=9001 WORK_VOLUME=our-work
+```
+
+### How do I run over HTTPS?
+
+Instead of `make notebook` run `make secure-notebook PASSWORD=your_desired_password`.
+
+### My pip/conda/apt-get installs disappear every time I restart the container. Can I make them permanent?
+
+```
+# add your pip, conda, apt-get, etc. permanent features to the Dockerfile where
+# indicated by the comments in the Dockerfile
+vi Dockerfile
+make image
+make notebook
+```
+
+### How do I upgrade my Docker container?
+
+```
+make image DOCKER_ARGS=--pull
+make notebook
+```
+
+The first line pulls the latest version of the Docker image used in the local Dockerfile. Then it rebuilds the local Docker image containing any customizations you may have added to it. The second line kills your currently running notebook container, and starts a fresh one using the new image.
+
+### Can I run on another VM provider other than VirtualBox?
+
+Yes. As an example, there's a `softlayer.makefile` included in this repo as an example. You would use it like so:
+
+```
+make softlayer-vm NAME=myhost \
+    SOFTLAYER_DOMAIN=your_desired_domain \
+    SOFTLAYER_USER=your_user_id \
+    SOFTLAYER_API_KEY=your_api_key
+eval $(docker-machine env myhost)
+# optional, creates a real DNS entry for the VM using the machine name as the hostname
+make softlayer-dns SOFTLAYER_DOMAIN=your_desired_domain
+make image
+make notebook
+```
+
+If you'd like to add support for another docker-machine driver, use the `softlayer.makefile` as a template.
+
+### Where are my notebooks stored?
+
+`make notebook` creates a Docker volume named after the notebook container with a `-data` suffix.
+
+### Where are my HTTPS certificate and key stored?
+
+`make secure-notebook` creates a Docker volume named after the notebook container with a `-secrets` suffix.
+
+### Uh ... make?
+
+Yes, sorry Windows users. It got the job done for a simple example. We can certainly accept other deployment mechanism examples in the parent folder or in other repos.
+
+### Are there any other options?
+
+Yes indeed. `cat Makefile` and enjoy.

examples/make-deploy/softlayer.makefile

@@ -0,0 +1,27 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+softlayer-vm: export SOFTLAYER_CPUS?=4
+softlayer-vm: export SOFTLAYER_DISK_SIZE?=100
+softlayer-vm: export SOFTLAYER_MEMORY?=4096
+softlayer-vm: export SOFTLAYER_REGION?=wdc01
+softlayer-vm: check
+	@test -n "$(NAME)" || \
+		(echo "ERROR: NAME not defined (make help)"; exit 1)
+	@test -n "$(SOFTLAYER_API_KEY)" || \
+		(echo "ERROR: SOFTLAYER_API_KEY not defined (make help)"; exit 1)
+	@test -n "$(SOFTLAYER_USER)" || \
+		(echo "ERROR: SOFTLAYER_USER not defined (make help)"; exit 1)
+	@test -n "$(SOFTLAYER_DOMAIN)" || \
+		(echo "ERROR: SOFTLAYER_DOMAIN not defined (make help)"; exit 1)
+	@docker-machine create -d softlayer $(NAME)
+	@echo "DONE: Docker host '$(NAME)' up at $$(docker-machine ip $(NAME))"
+
+softlayer-dns: HOST_NAME:=$$(docker-machine ip $$(docker-machine active))
+softlayer-dns: check
+	@which slcli > /dev/null || (echo "softlayer cli not found (pip install softlayer)"; exit 1)
+	@test -n "$(NAME)" || \
+		(echo "ERROR: NAME not defined (make help)"; exit 1)
+	@test -n "$(SOFTLAYER_DOMAIN)" || \
+		(echo "ERROR: SOFTLAYER_DOMAIN not defined (make help)"; exit 1)
+	@slcli dns record-add $(SOFTLAYER_DOMAIN) $(HOST_NAME) A $(HOST_NAME)

examples/make-deploy/virtualbox.makefile

@@ -0,0 +1,10 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+virtualbox-vm: VIRTUALBOX_CPUS?=4
+virtualbox-vm: VIRTUALBOX_DISK_SIZE?=100000
+virtualbox-vm: VIRTUALBOX_MEMORY_SIZE?=4096
+virtualbox-vm: check
+	@test -n "$(NAME)" || \
+		(echo "ERROR: NAME not defined (make help)"; exit 1)
+	@docker-machine create -d virtualbox $(NAME)