From 44eb7aa74a0669b5ad5dbcfe70a79d5d53a29ba8 Mon Sep 17 00:00:00 2001 From: Fabrizio Soppelsa Date: Mon, 7 Dec 2015 19:14:29 -0800 Subject: [PATCH] Order options in openstack.md, to make docs more readable Signed-off-by: Fabrizio Soppelsa --- docs/drivers/openstack.md | 66 +++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/drivers/openstack.md b/docs/drivers/openstack.md index f62d44d..25d82d2 100644 --- a/docs/drivers/openstack.md +++ b/docs/drivers/openstack.md @@ -20,50 +20,50 @@ Mandatory: Options: -- `--openstack-insecure`: Explicitly allow openstack driver to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution. -- `--openstack-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only) -- `--openstack-username`: User identifier to authenticate with. -- `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set. -- `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created. -- `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack. +- `--openstack-active-timeout`: The timeout in seconds until the OpenStack instance must be active. - `--openstack-availability-zone`: The availability zone in which to launch the server. +- `--openstack-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only). - `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL` -- `--openstack-net-name` or `--openstack-net-id`: Identify the private network the machine will be connected on. If your OpenStack project project contains only one private network it will be use automatically. -- `--openstack-sec-groups`: If security groups are available on your OpenStack you can specify a comma separated list - to use for the machine (e.g. `secgrp001,secgrp002`). - `--openstack-floatingip-pool`: The IP pool that will be used to get a public IP can assign it to the machine. If there is an IP address already allocated but not assigned to any machine, this IP will be chosen and assigned to the machine. If there is no IP address already allocated a new IP will be allocated and assigned to the machine. +- `--openstack-insecure`: Explicitly allow openstack driver to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution. - `--openstack-ip-version`: If the instance has both IPv4 and IPv6 address, you can select IP version. If not provided `4` will be used. -- `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used. +- `--openstack-net-name` or `--openstack-net-id`: Identify the private network the machine will be connected on. If your OpenStack project project contains only one private network it will be use automatically. +- `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set. +- `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack. +- `--openstack-sec-groups`: If security groups are available on your OpenStack you can specify a comma separated list + to use for the machine (e.g. `secgrp001,secgrp002`). +- `--openstack-username`: User identifier to authenticate with. - `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port. -- `--openstack-active-timeout`: The timeout in seconds until the OpenStack instance must be active. +- `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used. +- `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created. Environment variables and default values: | CLI option | Environment variable | Default | | ------------------------------- | ---------------------- | ----------- | -| `--openstack-auth-url` | `OS_AUTH_URL` | - | -| `--openstack-flavor-name` | `OS_FLAVOR_NAME` | - | -| `--openstack-flavor-id` | `OS_FLAVOR_ID` | - | -| `--openstack-image-name` | `OS_IMAGE_NAME` | - | -| `--openstack-image-id` | `OS_IMAGE_ID` | - | -| `--openstack-insecure` | `OS_INSECURE` | `false` | -| `--openstack-domain-name` | `OS_DOMAIN_NAME` | - | -| `--openstack-domain-id` | `OS_DOMAIN_ID` | - | -| `--openstack-username` | `OS_USERNAME` | - | -| `--openstack-password` | `OS_PASSWORD` | - | -| `--openstack-tenant-name` | `OS_TENANT_NAME` | - | -| `--openstack-tenant-id` | `OS_TENANT_ID` | - | -| `--openstack-region` | `OS_REGION_NAME` | - | -| `--openstack-availability-zone` | `OS_AVAILABILITY_ZONE` | - | -| `--openstack-endpoint-type` | `OS_ENDPOINT_TYPE` | `publicURL` | -| `--openstack-net-name` | `OS_NETWORK_NAME` | - | -| `--openstack-net-id` | `OS_NETWORK_ID` | - | -| `--openstack-sec-groups` | `OS_SECURITY_GROUPS` | - | -| `--openstack-floatingip-pool` | `OS_FLOATINGIP_POOL` | - | -| `--openstack-ip-version` | `OS_IP_VERSION` | `4` | -| `--openstack-ssh-user` | `OS_SSH_USER` | `root` | -| `--openstack-ssh-port` | `OS_SSH_PORT` | `22` | | `--openstack-active-timeout` | `OS_ACTIVE_TIMEOUT` | `200` | +| `--openstack-auth-url` | `OS_AUTH_URL` | - | +| `--openstack-availability-zone` | `OS_AVAILABILITY_ZONE` | - | +| `--openstack-domain-id` | `OS_DOMAIN_ID` | - | +| `--openstack-domain-name` | `OS_DOMAIN_NAME` | - | +| `--openstack-endpoint-type` | `OS_ENDPOINT_TYPE` | `publicURL` | +| `--openstack-flavor-id` | `OS_FLAVOR_ID` | - | +| `--openstack-flavor-name` | `OS_FLAVOR_NAME` | - | +| `--openstack-floatingip-pool` | `OS_FLOATINGIP_POOL` | - | +| `--openstack-image-id` | `OS_IMAGE_ID` | - | +| `--openstack-image-name` | `OS_IMAGE_NAME` | - | +| `--openstack-insecure` | `OS_INSECURE` | `false` | +| `--openstack-ip-version` | `OS_IP_VERSION` | `4` | +| `--openstack-net-id` | `OS_NETWORK_ID` | - | +| `--openstack-net-name` | `OS_NETWORK_NAME` | - | +| `--openstack-password` | `OS_PASSWORD` | - | +| `--openstack-region` | `OS_REGION_NAME` | - | +| `--openstack-sec-groups` | `OS_SECURITY_GROUPS` | - | +| `--openstack-ssh-port` | `OS_SSH_PORT` | `22` | +| `--openstack-ssh-user` | `OS_SSH_USER` | `root` | +| `--openstack-tenant-id` | `OS_TENANT_ID` | - | +| `--openstack-tenant-name` | `OS_TENANT_NAME` | - | +| `--openstack-username` | `OS_USERNAME` | - |