update docs to reflect resource region and versioning

This commit is contained in:
Jon Perritt 2015-01-26 19:26:53 -07:00
parent d86cb6be1c
commit d80a02c12d
12 changed files with 161 additions and 95 deletions

View File

@ -19,15 +19,14 @@ Use the navigation to the left to read about the available resources.
```
# Configure the OpenStack Provider
provider "openstack" {
username = "admin"
user_name = "admin"
tenant_name = "admin"
password = "pwd"
auth_url = "http://myauthurl:5000/v2.0"
region = "RegionOne"
}
# Create a web server
resource "openstack_compute_instance" "test-server" {
resource "openstack_compute_instance_v2" "test-server" {
...
}
```
@ -36,12 +35,20 @@ resource "openstack_compute_instance" "test-server" {
The following arguments are supported:
* `username` - (Required)
* `tenant_name` - (Required)
* `password` - (Required)
* `auth_url` - (Required)
* `region` - (Required)
* `user_name` - (Optional; Required for Identity V2)
* `user_id` - (Optional)
* `password` - (Optional; Required if not using `api_key`)
* `api_key` - (Optional; Required if not using `password`)
* `domain_id` - (Optional)
* `domain_name` - (Optional)
* `tenant_id` - (Optional)
* `tenant_name` - (Optional)

View File

@ -1,19 +1,19 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_compute_instance"
sidebar_current: "docs-openstack-resource-compute-instance"
page_title: "OpenStack: openstack_compute_instance_v2"
sidebar_current: "docs-openstack-resource-compute-instance-v2"
description: |-
Manages a VM instance resource within OpenStack.
Manages a V2 VM instance resource within OpenStack.
---
# openstack\_compute\_instance
# openstack\_compute\_instance_v2
Manages a VM instance resource within OpenStack.
Manages a V2 VM instance resource within OpenStack.
## Example Usage
```
resource "openstack_compute_instance" "test-server" {
resource "openstack_compute_instance_v2" "test-server" {
name = "tf-test"
image_ref = "ad091b52-742f-469e-8f3c-fd81cadf0743"
flavor_ref = "3"
@ -29,6 +29,10 @@ resource "openstack_compute_instance" "test-server" {
The following arguments are supported:
* `region` - (Required) The region in which to create the server instance. If
omitted, the `OS_REGION_NAME` environment variable is used. Changing this
creates a new server.
* `name` - (Required) A unique name for the resource.
* `image_ref` - (Required) The image reference (ID) for the desired image for
@ -73,6 +77,7 @@ The `network` block supports:
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.

View File

@ -1,19 +1,19 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_compute_keypair"
sidebar_current: "docs-openstack-resource-compute-keypair"
page_title: "OpenStack: openstack_compute_keypair_v2"
sidebar_current: "docs-openstack-resource-compute-keypair-v2"
description: |-
Manages a keypair resource within OpenStack.
Manages a V2 keypair resource within OpenStack.
---
# openstack\_compute\_keypair
# openstack\_compute\_keypair_v2
Manages a keypair resource within OpenStack.
Manages a V2 keypair resource within OpenStack.
## Example Usage
```
resource "openstack_compute_keypair" "test-keypair" {
resource "openstack_compute_keypair_v2" "test-keypair" {
name = "my-keypair"
public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAjpC1hwiOCCmKEWxJ4qzTTsJbKzndLotBCz5PcwtUnflmU+gHJtWMZKpuEGVi29h0A/+ydKek1O18k10Ff+4tyFjiHDQAnOfgWf7+b1yK+qDip3X1C0UPMbwHlTfSGWLGZqd9LvEFx9k3h/M+VtMvwR1lJ9LUyTAImnNjWG7TaIPmui30HvM2UiFEmqkr4ijq45MyX2+fLIePLRIF61p4whjHAQYufqyno3BS48icQb4p6iVEZPo4AE2o9oIyQvj2mx4dk5Y8CgSETOZTYDOR3rU2fZTRDRgPJDH9FWvQjF5tA0p3d9CoWWd2s6GKKbfoUIi8R/Db1BSPJwkqB"
}
@ -23,6 +23,11 @@ resource "openstack_compute_keypair" "test-keypair" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Compute client.
Keypairs are associated with accounts, but a Compute client is needed to
create one. If omitted, the `OS_REGION_NAME` environment variable is used.
Changing this creates a new keypair.
* `name` - (Required) A unique name for the keypair. Changing this creates a new
keypair.
@ -33,5 +38,6 @@ The following arguments are supported:
The following attributes are exported:
* `region` - See Argument Reference above.
* `name` - See Argument Reference above.
* `public_key` - See Argument Reference above.

View File

@ -1,19 +1,19 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_compute_secgroup"
sidebar_current: "docs-openstack-resource-compute-secgroup"
page_title: "OpenStack: openstack_compute_secgroup_v2"
sidebar_current: "docs-openstack-resource-compute-secgroup-2"
description: |-
Manages a security group resource within OpenStack.
Manages a V2 security group resource within OpenStack.
---
# openstack\_compute\_secgroup
# openstack\_compute\_secgroup_v2
Manages a security group resource within OpenStack.
Manages a V2 security group resource within OpenStack.
## Example Usage
```
resource "openstack_compute_secgroup" "secgroup_1" {
resource "openstack_compute_secgroup_v2" "secgroup_1" {
name = "my_secgroup"
description = "my security group"
}
@ -23,6 +23,11 @@ resource "openstack_compute_secgroup" "secgroup_1" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Compute client.
A Compute client is needed to create a security group. If omitted, the
`OS_REGION_NAME` environment variable is used. Changing this creates a new
security group.
* `name` - (Required) A unique name for the security group. Changing this
updates the `name` of an existing security group.
@ -33,5 +38,6 @@ The following arguments are supported:
The following attributes are exported:
* `region` - See Argument Reference above.
* `name` - See Argument Reference above.
* `description` - See Argument Reference above.

View File

@ -1,25 +1,25 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_compute_secgrouprule"
sidebar_current: "docs-openstack-resource-compute-secgrouprule"
page_title: "OpenStack: openstack_compute_secgrouprule_v2"
sidebar_current: "docs-openstack-resource-compute-secgrouprule-v2"
description: |-
Manages a security group rule resource within OpenStack.
Manages a V2 security group rule resource within OpenStack.
---
# openstack\_compute\_secgrouprule
# openstack\_compute\_secgrouprule_v2
Manages a security group rule resource within OpenStack.
Manages a V2 security group rule resource within OpenStack.
## Example Usage
```
resource "openstack_compute_secgroup" "secgroup_1" {
resource "openstack_compute_secgroup_v2" "secgroup_1" {
name = "my_secgroup"
description = "my security group"
}
resource "openstack_compute_secgrouprule" "secgrouprule_1" {
group_id = "${openstack_compute_secgroup.secgroup_1.id}"
resource "openstack_compute_secgrouprule_v2" "secgrouprule_1" {
group_id = "${openstack_compute_secgroup_v2.secgroup_1.id}"
from_port = 22
to_port = 22
ip_protocol = "TCP"
@ -31,6 +31,11 @@ resource "openstack_compute_secgrouprule" "secgrouprule_1" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Compute client.
A Compute client is needed to create a security group rule. If omitted, the
`OS_REGION_NAME` environment variable is used. Changing this creates a new
security group rule.
* `group_id` - (Required) The ID of the group to which this rule will be added.
Changing this creates a new security group rule.
@ -55,6 +60,7 @@ The following arguments are supported:
The following attributes are exported:
* `region` - See Argument Reference above.
* `group_id` - See Argument Reference above.
* `from_port` - See Argument Reference above.
* `to_port` - See Argument Reference above.

View File

@ -1,22 +1,22 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_lb_member"
sidebar_current: "docs-openstack-resource-lb-member"
page_title: "OpenStack: openstack_lb_member_v1"
sidebar_current: "docs-openstack-resource-lb-member-v1"
description: |-
Manages a load balancer member resource within OpenStack.
Manages a V1 load balancer member resource within OpenStack.
---
# openstack\_lb\_member
# openstack\_lb\_member_v1
Manages a load balancer member resource within OpenStack.
Manages a V1 load balancer member resource within OpenStack.
## Example Usage
```
resource "openstack_lb_member" "node_1" {
resource "openstack_lb_member_v1" "node_1" {
address = "196.172.0.1"
port = 80
pool_id = "$12345"
pool_id = "12345"
admin_state_up = true
}
```
@ -25,6 +25,11 @@ resource "openstack_lb_member" "node_1" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Networking client.
A Networking client is needed to create an LB member. If omitted, the
`OS_REGION_NAME` environment variable is used. Changing this creates a new
LB member.
* `address` - (Required) The IP address of the member. Changing this creates a
new member.
@ -45,6 +50,7 @@ The following arguments are supported:
The following attributes are exported:
* `region` - See Argument Reference above.
* `address` - See Argument Reference above.
* `port` - See Argument Reference above.
* `pool_id` - See Argument Reference above.

View File

@ -1,19 +1,19 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_lb_monitor"
sidebar_current: "docs-openstack-resource-lb-monitor"
page_title: "OpenStack: openstack_lb_monitor_v1"
sidebar_current: "docs-openstack-resource-lb-monitor-v1"
description: |-
Manages a load balancer monitor resource within OpenStack.
Manages a V1 load balancer monitor resource within OpenStack.
---
# openstack\_lb\_monitor
# openstack\_lb\_monitor_v1
Manages a load balancer monitor resource within OpenStack.
Manages a V1 load balancer monitor resource within OpenStack.
## Example Usage
```
resource "openstack_lb_monitor" "monitor_1" {
resource "openstack_lb_monitor_v1" "monitor_1" {
type = "PING"
delay = 30
timeout = 5
@ -26,6 +26,11 @@ resource "openstack_lb_monitor" "monitor_1" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Networking client.
A Networking client is needed to create an LB monitor. If omitted, the
`OS_REGION_NAME` environment variable is used. Changing this creates a new
LB monitor.
* `type` - (Required) The type of probe, which is PING, TCP, HTTP, or HTTPS,
that is sent by the monitor to verify the member state. Changing this
creates a new monitor.
@ -65,6 +70,7 @@ The following arguments are supported:
The following attributes are exported:
* `region` - See Argument Reference above.
* `type` - See Argument Reference above.
* `delay` - See Argument Reference above.
* `timeout` - See Argument Reference above.

View File

@ -1,19 +1,19 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_lb_pool"
sidebar_current: "docs-openstack-resource-lb-pool"
page_title: "OpenStack: openstack_lb_pool_v1"
sidebar_current: "docs-openstack-resource-lb-pool-v1"
description: |-
Manages a load balancer pool resource within OpenStack.
Manages a V1 load balancer pool resource within OpenStack.
---
# openstack\_lb\_pool
# openstack\_lb\_pool_v1
Manages a load balancer pool resource within OpenStack.
Manages a V1 load balancer pool resource within OpenStack.
## Example Usage
```
resource "openstack_lb_pool" "pool_1" {
resource "openstack_lb_pool_v1" "pool_1" {
name = "tf_test_lb_pool"
protocol = "HTTP"
subnet_id = "12345"
@ -26,6 +26,11 @@ resource "openstack_lb_pool" "pool_1" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Networking client.
A Networking client is needed to create an LB pool. If omitted, the
`OS_REGION_NAME` environment variable is used. Changing this creates a new
LB pool.
* `name` - (Required) The name of the pool. Changing this updates the name of
the existing pool.
@ -50,6 +55,7 @@ The following arguments are supported:
The following attributes are exported:
* `region` - See Argument Reference above.
* `name` - See Argument Reference above.
* `protocol` - See Argument Reference above.
* `subnet_id` - See Argument Reference above.

View File

@ -1,19 +1,19 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_lb_vip"
sidebar_current: "docs-openstack-resource-lb-vip"
page_title: "OpenStack: openstack_lb_vip_v1"
sidebar_current: "docs-openstack-resource-lb-vip-v1"
description: |-
Manages a load balancer vip resource within OpenStack.
Manages a V1 load balancer vip resource within OpenStack.
---
# openstack\_lb\_vip
# openstack\_lb\_vip_v1
Manages a load balancer vip resource within OpenStack.
Manages a V1 load balancer vip resource within OpenStack.
## Example Usage
```
resource "openstack_lb_vip" "vip_1" {
resource "openstack_lb_vip_v1" "vip_1" {
name = "tf_test_lb_vip"
subnet_id = "12345"
protocol = "HTTP"
@ -26,6 +26,11 @@ resource "openstack_lb_vip" "vip_1" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Networking client.
A Networking client is needed to create a VIP. If omitted, the
`OS_REGION_NAME` environment variable is used. Changing this creates a new
VIP.
* `name` - (Required) The name of the vip. Changing this updates the name of
the existing vip.
@ -76,6 +81,7 @@ The `persistence` block supports:
The following attributes are exported:
* `region` - See Argument Reference above.
* `name` - See Argument Reference above.
* `subnet_id` - See Argument Reference above.
* `protocol` - See Argument Reference above.

View File

@ -1,19 +1,19 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_networking_network"
sidebar_current: "docs-openstack-resource-networking-network"
page_title: "OpenStack: openstack_networking_network_v2"
sidebar_current: "docs-openstack-resource-networking-network-v2"
description: |-
Manages a Neutron network resource within OpenStack.
Manages a V2 Neutron network resource within OpenStack.
---
# openstack\_networking\_network
# openstack\_networking\_network_v2
Manages a Neutron network resource within OpenStack.
Manages a V2 Neutron network resource within OpenStack.
## Example Usage
```
resource "openstack_networking_network" "network_1" {
resource "openstack_networking_network_v2" "network_1" {
name = "tf_test_network"
admin_state_up = "true"
}
@ -23,6 +23,11 @@ resource "openstack_networking_network" "network_1" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Networking client.
A Networking client is needed to create a Neutron network. If omitted, the
`OS_REGION_NAME` environment variable is used. Changing this creates a new
network.
* `name` - (Optional) The name of the network. Changing this updates the name of
the existing network.
@ -41,6 +46,7 @@ The following arguments are supported:
The following attributes are exported:
* `region` - See Argument Reference above.
* `name` - See Argument Reference above.
* `shared` - See Argument Reference above.
* `tenant_id` - See Argument Reference above.

View File

@ -1,25 +1,25 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_networking_subnet"
sidebar_current: "docs-openstack-resource-networking-subnet"
page_title: "OpenStack: openstack_networking_subnet_v2"
sidebar_current: "docs-openstack-resource-networking-subnet-v2"
description: |-
Manages a Neutron subnet resource within OpenStack.
Manages a V2 Neutron subnet resource within OpenStack.
---
# openstack\_networking\_subnet
# openstack\_networking\_subnet_v2
Manages a Neutron subnet resource within OpenStack.
Manages a V2 Neutron subnet resource within OpenStack.
## Example Usage
```
resource "openstack_networking_network" "network_1" {
resource "openstack_networking_network_v2" "network_1" {
name = "tf_test_network"
admin_state_up = "true"
}
resource "openstack_networking_subnet" "subnet_1" {
network_id = "${openstack_networking_network.network_1.id}"
resource "openstack_networking_subnet_v2" "subnet_1" {
network_id = "${openstack_networking_network_v2.network_1.id}"
cidr = "192.168.199.0/24"
ip_version = 4
}
@ -29,6 +29,11 @@ resource "openstack_networking_subnet" "subnet_1" {
The following arguments are supported:
* `region` - (Required) The region in which to obtain the V2 Networking client.
A Networking client is needed to create a Neutron subnet. If omitted, the
`OS_REGION_NAME` environment variable is used. Changing this creates a new
subnet.
* `network_id` - (Required) The UUID of the parent network. Changing this
creates a new subnet.
@ -80,6 +85,7 @@ The `host_routes` block supports:
The following attributes are exported:
* `region` - See Argument Reference above.
* `network_id` - See Argument Reference above.
* `cidr` - See Argument Reference above.
* `ip_version` - See Argument Reference above.

View File

@ -13,35 +13,35 @@
<li<%= sidebar_current("docs-openstack-resource") %>>
<a href="#">Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-openstack-resource-compute-instance") %>>
<a href="/docs/providers/openstack/r/compute_instance.html">openstack_compute_instance</a>
<li<%= sidebar_current("docs-openstack-resource-compute-instance-v2") %>>
<a href="/docs/providers/openstack/r/compute_instance_v2.html">openstack_compute_instance_v2</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-compute-keypair") %>>
<a href="/docs/providers/openstack/r/compute_keypair.html">openstack_compute_keypair</a>
<li<%= sidebar_current("docs-openstack-resource-compute-keypair-v2") %>>
<a href="/docs/providers/openstack/r/compute_keypair_v2.html">openstack_compute_keypair_v2</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-compute-secgroup") %>>
<a href="/docs/providers/openstack/r/compute_secgroup.html">openstack_compute_secgroup</a>
<li<%= sidebar_current("docs-openstack-resource-compute-secgroup-v2") %>>
<a href="/docs/providers/openstack/r/compute_secgroup_v2.html">openstack_compute_secgroup_v2</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-compute-secgrouprule") %>>
<a href="/docs/providers/openstack/r/compute_secgrouprule.html">openstack_compute_secgrouprule</a>
<li<%= sidebar_current("docs-openstack-resource-compute-secgrouprule-v2") %>>
<a href="/docs/providers/openstack/r/compute_secgrouprule_v2.html">openstack_compute_secgrouprule_v2</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-lb-member") %>>
<a href="/docs/providers/openstack/r/lb_member.html">openstack_lb_member</a>
<li<%= sidebar_current("docs-openstack-resource-lb-member-v1") %>>
<a href="/docs/providers/openstack/r/lb_member_v1.html">openstack_lb_member_v1</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-lb-monitor") %>>
<a href="/docs/providers/openstack/r/lb_monitor.html">openstack_lb_monitor</a>
<li<%= sidebar_current("docs-openstack-resource-lb-monitor-v1") %>>
<a href="/docs/providers/openstack/r/lb_monitor_v1.html">openstack_lb_monitor_v1</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-lb-pool") %>>
<a href="/docs/providers/openstack/r/lb_pool.html">openstack_lb_pool</a>
<li<%= sidebar_current("docs-openstack-resource-lb-pool-v1") %>>
<a href="/docs/providers/openstack/r/lb_pool_v1.html">openstack_lb_pool_v1</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-lb-vip") %>>
<a href="/docs/providers/openstack/r/lb_vip.html">openstack_lb_vip</a>
<li<%= sidebar_current("docs-openstack-resource-lb-vip-v1") %>>
<a href="/docs/providers/openstack/r/lb_vip_v1.html">openstack_lb_vip_v1</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-networking-network") %>>
<a href="/docs/providers/openstack/r/networking_network.html">openstack_networking_network</a>
<li<%= sidebar_current("docs-openstack-resource-networking-network-v2") %>>
<a href="/docs/providers/openstack/r/networking_network_v2.html">openstack_networking_network_v2</a>
</li>
<li<%= sidebar_current("docs-openstack-resource-networking-subnet") %>>
<a href="/docs/providers/openstack/r/networking_subnet.html">openstack_networking_subnet</a>
<li<%= sidebar_current("docs-openstack-resource-networking-subnet-v2") %>>
<a href="/docs/providers/openstack/r/networking_subnet_v2.html">openstack_networking_subnet_v2</a>
</li>
</ul>
</li>