Merge pull request #3475 from SvenDowideit/daemon.md-filename-changed

Our validation tools assume master, but v1.11 engine has a different …

docs/Dockerfile

@@ -1,18 +1,9 @@
-FROM docs/base:latest
-MAINTAINER Mary Anthony <mary@docker.com> (@moxiegirl)
-
-RUN svn checkout https://github.com/docker/docker/trunk/docs /docs/content/engine
-RUN svn checkout https://github.com/docker/swarm/trunk/docs /docs/content/swarm
-RUN svn checkout https://github.com/docker/compose/trunk/docs /docs/content/compose
-RUN svn checkout https://github.com/docker/distribution/trunk/docs /docs/content/registry
-RUN svn checkout https://github.com/docker/notary/trunk/docs /docs/content/notary
-RUN svn checkout https://github.com/docker/kitematic/trunk/docs /docs/content/kitematic
-RUN svn checkout https://github.com/docker/toolbox/trunk/docs /docs/content/toolbox
-RUN svn checkout https://github.com/docker/opensource/trunk/docs /docs/content/opensource
+FROM docs/base:oss
+MAINTAINER Docker Docs <docs@docker.com>
 
 env PROJECT=machine
 
 # To get the git info for this repo
 COPY . /src
-
+RUN rm -rf /docs/content/$PROJECT/
 COPY . /docs/content/$PROJECT/

docs/Makefile

@@ -1,17 +1,4 @@
-.PHONY: all binary build cross default docs docs-build docs-shell shell test test-unit test-integration test-integration-cli test-docker-py validate
-
-# env vars passed through directly to Docker's build scripts
-# to allow things like `make DOCKER_CLIENTONLY=1 binary` easily
-# `docs/sources/contributing/devenvironment.md ` and `project/PACKAGERS.md` have some limited documentation of some of these
-DOCKER_ENVS := \
-	-e BUILDFLAGS \
-	-e DOCKER_CLIENTONLY \
-	-e DOCKER_EXECDRIVER \
-	-e DOCKER_GRAPHDRIVER \
-	-e TESTDIRS \
-	-e TESTFLAGS \
-	-e TIMEOUT
-# note: we _cannot_ add "-e DOCKER_BUILDTAGS" here because even if it's unset in the shell, that would shadow the "ENV DOCKER_BUILDTAGS" set in our Dockerfile, which is very important for our official builds
+.PHONY: all default docs docs-build docs-shell shell test
 
 # to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs)
 DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR))
@@ -25,9 +12,8 @@ HUGO_BASE_URL=$(shell test -z "$(DOCKER_IP)" && echo localhost || echo "$(DOCKER
 HUGO_BIND_IP=0.0.0.0
 
 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
-DOCKER_IMAGE := docker$(if $(GIT_BRANCH),:$(GIT_BRANCH))
-DOCKER_DOCS_IMAGE := docs-base$(if $(GIT_BRANCH),:$(GIT_BRANCH))
-
+GIT_BRANCH_CLEAN := $(shell echo $(GIT_BRANCH) | sed -e "s/[^[:alnum:]]/-/g")
+DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH_CLEAN),:$(GIT_BRANCH_CLEAN))
 
 DOCKER_RUN_DOCS := docker run --rm -it $(DOCS_MOUNT) -e AWS_S3_BUCKET -e NOCACHE
 
@@ -42,14 +28,11 @@ docs: docs-build
 docs-draft: docs-build
 	$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --buildDrafts="true" --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP)
 
-
 docs-shell: docs-build
 	$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" bash
 
+test: docs-build
+	$(DOCKER_RUN_DOCS) "$(DOCKER_DOCS_IMAGE)"
 
 docs-build:
-#	( git remote | grep -v upstream ) || git diff --name-status upstream/release..upstream/docs ./ > ./changed-files
-#	echo "$(GIT_BRANCH)" > GIT_BRANCH
-#	echo "$(AWS_S3_BUCKET)" > AWS_S3_BUCKET
-#	echo "$(GITCOMMIT)" > GITCOMMIT
 	docker build -t "$(DOCKER_DOCS_IMAGE)" .

docs/RELEASE.md

@@ -34,7 +34,8 @@ Machine core maintainers who might find themselves performing a release.
     the `CHANGELOG.md` file in the repository.
 5.  **Update the Documentation** -- Ensure that the `docs` branch on GitHub
     (which the Docker docs team uses to deploy from) is up to date with the
-    changes to be deployed from the release branch / master.
+    changes to be deployed from the release branch / master.  Make sure to
+    update `docs/install-machine.md` to have the correct version as well.
 6.  **Verify the Installation** -- Copy and paste the suggested commands in the
     installation notes to ensure that they work properly.  Best of all, grab an
     (uninvolved) buddy and have them try it.  `docker-machine -v` should give

docs/concepts.md

@@ -78,7 +78,7 @@ like-minded individuals, we have a number of open channels for communication.
     Github](https://github.com/docker/machine/pulls).
 
 For more information and resources, please visit
-[our help page](https://docs.docker.com/project/get-help/).
+[our help page](/opensource/get-help.md).
 
 ## Where to go next
 

docs/drivers/azure.md

@@ -66,7 +66,7 @@ Optional:
 - `--azure-use-private-ip`: Use private IP address of the machine to connect. It's useful for managing Docker machines from another machine on the same network e.g. while deploying Swarm.
 - `--azure-no-public-ip`: Do not create a public IP address for the machine (implies `--azure-use-private-ip`). Should be used only when creating machines from an Azure VM within the same subnet.
 - `--azure-static-public-ip`: Assign a static public IP address to the machine.
-- `--azure-docker-port`: Port number for Docker engine [$AZURE_DOCKER_PORT]
+- `--azure-docker-port`: Port number for Docker engine.
 - `--azure-environment`: Azure environment (e.g. `AzurePublicCloud`, `AzureChinaCloud`).
 
 [vm-image]: https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/

docs/drivers/generic.md

@@ -33,25 +33,9 @@ to the host.
     $ docker-machine create \
       --driver generic \
       --generic-ip-address=203.0.113.81 \
-      --generic-ssh-key=~/.ssh/id_rsa \
+      --generic-ssh-key ~/.ssh/id_rsa \
       vm
 
-### Password-protected SSH keys
-
-When an SSH identity is not provided (with the `--generic-ssh-key` flag),
-the SSH agent (if running) will be consulted. This makes it possible to
-easily use password-protected SSH keys.
-
-Note that this usage is _only_ supported if you're using the external SSH client,
-which is the default behaviour when the `ssh` binary is available. If you're
-using the native client (with `--native-ssh`), using the SSH agent is not yet
-supported.
-
-    $ docker-machine create \
-      --driver generic \
-      --generic-ip-address=203.0.113.81 \
-      other
-
 ### Sudo privileges
 
 The user that is used to SSH into the host can be specified with
@@ -76,6 +60,6 @@ Environment variables and default values:
 | -------------------------- | -------------------- | ------------------------- |
 | `--generic-engine-port`    | `GENERIC_ENGINE_PORT`| `2376`                    |
 | **`--generic-ip-address`** | `GENERIC_IP_ADDRESS` | -                         |
-| `--generic-ssh-key`        | `GENERIC_SSH_KEY`    | _(defers to `ssh-agent`)_ |
+| `--generic-ssh-key`        | `GENERIC_SSH_KEY`    | -                         |
 | `--generic-ssh-user`       | `GENERIC_SSH_USER`   | `root`                    |
 | `--generic-ssh-port`       | `GENERIC_SSH_PORT`   | `22`                      |

docs/drivers/os-base.md

@@ -28,7 +28,7 @@ $ docker-machine create -d azure --azure-subscription-id="SUB_ID" --azure-subscr
 ```
 
 To see a list of providers and review the options available to a provider, see
-the [Docker Machine driver reference](../index.md).
+the reference for that driver.
 
 In addition to the provider, you have the option of identifying a base operating
 system. It is an option because Docker Machine has defaults for both local and

docs/examples/aws.md

@@ -129,4 +129,4 @@ To remove an instance and all of its containers and images, first stop the machi
 -   [Understand Machine concepts](../concepts.md)
 -   [Docker Machine driver reference](../drivers/index.md)
 -   [Docker Machine subcommand reference](../reference/index.md)
--   [Provision a Docker Swarm cluster with Docker Machine](https://docs.docker.com/swarm/provision-with-machine/)
+-   [Provision a Docker Swarm cluster with Docker Machine](/swarm/provision-with-machine.md)

docs/examples/ocean.md

@@ -140,4 +140,4 @@ If you create a host with Docker Machine, but remove it through the cloud provid
 -   [Understand Machine concepts](../concepts.md)
 -   [Docker Machine driver reference](../drivers/index.md)
 -   [Docker Machine subcommand reference](../reference/index.md)
--   [Provision a Docker Swarm cluster with Docker Machine](https://docs.docker.com/swarm/provision-with-machine/)
+-   [Provision a Docker Swarm cluster with Docker Machine](/swarm/provision-with-machine.md)

docs/get-started-cloud.md

@@ -84,4 +84,4 @@ Docker Machine can also provision <a href="https://docs.docker.com/swarm/overvie
 -   [Understand Machine concepts](concepts.md)
 -   [Docker Machine driver reference](drivers/index.md)
 -   [Docker Machine subcommand reference](reference/index.md)
--   [Provision a Docker Swarm cluster with Docker Machine](https://docs.docker.com/swarm/provision-with-machine/)
+-   [Provision a Docker Swarm cluster with Docker Machine](/swarm/provision-with-machine.md)

docs/get-started.md

@@ -247,5 +247,5 @@ You can change the `default` string above to make this `LaunchAgent` start any
 
 -   Provision multiple Docker hosts [on your cloud provider](get-started-cloud.md)
 -   [Understand Machine concepts](concepts.md)
--   <a href="https://docs.docker.com/machine/drivers/index.md" target="_blank">Docker Machine driver reference</a>
+-   <a href="https://docs.docker.com/machine/drivers/" target="_blank">Docker Machine driver reference</a>
 -   <a href="https://docs.docker.com/machine/reference/" target="_blank">Docker Machine subcommand reference</a>

docs/install-machine.md

@@ -29,13 +29,13 @@ If you want only Docker Machine, you can install the Machine binaries directly b
 
     If you are running OS X or Linux:
 
-        $ curl -L https://github.com/docker/machine/releases/download/v0.6.0/docker-machine-`uname -s`-`uname -m` > /usr/local/bin/docker-machine && \
+        $ curl -L https://github.com/docker/machine/releases/download/v0.7.0/docker-machine-`uname -s`-`uname -m` > /usr/local/bin/docker-machine && \
         chmod +x /usr/local/bin/docker-machine
 
     If you are running Windows with git bash
 
         $ if [[ ! -d "$HOME/bin" ]]; then mkdir -p "$HOME/bin"; fi && \
-        curl -L https://github.com/docker/machine/releases/download/v0.6.0/docker-machine-Windows-x86_64.exe > "$HOME/bin/docker-machine.exe" && \
+        curl -L https://github.com/docker/machine/releases/download/v0.7.0/docker-machine-Windows-x86_64.exe > "$HOME/bin/docker-machine.exe" && \
         chmod +x "$HOME/bin/docker-machine.exe"
 
     Otherwise, download one of the releases from the <a href="https://github.com/docker/machine/releases/" target="_blank"> docker/machine release page</a> directly.
@@ -43,7 +43,7 @@ If you want only Docker Machine, you can install the Machine binaries directly b
 3.  Check the installation by displaying the Machine version:
 
         $ docker-machine version
-        docker-machine version 0.6.0, build 61388e9
+        docker-machine version 0.7.0, build 61388e9
 
 ## Installing bash completion scripts
 

docs/overview.md

@@ -60,7 +60,7 @@ When people say "Docker" they typically mean **Docker Engine**, the client-serve
 -   [Install Docker Machine](install-machine.md)
 -   Create and run a Docker host on your [local system using VirtualBox](get-started.md)
 -   Provision multiple Docker hosts [on your cloud provider](get-started-cloud.md)
--   [Provision a Docker Swarm cluster with Docker Machine](https://docs.docker.com/swarm/provision-with-machine/)
+-   [Provision a Docker Swarm cluster with Docker Machine](/swarm/provision-with-machine.md)
 -   [Understand Machine concepts](concepts.md)
 -   [Docker Machine driver reference](drivers/index.md)
 -   [Docker Machine subcommand reference](reference/index.md)

docs/reference/create.md

@@ -119,12 +119,12 @@ As part of the process of creation, Docker Machine installs Docker and
 configures it with some sensible defaults. For instance, it allows connection
 from the outside world over TCP with TLS-based encryption and defaults to AUFS
 as the [storage
-driver](https://docs.docker.com/reference/commandline/daemon/#daemon-storage-driver-option)
+driver](/engine/reference/commandline/daemon.md#daemon-storage-driver-option)
 when available.
 
 There are several cases where the user might want to set options for the created
 Docker engine (also known as the Docker _daemon_) themselves. For example, they
-may want to allow connection to a [registry](https://docs.docker.com/registry/)
+may want to allow connection to a [registry](/registry/index.md)
 that they are running themselves using the `--insecure-registry` flag for the
 daemon. Docker Machine supports the configuration of such options for the
 created engines via the `create` command flags which begin with `--engine`.
@@ -165,10 +165,10 @@ output of `docker info`:
 
 The supported flags are as follows:
 
--   `--engine-insecure-registry`: Specify [insecure registries](https://docs.docker.com/reference/commandline/cli/#insecure-registries) to allow with the created engine
--   `--engine-registry-mirror`: Specify [registry mirrors](https://github.com/docker/distribution/blob/master/docs/mirror.md) to use
--   `--engine-label`: Specify [labels](https://docs.docker.com/userguide/labels-custom-metadata/#daemon-labels) for the created engine
--   `--engine-storage-driver`: Specify a [storage driver](https://docs.docker.com/reference/commandline/cli/#daemon-storage-driver-option) to use with the engine
+-   `--engine-insecure-registry`: Specify [insecure registries](/engine/reference/commandline/cli.md#insecure-registries) to allow with the created engine
+-   `--engine-registry-mirror`: Specify [registry mirrors](/registry/recipes/mirror.md) to use
+-   `--engine-label`: Specify [labels](/engine/userguide/labels-custom-metadata.md#daemon-labels) for the created engine
+-   `--engine-storage-driver`: Specify a [storage driver](/engine/reference/commandline/cli.md#daemon-storage-driver-option) to use with the engine
 
 If the engine supports specifying the flag multiple times (such as with
 `--label`), then so does Docker Machine.
@@ -178,7 +178,7 @@ Machine also supports an additional flag, `--engine-opt`, which can be used to
 specify arbitrary daemon options with the syntax `--engine-opt flagname=value`.
 For example, to specify that the daemon should use `8.8.8.8` as the DNS server
 for all containers, and always use the `syslog` [log
-driver](https://docs.docker.com/reference/run/#logging-drivers-log-driver) you
+driver](/engine/reference/run.md#logging-drivers-log-driver) you
 could run the following create command:
 
     $ docker-machine create -d virtualbox \
@@ -200,7 +200,7 @@ specify arbitrary environment variables to be set within the engine with the syn
 In addition to being able to configure Docker Engine options as listed above,
 you can use Machine to specify how the created Swarm master should be
 configured. There is a `--swarm-strategy` flag, which you can use to specify
-the [scheduling strategy](https://docs.docker.com/swarm/scheduler/strategy/)
+the [scheduling strategy](/swarm/scheduler/strategy.md)
 which Docker Swarm should use (Machine defaults to the `spread` strategy).
 There is also a general purpose `--swarm-opt` option which works similar to how
 the aforementioned `--engine-opt` option does, except that it specifies options

docs/reference/env.md

@@ -106,4 +106,4 @@ required for internet access.
 
 You may also want to visit the [documentation on setting `HTTP_PROXY` for the
 created daemon using the `--engine-env` flag for `docker-machine
-create`](https://docs.docker.com/machine/reference/create/#specifying-configuration-options-for-the-created-docker-engine).
+create`](/machine/reference/create.md#specifying-configuration-options-for-the-created-docker-engine).

drivers/generic/generic.go

@@ -49,7 +49,7 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 		},
 		mcnflag.StringFlag{
 			Name:   "generic-ssh-key",
-			Usage:  "SSH private key path (if not provided, identities in ssh-agent will be used)",
+			Usage:  "SSH private key path (if not provided, default SSH key will be used)",
 			Value:  "",
 			EnvVar: "GENERIC_SSH_KEY",
 		},
@@ -123,8 +123,7 @@ func (d *Driver) PreCreateCheck() error {
 
 func (d *Driver) Create() error {
 	if d.SSHKey == "" {
-		log.Info("No SSH key specified. Connecting to this machine now and in the" +
-			" future will require the ssh agent to contain the appropriate key.")
+		log.Info("No SSH key specified. Assuming an existing key at the default location.")
 	} else {
 		log.Info("Importing SSH key...")
 		// TODO: validate the key is a valid key