mirror of https://github.com/docker/docs.git
OpenStack & Rackspace driver documentation
Signed-off-by: Guillaume Giamarchi <guillaume.giamarchi@gmail.com>
This commit is contained in:
parent
c16adeb46f
commit
edec8cd024
59
README.md
59
README.md
|
@ -180,37 +180,33 @@ Options:
|
||||||
|
|
||||||
Create machines on [Openstack](http://www.openstack.org/software/)
|
Create machines on [Openstack](http://www.openstack.org/software/)
|
||||||
|
|
||||||
#### Options
|
Mandatory:
|
||||||
|
|
||||||
Mandatory
|
|
||||||
|
|
||||||
- `--openstack-flavor-id`: The flavor ID to use when creating the machine
|
- `--openstack-flavor-id`: The flavor ID to use when creating the machine
|
||||||
- `--openstack-image-id`: The image ID to use when creating the machine. At the moment, the driver does not install
|
- `--openstack-image-id`: The image ID to use when creating the machine.
|
||||||
docker on the machine. That means the image you use should already contains a ready to use docker installation
|
|
||||||
|
|
||||||
Optional
|
Options:
|
||||||
|
|
||||||
- `--openstack-auth-url`: Keystone service base URL
|
- `--openstack-auth-url`: Keystone service base URL.
|
||||||
- `--openstack-username`: User identifer to authenticate with.
|
- `--openstack-username`: User identifer to authenticate with.
|
||||||
- `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set
|
- `--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-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 ony one region on the OpenStack
|
- `--openstack-region`: The region to work on. Can be omitted if there is ony one region on the OpenStack.
|
||||||
- `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver
|
- `--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`
|
to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL`
|
||||||
- `--openstack-net-id`: The private network id the machine will be connected on. If your OpenStack project project
|
- `--openstack-net-id`: The private network id the machine will be connected on. If your OpenStack project project
|
||||||
contains only one private network it will be use automatically
|
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
|
- `--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`)
|
to use for the machine (e.g. `secgrp001,secgrp002`).
|
||||||
- `--openstack-floatingip-pool`: The IP pool that will be used to get an IP an assign it to the machine. If there is an
|
- `--openstack-floatingip-pool`: The IP pool that will be used to get a public IP an 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 our machine. If
|
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, an new IP will be allocated and assigned to the machine
|
there is no IP address already allocated a new IP will be allocated and assigned to the machine.
|
||||||
- `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used.
|
- `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used.
|
||||||
- `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port
|
- `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port.
|
||||||
|
|
||||||
#### Environment variables
|
Environment variables:
|
||||||
|
|
||||||
Some options can be omitted if the corresponding standard OpenStack environment variable is set. Here
|
Here comes the list of the supported variables with the corresponding options. If both environment variable
|
||||||
comes the list of the supported variables with the corresponding options. If both environment variable
|
|
||||||
and CLI option are provided the CLI option takes the precedence.
|
and CLI option are provided the CLI option takes the precedence.
|
||||||
|
|
||||||
| Environment variable | CLI option |
|
| Environment variable | CLI option |
|
||||||
|
@ -223,6 +219,33 @@ and CLI option are provided the CLI option takes the precedence.
|
||||||
| `OS_REGION_NAME` | `--openstack-region` |
|
| `OS_REGION_NAME` | `--openstack-region` |
|
||||||
| `OS_ENDPOINT_TYPE` | `--openstack-endpoint-type` |
|
| `OS_ENDPOINT_TYPE` | `--openstack-endpoint-type` |
|
||||||
|
|
||||||
|
### Rackspace
|
||||||
|
|
||||||
|
Create machines on [Rackspace cloud](http://www.rackspace.com/cloud)
|
||||||
|
|
||||||
|
Options:
|
||||||
|
|
||||||
|
- `--rackspace-username`: Rackspace account username
|
||||||
|
- `--rackspace-api-key`: Rackspace API key
|
||||||
|
- `--rackspace-region`: Rackspace region name
|
||||||
|
- `--rackspace-endpoint-type`: Rackspace endpoint type (adminURL, internalURL or the default publicURL)
|
||||||
|
- `--rackspace-image-id`: Rackspace image ID. Default: Ubuntu 14.10 (Utopic Unicorn) (PVHVM)
|
||||||
|
- `--rackspace-flavor-id`: Rackspace flavor ID. Default: General Purpose 1GB
|
||||||
|
- `--rackspace-ssh-user`: SSH user for the newly booted machine. Set to root by default
|
||||||
|
- `--rackspace-ssh-port`: SSH port for the newly booted machine. Set to 22 by default
|
||||||
|
|
||||||
|
Environment variables:
|
||||||
|
|
||||||
|
Here comes the list of the supported variables with the corresponding options. If both environment
|
||||||
|
variable and CLI option are provided the CLI option takes the precedence.
|
||||||
|
|
||||||
|
| Environment variable | CLI option |
|
||||||
|
|----------------------|-----------------------------|
|
||||||
|
| `OS_USERNAME` | `--rackspace-username` |
|
||||||
|
| `OS_API_KEY` | `--rackspace-ap-key` |
|
||||||
|
| `OS_REGION_NAME` | `--rackspace-region` |
|
||||||
|
| `OS_ENDPOINT_TYPE` | `--rackspace-endpoint-type` |
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
[](https://godoc.org/github.com/docker/machine)
|
[](https://godoc.org/github.com/docker/machine)
|
||||||
|
|
Loading…
Reference in New Issue