Merge pull request #1496 from svanharmelen/f-cloudstack-template-docs

provider/cloudstack: adding docs for the new resource...
This commit is contained in:
Sander van Harmelen 2015-04-12 10:59:56 +02:00
commit a361a8beee
2 changed files with 82 additions and 0 deletions

View File

@ -0,0 +1,78 @@
---
layout: "cloudstack"
page_title: "CloudStack: cloudstack_template"
sidebar_current: "docs-cloudstack-resource-template"
description: |-
Registers an existing template into the CloudStack cloud.
---
# cloudstack\_template
Registers an existing template into the CloudStack cloud.
## Example Usage
```
resource "cloudstack_template" "centos64" {
name = "CentOS 6.4 x64"
format= "VHD"
hypervisor = "XenServer"
os_type = "CentOS 6.4 (64bit)"
url = "http://someurl.com/template.vhd"
zone = "zone-1"
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) The name of the template.
* `display_text` - (Optional) The display name of the template.
* `format` - (Required) The format of the template. Valid values are "QCOW2",
"RAW", and "VHD".
* `hypervisor` - (Required) The target hypervisor for the template. Changing
this forces a new resource to be created.
* `os_type` - (Required) The OS Type that best represents the OS of this
template.
* `url` - (Required) The URL of where the template is hosted. Changing this
forces a new resource to be created.
* `zone` - (Required) The name of the zone where this template will be created.
Changing this forces a new resource to be created.
* `is_dynamically_scalable` - (Optional) Set to indicate if the template contains
tools to support dynamic scaling of VM cpu/memory.
* `is_extractable` - (Optional) Set to indicate if the template is extractable
(defaults false)
* `is_featured` - (Optional) Set to indicate if the template is featured
(defaults false)
* `is_public` - (Optional) Set to indicate if the template is available for
all accounts (defaults true)
* `password_enabled` - (Optional) Set to indicate if the template should be
password enabled (defaults false)
* `is_ready_timeout` - (Optional) The maximum time in seconds to wait until the
template is ready for use (defaults 300 seconds)
## Attributes Reference
The following attributes are exported:
* `id` - The template ID.
* `display_text` - The display text of the template.
* `is_dynamically_scalable` - Set to "true" if the template is dynamically scalable.
* `is_extractable` - Set to "true" if the template is extractable.
* `is_featured` - Set to "true" if the template is featured.
* `is_public` - Set to "true" if the template is public.
* `password_enabled` - Set to "true" if the template is password enabled.
* `is_ready` - Set to "true" once the template is ready for use.

View File

@ -53,6 +53,10 @@
<a href="/docs/providers/cloudstack/r/port_forward.html">cloudstack_port_forward</a>
</li>
<li<%= sidebar_current("docs-cloudstack-resource-template") %>>
<a href="/docs/providers/cloudstack/r/template.html">cloudstack_template</a>
</li>
<li<%= sidebar_current("docs-cloudstack-resource-vpc") %>>
<a href="/docs/providers/cloudstack/r/vpc.html">cloudstack_vpc</a>
</li>