Browse Source

Remove old documentation source, add README on migration

Signed-off-by: John Mulhausen <john@docker.com>
John Mulhausen 2 years ago
parent
commit
464e29cddc
1 changed files with 0 additions and 79 deletions
  1. 0
    79
      docs/drivers/openstack.md

+ 0
- 79
docs/drivers/openstack.md View File

@@ -1,79 +0,0 @@
1
-<!--[metadata]>
2
-+++
3
-title = "OpenStack"
4
-description = "OpenStack driver for machine"
5
-keywords = ["machine, OpenStack, driver"]
6
-[menu.main]
7
-parent="smn_machine_drivers"
8
-+++
9
-<![end-metadata]-->
10
-
11
-# OpenStack
12
-
13
-Create machines on [OpenStack](http://www.openstack.org/software/)
14
-
15
-Mandatory:
16
-
17
--   `--openstack-auth-url`: Keystone service base URL.
18
--   `--openstack-flavor-id` or `--openstack-flavor-name`: Identify the flavor that will be used for the machine.
19
--   `--openstack-image-id` or `--openstack-image-name`: Identify the image that will be used for the machine.
20
-
21
-## Usage
22
-
23
-    $ docker-machine create --driver openstack vm
24
-
25
-## Options
26
-
27
--   `--openstack-active-timeout`: The timeout in seconds until the OpenStack instance must be active.
28
--   `--openstack-availability-zone`: The availability zone in which to launch the server.
29
--   `--openstack-cacert`: The CA certificate bundle to verify against.
30
--   `--openstack-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only).
31
--   `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver
32
-    to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL`
33
--   `--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
34
-    IP address already allocated but not assigned to any machine, this IP will be chosen and assigned to the machine. If
35
-    there is no IP address already allocated a new IP will be allocated and assigned to the machine.
36
--   `--openstack-keypair-name`: Specify the existing Nova keypair to use.
37
--   `--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.
39
--   `--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.
40
--   `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set.
41
--   `--openstack-private-key-file`: Used with `--openstack-keypair-name`, associates the private key to the keypair.
42
--   `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack.
43
--   `--openstack-sec-groups`: If security groups are available on your OpenStack you can specify a comma separated list
44
-    to use for the machine (e.g. `secgrp001,secgrp002`).
45
--   `--openstack-username`: User identifier to authenticate with.
46
--   `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port.
47
--   `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used.
48
--   `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created.
49
-
50
-#### Environment variables and default values
51
-
52
-| CLI option                      | Environment variable   | Default     |
53
-| ------------------------------- | ---------------------- | ----------- |
54
-| `--openstack-active-timeout`    | `OS_ACTIVE_TIMEOUT`    | `200`       |
55
-| `--openstack-auth-url`          | `OS_AUTH_URL`          | -           |
56
-| `--openstack-availability-zone` | `OS_AVAILABILITY_ZONE` | -           |
57
-| `--openstack-cacert`            | `OS_CACERT             | -           |
58
-| `--openstack-domain-id`         | `OS_DOMAIN_ID`         | -           |
59
-| `--openstack-domain-name`       | `OS_DOMAIN_NAME`       | -           |
60
-| `--openstack-endpoint-type`     | `OS_ENDPOINT_TYPE`     | `publicURL` |
61
-| `--openstack-flavor-id`         | `OS_FLAVOR_ID`         | -           |
62
-| `--openstack-flavor-name`       | `OS_FLAVOR_NAME`       | -           |
63
-| `--openstack-floatingip-pool`   | `OS_FLOATINGIP_POOL`   | -           |
64
-| `--openstack-image-id`          | `OS_IMAGE_ID`          | -           |
65
-| `--openstack-image-name`        | `OS_IMAGE_NAME`        | -           |
66
-| `--openstack-insecure`          | `OS_INSECURE`          | `false`     |
67
-| `--openstack-ip-version`        | `OS_IP_VERSION`        | `4`         |
68
-| `--openstack-keypair-name`      | `OS_KEYPAIR_NAME`      | -           |
69
-| `--openstack-net-id`            | `OS_NETWORK_ID`        | -           |
70
-| `--openstack-net-name`          | `OS_NETWORK_NAME`      | -           |
71
-| `--openstack-password`          | `OS_PASSWORD`          | -           |
72
-| `--openstack-private-key-file`  | `OS_PRIVATE_KEY_FILE`  | -           |
73
-| `--openstack-region`            | `OS_REGION_NAME`       | -           |
74
-| `--openstack-sec-groups`        | `OS_SECURITY_GROUPS`   | -           |
75
-| `--openstack-ssh-port`          | `OS_SSH_PORT`          | `22`        |
76
-| `--openstack-ssh-user`          | `OS_SSH_USER`          | `root`      |
77
-| `--openstack-tenant-id`         | `OS_TENANT_ID`         | -           |
78
-| `--openstack-tenant-name`       | `OS_TENANT_NAME`       | -           |
79
-| `--openstack-username`          | `OS_USERNAME`          | -           |

Loading…
Cancel
Save