summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMary Anthony <mary@docker.com>2015-07-07 09:53:04 -0700
committerMary Anthony <mary@docker.com>2015-07-14 12:44:56 -0700
commit6c928fd4053ba9f3e32470620948da759f4945a2 (patch)
tree1ed4c33491b6e0651869b67d1b7f39d587db68ed
parent6511219f6defb9b9d83658ba73b79bfb76fdb5b6 (diff)
First stage of splitting out
Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
-rw-r--r--docs/drivers/openstack.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/drivers/openstack.md b/docs/drivers/openstack.md
new file mode 100644
index 0000000..649d451
--- /dev/null
+++ b/docs/drivers/openstack.md
@@ -0,0 +1,64 @@
1<!--[metadata]>
2+++
3title = "OpenStack"
4description = "OpenStack driver for machine"
5keywords = ["machine, OpenStack, driver"]
6[menu.main]
7parent="smn_machine_drivers"
8+++
9<![end-metadata]-->
10
11# OpenStack
12Create machines on [OpenStack](http://www.openstack.org/software/)
13
14Mandatory:
15
16 - `--openstack-auth-url`: Keystone service base URL.
17 - `--openstack-flavor-id` or `--openstack-flavor-name`: Identify the flavor that will be used for the machine.
18 - `--openstack-image-id` or `--openstack-image-name`: Identify the image that will be used for the machine.
19
20Options:
21
22 - `--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-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only)
24 - `--openstack-username`: User identifier to authenticate with.
25 - `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set.
26 - `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created.
27 - `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack.
28 - `--openstack-availability-zone`: The availability zone in which to launch the server.
29 - `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver
30 to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL`
31 - `--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.
32 - `--openstack-sec-groups`: If security groups are available on your OpenStack you can specify a comma separated list
33 to use for the machine (e.g. `secgrp001,secgrp002`).
34 - `--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
35 IP address already allocated but not assigned to any machine, this IP will be chosen and assigned to the machine. If
36 there is no IP address already allocated a new IP will be allocated and assigned to the machine.
37 - `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used.
38 - `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port.
39
40Environment variables and default values:
41
42| CLI option | Environment variable | Default |
43|----------------------------------|------------------------|---------|
44| `--openstack-auth-url` | `OS_AUTH_URL` | - |
45| `--openstack-flavor-name` | - | - |
46| `--openstack-flavor-id` | - | - |
47| `--openstack-image-name` | - | - |
48| `--openstack-image-id` | - | - |
49| `--openstack-insecure` | - | - |
50| `--openstack-domain-name` | `OS_DOMAIN_NAME` | - |
51| `--openstack-domain-id` | `OS_DOMAIN_ID` | - |
52| `--openstack-username` | `OS_USERNAME` | - |
53| `--openstack-password` | `OS_PASSWORD` | - |
54| `--openstack-tenant-name` | `OS_TENANT_NAME` | - |
55| `--openstack-tenant-id` | `OS_TENANT_ID` | - |
56| `--openstack-region` | `OS_REGION_NAME` | - |
57| `--openstack-availability-zone` | `OS_AVAILABILITY_ZONE` | - |
58| `--openstack-endpoint-type` | `OS_ENDPOINT_TYPE` | - |
59| `--openstack-net-name` | - | - |
60| `--openstack-net-id` | - | - |
61| `--openstack-sec-groups` | - | - |
62| `--openstack-floatingip-pool` | - | - |
63| `--openstack-ssh-user` | - | `root` |
64| `--openstack-ssh-port` | - | `22` |