From 8fab2e5950d5063f0029d93c825f7f2f4d038f3c Mon Sep 17 00:00:00 2001 From: Nathan LeClaire Date: Tue, 16 Jun 2015 15:47:32 -0700 Subject: [PATCH] Update docs usage and output Signed-off-by: Nathan LeClaire --- README.md | 25 ++++++------ docs/machine-overview.md | 84 +++++++++++++++++++++------------------- 2 files changed, 57 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 9377b93fab..e7f6febe23 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,16 @@ It works a bit like this: ```console $ docker-machine create -d virtualbox dev -INFO[0000] Creating SSH key... -INFO[0000] Creating VirtualBox VM... -INFO[0007] Starting VirtualBox VM... -INFO[0007] Waiting for VM to start... -INFO[0041] "dev" has been created and is now the active machine. -INFO[0041] To point your Docker client at it, run this in your shell: eval "$(docker-machine env dev)" +Creating CA: /home/username/.docker/machine/certs/ca.pem +Creating client certificate: /home/username/.docker/machine/certs/cert.pem +Image cache does not exist, creating it at /home/username/.docker/machine/cache... +No default boot2docker iso found locally, downloading the latest release... +Downloading https://github.com/boot2docker/boot2docker/releases/download/v1.6.2/boot2docker.iso to /home/username/.docker/machine/cache/boot2docker.iso... +Creating VirtualBox VM... +Creating SSH key... +Starting VirtualBox VM... +Starting VM... +To see how to connect Docker to this machine, run: docker-machine env dev $ docker-machine ls NAME ACTIVE DRIVER STATE URL SWARM @@ -30,12 +34,9 @@ ea13149945cb: Pull complete hello world $ docker-machine create -d digitalocean --digitalocean-access-token=secret staging -INFO[0000] Creating SSH key... -INFO[0001] Creating Digital Ocean droplet... -INFO[0002] Waiting for SSH... -INFO[0070] Configuring Machine... -INFO[0109] "staging" has been created and is now the active machine. -INFO[0109] To point your Docker client at it, run this in your shell: eval "$(docker-machine env staging)" +Creating SSH key... +Creating Digital Ocean droplet... +To see how to connect Docker to this machine, run: docker-machine env staging $ docker-machine ls NAME ACTIVE DRIVER STATE URL SWARM diff --git a/docs/machine-overview.md b/docs/machine-overview.md index 3601ceec90..e069332537 100644 --- a/docs/machine-overview.md +++ b/docs/machine-overview.md @@ -140,16 +140,20 @@ daemon installed, and will create and start a VirtualBox VM with Docker running. ``` $ docker-machine create --driver virtualbox dev -INFO[0001] Downloading boot2docker.iso to /home//.docker/machine/cache/boot2docker.iso... -INFO[0011] Creating SSH key... -INFO[0012] Creating VirtualBox VM... -INFO[0019] Starting VirtualBox VM... -INFO[0020] Waiting for VM to start... -INFO[0053] To see how to connect Docker to this machine, run: docker-machine env dev" +Creating CA: /home/username/.docker/machine/certs/ca.pem +Creating client certificate: /home/username/.docker/machine/certs/cert.pem +Image cache does not exist, creating it at /home/username/.docker/machine/cache... +No default boot2docker iso found locally, downloading the latest release... +Downloading https://github.com/boot2docker/boot2docker/releases/download/v1.6.2/boot2docker.iso to /home/username/.docker/machine/cache/boot2docker.iso... +Creating VirtualBox VM... +Creating SSH key... +Starting VirtualBox VM... +Starting VM... +To see how to connect Docker to this machine, run: docker-machine env dev ``` -You can see the machine you have created by running the `docker-machine ls` command -again: +You can see the machine you have created by running the `docker-machine ls` +command again: ``` $ docker-machine ls @@ -157,9 +161,9 @@ NAME ACTIVE DRIVER STATE URL SWARM dev virtualbox Running tcp://192.168.99.100:2376 ``` -Next, as noted in the output of the `docker-machine create` command, we have to tell -Docker to talk to that machine. You can do this with the `docker-machine env` -command. For example, +Next, as noted in the output of the `docker-machine create` command, we have to +tell Docker to talk to that machine. You can do this with the `docker-machine +env` command. For example, ``` $ eval "$(docker-machine env dev)" @@ -204,7 +208,7 @@ Any exposed ports are available on the Docker host’s IP address, which you can get using the `docker-machine ip` command: ``` -$ docker-machine ip +$ docker-machine ip dev 192.168.99.100 ``` @@ -297,11 +301,9 @@ $ docker-machine create \ --driver digitalocean \ --digitalocean-access-token 0ab77166d407f479c6701652cee3a46830fef88b8199722b87821621736ab2d4 \ staging -INFO[0000] Creating SSH key... -INFO[0000] Creating Digital Ocean droplet... -INFO[0002] Waiting for SSH... -INFO[0085] "staging" has been created. -INFO[0085] To see how to connect Docker to this machine, run: docker-machine env staging" +Creating SSH key... +Creating Digital Ocean droplet... +To see how to connect Docker to this machine, run: docker-machine env staging ``` For convenience, `docker-machine` will use sensible defaults for choosing @@ -465,12 +467,16 @@ Create a machine. ``` $ docker-machine create --driver virtualbox dev -INFO[0001] Downloading boot2docker.iso to /home/ehazlett/.docker/machine/cache/boot2docker.iso... -INFO[0000] Creating SSH key... -INFO[0000] Creating VirtualBox VM... -INFO[0007] Starting VirtualBox VM... -INFO[0007] Waiting for VM to start... -INFO[0038] To see how to connect Docker to this machine, run: docker-machine env dev +Creating CA: /home/username/.docker/machine/certs/ca.pem +Creating client certificate: /home/username/.docker/machine/certs/cert.pem +Image cache does not exist, creating it at /home/username/.docker/machine/cache... +No default boot2docker iso found locally, downloading the latest release... +Downloading https://github.com/boot2docker/boot2docker/releases/download/v1.6.2/boot2docker.iso to /home/username/.docker/machine/cache/boot2docker.iso... +Creating VirtualBox VM... +Creating SSH key... +Starting VirtualBox VM... +Starting VM... +To see how to connect Docker to this machine, run: docker-machine env dev ``` ##### Filtering create flags by driver in the help text @@ -803,8 +809,6 @@ Show help text. Get the IP address of one or more machines. ``` -$ docker-machine ip -192.168.99.104 $ docker-machine ip dev 192.168.99.104 $ docker-machine ip dev dev2 @@ -872,9 +876,9 @@ dev virtualbox Stopped Regenerate TLS certificates and update the machine with new certs. ``` -$ docker-machine regenerate-certs +$ docker-machine regenerate-certs dev Regenerate TLS machine certs? Warning: this is irreversible. (y/n): y -INFO[0013] Regenerating TLS certificates +Regenerating TLS certificates ``` #### restart @@ -883,8 +887,8 @@ Restart a machine. Oftentimes this is equivalent to `docker-machine stop; machine start`. ``` -$ docker-machine restart -INFO[0005] Waiting for VM to start... +$ docker-machine restart dev +Waiting for VM to start... ``` #### rm @@ -1010,11 +1014,11 @@ local host's filesystem first (using `scp`'s `-3` flag). #### start -Gracefully start a machine. +Start a machine. ``` -$ docker-machine restart -INFO[0005] Waiting for VM to start... +$ docker-machine start dev +Starting VM... ``` #### stop @@ -1041,11 +1045,11 @@ with the latest. ``` $ docker-machine upgrade dev -INFO[0000] Stopping machine to do the upgrade... -INFO[0005] Upgrading machine dev... -INFO[0006] Downloading latest boot2docker release to /tmp/store/cache/boot2docker.iso... -INFO[0008] Starting machine back up... -INFO[0008] Waiting for VM to start... +Stopping machine to do the upgrade... +Upgrading machine dev... +Downloading latest boot2docker release to /home/username/.docker/machine/cache/boot2docker.iso... +Starting machine back up... +Waiting for VM to start... ``` > **Note**: If you are using a custom boot2docker ISO specified using @@ -1058,7 +1062,7 @@ INFO[0008] Waiting for VM to start... Get the URL of a host ``` -$ docker-machine url +$ docker-machine url dev tcp://192.168.99.109:2376 ``` @@ -1637,9 +1641,9 @@ To use a different base operating system on a remote provider, specify the provider's image flag and one of its available images. For example, to select a `debian-8-x64` image on DigitalOcean you would supply the following: - --digitalocean-image=debian-8-x64` + --digitalocean-image=debian-8-x64 If you change the base image for a provider, you may also need to change the SSH user. For example, the default Red Hat AMI on EC2 expects the SSH user to be `ec2-user`, so you would have to specify this with -`--amazonec2-ssh-user ec2-user`. \ No newline at end of file +`--amazonec2-ssh-user ec2-user`.