Merge pull request #4270 from technosophos/issue/4266-deprecate-boot2docker

chore(docs): use Docker Toolbox, not boot2docker

Author: technosophos

Makefile

@@ -19,8 +19,8 @@ all: build run
 dev-registry: check-docker
 	@docker inspect registry >/dev/null 2>&1 && docker start registry || docker run --restart="always" -d -p 5000:5000 --name registry registry:0.9.1
 	@echo
-	@echo "To use local boot2docker registry for Deis development:"
-	@echo "    export DEV_REGISTRY=`boot2docker ip 2>/dev/null`:5000"
+	@echo "To use a local registry for Deis development:"
+	@echo "    export DEV_REGISTRY=`docker-machine ip $$(docker-machine active) 2>/dev/null`:5000"
 
 dev-cluster: discovery-url
 	vagrant up

controller/Makefile

@@ -56,7 +56,7 @@ postgres:
 	docker start postgres || docker run --restart="always" -d -p 5432:5432 --name postgres postgres:9.4.1
 	docker exec postgres createdb -U postgres deis 2>/dev/null || true
 	@echo "To use postgres for local development:"
-	@echo "    export PGHOST=`boot2docker ip 2>/dev/null || echo 127.0.0.1`"
+	@echo "    export PGHOST=`docker-machine ip $$(docker-machine active) 2>/dev/null || echo 127.0.0.1`"
 	@echo "    export PGPORT=5432"
 	@echo "    export PGUSER=postgres"
 

docs/contributing/hacking.rst

@@ -12,7 +12,7 @@ Deis environment, this document covers a specific setup:
 
 - Developing on **Mac OSX** or **Linux**
 - Managing virtualization with **Vagrant/Virtualbox**
-- Hosting a docker registry with **Boot2Docker** (Mac)
+- Hosting a docker registry with **docker-machine** (Mac)
 
 We try to make it simple to hack on Deis. However, there are necessarily several moving
 pieces and some setup required. We welcome any suggestions for automating or simplifying
@@ -39,7 +39,7 @@ At a glance, you will need:
 - VirtualBox latest
 - Vagrant 1.5 or later
 - On Mac, you will also want
-  - Boot2Docker
+  - Docker Machine (http://docs.docker.com/machine/install-machine/)
 
 In most cases, you should simply install according to the instructions. There
 are a few special cases, though. We cover these below.
@@ -72,49 +72,40 @@ It is also straightforward to build Go from source:
 Once you can compile to ``linux/amd64``, you should be able to compile Deis'
 components as normal.
 
-Configuring Boot2Docker (Mac)
-`````````````````````````````
+Configuring Docker Machine (Mac)
+````````````````````````````````
 
 Deis needs a Docker registry running independently of the Deis cluster. On
-OS X, you will need to run this docker registry inside of Boot2Docker (http://boot2docker.io).
+OS X, you will need Docker Machine (http://docs.docker.com/machine/install-machine/) 
+to run the registry inside of a VirtualBox image.
 
-Install Boot2Docker according to the normal installation instructions. When you
-run ``init``, we highly recommend allocating a large disk, since the Docker
-registry that will live there is fairly large.
-
-.. code-block:: console
-
-    $ boot2docker init --disksize=100000
-
-That will create virtual disk that can eventually take up a full 100,000MB of
-disk space. Then start up Boot2Docker.
-
-Once you have run ``boot2docker up``, you should be able to connect to it. You
-need to make a minor editor to the boot2docker config:
-
-.. code-block:: console
+.. note::
 
-    $ boot2docker ip
-    192.168.59.103
-    $ boot2docker ssh sudo vi /var/lib/boot2docker/profile
+    Previously, Deis used boot2docker to run the registry. However, Docker has
+    deprecated boot2docker in favor of Docker Machine.
 
-Inside of the profile, you need to add one line, making sure to set the IP
-address to whatever ``boot2docker ip`` printed.
+Install Docker Machine according to the normal installation instructions. Then
+create a new image for hosting your Deis Docker registry:
 
 .. code-block:: console
 
-    EXTRA_ARGS="--insecure-registry 192.168.59.103:5000"
+    $ docker-machine create --driver virtualbox --virtualbox-disk-size=100000 \
+    --engine-insecure-registry=192.168.0.0/16 deis-registry
 
-Once that line has been added, you can either restart boot2docker's docker
-server, or you can restart boot2docker. We recommend the latter.
+This will create a new virtual machine named `deis-registry` that will take
+up as much as 100,000 MB of disk space. Registries tend to be large, so
+allocating a big disk is a good idea.
 
-.. code-block:: console
+.. note::
 
-    $ boot2docker halt
-    $ boot2docker up
+    Because the registry that we create will not have a valid SSL certificate,
+    we run the local registry as an insecure (HTTP, not HTTPS) registry. Each
+    time Docker Machine reboots, the registry will get a new IP address
+    somewhere in the 192.168.0.0/16 range. We must declare that explicitly when
+    configuring Docker Machine.
 
-At this point, Boot2Docker can now serve as a registry for Deis' Docker images.
-Later on we will return to this.
+At this point, our `deis-registry` VM can now serve as a registry for Deis'
+Docker images. Later we will return to this.
 
 Fork the Deis Repository
 ------------------------
@@ -303,7 +294,7 @@ Configure a Docker Registry
 The development workflow requires Docker Registry set at the ``DEV_REGISTRY``
 environment variable.  If you're developing locally you can use the ``dev-registry``
 target to spin up a quick, disposable registry inside a Docker container.
-The target ``dev-registry`` prints the registry's address and port when using ``boot2docker``;
+The target ``dev-registry`` prints the registry's address and port when using ``docker-machine``;
 otherwise, use your host's IP address as returned by ``ifconfig`` with port 5000 for ``DEV_REGISTRY``.
 
 .. code-block:: console
@@ -315,11 +306,6 @@ otherwise, use your host's IP address as returned by ``ifconfig`` with port 5000
 
 It is important that you export the ``DEV_REGISTRY`` variable as instructed.
 
-.. note::
-
-    If you are using Boot2Docker, make sure you set the ``EXTRA_ARGS`` as
-    explained in the prerequisites. Otherwise your registry will not work.
-
 If you are developing elsewhere, you must set up a registry yourself.
 Make sure it meets the following requirements:
 

docs/contributing/testing.rst

@@ -46,14 +46,14 @@ binary artifacts--just as a real-world provisioning of Deis pulls images from
 the Docker Hub.
 
 If you don't have a Docker registry already accessible for your testing or for
-continuous deployment, start one locally:
+continuous deployment, start one locally.
 
 .. code-block:: console
 
     $ make dev-registry
     registry
 
-    To use local boot2docker registry for Deis development:
+    To use local registry for Deis development:
         export DEV_REGISTRY=192.168.59.103:5000
 
 .. important::
@@ -149,7 +149,7 @@ The file ``tests/bin/test-setup.sh`` is the best reference to environment
 variables that can affect the tests' behavior. Here are some important ones:
 
 - ``HOST_IPADDR`` - address on which Docker containers can communicate for the
-  functional tests, probably the host's IP or the one assigned to boot2docker_.
+  functional tests, probably the host's IP or the one assigned to `Docker Machine`_.
 - ``DEIS_TEST_APP`` - name of the `Deis example app`_ to use, which is cloned
   from GitHub (default: ``example-go``)
 - ``DEIS_TEST_AUTH_KEY`` - SSH key used to register with the Deis controller
@@ -164,7 +164,7 @@ variables that can affect the tests' behavior. Here are some important ones:
 .. _`functional tests`: http://en.wikipedia.org/wiki/Functional_testing
 .. _`integration tests`: http://en.wikipedia.org/wiki/Integration_testing
 .. _`continuous integration`: http://en.wikipedia.org/wiki/Continuous_integration
-.. _boot2docker: http://boot2docker.io/
+.. _`Docker Machine`: http://docs.docker.com/machine/install-machine/
 .. _`source code`: https://github.com/deis/deis
 .. _`Docker registry`: https://github.com/docker/docker-registry
 .. _`Deis example app`: https://github.com/deis?query=example-