From e6a6762b76891b4849fb276a2e3f5788d11a0ac7 Mon Sep 17 00:00:00 2001 From: zchee Date: Thu, 14 May 2015 09:46:24 +0900 Subject: [PATCH] Update docs for VMware vCloud Air Signed-off-by: Koichi Shiraishi --- docs/index.md | 44 +++++++++++++++++++++++++++++++------------- 1 file changed, 31 insertions(+), 13 deletions(-) diff --git a/docs/index.md b/docs/index.md index b653b3587a..10def1a2b4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1433,24 +1433,42 @@ Creates machines on [vCloud Air](http://vcloud.vmware.com) subscription service. Options: - - `--vmwarevcloudair-username`: vCloud Air Username. - - `--vmwarevcloudair-password`: vCloud Air Password. - - `--vmwarevcloudair-catalog`: Catalog. Default: `Public Catalog` - - `--vmwarevcloudair-catalogitem`: Catalog Item. Default: `Ubuntu Server 12.04 LTS (amd64 20140927)` + - `--vmwarevcloudair-username`: **required** vCloud Air Username. + - `--vmwarevcloudair-password`: **required** vCloud Air Password. - `--vmwarevcloudair-computeid`: Compute ID (if using Dedicated Cloud). - - `--vmwarevcloudair-cpu-count`: VM Cpu Count. Default: `1` - - `--vmwarevcloudair-docker-port`: Docker port. Default: `2376` - - `--vmwarevcloudair-edgegateway`: Organization Edge Gateway. Default: `` - - `--vmwarevcloudair-memory-size`: VM Memory Size in MB. Default: `2048` - - `--vmwarevcloudair-name`: vApp Name. Default: `` - - `--vmwarevcloudair-orgvdcnetwork`: Organization VDC Network to attach. Default: `-default-routed` - - `--vmwarevcloudair-provision`: Install Docker binaries. Default: `true` - - `--vmwarevcloudair-publicip`: Org Public IP to use. - - `--vmwarevcloudair-ssh-port`: SSH port. Default: `22` - `--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-cpu-count`: VM CPU Count. + - `--vmwarevcloudair-memory-size`: VM Memory Size in MB. + - `--vmwarevcloudair-ssh-port`: SSH port. + - `--vmwarevcloudair-docker-port`: Docker port. The VMware vCloud Air driver will use the `Ubuntu Server 12.04 LTS (amd64 20140927)` image by default. +Environment variables and default values: + +| 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-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` | + #### VMware vSphere Creates machines on a [VMware vSphere](http://www.vmware.com/products/vsphere) Virtual Infrastructure. Requires a working vSphere (ESXi and optionally vCenter) installation. The vSphere driver depends on [`govc`](https://github.com/vmware/govmomi/tree/master/govc) (must be in path) and has been tested with [vmware/govmomi@`c848630`](https://github.com/vmware/govmomi/commit/c8486300bfe19427e4f3226e3b3eac067717ef17).