-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
provider/powerdns: Add site documentation
- Loading branch information
Showing
5 changed files
with
102 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
website/source/docs/providers/powerdns/index.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
layout: "powerdns" | ||
page_title: "Provider: PowerDNS" | ||
sidebar_current: "docs-powerdns-index" | ||
description: |- | ||
The PowerDNS provider is used manipulate DNS records supported by PowerDNS server. The provider needs to be configured with the proper credentials before it can be used. | ||
--- | ||
|
||
# PowerDNS Provider | ||
|
||
The PowerDNS provider is used manipulate DNS records supported by PowerDNS server. 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 PowerDNS provider | ||
provider "powerdns" { | ||
api_key = "${var.pdns_api_key}" | ||
server_url = "${var.pdns_server_url}" | ||
} | ||
# Create a record | ||
resource "powerdns_record" "www" { | ||
... | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `api_key` - (Required) The PowerDNS API key. This can also be specified with `PDNS_API_KEY` environment variable. | ||
* `server_url` - (Required) The address of PowerDNS server. This can also be specified with `PDNS_SERVER_URL` environment variable. |
35 changes: 35 additions & 0 deletions
35
website/source/docs/providers/powerdns/r/record.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
layout: "powerdns" | ||
page_title: "PowerDNS: powerdns_record" | ||
sidebar_current: "docs-powerdns-resource-record" | ||
description: |- | ||
Provides a PowerDNS record resource. | ||
--- | ||
|
||
# powerdns\_record | ||
|
||
Provides a PowerDNS record resource. | ||
|
||
## Example Usage | ||
|
||
``` | ||
# Add a record to the zone | ||
resource "powerdns_record" "foobar" { | ||
zone = "example.com" | ||
name = "www.example.com" | ||
This comment has been minimized.
Sorry, something went wrong. |
||
type = "A" | ||
ttl = 300 | ||
records = ["192.168.0.11"] | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `zone` - (Required) The name of zone to contain this record. | ||
* `name` - (Required) The name of the record. | ||
* `type` - (Required) The record type. | ||
* `ttl` - (Required) The TTL of the record. | ||
* `records` - (Required) A string list of records. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<% 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">« Documentation Home</a> | ||
</li> | ||
|
||
<li<%= sidebar_current("docs-powerdns-index") %>> | ||
<a href="/docs/providers/powerdns/index.html">PowerDNS Provider</a> | ||
</li> | ||
|
||
<li<%= sidebar_current(/^docs-powerdns-resource/) %>> | ||
<a href="#">Resources</a> | ||
<ul class="nav nav-visible"> | ||
<li<%= sidebar_current("docs-powerdns-resource-record") %>> | ||
<a href="/docs/providers/powerdns/r/record.html">powerdns_record</a> | ||
</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</div> | ||
<% end %> | ||
|
||
<%= yield %> | ||
<% end %> |
In this example the name value should be terminated by a . (dot) otherwise an error is raised during Terraform apply: powerdns_record.www: Failed to create PowerDNS Record: Error creating record set: www.example.org-A, reason: "DNS Name 'www.example.org' is not canonical"
So the example under the "powerdns_record" should be as follow: name = "www.example.com**.**"