docs for volume and container resources

This commit is contained in:
Jon Perritt 2015-02-01 01:11:01 -07:00
parent 761d58df2f
commit 9c128b7c99
3 changed files with 142 additions and 0 deletions

View File

@ -0,0 +1,68 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_blockstorage_volume_v1"
sidebar_current: "docs-openstack-resource-blockstorage-volume-v1"
description: |-
Manages a V1 volume resource within OpenStack.
---
# openstack\_blockstorage\_volume_v1
Manages a V1 volume resource within OpenStack.
## Example Usage
```
resource "openstack_blockstorage_volume_v1" "volume_1" {
region = "RegionOne"
name = "tf-test-volume"
description = "first test volume"
size = 3
}
```
## Argument Reference
The following arguments are supported:
* `region` - (Required) The region in which to create the volume. If
omitted, the `OS_REGION_NAME` environment variable is used. Changing this
creates a new volume.
* `size` - (Required) The size of the volume to create (in gigabytes). Changing
this creates a new volume.
* `name` - (Optional) A unique name for the volume. Changing this updates the
volume's name.
* `description` - (Optional) A description of the volume. Changing this updates
the volume's description.
* `image_id` - (Optional) The image ID from which to create the volume.
Changing this creates a new volume.
* `snapshot_id` - (Optional) The snapshot ID from which to create the volume.
Changing this creates a new volume.
* `source_vol_id` - (Optional) The volume ID from which to create the volume.
Changing this creates a new volume.
* `metadata` - (Optional) Metadata key/value pairs to associate with the volume.
Changing this updates the existing volume metadata.
* `volume_type` - (Optional) The type of volume to create (either SATA or SSD).
Changing this creates a new volume.
## Attributes Reference
The following attributes are exported:
* `region` - See Argument Reference above.
* `size` - See Argument Reference above.
* `name` - See Argument Reference above.
* `description` - See Argument Reference above.
* `image_id` - See Argument Reference above.
* `source_vol_id` - See Argument Reference above.
* `snapshot_id` - See Argument Reference above.
* `metadata` - See Argument Reference above.
* `volume_type` - See Argument Reference above.

View File

@ -0,0 +1,68 @@
---
layout: "openstack"
page_title: "OpenStack: openstack_objectstorage_container_v1"
sidebar_current: "docs-openstack-resource-objectstorage-container-v1"
description: |-
Manages a V1 container resource within OpenStack.
---
# openstack\_objectstorage\_container_v1
Manages a V1 container resource within OpenStack.
## Example Usage
```
resource "openstack_objectstorage_container_v1" "container_1" {
region = "RegionOne"
name = "tf-test-container-1"
metadata {
test = "true"
}
content_type = "application/json"
}
```
## Argument Reference
The following arguments are supported:
* `region` - (Required) The region in which to create the container. If
omitted, the `OS_REGION_NAME` environment variable is used. Changing this
creates a new container.
* `name` - (Required) A unique name for the container. Changing this creates a
new container.
* `container_read` - (Optional) Sets an access control list (ACL) that grants
read access. This header can contain a comma-delimited list of users that
can read the container (allows the GET method for all objects in the
container). Changing this updates the access control list read access.
* `container_sync_to` - (Optional) The destination for container synchronization.
Changing this updates container synchronization.
* `container_sync_key` - (Optional) The secret key for container synchronization.
Changing this updates container synchronization.
* `container_write` - (Optional) Sets an ACL that grants write access.
Changing this updates the access control list write access.
* `metadata` - (Optional) Custom key/value pairs to associate with the container.
Changing this updates the existing container metadata.
* `content_type` - (Optional) The MIME type for the container. Changing this
updates the MIME type.
## Attributes Reference
The following attributes are exported:
* `region` - See Argument Reference above.
* `name` - See Argument Reference above.
* `container_read` - See Argument Reference above.
* `container_sync_to` - See Argument Reference above.
* `container_sync_key` - See Argument Reference above.
* `container_write` - See Argument Reference above.
* `metadata` - See Argument Reference above.
* `content_type` - See Argument Reference above.

View File

@ -13,6 +13,9 @@
<li<%= sidebar_current("docs-openstack-resource") %>>
<a href="#">Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-openstack-resource-blockstorage-volume-v1") %>>
<a href="/docs/providers/openstack/r/blockstorage_volume_v1.html">openstack_blockstorage_volume_v1</a>
</li>
<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>
@ -37,6 +40,9 @@
<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>
<li<%= sidebar_current("docs-openstack-resource-objectstorage-container-v1") %>>
<a href="/docs/providers/openstack/r/objectstorage_container_v1.html">openstack_objectstorage_container_v1</a>
</li>
</ul>
</li>
</ul>