Skip to content

Commit

Permalink
docs: rebuild them, include dnssec resource
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeCarrier authored and lexfrei committed Nov 7, 2024
1 parent bff94a5 commit 8cf268b
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Supported features:

## Usage

```HCL
```hcl
# Set up the provider
terraform {
required_providers {
Expand Down
13 changes: 7 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ description: |-

This provider allows you to manage your [namedotcom](https://www.namedotcom.com/) account.

Currently, this provider only supports the following resources:
Currently, this provider supports the following resources:

- [namedotcom_domain_nameservers](resources/domain_nameservers.md)
- [namedotcom_record](resources/record.md)
- [`namedotcom_dnssec`](resources/dnssec.md)
- [`namedotcom_domain_nameservers`](resources/domain_nameservers.md)
- [`namedotcom_record`](resources/record.md)

## Example Usage

```HCL
```hcl
terraform {
required_providers {
namedotcom = {
Expand All @@ -41,5 +42,5 @@ provider "namedotcom" {

### Required

- `token` (String) Name.com API Token Value
- `username` (String) Name.com API Username
- `username` (String) Name.com API Username; can alternatively be specified via `NAMEDOTCOM_USERNAME` environment variable.
- `token` (String) Name.com API Token Value; can alternatively be specified via `NAMEDOTCOM_TOKEN` environment variable.
37 changes: 37 additions & 0 deletions docs/resources/dnssec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "namedotcom_dnssec Resource - terraform-provider-namedotcom"
subcategory: ""
description: |-
---

# namedotcom_dnssec (Resource)

## Example usage

```hcl
resource "namedotcom_dnssec" "this" {
domain_name = var.domain
key_tag = var.dnssec.key_tag
algorithm = 13
digest_type = 2
digest = "6B3ED3311DE85004BF6DD325BA82340BC89B40B86D4055780F3BE4390B81B59A"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `algorithm` (Number) Algorithm is an integer identifying the algorithm used for signing.
- `digest` (String) Digest is a digest of the DNSKEY RR that is registered with the registry.
- `digest_type` (Number) DigestType is an integer identifying the algorithm used to create the digest.
- `domain_name` (String) DomainName is the zone that the DNSSEC belongs to
- `key_tag` (Number) KeyTag contains the key tag value of the DNSKEY RR that validates this signature.

### Read-Only

- `id` (String) The ID of this resource.
2 changes: 1 addition & 1 deletion docs/resources/domain_nameservers.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: |-

Setting nameservers from a generated hosted_zone

```HCL
```hcl
provider "aws" {
region = "us-west-2"
}
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/record.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

## Example Usage

```HCL
```hcl
// example.com CNAME -> bar.com
resource "namedotcom_record" "bar" {
Expand All @@ -32,7 +32,7 @@ resource "namedotcom_record" "foo" {

Many records per domain example

```HCL
```hcl
resource "namedotcom_record" "domain-me" {
domain_name = "domain.me"
record_type = "A"
Expand Down

0 comments on commit 8cf268b

Please sign in to comment.