Skip to content

Commit 76dcc66

Browse files
committed
Dyn provider docs
1 parent 9b2ec3a commit 76dcc66

3 files changed

Lines changed: 104 additions & 0 deletions

File tree

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: "dyn"
3+
page_title: "Provider: Dyn"
4+
sidebar_current: "docs-dyn-index"
5+
description: |-
6+
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.
7+
---
8+
9+
# Dyn Provider
10+
11+
The Dyn provider is used to interact with the
12+
resources supported by Dyn. The provider needs to be configured
13+
with the proper credentials before it can be used.
14+
15+
Use the navigation to the left to read about the available resources.
16+
17+
## Example Usage
18+
19+
```
20+
# Configure the Dyn provider
21+
provider "dyn" {
22+
customer_name = "${var.dyn_customer_name}"
23+
username = "${var.dyn_username}"
24+
password = "${var.dyn_password}"
25+
}
26+
27+
# Create a record
28+
resource "dyn_record" "www" {
29+
...
30+
}
31+
```
32+
33+
## Argument Reference
34+
35+
The following arguments are supported:
36+
37+
* `customer_name` - (Required) The Dyn customer name. It must be provided, but it can also be sourced from the `DYN_CUSTOMER_NAME` environment variable.
38+
* `username` - (Required) The Dyn username. It must be provided, but it can also be sourced from the `DYN_USERNAME` environment variable.
39+
* `password` - (Required) The Dyn password. It must be provided, but it can also be sourced from the `DYN_PASSWORD` environment variable.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: "dyn"
3+
page_title: "Dyn: dyn_record"
4+
sidebar_current: "docs-dyn-resource-record"
5+
description: |-
6+
Provides a Dyn DNS record resource.
7+
---
8+
9+
# dyn\_record
10+
11+
Provides a Dyn DNS record resource.
12+
13+
## Example Usage
14+
15+
```
16+
# Add a record to the domain
17+
resource "dyn_record" "foobar" {
18+
zone = "${var.dyn_zone}"
19+
name = "terraform"
20+
value = "192.168.0.11"
21+
type = "A"
22+
ttl = 3600
23+
}
24+
```
25+
26+
## Argument Reference
27+
28+
The following arguments are supported:
29+
30+
* `name` - (Required) The name of the record.
31+
* `type` - (Required) The type of the record.
32+
* `value` - (Required) The value of the record.
33+
* `zone` - (Required) The DNS zone to add the record to.
34+
* `ttl` - (Optional) The TTL of the record. Default uses the zone default.
35+
36+
## Attributes Reference
37+
38+
The following attributes are exported:
39+
40+
* `id` - The record ID.
41+
* `fqdn` - The FQDN of the record, built from the `name` and the `zone`.

website/source/layouts/dyn.erb

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<% wrap_layout :inner do %>
2+
<% content_for :sidebar do %>
3+
<div class="docs-sidebar hidden-print affix-top" role="complementary">
4+
<ul class="nav docs-sidenav">
5+
<li<%= sidebar_current("docs-home") %>>
6+
<a href="/docs/providers/index.html">&laquo; Documentation Home</a>
7+
</li>
8+
<li<%= sidebar_current("docs-dyn-index") %>>
9+
<a href="/docs/providers/dyn/index.html">Dyn Provider</a>
10+
</li>
11+
<li<%= sidebar_current(/^docs-dyn-resource/) %>>
12+
<a href="#">Resources</a>
13+
<ul class="nav nav-visible">
14+
<li<%= sidebar_current("docs-dyn-resource-record") %>>
15+
<a href="/docs/providers/dyn/r/record.html">dyn_record</a>
16+
</li>
17+
</ul>
18+
</li>
19+
</ul>
20+
</div>
21+
<% end %>
22+
23+
<%= yield %>
24+
<% end %>

0 commit comments

Comments
 (0)