Dyn provider docs

This commit is contained in:
David Radcliffe 2015-07-21 20:43:20 -04:00
parent 9b2ec3ac53
commit 76dcc66597
3 changed files with 104 additions and 0 deletions

View File

@ -0,0 +1,39 @@
---
layout: "dyn"
page_title: "Provider: Dyn"
sidebar_current: "docs-dyn-index"
description: |-
The Dyn provider is used to interact with the resources supported by Dyn. The provider needs to be configured with the proper credentials before it can be used.
---
# Dyn Provider
The Dyn provider is used to interact with the
resources supported by Dyn. The provider needs to be configured
with the proper credentials before it can be used.
Use the navigation to the left to read about the available resources.
## Example Usage
```
# Configure the Dyn provider
provider "dyn" {
customer_name = "${var.dyn_customer_name}"
username = "${var.dyn_username}"
password = "${var.dyn_password}"
}
# Create a record
resource "dyn_record" "www" {
...
}
```
## Argument Reference
The following arguments are supported:
* `customer_name` - (Required) The Dyn customer name. It must be provided, but it can also be sourced from the `DYN_CUSTOMER_NAME` environment variable.
* `username` - (Required) The Dyn username. It must be provided, but it can also be sourced from the `DYN_USERNAME` environment variable.
* `password` - (Required) The Dyn password. It must be provided, but it can also be sourced from the `DYN_PASSWORD` environment variable.

View File

@ -0,0 +1,41 @@
---
layout: "dyn"
page_title: "Dyn: dyn_record"
sidebar_current: "docs-dyn-resource-record"
description: |-
Provides a Dyn DNS record resource.
---
# dyn\_record
Provides a Dyn DNS record resource.
## Example Usage
```
# Add a record to the domain
resource "dyn_record" "foobar" {
zone = "${var.dyn_zone}"
name = "terraform"
value = "192.168.0.11"
type = "A"
ttl = 3600
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) The name of the record.
* `type` - (Required) The type of the record.
* `value` - (Required) The value of the record.
* `zone` - (Required) The DNS zone to add the record to.
* `ttl` - (Optional) The TTL of the record. Default uses the zone default.
## Attributes Reference
The following attributes are exported:
* `id` - The record ID.
* `fqdn` - The FQDN of the record, built from the `name` and the `zone`.

View File

@ -0,0 +1,24 @@
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<div class="docs-sidebar hidden-print affix-top" role="complementary">
<ul class="nav docs-sidenav">
<li<%= sidebar_current("docs-home") %>>
<a href="/docs/providers/index.html">&laquo; Documentation Home</a>
</li>
<li<%= sidebar_current("docs-dyn-index") %>>
<a href="/docs/providers/dyn/index.html">Dyn Provider</a>
</li>
<li<%= sidebar_current(/^docs-dyn-resource/) %>>
<a href="#">Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-dyn-resource-record") %>>
<a href="/docs/providers/dyn/r/record.html">dyn_record</a>
</li>
</ul>
</li>
</ul>
</div>
<% end %>
<%= yield %>
<% end %>