Skip to content

Commit

Permalink
Generate new data-source docs
Browse files Browse the repository at this point in the history
  • Loading branch information
browningluke committed Jul 29, 2023
1 parent fcfa77e commit d80a5b9
Show file tree
Hide file tree
Showing 6 changed files with 0 additions and 153 deletions.
21 changes: 0 additions & 21 deletions docs/data-sources/interfaces_vlan.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,6 @@ description: |-

VLANs (Virtual LANs) can be used to segment a single physical network into multiple virtual networks.

## Example Usage

```terraform
// OPNsense generates a device name
resource "opnsense_interfaces_vlan" "vlan" {
description = "Example vlan"
tag = 10
priority = 0
parent = "vtnet0"
}
// Manually configure a device name
resource "opnsense_interfaces_vlan" "vlan04" {
description = "Example vlan 4"
tag = 50
priority = 5
parent = "vtnet0"
device = "vlan04"
}
```

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

Expand Down
19 changes: 0 additions & 19 deletions docs/data-sources/route.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,6 @@ description: |-

Routes can be used to teach your firewall which path it should take when forwarding packets to a specific network.

## Example Usage

```terraform
// Enabled with description
resource "opnsense_route" "one_route" {
description = "Example route"
gateway = "LAN_DHCP"
network = "10.9.0.0/24"
}
// Disabled without description
resource "opnsense_route" "two_route" {
enabled = false
gateway = "LAN"
network = "10.10.0.0/24"
}
```

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

Expand Down
21 changes: 0 additions & 21 deletions docs/data-sources/unbound_domain_override.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,6 @@ description: |-

Domain overrides can be used to forward queries for specific domains (and subsequent subdomains) to local or remote DNS servers.

## Example Usage

```terraform
// Enabled with description
resource "opnsense_unbound_domain_override" "one_override" {
enabled = true
description = "Example override"
domain = "example.lan"
server = "192.168.1.1"
}
// Disabled without description
resource "opnsense_unbound_domain_override" "two_override" {
enabled = false
domain = "example.arpa"
server = "192.168.1.100"
}
```

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

Expand Down
22 changes: 0 additions & 22 deletions docs/data-sources/unbound_forward.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,6 @@ description: |-

Query Forwarding section allows for entering arbitrary nameservers to forward queries to. Can forward queries normally, or over TLS.

## Example Usage

```terraform
// Query Forward
resource "opnsense_unbound_forward" "query" {
domain = "example.lan"
server_ip = "192.168.1.2"
server_port = 853
}
// DoT forward
resource "opnsense_unbound_forward" "dot" {
enabled = false
type = "dot"
domain = "example.dev"
server_ip = "192.168.1.1"
server_port = 53
verify_cn = "example.dev"
}
```

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

Expand Down
33 changes: 0 additions & 33 deletions docs/data-sources/unbound_host_alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,6 @@ description: |-

Host aliases can be used to create alternative names for a Host.

## Example Usage

```terraform
// 'A' record
resource "opnsense_unbound_host_override" "a_override" {
enabled = true
description = "A record override"
hostname = "*"
domain = "example.com"
server = "192.168.1.1"
}
// Enabled alias with description
resource "opnsense_unbound_host_alias" "one_alias" {
override = opnsense_unbound_host_override.a_override.id
enabled = true
hostname = "*"
domain = "1.example.com"
description = "Example 1"
}
// Disabled alias without description
resource "opnsense_unbound_host_alias" "two_alias" {
override = opnsense_unbound_host_override.a_override.id
enabled = false
hostname = "*"
domain = "2.example.com"
}
```

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

Expand Down
37 changes: 0 additions & 37 deletions docs/data-sources/unbound_host_override.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,43 +9,6 @@ description: |-

Host overrides can be used to change DNS results from client queries or to add custom DNS records.

## Example Usage

```terraform
// 'A' record
resource "opnsense_unbound_host_override" "a_override" {
enabled = true
description = "A record override"
hostname = "*"
domain = "example.com"
server = "192.168.1.1"
}
// 'AAAA' record
resource "opnsense_unbound_host_override" "aaaa_override" {
enabled = true
type = "AAAA"
hostname = "*"
domain = "example.com"
server = "fd00:abcd::1"
}
// 'MX' record
resource "opnsense_unbound_host_override" "mx_override" {
enabled = false
description = "MX record override"
type = "MX"
hostname = "*"
domain = "example.com"
mx_priority = 10
mx_host = "mail.example.dev"
}
```

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

Expand Down

0 comments on commit d80a5b9

Please sign in to comment.