From 2ead7d5dd3ccfaaf2f7d27bb0e830fb28ca9df37 Mon Sep 17 00:00:00 2001 From: Martijn van Calker Date: Tue, 26 Dec 2017 21:51:27 +0100 Subject: [PATCH] docs: Sort lists and tables ASC (#5600) --- machine/drivers/azure.md | 36 +++++++++++------------ machine/drivers/digital-ocean.md | 24 +++++++-------- machine/drivers/exoscale.md | 16 +++++----- machine/drivers/gce.md | 50 ++++++++++++++++---------------- machine/drivers/hyper-v.md | 4 +-- machine/drivers/rackspace.md | 24 +++++++-------- machine/drivers/soft-layer.md | 34 +++++++++++----------- machine/drivers/virtualbox.md | 24 +++++++-------- machine/drivers/vm-cloud.md | 36 +++++++++++------------ machine/drivers/vsphere.md | 36 +++++++++++------------ 10 files changed, 142 insertions(+), 142 deletions(-) diff --git a/machine/drivers/azure.md b/machine/drivers/azure.md index 6367e9e3eac..190fe8b7573 100644 --- a/machine/drivers/azure.md +++ b/machine/drivers/azure.md @@ -46,23 +46,23 @@ Required: Optional: +- `--azure-availability-set`: Azure Availability Set to place the virtual machine into. [[?][av-set]] +- `--azure-docker-port`: Port number for Docker engine. +- `--azure-environment`: Azure environment (e.g. `AzurePublicCloud`, `AzureChinaCloud`). - `--azure-image`: Azure virtual machine image in the format of Publisher:Offer:Sku:Version [[?][vm-image]] - `--azure-location`: Azure region to create the virtual machine. [[?][location]] +- `--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-open-port`: Make additional port number(s) accessible from the Internet [[?][nsg]] +- `--azure-private-ip-address`: Specify a static private IP address for the machine. - `--azure-resource-group`: Azure Resource Group name to create the resources in. - `--azure-size`: Size for Azure Virtual Machine. [[?][vm-size]] - `--azure-ssh-user`: Username for SSH login. -- `--azure-vnet`: Azure Virtual Network name to connect the virtual machine. - [[?][vnet]] To specify a Virtual Network from another resource group, use `resourcegroup:vnet-name` format. +- `--azure-static-public-ip`: Assign a static public IP address to the machine. - `--azure-subnet`: Azure Subnet Name to be used within the Virtual Network. - `--azure-subnet-prefix`: Private CIDR block. Used to create subnet if it does not exist. Must match in the case that the subnet does exist. -- `--azure-availability-set`: Azure Availability Set to place the virtual machine into. [[?][av-set]] -- `--azure-open-port`: Make additional port number(s) accessible from the Internet [[?][nsg]] -- `--azure-private-ip-address`: Specify a static private IP address for the machine. - `--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-environment`: Azure environment (e.g. `AzurePublicCloud`, `AzureChinaCloud`). +- `--azure-vnet`: Azure Virtual Network name to connect the virtual machine. + [[?][vnet]] To specify a Virtual Network from another resource group, use `resourcegroup:vnet-name` format. [vm-image]: https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/ [location]: https://azure.microsoft.com/en-us/regions/ @@ -74,23 +74,23 @@ Optional: | CLI option | Environment variable | Default | | ------------------------------- | ----------------------------- | ------------------ | -| **`--azure-subscription-id`** | `AZURE_SUBSCRIPTION_ID` | - | +| `--azure-availability-set` | `AZURE_AVAILABILITY_SET` | `docker-machine` | +| `--azure-docker-port` | `AZURE_DOCKER_PORT` | `2376` | | `--azure-environment` | `AZURE_ENVIRONMENT` | `AzurePublicCloud` | | `--azure-image` | `AZURE_IMAGE` | `canonical:UbuntuServer:16.04.0-LTS:latest` | | `--azure-location` | `AZURE_LOCATION` | `westus` | +| `--azure-no-public-ip` | - | - | +| `--azure-open-port` | - | - | +| `--azure-private-ip-address` | - | - | | `--azure-resource-group` | `AZURE_RESOURCE_GROUP` | `docker-machine` | | `--azure-size` | `AZURE_SIZE` | `Standard_A2` | | `--azure-ssh-user` | `AZURE_SSH_USER` | `docker-user` | -| `--azure-vnet` | `AZURE_VNET` | `docker-machine` | -| `--azure-subnet` | `AZURE_SUBNET` | `docker-machine` | +| `--azure-static-public-ip` | - | - | | `--azure-subnet-prefix` | `AZURE_SUBNET_PREFIX` | `192.168.0.0/16` | -| `--azure-availability-set` | `AZURE_AVAILABILITY_SET` | `docker-machine` | -| `--azure-open-port` | - | - | -| `--azure-private-ip-address` | - | - | +| `--azure-subnet` | `AZURE_SUBNET` | `docker-machine` | +| **`--azure-subscription-id`** | `AZURE_SUBSCRIPTION_ID` | - | | `--azure-use-private-ip` | - | - | -| `--azure-no-public-ip` | - | - | -| `--azure-static-public-ip` | - | - | -| `--azure-docker-port` | `AZURE_DOCKER_PORT` | `2376` | +| `--azure-vnet` | `AZURE_VNET` | `docker-machine` | ## Notes diff --git a/machine/drivers/digital-ocean.md b/machine/drivers/digital-ocean.md index a1914a58837..1f9a905b282 100644 --- a/machine/drivers/digital-ocean.md +++ b/machine/drivers/digital-ocean.md @@ -27,17 +27,17 @@ Control Panel and pass that to `docker-machine create` with the `--digitalocean- ## Options - `--digitalocean-access-token`: **required**. Your personal access token for the Digital Ocean API. +- `--digitalocean-backups`: Enable Digital Ocean backups for the droplet. - `--digitalocean-image`: The name of the Digital Ocean image to use. -- `--digitalocean-region`: The region to create the droplet in, see [Regions API](https://developers.digitalocean.com/documentation/v2/#regions) for how to get a list. -- `--digitalocean-size`: The size of the Digital Ocean droplet (larger than default options are of the form `2gb`). - `--digitalocean-ipv6`: Enable IPv6 support for the droplet. - `--digitalocean-private-networking`: Enable private networking support for the droplet. -- `--digitalocean-backups`: Enable Digital Ocean backups for the droplet. -- `--digitalocean-userdata`: Path to file containing User Data for the droplet. -- `--digitalocean-ssh-user`: SSH username. -- `--digitalocean-ssh-port`: SSH port. +- `--digitalocean-region`: The region to create the droplet in, see [Regions API](https://developers.digitalocean.com/documentation/v2/#regions) for how to get a list. +- `--digitalocean-size`: The size of the Digital Ocean droplet (larger than default options are of the form `2gb`). - `--digitalocean-ssh-key-fingerprint`: Use an existing SSH key instead of creating a new one, see [SSH keys](https://developers.digitalocean.com/documentation/v2/#ssh-keys). +- `--digitalocean-ssh-port`: SSH port. +- `--digitalocean-ssh-user`: SSH username. - `--digitalocean-tags`: Comma-separated list of tags to apply to the Droplet, see [Droplet tagging](https://developers.digitalocean.com/documentation/v2/#tags) +- `--digitalocean-userdata`: Path to file containing User Data for the droplet. The DigitalOcean driver will use `ubuntu-16-04-x64` as the default image. @@ -46,14 +46,14 @@ The DigitalOcean driver will use `ubuntu-16-04-x64` as the default image. | CLI option | Environment variable | Default | | ----------------------------------- | --------------------------------- | ------------------ | | **`--digitalocean-access-token`** | `DIGITALOCEAN_ACCESS_TOKEN` | - | +| `--digitalocean-backups` | `DIGITALOCEAN_BACKUPS` | `false` | | `--digitalocean-image` | `DIGITALOCEAN_IMAGE` | `ubuntu-16-04-x64` | -| `--digitalocean-region` | `DIGITALOCEAN_REGION` | `nyc3` | -| `--digitalocean-size` | `DIGITALOCEAN_SIZE` | `512mb` | | `--digitalocean-ipv6` | `DIGITALOCEAN_IPV6` | `false` | | `--digitalocean-private-networking` | `DIGITALOCEAN_PRIVATE_NETWORKING` | `false` | -| `--digitalocean-backups` | `DIGITALOCEAN_BACKUPS` | `false` | -| `--digitalocean-userdata` | `DIGITALOCEAN_USERDATA` | - | -| `--digitalocean-ssh-user` | `DIGITALOCEAN_SSH_USER` | `root` | -| `--digitalocean-ssh-port` | `DIGITALOCEAN_SSH_PORT` | 22 | +| `--digitalocean-region` | `DIGITALOCEAN_REGION` | `nyc3` | +| `--digitalocean-size` | `DIGITALOCEAN_SIZE` | `512mb` | | `--digitalocean-ssh-key-fingerprint`| `DIGITALOCEAN_SSH_KEY_FINGERPRINT`| - | +| `--digitalocean-ssh-port` | `DIGITALOCEAN_SSH_PORT` | 22 | +| `--digitalocean-ssh-user` | `DIGITALOCEAN_SSH_USER` | `root` | | `--digitalocean-tags` | `DIGITALOCEAN_TAGS` | - | +| `--digitalocean-userdata` | `DIGITALOCEAN_USERDATA` | - | diff --git a/machine/drivers/exoscale.md b/machine/drivers/exoscale.md index 082028457ed..0b2d555444b 100644 --- a/machine/drivers/exoscale.md +++ b/machine/drivers/exoscale.md @@ -17,33 +17,33 @@ Get your API key and API secret key from [API details](https://portal.exoscale.c ## Options -- `--exoscale-url`: Your API endpoint; +- `--exoscale-affinity-group`: [Anti-affinity group][anti-affinity] the machine will be started in. - `--exoscale-api-key`: **required** Your API key; - `--exoscale-api-secret-key`: **required** Your API secret key; -- `--exoscale-instance-profile`: Instance profile (Small, Medium, Large, ...); +- `--exoscale-availability-zone`: Exoscale [availability zone][datacenters] (CH-DK-2, AT-VIE-1, DE-FRA-1, ...); - `--exoscale-disk-size`: Disk size for the host in GB (10, 50, 100, 200, 400); - `--exoscale-image`: Image template (e.g. `Linux Ubuntu 16.04 LTS 64-bit` also known as `ubuntu-16.04`, [see below](#image-template-name)); +- `--exoscale-instance-profile`: Instance profile (Small, Medium, Large, ...); - `--exoscale-security-group`: Security group. _It will be created if it doesn't exist_; -- `--exoscale-availability-zone`: Exoscale [availability zone][datacenters] (CH-DK-2, AT-VIE-1, DE-FRA-1, ...); - `--exoscale-ssh-user`: SSH username (e.g. `ubuntu`, [see below](#ssh-username)); +- `--exoscale-url`: Your API endpoint; - `--exoscale-userdata`: Path to file containing user data for [cloud-init](https://cloud-init.io/); -- `--exoscale-affinity-group`: [Anti-affinity group][anti-affinity] the machine will be started in. ### Environment variables and default values | CLI option | Environment variable | Default | | ------------------------------- | ---------------------------- | --------------------------------- | -| `--exoscale-url` | `EXOSCALE_ENDPOINT` | `https://api.exoscale.ch/compute` | +| `--exoscale-affinity-group` | `EXOSCALE_AFFINITY_GROUP` | - | | **`--exoscale-api-key`** | `EXOSCALE_API_KEY` | - | | **`--exoscale-api-secret-key`** | `EXOSCALE_API_SECRET` | - | -| `--exoscale-instance-profile` | `EXOSCALE_INSTANCE_PROFILE` | `small` | +| `--exoscale-availability-zone` | `EXOSCALE_AVAILABILITY_ZONE` | `ch-dk-2` | | `--exoscale-disk-size` | `EXOSCALE_DISK_SIZE` | `50` | | `--exoscale-image` | `EXOSCALE_IMAGE` | `Linux Ubuntu 16.04 LTS 64-bit` | +| `--exoscale-instance-profile` | `EXOSCALE_INSTANCE_PROFILE` | `small` | | `--exoscale-security-group` | `EXOSCALE_SECURITY_GROUP` | `docker-machine` | -| `--exoscale-availability-zone` | `EXOSCALE_AVAILABILITY_ZONE` | `ch-dk-2` | | `--exoscale-ssh-user` | `EXOSCALE_SSH_USER` | - | +| `--exoscale-url` | `EXOSCALE_ENDPOINT` | `https://api.exoscale.ch/compute` | | `--exoscale-userdata` | `EXOSCALE_USERDATA` | - | -| `--exoscale-affinity-group` | `EXOSCALE_AFFINITY_GROUP` | - | **NB:** the _instance profile_, _image_, and _availability zone_ are case insensitive. diff --git a/machine/drivers/gce.md b/machine/drivers/gce.md index 6abe5fb8ca8..2dd0316ba47 100644 --- a/machine/drivers/gce.md +++ b/machine/drivers/gce.md @@ -36,22 +36,22 @@ To create a machine instance, specify `--driver google`, the project ID and the ### Options - - `--google-project`: **required** The ID of your project to use when launching the instance. - - `--google-zone`: The zone to launch the instance. - - `--google-machine-type`: The type of instance. - - `--google-machine-image`: The absolute URL to a base VM image to instantiate. - - `--google-username`: The username to use for the instance. - - `--google-scopes`: The scopes for OAuth 2.0 to Access Google APIs. See [Google Compute Engine Doc](https://cloud.google.com/storage/docs/authentication). - - `--google-disk-size`: The disk size of instance. - - `--google-disk-type`: The disk type of instance. - - `--google-address`: Instance's static external IP (name or IP). - - `--google-network`: Specify network in which to provision VM. - - `--google-subnetwork`: Specify subnetwork in which to provision VM. - - `--google-preemptible`: Instance preemptibility. - - `--google-tags`: Instance tags (comma-separated). - - `--google-use-internal-ip`: When this option is used during create it will make docker-machine use internal rather than public NATed IPs. The flag is persistent in the sense that a machine created with it retains the IP. It's useful for managing docker machines from another machine on the same network e.g. while deploying swarm. - - `--google-use-internal-ip-only`: When this option is used during create, the new VM will not be assigned a public IP address. This is useful only when the host running `docker-machine` is located inside the Google Cloud infrastructure; otherwise, `docker-machine` can't reach the VM to provision the Docker daemon. The presence of this flag implies `--google-use-internal-ip`. - - `--google-use-existing`: Don't create a new VM, use an existing one. This is useful when you'd like to provision Docker on a VM you created yourself, maybe because it uses create options not supported by this driver. +- `--google-address`: Instance's static external IP (name or IP). +- `--google-disk-size`: The disk size of instance. +- `--google-disk-type`: The disk type of instance. +- `--google-machine-image`: The absolute URL to a base VM image to instantiate. +- `--google-machine-type`: The type of instance. +- `--google-network`: Specify network in which to provision VM. +- `--google-preemptible`: Instance preemptibility. +- `--google-project`: **required** The ID of your project to use when launching the instance. +- `--google-scopes`: The scopes for OAuth 2.0 to Access Google APIs. See [Google Compute Engine Doc](https://cloud.google.com/storage/docs/authentication). +- `--google-subnetwork`: Specify subnetwork in which to provision VM. +- `--google-tags`: Instance tags (comma-separated). +- `--google-use-existing`: Don't create a new VM, use an existing one. This is useful when you'd like to provision Docker on a VM you created yourself, maybe because it uses create options not supported by this driver. +- `--google-use-internal-ip-only`: When this option is used during create, the new VM will not be assigned a public IP address. This is useful only when the host running `docker-machine` is located inside the Google Cloud infrastructure; otherwise, `docker-machine` can't reach the VM to provision the Docker daemon. The presence of this flag implies `--google-use-internal-ip`. +- `--google-use-internal-ip`: When this option is used during create it will make docker-machine use internal rather than public NATed IPs. The flag is persistent in the sense that a machine created with it retains the IP. It's useful for managing docker machines from another machine on the same network e.g. while deploying swarm. +- `--google-username`: The username to use for the instance. +- `--google-zone`: The zone to launch the instance. The GCE driver will use the `ubuntu-1604-xenial-v20161130` instance image unless otherwise specified. To obtain a list of image URLs run: @@ -77,18 +77,18 @@ For example, to create an instance from the latest Ubuntu 16 LTS image, specify | CLI option | Environment variable | Default | |:---------------------------|:-------------------------|:-------------------------------------| -| **`--google-project`** | `GOOGLE_PROJECT` | - | -| `--google-zone` | `GOOGLE_ZONE` | `us-central1-a` | -| `--google-machine-type` | `GOOGLE_MACHINE_TYPE` | `f1-standard-1` | -| `--google-machine-image` | `GOOGLE_MACHINE_IMAGE` | `ubuntu-1510-wily-v20151114` | -| `--google-username` | `GOOGLE_USERNAME` | `docker-user` | -| `--google-scopes` | `GOOGLE_SCOPES` | `devstorage.read_only,logging.write` | +| `--google-address` | `GOOGLE_ADDRESS` | - | | `--google-disk-size` | `GOOGLE_DISK_SIZE` | `10` | | `--google-disk-type` | `GOOGLE_DISK_TYPE` | `pd-standard` | -| `--google-address` | `GOOGLE_ADDRESS` | - | +| `--google-machine-image` | `GOOGLE_MACHINE_IMAGE` | `ubuntu-1510-wily-v20151114` | +| `--google-machine-type` | `GOOGLE_MACHINE_TYPE` | `f1-standard-1` | | `--google-network` | `GOOGLE_NETWORK` | `default` | -| `--google-subnetwork` | `GOOGLE_SUBNETWORK` | - | | `--google-preemptible` | `GOOGLE_PREEMPTIBLE` | - | +| **`--google-project`** | `GOOGLE_PROJECT` | - | +| `--google-scopes` | `GOOGLE_SCOPES` | `devstorage.read_only,logging.write` | +| `--google-subnetwork` | `GOOGLE_SUBNETWORK` | - | | `--google-tags` | `GOOGLE_TAGS` | - | -| `--google-use-internal-ip` | `GOOGLE_USE_INTERNAL_IP` | - | | `--google-use-existing` | `GOOGLE_USE_EXISTING` | - | +| `--google-use-internal-ip` | `GOOGLE_USE_INTERNAL_IP` | - | +| `--google-username` | `GOOGLE_USERNAME` | `docker-user` | +| `--google-zone` | `GOOGLE_ZONE` | `us-central1-a` | diff --git a/machine/drivers/hyper-v.md b/machine/drivers/hyper-v.md index 141b2729aac..d4e48bfe73e 100644 --- a/machine/drivers/hyper-v.md +++ b/machine/drivers/hyper-v.md @@ -44,11 +44,11 @@ Hyper-V](https://msdn.microsoft.com/en-us/virtualization/hyperv_on_windows/quick | CLI option | Environment variable | Default | | ---------------------------- | -------------------------- | ------------------------ | | `--hyperv-boot2docker-url` | `HYPERV_BOOT2DOCKER_URL` | _Latest boot2docker url_ | -| `--hyperv-virtual-switch` | `HYPERV_VIRTUAL_SWITCH` | _first found_ | +| `--hyperv-cpu-count` | `HYPERV_CPU_COUNT` | `1` | | `--hyperv-disk-size` | `HYPERV_DISK_SIZE` | `20000` | | `--hyperv-memory` | `HYPERV_MEMORY` | `1024` | -| `--hyperv-cpu-count` | `HYPERV_CPU_COUNT` | `1` | | `--hyperv-static-macaddress` | `HYPERV_STATIC_MACADDRESS` | _undefined_ | +| `--hyperv-virtual-switch` | `HYPERV_VIRTUAL_SWITCH` | _first found_ | | `--hyperv-vlan-id` | `HYPERV_VLAN_ID` | _undefined_ | ## Example diff --git a/machine/drivers/rackspace.md b/machine/drivers/rackspace.md index ffb402fad8e..dde4b2ee7a6 100644 --- a/machine/drivers/rackspace.md +++ b/machine/drivers/rackspace.md @@ -12,16 +12,16 @@ Create machines on [Rackspace cloud](http://www.rackspace.com/cloud) ## Options -- `--rackspace-username`: **required** Rackspace account username. +- `--rackspace-active-timeout`: Rackspace active timeout - `--rackspace-api-key`: **required** Rackspace API key. -- `--rackspace-region`: **required** Rackspace region name. +- `--rackspace-docker-install`: Set if Docker has to be installed on the machine. - `--rackspace-endpoint-type`: Rackspace endpoint type (`adminURL`, `internalURL` or the default `publicURL`). -- `--rackspace-image-id`: Rackspace image ID. Default: Ubuntu 16.04 LTS (Xenial Xerus) (PVHVM). - `--rackspace-flavor-id`: Rackspace flavor ID. Default: General Purpose 1GB. -- `--rackspace-ssh-user`: SSH user for the newly booted machine. +- `--rackspace-image-id`: Rackspace image ID. Default: Ubuntu 16.04 LTS (Xenial Xerus) (PVHVM). +- `--rackspace-region`: **required** Rackspace region name. - `--rackspace-ssh-port`: SSH port for the newly booted machine. -- `--rackspace-docker-install`: Set if Docker has to be installed on the machine. -- `--rackspace-active-timeout`: Rackspace active timeout +- `--rackspace-ssh-user`: SSH user for the newly booted machine. +- `--rackspace-username`: **required** Rackspace account username. The Rackspace driver will use `821ba5f4-712d-4ec8-9c65-a3fa4bc500f9` (Ubuntu 16.04 LTS) by default. @@ -29,13 +29,13 @@ The Rackspace driver will use `821ba5f4-712d-4ec8-9c65-a3fa4bc500f9` (Ubuntu 16. | CLI option | Environment variable | Default | | ---------------------------- | -------------------- | -------------------------------------- | -| **`--rackspace-username`** | `OS_USERNAME` | - | +| `--rackspace-active-timeout` | `OS_ACTIVE_TIMEOUT` | `300` | | **`--rackspace-api-key`** | `OS_API_KEY` | - | -| **`--rackspace-region`** | `OS_REGION_NAME` | `IAD` (Northern Virginia) | +| `--rackspace-docker-install` | - | `true` | | `--rackspace-endpoint-type` | `OS_ENDPOINT_TYPE` | `publicURL` | -| `--rackspace-image-id` | `OS_IMAGE_ID` | `821ba5f4-712d-4ec8-9c65-a3fa4bc500f9` | | `--rackspace-flavor-id` | `OS_FLAVOR_ID` | `general1-1` | -| `--rackspace-ssh-user` | `OS_SSH_USER` | `root` | +| `--rackspace-image-id` | `OS_IMAGE_ID` | `821ba5f4-712d-4ec8-9c65-a3fa4bc500f9` | +| **`--rackspace-region`** | `OS_REGION_NAME` | `IAD` (Northern Virginia) | | `--rackspace-ssh-port` | `OS_SSH_PORT` | `22` | -| `--rackspace-docker-install` | - | `true` | -| `--rackspace-active-timeout` | `OS_ACTIVE_TIMEOUT` | `300` | +| `--rackspace-ssh-user` | `OS_SSH_USER` | `root` | +| **`--rackspace-username`** | `OS_USERNAME` | - | diff --git a/machine/drivers/soft-layer.md b/machine/drivers/soft-layer.md index a1f8b2ca79d..4ff4e874c39 100644 --- a/machine/drivers/soft-layer.md +++ b/machine/drivers/soft-layer.md @@ -15,22 +15,22 @@ You need to generate an API key in the softlayer control panel. ## Options -- `--softlayer-memory`: Memory for host in MB. -- `--softlayer-disk-size`: A value of `0` will set the SoftLayer default. -- `--softlayer-user`: **required** Username for your SoftLayer account, API key needs to match this user. +- `--softlayer-api-endpoint`: Change SoftLayer API endpoint. - `--softlayer-api-key`: **required** API key for your user account. -- `--softlayer-region`: SoftLayer region. - `--softlayer-cpu`: Number of CPUs for the machine. -- `--softlayer-hostname`: Hostname for the machine. +- `--softlayer-disk-size`: A value of `0` will set the SoftLayer default. - `--softlayer-domain`: **required** Domain name for the machine. -- `--softlayer-api-endpoint`: Change SoftLayer API endpoint. +- `--softlayer-hostname`: Hostname for the machine. - `--softlayer-hourly-billing`: Specifies that hourly billing should be used, otherwise monthly billing is used. +- `--softlayer-image`: OS Image to use. - `--softlayer-local-disk`: Use local machine disk instead of SoftLayer SAN. +- `--softlayer-memory`: Memory for host in MB. +- `--softlayer-network-max-speed`: Speed of network uplinks in Mbps (e.g., 1000, 100, 10). - `--softlayer-private-net-only`: Disable public networking. -- `--softlayer-image`: OS Image to use. -- `--softlayer-public-vlan-id`: Your public VLAN ID. - `--softlayer-private-vlan-id`: Your private VLAN ID. -- `--softlayer-network-max-speed`: Speed of network uplinks in Mbps (e.g., 1000, 100, 10). +- `--softlayer-public-vlan-id`: Your public VLAN ID. +- `--softlayer-region`: SoftLayer region. +- `--softlayer-user`: **required** Username for your SoftLayer account, API key needs to match this user. The SoftLayer driver will use `UBUNTU_LATEST` as the image type by default. @@ -38,18 +38,18 @@ The SoftLayer driver will use `UBUNTU_LATEST` as the image type by default. | CLI option | Environment variable | Default | | ------------------------------ | --------------------------- | --------------------------- | -| `--softlayer-memory` | `SOFTLAYER_MEMORY` | `1024` | -| `--softlayer-disk-size` | `SOFTLAYER_DISK_SIZE` | `0` | -| **`--softlayer-user`** | `SOFTLAYER_USER` | - | +| `--softlayer-api-endpoint` | `SOFTLAYER_API_ENDPOINT` | `api.softlayer.com/rest/v3` | | **`--softlayer-api-key`** | `SOFTLAYER_API_KEY` | - | -| `--softlayer-region` | `SOFTLAYER_REGION` | `dal01` | | `--softlayer-cpu` | `SOFTLAYER_CPU` | `1` | -| `--softlayer-hostname` | `SOFTLAYER_HOSTNAME` | `docker` | +| `--softlayer-disk-size` | `SOFTLAYER_DISK_SIZE` | `0` | | **`--softlayer-domain`** | `SOFTLAYER_DOMAIN` | - | -| `--softlayer-api-endpoint` | `SOFTLAYER_API_ENDPOINT` | `api.softlayer.com/rest/v3` | +| `--softlayer-hostname` | `SOFTLAYER_HOSTNAME` | `docker` | | `--softlayer-hourly-billing` | `SOFTLAYER_HOURLY_BILLING` | `false` | +| `--softlayer-image` | `SOFTLAYER_IMAGE` | `UBUNTU_LATEST` | | `--softlayer-local-disk` | `SOFTLAYER_LOCAL_DISK` | `false` | +| `--softlayer-memory` | `SOFTLAYER_MEMORY` | `1024` | | `--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-public-vlan-id` | `SOFTLAYER_PUBLIC_VLAN_ID` | `0` | +| `--softlayer-region` | `SOFTLAYER_REGION` | `dal01` | +| **`--softlayer-user`** | `SOFTLAYER_USER` | - | diff --git a/machine/drivers/virtualbox.md b/machine/drivers/virtualbox.md index db897e5ec70..6473c03343d 100644 --- a/machine/drivers/virtualbox.md +++ b/machine/drivers/virtualbox.md @@ -25,22 +25,22 @@ The size of the VM's disk can be configured this way: ## Options -- `--virtualbox-memory`: Size of memory for the host in MB. +- `--virtualbox-boot2docker-url`: The URL of the boot2docker image. Defaults to the latest available version. - `--virtualbox-cpu-count`: Number of CPUs to use to create the VM. Defaults to single CPU. - `--virtualbox-disk-size`: Size of disk for the host in MB. - `--virtualbox-host-dns-resolver`: Use the host DNS resolver. (Boolean value, defaults to false) -- `--virtualbox-boot2docker-url`: The URL of the boot2docker image. Defaults to the latest available version. -- `--virtualbox-import-boot2docker-vm`: The name of a Boot2Docker VM to import. - `--virtualbox-hostonly-cidr`: The CIDR of the host only adapter. -- `--virtualbox-hostonly-nictype`: Host Only Network Adapter Type. Possible values are '82540EM' (Intel PRO/1000), 'Am79C973' (PCnet-FAST III), and 'virtio' Paravirtualized network adapter. - `--virtualbox-hostonly-nicpromisc`: Host Only Network Adapter Promiscuous Mode. Possible options are deny , allow-vms, allow-all +- `--virtualbox-hostonly-nictype`: Host Only Network Adapter Type. Possible values are '82540EM' (Intel PRO/1000), 'Am79C973' (PCnet-FAST III), and 'virtio' Paravirtualized network adapter. - `--virtualbox-hostonly-no-dhcp`: Disable the Host Only DHCP Server +- `--virtualbox-import-boot2docker-vm`: The name of a Boot2Docker VM to import. +- `--virtualbox-memory`: Size of memory for the host in MB. - `--virtualbox-nat-nictype`: Specify the NAT Network Adapter Type. Possible values are are '82540EM' (Intel PRO/1000), 'Am79C973' (PCnet-FAST III) and 'virtio' Paravirtualized network adapter. -- `--virtualbox-no-share`: Disable the mount of your home directory - `--virtualbox-no-dns-proxy`: Disable proxying all DNS requests to the host (Boolean value, default to false) +- `--virtualbox-no-share`: Disable the mount of your home directory - `--virtualbox-no-vtx-check`: Disable checking for the availability of hardware virtualization before the vm is started -- `--virtualbox-ui-type`: Specify the UI Type: (gui|sdl|headless|separate) - `--virtualbox-share-folder`: Mount the specified directory instead of the default home location. Format: dir:name +- `--virtualbox-ui-type`: Specify the UI Type: (gui|sdl|headless|separate) The `--virtualbox-boot2docker-url` flag takes a few different forms. By default, if no value is specified for this flag, Machine will check locally for @@ -72,22 +72,22 @@ upper bound of `192.168.24.254`. | CLI option | Environment variable | Default | |:-------------------------------------|:-----------------------------------|:-------------------------| -| `--virtualbox-memory` | `VIRTUALBOX_MEMORY_SIZE` | `1024` | +| `--virtualbox-boot2docker-url` | `VIRTUALBOX_BOOT2DOCKER_URL` | _Latest boot2docker url_ | | `--virtualbox-cpu-count` | `VIRTUALBOX_CPU_COUNT` | `1` | | `--virtualbox-disk-size` | `VIRTUALBOX_DISK_SIZE` | `20000` | | `--virtualbox-host-dns-resolver` | `VIRTUALBOX_HOST_DNS_RESOLVER` | `false` | -| `--virtualbox-boot2docker-url` | `VIRTUALBOX_BOOT2DOCKER_URL` | _Latest boot2docker url_ | -| `--virtualbox-import-boot2docker-vm` | `VIRTUALBOX_BOOT2DOCKER_IMPORT_VM` | `boot2docker-vm` | | `--virtualbox-hostonly-cidr` | `VIRTUALBOX_HOSTONLY_CIDR` | `192.168.99.1/24` | -| `--virtualbox-hostonly-nictype` | `VIRTUALBOX_HOSTONLY_NIC_TYPE` | `82540EM` | | `--virtualbox-hostonly-nicpromisc` | `VIRTUALBOX_HOSTONLY_NIC_PROMISC` | `deny` | +| `--virtualbox-hostonly-nictype` | `VIRTUALBOX_HOSTONLY_NIC_TYPE` | `82540EM` | | `--virtualbox-hostonly-no-dhcp` | `VIRTUALBOX_HOSTONLY_NO_DHCP` | `false` | +| `--virtualbox-import-boot2docker-vm` | `VIRTUALBOX_BOOT2DOCKER_IMPORT_VM` | `boot2docker-vm` | +| `--virtualbox-memory` | `VIRTUALBOX_MEMORY_SIZE` | `1024` | | `--virtualbox-nat-nictype` | `VIRTUALBOX_NAT_NICTYPE` | `82540EM` | -| `--virtualbox-no-share` | `VIRTUALBOX_NO_SHARE` | `false` | | `--virtualbox-no-dns-proxy` | `VIRTUALBOX_NO_DNS_PROXY` | `false` | +| `--virtualbox-no-share` | `VIRTUALBOX_NO_SHARE` | `false` | | `--virtualbox-no-vtx-check` | `VIRTUALBOX_NO_VTX_CHECK` | `false` | -| `--virtualbox-ui-type` | `VIRTUALBOX_UI_TYPE` | `headless` | | `--virtualbox-share-folder` | `VIRTUALBOX_SHARE_FOLDER` | - | +| `--virtualbox-ui-type` | `VIRTUALBOX_UI_TYPE` | `headless` | ## Known Issues diff --git a/machine/drivers/vm-cloud.md b/machine/drivers/vm-cloud.md index 33692c45954..3f54edc6641 100644 --- a/machine/drivers/vm-cloud.md +++ b/machine/drivers/vm-cloud.md @@ -12,20 +12,20 @@ Creates machines on [vCloud Air](http://vcloud.vmware.com) subscription service. ## Options -- `--vmwarevcloudair-username`: **required** vCloud Air Username. -- `--vmwarevcloudair-password`: **required** vCloud Air Password. -- `--vmwarevcloudair-computeid`: Compute ID (if using Dedicated Cloud). -- `--vmwarevcloudair-vdcid`: Virtual Data Center ID. -- `--vmwarevcloudair-orgvdcnetwork`: Organization VDC Network to attach. -- `--vmwarevcloudair-edgegateway`: Organization Edge Gateway. -- `--vmwarevcloudair-publicip`: Org Public IP to use. - `--vmwarevcloudair-catalog`: Catalog. - `--vmwarevcloudair-catalogitem`: Catalog Item. -- `--vmwarevcloudair-provision`: Install Docker binaries. +- `--vmwarevcloudair-computeid`: Compute ID (if using Dedicated Cloud). - `--vmwarevcloudair-cpu-count`: VM CPU Count. +- `--vmwarevcloudair-docker-port`: Docker port. +- `--vmwarevcloudair-edgegateway`: Organization Edge Gateway. - `--vmwarevcloudair-memory-size`: VM Memory Size in MB. +- `--vmwarevcloudair-orgvdcnetwork`: Organization VDC Network to attach. +- `--vmwarevcloudair-password`: **required** vCloud Air Password. +- `--vmwarevcloudair-provision`: Install Docker binaries. +- `--vmwarevcloudair-publicip`: Org Public IP to use. - `--vmwarevcloudair-ssh-port`: SSH port. -- `--vmwarevcloudair-docker-port`: Docker port. +- `--vmwarevcloudair-username`: **required** vCloud Air Username. +- `--vmwarevcloudair-vdcid`: Virtual Data Center ID. The VMware vCloud Air driver will use the `Ubuntu Server 12.04 LTS (amd64 20140927)` image by default. @@ -33,17 +33,17 @@ The VMware vCloud Air driver will use the `Ubuntu Server 12.04 LTS (amd64 201409 | CLI option | Environment variable | Default | | --------------------------------- | ------------------------- | ------------------------------------------ | -| **`--vmwarevcloudair-username`** | `VCLOUDAIR_USERNAME` | - | -| **`--vmwarevcloudair-password`** | `VCLOUDAIR_PASSWORD` | - | -| `--vmwarevcloudair-computeid` | `VCLOUDAIR_COMPUTEID` | - | -| `--vmwarevcloudair-vdcid` | `VCLOUDAIR_VDCID` | - | -| `--vmwarevcloudair-orgvdcnetwork` | `VCLOUDAIR_ORGVDCNETWORK` | `-default-routed` | -| `--vmwarevcloudair-edgegateway` | `VCLOUDAIR_EDGEGATEWAY` | `` | -| `--vmwarevcloudair-publicip` | `VCLOUDAIR_PUBLICIP` | - | | `--vmwarevcloudair-catalog` | `VCLOUDAIR_CATALOG` | `Public Catalog` | | `--vmwarevcloudair-catalogitem` | `VCLOUDAIR_CATALOGITEM` | `Ubuntu Server 12.04 LTS (amd64 20140927)` | -| `--vmwarevcloudair-provision` | `VCLOUDAIR_PROVISION` | `true` | +| `--vmwarevcloudair-computeid` | `VCLOUDAIR_COMPUTEID` | - | | `--vmwarevcloudair-cpu-count` | `VCLOUDAIR_CPU_COUNT` | `1` | +| `--vmwarevcloudair-docker-port` | `VCLOUDAIR_DOCKER_PORT` | `2376` | +| `--vmwarevcloudair-edgegateway` | `VCLOUDAIR_EDGEGATEWAY` | `` | | `--vmwarevcloudair-memory-size` | `VCLOUDAIR_MEMORY_SIZE` | `2048` | +| `--vmwarevcloudair-orgvdcnetwork` | `VCLOUDAIR_ORGVDCNETWORK` | `-default-routed` | +| **`--vmwarevcloudair-password`** | `VCLOUDAIR_PASSWORD` | - | +| `--vmwarevcloudair-provision` | `VCLOUDAIR_PROVISION` | `true` | +| `--vmwarevcloudair-publicip` | `VCLOUDAIR_PUBLICIP` | - | | `--vmwarevcloudair-ssh-port` | `VCLOUDAIR_SSH_PORT` | `22` | -| `--vmwarevcloudair-docker-port` | `VCLOUDAIR_DOCKER_PORT` | `2376` | \ No newline at end of file +| **`--vmwarevcloudair-username`** | `VCLOUDAIR_USERNAME` | - | +| `--vmwarevcloudair-vdcid` | `VCLOUDAIR_VDCID` | - | \ No newline at end of file diff --git a/machine/drivers/vsphere.md b/machine/drivers/vsphere.md index 45b366c73c2..64318397828 100644 --- a/machine/drivers/vsphere.md +++ b/machine/drivers/vsphere.md @@ -12,19 +12,19 @@ Creates machines on a [VMware vSphere](http://www.vmware.com/products/vsphere) V ## Options -- `--vmwarevsphere-username`: **required** vSphere Username. -- `--vmwarevsphere-password`: **required** vSphere Password. +- `--vmwarevsphere-boot2docker-url`: URL for boot2docker image. - `--vmwarevsphere-cpu-count`: CPU number for Docker VM. -- `--vmwarevsphere-memory-size`: Size of memory for Docker VM (in MB). +- `--vmwarevsphere-datacenter`: Datacenter for Docker VM (must be set to `ha-datacenter` when connecting to a single host). +- `--vmwarevsphere-datastore`: Datastore for Docker VM. - `--vmwarevsphere-disk-size`: Size of disk for Docker VM (in MB). -- `--vmwarevsphere-boot2docker-url`: URL for boot2docker image. -- `--vmwarevsphere-vcenter`: IP/hostname for vCenter (or ESXi if connecting directly to a single host). -- `--vmwarevsphere-vcenter-port`: vSphere Port for vCenter. +- `--vmwarevsphere-hostsystem`: vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS. +- `--vmwarevsphere-memory-size`: Size of memory for Docker VM (in MB). - `--vmwarevsphere-network`: Network where the Docker VM will be attached. -- `--vmwarevsphere-datastore`: Datastore for Docker VM. -- `--vmwarevsphere-datacenter`: Datacenter for Docker VM (must be set to `ha-datacenter` when connecting to a single host). +- `--vmwarevsphere-password`: **required** vSphere Password. - `--vmwarevsphere-pool`: Resource pool for Docker VM. -- `--vmwarevsphere-hostsystem`: vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS. +- `--vmwarevsphere-username`: **required** vSphere Username. +- `--vmwarevsphere-vcenter-port`: vSphere Port for vCenter. +- `--vmwarevsphere-vcenter`: IP/hostname for vCenter (or ESXi if connecting directly to a single host). The VMware vSphere driver uses the latest boot2docker image. @@ -32,16 +32,16 @@ The VMware vSphere driver uses the latest boot2docker image. | CLI option | Environment variable | Default | | --------------------------------- | ------------------------- | ------------------------ | -| **`--vmwarevsphere-username`** | `VSPHERE_USERNAME` | - | -| **`--vmwarevsphere-password`** | `VSPHERE_PASSWORD` | - | -| `--vmwarevsphere-cpu-count` | `VSPHERE_CPU_COUNT` | `2` | -| `--vmwarevsphere-memory-size` | `VSPHERE_MEMORY_SIZE` | `2048` | | `--vmwarevsphere-boot2docker-url` | `VSPHERE_BOOT2DOCKER_URL` | _Latest boot2docker url_ | -| `--vmwarevsphere-vcenter` | `VSPHERE_VCENTER` | - | -| `--vmwarevsphere-vcenter-port` | `VSPHERE_VCENTER_PORT` | 443 | +| `--vmwarevsphere-cpu-count` | `VSPHERE_CPU_COUNT` | `2` | +| `--vmwarevsphere-datacenter` | `VSPHERE_DATACENTER` | - | +| `--vmwarevsphere-datastore` | `VSPHERE_DATASTORE` | - | | `--vmwarevsphere-disk-size` | `VSPHERE_DISK_SIZE` | `20000` | +| `--vmwarevsphere-hostsystem` | `VSPHERE_HOSTSYSTEM` | - | +| `--vmwarevsphere-memory-size` | `VSPHERE_MEMORY_SIZE` | `2048` | | `--vmwarevsphere-network` | `VSPHERE_NETWORK` | - | -| `--vmwarevsphere-datastore` | `VSPHERE_DATASTORE` | - | -| `--vmwarevsphere-datacenter` | `VSPHERE_DATACENTER` | - | +| **`--vmwarevsphere-password`** | `VSPHERE_PASSWORD` | - | | `--vmwarevsphere-pool` | `VSPHERE_POOL` | - | -| `--vmwarevsphere-hostsystem` | `VSPHERE_HOSTSYSTEM` | - | +| **`--vmwarevsphere-username`** | `VSPHERE_USERNAME` | - | +| `--vmwarevsphere-vcenter-port` | `VSPHERE_VCENTER_PORT` | 443 | +| `--vmwarevsphere-vcenter` | `VSPHERE_VCENTER` | - |