summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabrizio Soppelsa <fsoppelsa@darthvader.local>2015-12-07 19:14:29 -0800
committerFabrizio Soppelsa <fsoppelsa@darthvader.local>2015-12-07 19:14:29 -0800
commit44eb7aa74a0669b5ad5dbcfe70a79d5d53a29ba8 (patch)
tree1e5d56e94f4d2d8d0b66640bea53272d5c86b734
parentb9590a0248e4beb7f37a274757c1cb3aea18cd2a (diff)
Order options in openstack.md, to make docs more readable
Signed-off-by: Fabrizio Soppelsa <fsoppelsa@mirantis.com>
-rw-r--r--docs/drivers/openstack.md52
1 files changed, 26 insertions, 26 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:
20 20
21Options: 21Options:
22 22
23- `--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. 23- `--openstack-active-timeout`: The timeout in seconds until the OpenStack instance must be active.
24- `--openstack-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only)
25- `--openstack-username`: User identifier to authenticate with.
26- `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set.
27- `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created.
28- `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack.
29- `--openstack-availability-zone`: The availability zone in which to launch the server. 24- `--openstack-availability-zone`: The availability zone in which to launch the server.
25- `--openstack-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only).
30- `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver 26- `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver
31 to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL` 27 to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL`
32- `--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.
33- `--openstack-sec-groups`: If security groups are available on your OpenStack you can specify a comma separated list
34 to use for the machine (e.g. `secgrp001,secgrp002`).
35- `--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 28- `--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
36 IP address already allocated but not assigned to any machine, this IP will be chosen and assigned to the machine. If 29 IP address already allocated but not assigned to any machine, this IP will be chosen and assigned to the machine. If
37 there is no IP address already allocated a new IP will be allocated and assigned to the machine. 30 there is no IP address already allocated a new IP will be allocated and assigned to the machine.
31- `--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.
38- `--openstack-ip-version`: If the instance has both IPv4 and IPv6 address, you can select IP version. If not provided `4` will be used. 32- `--openstack-ip-version`: If the instance has both IPv4 and IPv6 address, you can select IP version. If not provided `4` will be used.
39- `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used. 33- `--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.
34- `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set.
35- `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack.
36- `--openstack-sec-groups`: If security groups are available on your OpenStack you can specify a comma separated list
37 to use for the machine (e.g. `secgrp001,secgrp002`).
38- `--openstack-username`: User identifier to authenticate with.
40- `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port. 39- `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port.
41- `--openstack-active-timeout`: The timeout in seconds until the OpenStack instance must be active. 40- `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used.
41- `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created.
42 42
43Environment variables and default values: 43Environment variables and default values:
44 44
45| CLI option | Environment variable | Default | 45| CLI option | Environment variable | Default |
46| ------------------------------- | ---------------------- | ----------- | 46| ------------------------------- | ---------------------- | ----------- |
47| `--openstack-active-timeout` | `OS_ACTIVE_TIMEOUT` | `200` |
47| `--openstack-auth-url` | `OS_AUTH_URL` | - | 48| `--openstack-auth-url` | `OS_AUTH_URL` | - |
48| `--openstack-flavor-name` | `OS_FLAVOR_NAME` | - | 49| `--openstack-availability-zone` | `OS_AVAILABILITY_ZONE` | - |
50| `--openstack-domain-id` | `OS_DOMAIN_ID` | - |
51| `--openstack-domain-name` | `OS_DOMAIN_NAME` | - |
52| `--openstack-endpoint-type` | `OS_ENDPOINT_TYPE` | `publicURL` |
49| `--openstack-flavor-id` | `OS_FLAVOR_ID` | - | 53| `--openstack-flavor-id` | `OS_FLAVOR_ID` | - |
50| `--openstack-image-name` | `OS_IMAGE_NAME` | - | 54| `--openstack-flavor-name` | `OS_FLAVOR_NAME` | - |
55| `--openstack-floatingip-pool` | `OS_FLOATINGIP_POOL` | - |
51| `--openstack-image-id` | `OS_IMAGE_ID` | - | 56| `--openstack-image-id` | `OS_IMAGE_ID` | - |
57| `--openstack-image-name` | `OS_IMAGE_NAME` | - |
52| `--openstack-insecure` | `OS_INSECURE` | `false` | 58| `--openstack-insecure` | `OS_INSECURE` | `false` |
53| `--openstack-domain-name` | `OS_DOMAIN_NAME` | - | 59| `--openstack-ip-version` | `OS_IP_VERSION` | `4` |
54| `--openstack-domain-id` | `OS_DOMAIN_ID` | - | 60| `--openstack-net-id` | `OS_NETWORK_ID` | - |
55| `--openstack-username` | `OS_USERNAME` | - | 61| `--openstack-net-name` | `OS_NETWORK_NAME` | - |
56| `--openstack-password` | `OS_PASSWORD` | - | 62| `--openstack-password` | `OS_PASSWORD` | - |
57| `--openstack-tenant-name` | `OS_TENANT_NAME` | - |
58| `--openstack-tenant-id` | `OS_TENANT_ID` | - |
59| `--openstack-region` | `OS_REGION_NAME` | - | 63| `--openstack-region` | `OS_REGION_NAME` | - |
60| `--openstack-availability-zone` | `OS_AVAILABILITY_ZONE` | - |
61| `--openstack-endpoint-type` | `OS_ENDPOINT_TYPE` | `publicURL` |
62| `--openstack-net-name` | `OS_NETWORK_NAME` | - |
63| `--openstack-net-id` | `OS_NETWORK_ID` | - |
64| `--openstack-sec-groups` | `OS_SECURITY_GROUPS` | - | 64| `--openstack-sec-groups` | `OS_SECURITY_GROUPS` | - |
65| `--openstack-floatingip-pool` | `OS_FLOATINGIP_POOL` | - |
66| `--openstack-ip-version` | `OS_IP_VERSION` | `4` |
67| `--openstack-ssh-user` | `OS_SSH_USER` | `root` |
68| `--openstack-ssh-port` | `OS_SSH_PORT` | `22` | 65| `--openstack-ssh-port` | `OS_SSH_PORT` | `22` |
69| `--openstack-active-timeout` | `OS_ACTIVE_TIMEOUT` | `200` | 66| `--openstack-ssh-user` | `OS_SSH_USER` | `root` |
67| `--openstack-tenant-id` | `OS_TENANT_ID` | - |
68| `--openstack-tenant-name` | `OS_TENANT_NAME` | - |
69| `--openstack-username` | `OS_USERNAME` | - |