Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix type of keywords entry in frontmatter (in /machine/ and index.md) #556

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
description: Home page for Docker's documentation
keywords:
- Docker, documentation, manual, guide, reference, api
title: Welcome to the Docs
keywords: Docker, documentation, manual, guide, reference, api
layout: docs
title: Welcome to the Docs
---

{% include content/docker_elevator_pitch.md %}
Expand Down Expand Up @@ -140,4 +139,4 @@ layout: docs
</div>
</li>
</ul>
</section>
</section>
5 changes: 2 additions & 3 deletions machine/DRIVER_SPEC.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
description: machine
keywords: machine, orchestration, install, installation, docker, documentation
published: false
keywords:
- machine, orchestration, install, installation, docker, documentation
title: Machine driver specification v1
---

Expand Down Expand Up @@ -141,4 +140,4 @@ a `GetCreateFlags` func. For example:
## Examples

You can reference the existing [Drivers](https://github.com/docker/machine/tree/master/drivers)
as well.
as well.
5 changes: 2 additions & 3 deletions machine/completion.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Install Machine command-line completion
keywords:
- machine, docker, orchestration, cli, reference
keywords: machine, docker, orchestration, cli, reference
title: Command-line completion
---

Expand Down Expand Up @@ -49,4 +48,4 @@ Then reload your shell
## Available completions

**TODO**
<![end-metadata]-->
<![end-metadata]-->
5 changes: 2 additions & 3 deletions machine/concepts.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Understand concepts for Docker Machine, including drivers, base OS, IP addresses, environment variables
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
title: Machine concepts and getting help
---

Expand Down Expand Up @@ -94,4 +93,4 @@ For more information and resources, please visit
- 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)
- <a href="../drivers/" target="_blank">Docker Machine driver reference</a>
- <a href="../reference/" target="_blank">Docker Machine subcommand reference</a>
- <a href="../reference/" target="_blank">Docker Machine subcommand reference</a>
5 changes: 2 additions & 3 deletions machine/drivers/aws.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Amazon Web Services driver for machine
keywords:
- machine, Amazon Web Services, driver
keywords: machine, Amazon Web Services, driver
title: Amazon Web Services
---

Expand Down Expand Up @@ -160,4 +159,4 @@ The default SSH username for the default AMIs is `ubuntu`.

You need to change the SSH username only if the custom AMI you use has a different SSH username.

You can change the SSH username with the `--amazonec2-ssh-user` according to the AMI you selected with the `--amazonec2-ami`.
You can change the SSH username with the `--amazonec2-ssh-user` according to the AMI you selected with the `--amazonec2-ami`.
5 changes: 2 additions & 3 deletions machine/drivers/azure.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Microsoft Azure driver for machine
keywords:
- machine, Microsoft Azure, driver
keywords: machine, Microsoft Azure, driver
title: Microsoft Azure
---

Expand Down Expand Up @@ -117,4 +116,4 @@ rules and open ports of the machine from the [Azure Portal][portal].

[arm]: https://azure.microsoft.com/en-us/documentation/articles/resource-group-overview/
[nsg]: https://azure.microsoft.com/en-us/documentation/articles/virtual-networks-nsg/
[portal]: https://portal.azure.com/
[portal]: https://portal.azure.com/
5 changes: 2 additions & 3 deletions machine/drivers/digital-ocean.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Digital Ocean driver for machine
keywords:
- machine, Digital Ocean, driver
keywords: machine, Digital Ocean, driver
title: Digital Ocean
---

Expand Down Expand Up @@ -44,4 +43,4 @@ The DigitalOcean driver will use `ubuntu-15-10-x64` as the default image.
| `--digitalocean-userdata` | `DIGITALOCEAN_USERDATA` | - |
| `--digitalocean-ssh-user` | `DIGITALOCEAN_SSH_USER` | `root` |
| `--digitalocean-ssh-port` | `DIGITALOCEAN_SSH_PORT` | 22 |
| `--digitalocean-ssh-key-fingerprint`| `DIGITALOCEAN_SSH_KEY_FINGERPRINT`| - |
| `--digitalocean-ssh-key-fingerprint`| `DIGITALOCEAN_SSH_KEY_FINGERPRINT`| - |
5 changes: 2 additions & 3 deletions machine/drivers/exoscale.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Exoscale driver for machine
keywords:
- machine, exoscale, driver
keywords: machine, exoscale, driver
title: Exoscale
---

Expand Down Expand Up @@ -45,4 +44,4 @@ There is a limit to the number of docker machines that an anti-affinity group ca
| `--exoscale-availability-zone` | `EXOSCALE_AVAILABILITY_ZONE` | `ch-dk-2` |
| `--exoscale-ssh-user` | `EXOSCALE_SSH_USER` | `ubuntu` |
| `--exoscale-userdata` | `EXOSCALE_USERDATA` | - |
| `--exoscale-affinity-group` | `EXOSCALE_AFFINITY_GROUP` | `docker-machine` |
| `--exoscale-affinity-group` | `EXOSCALE_AFFINITY_GROUP` | `docker-machine` |
5 changes: 2 additions & 3 deletions machine/drivers/gce.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Google Compute Engine driver for machine
keywords:
- machine, Google Compute Engine, driver
keywords: machine, Google Compute Engine, driver
title: Google Compute Engine
---

Expand Down Expand Up @@ -69,4 +68,4 @@ list of image URLs run:
| `--google-preemptible` | `GOOGLE_PREEMPTIBLE` | - |
| `--google-tags` | `GOOGLE_TAGS` | - |
| `--google-use-internal-ip` | `GOOGLE_USE_INTERNAL_IP` | - |
| `--google-use-existing` | `GOOGLE_USE_EXISTING` | - |
| `--google-use-existing` | `GOOGLE_USE_EXISTING` | - |
5 changes: 2 additions & 3 deletions machine/drivers/generic.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Generic driver for machine
keywords:
- machine, Generic, driver
keywords: machine, Generic, driver
title: Generic
---

Expand Down Expand Up @@ -57,4 +56,4 @@ as a sudoer with `NOPASSWD`. See https://help.ubuntu.com/community/Sudoers.
| **`--generic-ip-address`** | `GENERIC_IP_ADDRESS` | - |
| `--generic-ssh-key` | `GENERIC_SSH_KEY` | - |
| `--generic-ssh-user` | `GENERIC_SSH_USER` | `root` |
| `--generic-ssh-port` | `GENERIC_SSH_PORT` | `22` |
| `--generic-ssh-port` | `GENERIC_SSH_PORT` | `22` |
5 changes: 2 additions & 3 deletions machine/drivers/hyper-v.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Microsoft Hyper-V driver for machine
keywords:
- machine, Microsoft Hyper-V, driver
keywords: machine, Microsoft Hyper-V, driver
title: Microsoft Hyper-V
---

Expand Down Expand Up @@ -131,4 +130,4 @@ you can create these swarm nodes: `manager1`, `worker1`, `worker2`.
```shell
docker-machine create -d hyperv --hyperv-virtual-switch "Primary Virtual Switch" worker1
docker-machine create -d hyperv --hyperv-virtual-switch "Primary Virtual Switch" worker2
```
```
5 changes: 2 additions & 3 deletions machine/drivers/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Reference for drivers Docker Machine supports
keywords:
- machine, drivers, supports
keywords: machine, drivers, supports
title: Drivers
---

Expand All @@ -18,4 +17,4 @@ title: Drivers
- [Oracle VirtualBox](virtualbox.md)
- [VMware vCloud Air](vm-cloud.md)
- [VMware Fusion](vm-fusion.md)
- [VMware vSphere](vsphere.md)
- [VMware vSphere](vsphere.md)
5 changes: 2 additions & 3 deletions machine/drivers/openstack.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: OpenStack driver for machine
keywords:
- machine, OpenStack, driver
keywords: machine, OpenStack, driver
title: OpenStack
---

Expand Down Expand Up @@ -69,4 +68,4 @@ Mandatory:
| `--openstack-ssh-user` | `OS_SSH_USER` | `root` |
| `--openstack-tenant-id` | `OS_TENANT_ID` | - |
| `--openstack-tenant-name` | `OS_TENANT_NAME` | - |
| `--openstack-username` | `OS_USERNAME` | - |
| `--openstack-username` | `OS_USERNAME` | - |
5 changes: 2 additions & 3 deletions machine/drivers/os-base.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Identify active machines
keywords:
- machine, driver, base, operating system
keywords: machine, driver, base, operating system
title: Driver options and operating system defaults
---

Expand Down Expand Up @@ -48,4 +47,4 @@ provider's image flag and one of its available images. For example, to select a
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`.
`--amazonec2-ssh-user ec2-user`.
5 changes: 2 additions & 3 deletions machine/drivers/rackspace.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Rackspace driver for machine
keywords:
- machine, Rackspace, driver
keywords: machine, Rackspace, driver
title: Rackspace
---

Expand Down Expand Up @@ -37,4 +36,4 @@ The Rackspace driver will use `59a3fadd-93e7-4674-886a-64883e17115f` (Ubuntu 15.
| `--rackspace-flavor-id` | `OS_FLAVOR_ID` | `general1-1` |
| `--rackspace-ssh-user` | - | `root` |
| `--rackspace-ssh-port` | - | `22` |
| `--rackspace-docker-install` | - | `true` |
| `--rackspace-docker-install` | - | `true` |
5 changes: 2 additions & 3 deletions machine/drivers/soft-layer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: IBM Softlayer driver for machine
keywords:
- machine, IBM Softlayer, driver
keywords: machine, IBM Softlayer, driver
title: IBM Softlayer
---

Expand Down Expand Up @@ -52,4 +51,4 @@ The SoftLayer driver will use `UBUNTU_LATEST` as the image type by default.
| `--softlayer-private-net-only` | `SOFTLAYER_PRIVATE_NET` | `false` |
| `--softlayer-image` | `SOFTLAYER_IMAGE` | `UBUNTU_LATEST` |
| `--softlayer-public-vlan-id` | `SOFTLAYER_PUBLIC_VLAN_ID` | `0` |
| `--softlayer-private-vlan-id` | `SOFTLAYER_PRIVATE_VLAN_ID` | `0` |
| `--softlayer-private-vlan-id` | `SOFTLAYER_PRIVATE_VLAN_ID` | `0` |
5 changes: 2 additions & 3 deletions machine/drivers/virtualbox.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Oracle VirtualBox driver for machine
keywords:
- machine, Oracle VirtualBox, driver
keywords: machine, Oracle VirtualBox, driver
title: Oracle VirtualBox
---

Expand Down Expand Up @@ -90,4 +89,4 @@ contents.

This will often cause problems when using a web server such as nginx to serve
static files from a shared volume. For development environments, a good
workaround is to disable sendfile in your server configuration.
workaround is to disable sendfile in your server configuration.
5 changes: 2 additions & 3 deletions machine/drivers/vm-cloud.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: VMware vCloud Air driver for machine
keywords:
- machine, VMware vCloud Air, driver
keywords: machine, VMware vCloud Air, driver
title: VMware vCloud Air
---

Expand Down Expand Up @@ -47,4 +46,4 @@ The VMware vCloud Air driver will use the `Ubuntu Server 12.04 LTS (amd64 201409
| `--vmwarevcloudair-cpu-count` | `VCLOUDAIR_CPU_COUNT` | `1` |
| `--vmwarevcloudair-memory-size` | `VCLOUDAIR_MEMORY_SIZE` | `2048` |
| `--vmwarevcloudair-ssh-port` | `VCLOUDAIR_SSH_PORT` | `22` |
| `--vmwarevcloudair-docker-port` | `VCLOUDAIR_DOCKER_PORT` | `2376` |
| `--vmwarevcloudair-docker-port` | `VCLOUDAIR_DOCKER_PORT` | `2376` |
5 changes: 2 additions & 3 deletions machine/drivers/vm-fusion.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: VMware Fusion driver for machine
keywords:
- machine, VMware Fusion, driver
keywords: machine, VMware Fusion, driver
title: VMware Fusion
---

Expand Down Expand Up @@ -30,4 +29,4 @@ See [frapposelli/boot2docker](https://github.com/frapposelli/boot2docker/tree/vm
| `--vmwarefusion-cpu-count` | `FUSION_CPU_COUNT` | `1` |
| `--vmwarefusion-disk-size` | `FUSION_DISK_SIZE` | `20000` |
| `--vmwarefusion-memory-size` | `FUSION_MEMORY_SIZE` | `1024` |
| `--vmwarefusion-no-share` | `FUSION_NO_SHARE` | `false` |
| `--vmwarefusion-no-share` | `FUSION_NO_SHARE` | `false` |
5 changes: 2 additions & 3 deletions machine/drivers/vsphere.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: VMware vSphere driver for machine
keywords:
- machine, VMware vSphere, driver
keywords: machine, VMware vSphere, driver
title: VMware vSphere
---

Expand Down Expand Up @@ -45,4 +44,4 @@ The VMware vSphere driver uses the latest boot2docker image.
| `--vmwarevsphere-datastore` | `VSPHERE_DATASTORE` | - |
| `--vmwarevsphere-datacenter` | `VSPHERE_DATACENTER` | - |
| `--vmwarevsphere-pool` | `VSPHERE_POOL` | - |
| `--vmwarevsphere-hostsystem` | `VSPHERE_HOSTSYSTEM` | - |
| `--vmwarevsphere-hostsystem` | `VSPHERE_HOSTSYSTEM` | - |
5 changes: 2 additions & 3 deletions machine/examples/aws.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Using Docker Machine to provision hosts on AWS
keywords:
- docker, machine, cloud, aws
keywords: docker, machine, cloud, aws
title: Amazon Web Services (AWS) EC2 example
---

Expand Down Expand Up @@ -123,4 +122,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](/swarm/provision-with-machine.md)
- [Provision a Docker Swarm cluster with Docker Machine](/swarm/provision-with-machine.md)
5 changes: 2 additions & 3 deletions machine/examples/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
description: Examples of cloud installs
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
title: Learn by example
---

- [Digital Ocean Example](ocean.md)
- [AWS Example](aws.md)
- [AWS Example](aws.md)
5 changes: 2 additions & 3 deletions machine/examples/ocean.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Using Docker Machine to provision hosts on Digital Ocean
keywords:
- docker, machine, cloud, digital ocean
keywords: docker, machine, cloud, digital ocean
title: Digital Ocean example
---

Expand Down Expand Up @@ -137,4 +136,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](/swarm/provision-with-machine.md)
- [Provision a Docker Swarm cluster with Docker Machine](/swarm/provision-with-machine.md)
5 changes: 2 additions & 3 deletions machine/get-started-cloud.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Using Docker Machine to provision hosts on cloud providers
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
title: Use Docker Machine to provision hosts on cloud providers
---

Expand Down Expand Up @@ -78,4 +77,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](/swarm/provision-with-machine.md)
- [Provision a Docker Swarm cluster with Docker Machine](/swarm/provision-with-machine.md)
Loading