New navigation for 1.10 Release

Removing unneeded processing script

Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
Mary Anthony 2016-01-24 13:09:31 -08:00
parent 9e83c68f1b
commit 338a987699
11 changed files with 137 additions and 177 deletions

View File

@ -62,7 +62,7 @@ The top of each Docker machine documentation file contains TOML metadata. The me
description = "How to use Docker machine's extends keyword to share configuration between files and projects" description = "How to use Docker machine's extends keyword to share configuration between files and projects"
keywords = ["fig, composition, machine, docker, orchestration, documentation, docs"] keywords = ["fig, composition, machine, docker, orchestration, documentation, docs"]
[menu.main] [menu.main]
parent="smn_workw_machine" parent="workw_machine"
weight=2 weight=2
+++ +++
<![end-metadata]--> <![end-metadata]-->
@ -74,7 +74,7 @@ The metadata alone has this structure:
description = "How to use Docker machine's extends keyword to share configuration between files and projects" description = "How to use Docker machine's extends keyword to share configuration between files and projects"
keywords = ["fig, composition, machine, docker, orchestration, documentation, docs"] keywords = ["fig, composition, machine, docker, orchestration, documentation, docs"]
[menu.main] [menu.main]
parent="smn_workw_machine" parent="workw_machine"
weight=2 weight=2
+++ +++

View File

@ -4,8 +4,9 @@ title = "Command-line Completion"
description = "Install Machine command-line completion" description = "Install Machine command-line completion"
keywords = ["machine, docker, orchestration, cli, reference"] keywords = ["machine, docker, orchestration, cli, reference"]
[menu.main] [menu.main]
parent="smn_workw_machine" identifier="machine_completion"
weight=10 parent="workw_machine"
weight=99
+++ +++
<![end-metadata]--> <![end-metadata]-->

View File

@ -4,8 +4,9 @@ title = "Drivers"
description = "Reference for drivers Docker Machine supports" description = "Reference for drivers Docker Machine supports"
keywords = ["machine, drivers, supports"] keywords = ["machine, drivers, supports"]
[menu.main] [menu.main]
parent="smn_machine_ref" parent="workw_machine"
identifier="smn_machine_drivers" identifier="smn_machine_drivers"
weight=90
+++ +++
<![end-metadata]--> <![end-metadata]-->

View File

@ -1,15 +1,15 @@
<!--[metadata]> <!--[metadata]>
+++ +++
title = "Using Docker Machine with a cloud provider" title = "Use Machine with a cloud provider"
description = "Using Docker Machine with a cloud provider" description = "Using Docker Machine with a cloud provider"
keywords = ["docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale"] keywords = ["docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale"]
[menu.main] [menu.main]
parent="smn_workw_machine" parent="workw_machine"
weight=2 weight=2
+++ +++
<![end-metadata]--> <![end-metadata]-->
## Using Docker Machine with a cloud provider ## Use Docker Machine with a cloud provider
Creating a local virtual machine running Docker is useful and fun, but it isn't the only thing Docker Machine can do. Docker Machine supports several Creating a local virtual machine running Docker is useful and fun, but it isn't the only thing Docker Machine can do. Docker Machine supports several
“drivers” which let you use the same interface to create hosts on many different “drivers” which let you use the same interface to create hosts on many different

View File

@ -1,10 +1,10 @@
<!--[metadata]> <!--[metadata]>
+++ +++
title = "Get started with Docker Machine and a local VM" title = "Get started with Machine and a local VM"
description = "Get started with Docker Machine and a local VM" description = "Get started with Docker Machine and a local VM"
keywords = ["docker, machine, virtualbox, local"] keywords = ["docker, machine, virtualbox, local"]
[menu.main] [menu.main]
parent="smn_workw_machine" parent="workw_machine"
weight=1 weight=1
+++ +++
<![end-metadata]--> <![end-metadata]-->

View File

@ -1,111 +1,16 @@
<!--[metadata]> <!--[metadata]>
+++ +++
title = "Overview of Docker Machine" title = "Machine"
description = "Introduction and Overview of Machine" description = "Introduction and Overview of Machine"
keywords = ["docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale"] keywords = ["docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale"]
[menu.main] [menu.main]
parent="smn_workw_machine" identifier="workw_machine"
+++ +++
<![end-metadata]--> <![end-metadata]-->
# Docker Machine # Docker Machine
Machine lets you create Docker hosts on your computer, on cloud providers, and -
inside your own data center. It automatically creates hosts, installs Docker on
them, then configures the `docker` client to talk to them. A "machine" is the
combination of a Docker host and a configured client.
Once you create one or more Docker hosts, Docker Machine supplies a number of
commands for managing them. Using these commands you can
- start, inspect, stop, and restart a host
- upgrade the Docker client and daemon
- configure a Docker client to talk to your host
### Looking for the installation docs?
For Windows or Mac, you can obtain Docker Machine by installing the [Docker
Toolbox](https://www.docker.com/toolbox). To read instructions for installing
Machine on Linux or for installing Machine alone without Docker Toolbox, see the
[Machine installation instructions](install-machine.md).
## Understand Docker Machine basic concepts
Docker Machine allows you to provision Docker on virtual machines that reside
either on your local system or on a cloud provider. Docker Machine creates a
host on a VM and you use the Docker Engine client as needed to build images and
create containers on the host.
To create a virtual machine, you supply Docker Machine with the name of the
driver you want use. The driver represents the virtual environment. For example,
on a local Linux, Mac, or Windows system the driver is typically Oracle Virtual
Box. For cloud providers, Docker Machine supports drivers such as AWS, Microsoft
Azure, Digital Ocean and many more. The Docker Machine reference includes a
complete [list of the supported drivers](drivers/index.md).
Since Docker runs on Linux, each VM that Docker Machine provisions relies on a
base operating system. For convenience, there are default base operating
systems. For the Oracle Virtual Box driver, this base operating system is the
`boot2docker.iso`. For drivers used to connect to cloud providers, the base
operating system is Ubuntu 12.04+. You can change this default when you create a
machine. The Docker Machine reference includes a complete [list of the supported
operating systems](drivers/os-base.md).
For each machine you create, the Docker host address is the IP address of the
Linux VM. This address is assigned by the `docker-machine create` subcommand.
You use the `docker-machine ls` command to list the machines you have created.
The `docker-machine ip <machine-name>` command returns a specific host's IP
address.
Before you can run a `docker` command on a machine, you configure your
command-line to point to that machine. The `docker-machine env <machine-name>`
subcommand outputs the configuration command you should use. When you run a
container on the Docker host, the container's ports map to ports on the VM.
For a complete list of the `docker-machine` subcommands, see the [Docker Machine
subcommand reference](reference/index.md).
## Crash Reporting
Provisioning a host is a complex matter that can fail for a lot of reasons.
Your workstation may have a wide variety of shell, network configuration, VPN,
proxy or firewall issues. There are also reasons from the other end of the
chain: your cloud provider or the network in between.
To help `docker-machine` be as stable as possible, we added a monitoring of
crashes whenever you try to `create` or `upgrade` a host. This will send, over
HTTPS, to Bugsnag some information about your `docker-machine` version, build,
OS, ARCH, the path to your current shell and, the history of the last command as
you could see it with a `--debug` option. This data is sent to help us pinpoint
recurring issues with `docker-machine` and will only be transmitted in the case
of a crash of `docker-machine`.
If you wish to opt out of error reporting, you can create a `no-error-report`
file in your `$HOME/.docker/machine` directory, and Docker Machine will disable
this behavior. e.g.:
$ mkdir -p ~/.docker/machine && touch ~/.docker/machine/no-error-report
Leaving the file empty is fine -- Docker Machine just checks for its presence.
## Getting help
Docker Machine is still in its infancy and under active development. If you need
help, would like to contribute, or simply want to talk about the project with
like-minded individuals, we have a number of open channels for communication.
- To report bugs or file feature requests: please use the [issue tracker on
Github](https://github.com/docker/machine/issues).
- To talk about the project with people in real time: please join the
`#docker-machine` channel on IRC.
- To contribute code or documentation changes: please [submit a pull request on
Github](https://github.com/docker/machine/pulls).
For more information and resources, please visit
[our help page](https://docs.docker.com/project/get-help/).
## Where to go next
- Install a machine on your [local system using VirtualBox](get-started.md). - Install a machine on your [local system using VirtualBox](get-started.md).
- Install multiple machines [on your cloud provider](get-started-cloud.md). - Install multiple machines [on your cloud provider](get-started-cloud.md).
- [Docker Machine driver reference](drivers/index.md) - [Docker Machine driver reference](drivers/index.md)

View File

@ -1,11 +1,11 @@
<!--[metadata]> <!--[metadata]>
+++ +++
title = "Docker Machine" title = "Install Machine"
description = "How to install Docker Machine" description = "How to install Docker Machine"
keywords = ["machine, orchestration, install, installation, docker, documentation"] keywords = ["machine, orchestration, install, installation, docker, documentation"]
[menu.main] [menu.main]
parent="mn_install" parent="workw_machine"
weight=3 weight=-80
+++ +++
<![end-metadata]--> <![end-metadata]-->

View File

@ -1,10 +1,10 @@
<!--[metadata]> <!--[metadata]>
+++ +++
title = "Migrate from Boot2Docker to Docker Machine" title = "Migrate from Boot2Docker to Machine"
description = "Migrate from Boot2Docker to Docker Machine" description = "Migrate from Boot2Docker to Docker Machine"
keywords = ["machine, commands, boot2docker, migrate, docker"] keywords = ["machine, commands, boot2docker, migrate, docker"]
[menu.main] [menu.main]
parent="smn_workw_machine" parent="workw_machine"
weight=4 weight=4
+++ +++
<![end-metadata]--> <![end-metadata]-->

113
docs/overview.md Normal file
View File

@ -0,0 +1,113 @@
<!--[metadata]>
+++
title = "Overview of Machine"
description = "Introduction and Overview of Machine"
keywords = ["docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale"]
[menu.main]
parent="workw_machine"
weight=-90
+++
<![end-metadata]-->
# Overview of Docker Machine
Machine lets you create Docker hosts on your computer, on cloud providers, and
inside your own data center. It automatically creates hosts, installs Docker on
them, then configures the `docker` client to talk to them. A "machine" is the
combination of a Docker host and a configured client.
Once you create one or more Docker hosts, Docker Machine supplies a number of
commands for managing them. Using these commands you can
- start, inspect, stop, and restart a host
- upgrade the Docker client and daemon
- configure a Docker client to talk to your host
### Looking for the installation docs?
For Windows or Mac, you can obtain Docker Machine by installing the [Docker
Toolbox](https://www.docker.com/toolbox). To read instructions for installing
Machine on Linux or for installing Machine alone without Docker Toolbox, see the
[Machine installation instructions](install-machine.md).
## Understand Docker Machine basic concepts
Docker Machine allows you to provision Docker on virtual machines that reside
either on your local system or on a cloud provider. Docker Machine creates a
host on a VM and you use the Docker Engine client as needed to build images and
create containers on the host.
To create a virtual machine, you supply Docker Machine with the name of the
driver you want use. The driver represents the virtual environment. For example,
on a local Linux, Mac, or Windows system the driver is typically Oracle Virtual
Box. For cloud providers, Docker Machine supports drivers such as AWS, Microsoft
Azure, Digital Ocean and many more. The Docker Machine reference includes a
complete [list of the supported drivers](drivers/index.md).
Since Docker runs on Linux, each VM that Docker Machine provisions relies on a
base operating system. For convenience, there are default base operating
systems. For the Oracle Virtual Box driver, this base operating system is the
`boot2docker.iso`. For drivers used to connect to cloud providers, the base
operating system is Ubuntu 12.04+. You can change this default when you create a
machine. The Docker Machine reference includes a complete [list of the supported
operating systems](drivers/os-base.md).
For each machine you create, the Docker host address is the IP address of the
Linux VM. This address is assigned by the `docker-machine create` subcommand.
You use the `docker-machine ls` command to list the machines you have created.
The `docker-machine ip <machine-name>` command returns a specific host's IP
address.
Before you can run a `docker` command on a machine, you configure your
command-line to point to that machine. The `docker-machine env <machine-name>`
subcommand outputs the configuration command you should use. When you run a
container on the Docker host, the container's ports map to ports on the VM.
For a complete list of the `docker-machine` subcommands, see the [Docker Machine
subcommand reference](reference/index.md).
## Crash Reporting
Provisioning a host is a complex matter that can fail for a lot of reasons.
Your workstation may have a wide variety of shell, network configuration, VPN,
proxy or firewall issues. There are also reasons from the other end of the
chain: your cloud provider or the network in between.
To help `docker-machine` be as stable as possible, we added a monitoring of
crashes whenever you try to `create` or `upgrade` a host. This will send, over
HTTPS, to Bugsnag some information about your `docker-machine` version, build,
OS, ARCH, the path to your current shell and, the history of the last command as
you could see it with a `--debug` option. This data is sent to help us pinpoint
recurring issues with `docker-machine` and will only be transmitted in the case
of a crash of `docker-machine`.
If you wish to opt out of error reporting, you can create a `no-error-report`
file in your `$HOME/.docker/machine` directory, and Docker Machine will disable
this behavior. e.g.:
$ mkdir -p ~/.docker/machine && touch ~/.docker/machine/no-error-report
Leaving the file empty is fine -- Docker Machine just checks for its presence.
## Getting help
Docker Machine is still in its infancy and under active development. If you need
help, would like to contribute, or simply want to talk about the project with
like-minded individuals, we have a number of open channels for communication.
- To report bugs or file feature requests: please use the [issue tracker on
Github](https://github.com/docker/machine/issues).
- To talk about the project with people in real time: please join the
`#docker-machine` channel on IRC.
- To contribute code or documentation changes: please [submit a pull request on
Github](https://github.com/docker/machine/pulls).
For more information and resources, please visit
[our help page](https://docs.docker.com/project/get-help/).
## Where to go next
- Install a machine on your [local system using VirtualBox](get-started.md).
- Install multiple machines [on your cloud provider](get-started-cloud.md).
- [Docker Machine driver reference](drivers/index.md)
- [Docker Machine subcommand reference](reference/index.md)

View File

@ -1,61 +0,0 @@
#!/bin/bash -e
# Populate an array with just docker dirs and one with content dirs
docker_dir=(`ls -d /docs/content/docker/*`)
content_dir=(`ls -d /docs/content/*`)
# Loop content not of docker/
#
# Sed to process GitHub Markdown
# 1-2 Remove comment code from metadata block
# 3 Remove .md extension from link text
# 4 Change ](/ to ](/project/ in links
# 5 Change ](word) to ](/project/word)
# 6 Change ](../../ to ](/project/
# 7 Change ](../ to ](/project/word)
#
for i in "${content_dir[@]}"
do
:
case $i in
"/docs/content/windows")
;;
"/docs/content/mac")
;;
"/docs/content/linux")
;;
"/docs/content/docker")
y=${i##*/}
find $i -type f -name "*.md" -exec sed -i.old \
-e '/^<!.*metadata]>/g' \
-e '/^<!.*end-metadata.*>/g' {} \;
;;
*)
y=${i##*/}
find $i -type f -name "*.md" -exec sed -i.old \
-e '/^<!.*metadata]>/g' \
-e '/^<!.*end-metadata.*>/g' \
-e 's/\(\]\)\([(]\)\(\/\)/\1\2\/'$y'\//g' \
-e 's/\(\][(]\)\([A-z].*\)\(\.md\)/\1\/'$y'\/\2/g' \
-e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \
-e 's/\(\][(]\)\(\.\/\)/\1\/'$y'\//g' \
-e 's/\(\][(]\)\(\.\.\/\.\.\/\)/\1\/'$y'\//g' \
-e 's/\(\][(]\)\(\.\.\/\)/\1\/'$y'\//g' {} \;
;;
esac
done
#
# Move docker directories to content
#
for i in "${docker_dir[@]}"
do
:
if [ -d $i ]
then
mv $i /docs/content/
fi
done
rm -rf /docs/content/docker

View File

@ -1,15 +1,16 @@
<!--[metadata]> <!--[metadata]>
+++ +++
title = "Subcommands" title = "Command line reference"
description = "Docker Machine Commands Overview" description = "Docker Machine Commands Overview"
keywords = ["machine, commands"] keywords = ["machine, commands"]
[menu.main] [menu.main]
identifier="smn_machine_subcmds" identifier="smn_machine_subcmds"
parent="smn_machine_ref" parent="workw_machine"
weight=80
+++ +++
<![end-metadata]--> <![end-metadata]-->
# Supported Docker Machine subcommands # Docker Machine command line reference
- [active](active.md) - [active](active.md)
- [config](config.md) - [config](config.md)