update docs to remove security group rule and lb member files

This commit is contained in:
Jon Perritt 2015-01-31 17:37:11 -07:00
parent 7cdb790ece
commit 3427597bd0
5 changed files with 57 additions and 134 deletions

View File

@ -16,6 +16,12 @@ Manages a V2 security group resource within OpenStack.
resource "openstack_compute_secgroup_v2" "secgroup_1" { resource "openstack_compute_secgroup_v2" "secgroup_1" {
name = "my_secgroup" name = "my_secgroup"
description = "my security group" description = "my security group"
rule {
from_port = 22
to_port = 22
ip_protocol = "tcp"
cidr = "0.0.0.0/0"
}
} }
``` ```
@ -34,6 +40,29 @@ The following arguments are supported:
* `description` - (Required) A description for the security group. Changing this * `description` - (Required) A description for the security group. Changing this
updates the `description` of an existing security group. updates the `description` of an existing security group.
* `rule` - (Optional) A rule describing how the security group operates. The
rule object structure is documented below. Changing this updates the
security group rules.
The `rule` block supports:
* `from_port` - (Required) An integer representing the lower bound of the port
range to open. Changing this creates a new security group rule.
* `to_port` - (Required) An integer representing the upper bound of the port
range to open. Changing this creates a new security group rule.
* `ip_protocol` - (Required) The protocol type that will be allowed. Changing
this creates a new security group rule.
* `cidr` - (Optional) Required if `from_group_id` is empty. The IP range that
will be the source of network traffic to the security group. Use 0.0.0.0./0
to allow all IP addresses. Changing this creates a new security group rule.
* `from_group_id - (Optional) Required if `cidr` is empty. The ID of a group
from which to forward traffic to the parent group. Changing
this creates a new security group rule.
## Attributes Reference ## Attributes Reference
The following attributes are exported: The following attributes are exported:
@ -41,3 +70,4 @@ The following attributes are exported:
* `region` - See Argument Reference above. * `region` - See Argument Reference above.
* `name` - See Argument Reference above. * `name` - See Argument Reference above.
* `description` - See Argument Reference above. * `description` - See Argument Reference above.
* `rule` - See Argument Reference above.

View File

@ -1,69 +0,0 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_compute_secgrouprule_v2"
sidebar_current: "docs-openstack-resource-compute-secgrouprule-v2"
description: |-
Manages a V2 security group rule resource within OpenStack.
---
# openstack\_compute\_secgrouprule_v2
Manages a V2 security group rule resource within OpenStack.
## Example Usage
```
resource "openstack_compute_secgroup_v2" "secgroup_1" {
name = "my_secgroup"
description = "my security group"
}
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"
cidr = "0.0.0.0/0"
}
```
## Argument Reference
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.
* `from_port` - (Required) An integer representing the lower bound of the port
range to open. Changing this creates a new security group rule.
* `to_port` - (Required) An integer representing the upper bound of the port
range to open. Changing this creates a new security group rule.
* `ip_protocol` - (Required) The protocol type that will be allowed. Changing
this creates a new security group rule.
* `cidr` - (Optional) Required if `from_group_id` is empty. The IP range that
will be the source of network traffic to the security group. Use 0.0.0.0./0
to allow all IP addresses. Changing this creates a new security group rule.
* `from_group_id - (Optional) Required if `cidr` is empty. The ID of a group
from which to forward traffic to the parent group. Changing
this creates a new security group rule.
## Attributes Reference
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.
* `ip_protocol` - See Argument Reference above.
* `cidr` - See Argument Reference above.
* `from_group_id` - See Argument Reference above.

View File

@ -1,58 +0,0 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_lb_member_v1"
sidebar_current: "docs-openstack-resource-lb-member-v1"
description: |-
Manages a V1 load balancer member resource within OpenStack.
---
# openstack\_lb\_member_v1
Manages a V1 load balancer member resource within OpenStack.
## Example Usage
```
resource "openstack_lb_member_v1" "node_1" {
address = "196.172.0.1"
port = 80
pool_id = "12345"
admin_state_up = true
}
```
## Argument Reference
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.
* `port` - (Required) An integer representing the port on which the member is
hosted. Changing this creates a new member.
* `pool_id` - (Required) The pool to which this member will belong. Changing
this creates a new member.
* `admin_state_up` - (Optional) The administrative state of the member.
Acceptable values are 'true' and 'false'. Changing this value updates the
state of the existing member.
* `tenant_id` - (Optional) The owner of the member. Required if admin wants to
create a pool member for another tenant. Changing this creates a new member.
## Attributes Reference
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.
* `admin_state_up` - See Argument Reference above.
* `tenant_id` - See Argument Reference above.

View File

@ -18,7 +18,12 @@ resource "openstack_lb_pool_v1" "pool_1" {
protocol = "HTTP" protocol = "HTTP"
subnet_id = "12345" subnet_id = "12345"
lb_method = "ROUND_ROBIN" lb_method = "ROUND_ROBIN"
monitor_id = "67890" monitor_ids = ["67890"]
member {
address = "192.168.0.1"
port = 80
admin_state_up = "true"
}
} }
``` ```
@ -51,6 +56,26 @@ The following arguments are supported:
* `monitor_ids` - (Optional) A list of IDs of monitors to associate with the * `monitor_ids` - (Optional) A list of IDs of monitors to associate with the
pool. pool.
* `member` - (Optional) An existing node to add to the pool. Changing this
updates the members of the pool. The member object structure is documented
below.
The `member` block supports:
* `address` - (Required) The IP address of the member. Changing this creates a
new member.
* `port` - (Required) An integer representing the port on which the member is
hosted. Changing this creates a new member.
* `admin_state_up` - (Optional) The administrative state of the member.
Acceptable values are 'true' and 'false'. Changing this value updates the
state of the existing member.
* `tenant_id` - (Optional) The owner of the member. Required if admin wants to
create a pool member for another tenant. Changing this creates a new member.
## Attributes Reference ## Attributes Reference
The following attributes are exported: The following attributes are exported:
@ -62,3 +87,4 @@ The following attributes are exported:
* `lb_method` - See Argument Reference above. * `lb_method` - See Argument Reference above.
* `tenant_id` - See Argument Reference above. * `tenant_id` - See Argument Reference above.
* `monitor_id` - See Argument Reference above. * `monitor_id` - See Argument Reference above.
* `member` - See Argument Reference above.

View File

@ -22,12 +22,6 @@
<li<%= sidebar_current("docs-openstack-resource-compute-secgroup-v2") %>> <li<%= sidebar_current("docs-openstack-resource-compute-secgroup-v2") %>>
<a href="/docs/providers/openstack/r/compute_secgroup_v2.html">openstack_compute_secgroup_v2</a> <a href="/docs/providers/openstack/r/compute_secgroup_v2.html">openstack_compute_secgroup_v2</a>
</li> </li>
<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-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-v1") %>> <li<%= sidebar_current("docs-openstack-resource-lb-monitor-v1") %>>
<a href="/docs/providers/openstack/r/lb_monitor_v1.html">openstack_lb_monitor_v1</a> <a href="/docs/providers/openstack/r/lb_monitor_v1.html">openstack_lb_monitor_v1</a>
</li> </li>