forked from nutcr4cker/terraform-kea-dhcp4
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation, add workflow unshallow step
Signed-off-by: Feliksas <[email protected]>
- Loading branch information
Showing
11 changed files
with
313 additions
and
37 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
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,49 @@ | ||
| --- | ||
| page_title: "Provider: kea-dhcp4" | ||
| description: |- | ||
| Provider for ISC Kea DHCP server for provisioning static DHCP leases. | ||
| --- | ||
|
|
||
| # KEA-DHCP4 Provider | ||
|
|
||
| The provider uses Kea Control Agent's REST API for communication with an underlying Kea DHCP4 server (DHCP6 currently not supported), with optional reverse proxying for adding TLS and authentication. | ||
|
|
||
| Before using the provider, you must correctly specify the connection URL, credentials (if any), and path to DHCP server conffile on host (required for config-write API command). | ||
|
|
||
|
|
||
| ## Requirements | ||
|
|
||
| * ISC Kea DHCP server v1.8+ | ||
| * Terraform 0.14+ | ||
|
|
||
| ## Example Usage | ||
| ```terraform | ||
| terraform { | ||
| required_providers { | ||
| kea-dhcp4 = { | ||
| source = "Feliksas/kea-dhcp4" | ||
| version = "1.1.0" | ||
| } | ||
| } | ||
| } | ||
| provider "kea-dhcp4" { | ||
| kea_server_address = "http://localhost:8080" | ||
| kea_server_username = "test" | ||
| kea_server_password = "1234" | ||
| kea_server_configfile = "/etc/kea/kea-dhcp4.conf" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `kea_server_address` (String) IP or FQDN of host which serves Kea Control Agent API | ||
| - `kea_server_configfile` (String) Path to Kea DHCP4 server config (on server, required for config-write command) | ||
|
|
||
| ### Optional | ||
|
|
||
| - `kea_server_password` (String) HTTP basic auth password (if configured) | ||
| - `kea_server_username` (String) HTTP basic auth username (if configured) |
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,49 @@ | ||
| # kea-dhcp4_host_lease (Resource) | ||
|
|
||
|
|
||
| ## Example Usage | ||
| ```terraform | ||
| resource "kea-dhcp4_host_lease" "some_host" { | ||
| name = "some_host.local" | ||
| mac_address = "00:11:22:33:44:55" | ||
| ip_address = "10.0.0.1" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `ip_address` (String) ip address to assign for mac | ||
| - `mac_address` (String) mac address in lower-case | ||
| - `name` (String) lease_name in lowercase | ||
|
|
||
| ### Optional | ||
|
|
||
| - `boot_file_name` (String) (Optional) Path to boot file on TFTP server | ||
| - `client_classes` (List of String) (Optional) List of client classes to apply | ||
| - `next_server` (String) (Optional) TFTP server to boot from | ||
| - `option_data` (Block List) (Optional) List of custom DHCP options for host (see [below for nested schema](#nestedblock--option_data)) | ||
| - `server_hostname` (String) (Optional) TFTP server hostname | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) The ID of this resource. | ||
|
|
||
| <a id="nestedblock--option_data"></a> | ||
| ### Nested Schema for `option_data` | ||
|
|
||
| Required: | ||
|
|
||
| - `data` (String) DHCP option data | ||
|
|
||
| Optional: | ||
|
|
||
| - `always_send` (Boolean) (Optional) Force sending this DHCP option | ||
| - `code` (Number) (Optional) DHCP option code | ||
| - `csv_format` (Boolean) (Optional) Set to true if data is specified in hex format | ||
| - `name` (String) (Optional) DHCP option name | ||
| - `space` (String) (Optional) DHCP space identifier, default is dhcp4 | ||
|
|
||
|
|
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,15 @@ | ||
| terraform { | ||
| required_providers { | ||
| kea-dhcp4 = { | ||
| source = "Feliksas/kea-dhcp4" | ||
| version = "1.1.0" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| provider "kea-dhcp4" { | ||
| kea_server_address = "http://localhost:8080" | ||
| kea_server_username = "test" | ||
| kea_server_password = "1234" | ||
| kea_server_configfile = "/etc/kea/kea-dhcp4.conf" | ||
| } |
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,5 @@ | ||
| resource "kea-dhcp4_host_lease" "some_host" { | ||
| name = "some_host.local" | ||
| mac_address = "00:11:22:33:44:55" | ||
| ip_address = "10.0.0.1" | ||
| } |
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
Oops, something went wrong.