OpenStack Documentation Updates

This commit is contained in:
Joe Topjian 2015-04-02 16:12:18 +00:00
parent 87e1260fac
commit c6a8849725
3 changed files with 64 additions and 12 deletions

View File

@ -35,13 +35,16 @@ resource "openstack_compute_instance_v2" "test-server" {
The following arguments are supported:
* `auth_url` - (Required)
* `auth_url` - (Required) If omitted, the `OS_AUTH_URL` environment
variable is used.
* `user_name` - (Optional; Required for Identity V2)
* `user_name` - (Optional; Required for Identity V2) If omitted, the
`OS_USERNAME` environment variable is used.
* `user_id` - (Optional)
* `password` - (Optional; Required if not using `api_key`)
* `password` - (Optional; Required if not using `api_key`) If omitted, the
`OS_PASSWORD` environment variable is used.
* `api_key` - (Optional; Required if not using `password`)
@ -51,4 +54,21 @@ The following arguments are supported:
* `tenant_id` - (Optional)
* `tenant_name` - (Optional)
* `tenant_name` - (Optional) If omitted, the `OS_TENANT_NAME` environment
variable is used.
## Testing
In order to run the Acceptance Tests for development, the following environment
variables must also be set:
* `OS_REGION_NAME` - The region in which to create the server instance.
* `OS_IMAGE_ID` or `OS_IMAGE_NAME` - a UUID or name of an existing image in
Glance.
* `OS_FLAVOR_ID` or `OS_FLAVOR_NAME` - an ID or name of an existing flavor.
* `OS_POOL_NAME` - The name of a Floating IP pool.
* `OS_NETWORK_ID` - The UUID of a network in your test environment.

View File

@ -66,3 +66,6 @@ The following attributes are exported:
* `snapshot_id` - See Argument Reference above.
* `metadata` - See Argument Reference above.
* `volume_type` - See Argument Reference above.
* `attachment` - If a volume is attached to an instance, this attribute will
display the Attachment ID, Instance ID, and the Device as the Instance
sees it.

View File

@ -47,6 +47,12 @@ The following arguments are supported:
* `flavor_name` - (Optional; Required if `flavor_id` is empty) The name of the
desired flavor for the server. Changing this resizes the existing server.
* `floating_ip` - (Optional) A Floating IP that will be associated with the
Instance. The Floating IP must be provisioned already.
* `user_data` - (Optional) The user data to provide when launching the instance.
Changing this creates a new server.
* `security_groups` - (Optional) An array of one or more security group names
to associate with the server. Changing this results in adding/removing
security groups from the existing server.
@ -61,6 +67,9 @@ The following arguments are supported:
* `metadata` - (Optional) Metadata key/value pairs to make available from
within the instance. Changing this updates the existing server metadata.
* `config_drive` - (Optional) Whether to use the config_drive feature to
configure the instance. Changing this creates a new server.
* `admin_pass` - (Optional) The administrative password to assign to the server.
Changing this changes the root password on the existing server.
@ -76,13 +85,16 @@ The following arguments are supported:
The `network` block supports:
* `uuid` - (Required unless `port` is provided) The network UUID to attach to
the server.
* `port` - (Required unless `uuid` is provided) The port UUID of a network to
* `uuid` - (Required unless `port` or `name` is provided) The network UUID to
attach to the server.
* `fixed_ip` - (Optional) Specifies a fixed IP address to be used on this
* `name` - (Required unless `uuid` or `port` is provided) The human-readable
name of the network.
* `port` - (Required unless `uuid` or `name` is provided) The port UUID of a
network to attach to the server.
* `fixed_ip_v4` - (Optional) Specifies a fixed IPv4 address to be used on this
network.
The `block_device` block supports:
@ -113,8 +125,25 @@ The following attributes are exported:
* `region` - See Argument Reference above.
* `name` - See Argument Reference above.
* `access_ip_v4` - See Argument Reference above.
* `access_ip_v6` - See Argument Reference above.
* `access_ip_v4` - The first detected Fixed IPv4 address _or_ the
Floating IP.
* `access_ip_v6` - The first detected Fixed IPv6 address.
* `metadata` - See Argument Reference above.
* `security_groups` - See Argument Reference above.
* `flavor_ref` - See Argument Reference above.
* `flavor_id` - See Argument Reference above.
* `flavor_name` - See Argument Reference above.
* `network/uuid` - See Argument Reference above.
* `network/name` - See Argument Reference above.
* `network/port` - See Argument Reference above.
* `network/fixed_ip_v4` - The Fixed IPv4 address of the Instance on that
network.
* `network/fixed_ip_v6` - The Fixed IPv6 address of the Instance on that
network.
* `network/mac` - The MAC address of the NIC on that network.
## Notes
If you configure the instance to have multiple networks, be aware that only
the first network can be associated with a Floating IP. So the first network
in the instance resource _must_ be the network that you have configured to
communicate with your floating IP / public network via a Neutron Router.