diff --git a/readme.md b/readme.md index f371c6d..fc80ece 100644 --- a/readme.md +++ b/readme.md @@ -1,14 +1,30 @@ -# Overview +# Ansible Role: KEA DHCP -This role configures KEA DHCP. +Install and configure [KEA DHCP](https://www.isc.org/kea/) server. -## Supported Operating Systems +## Variables -| Operating System | Version | -| --- | ----- | -| Alpine | 3.23 | -| Debian | 13 | +| Variable | Required | Default | Description | +|----------|----------|---------|-------------| +| `kea_dhcp_interface` | Yes | `eth0` | Network interface to listen on | +| `kea_dhcp_lease_rebind` | No | `750` | Lease rebind time in seconds | +| `kea_dhcp_lease_renew` | No | `600` | Lease renewal time in seconds | +| `kea_dhcp_lease_lifetime` | No | `900` | Lease lifetime in seconds | +| `kea_dhcp_subnets` | Yes | `[]` | List of DHCP subnets to configure | -## Tags +## Example -This role has no tags. +```yaml +kea_dhcp_interface: "eth0" +kea_dhcp_lease_lifetime: "3600" +kea_dhcp_subnets: + - name: "production-lan" + subnet: "192.168.1.0/24" + pool: "192.168.1.100 - 192.168.1.200" + gateway: "192.168.1.1" + dns: "192.168.1.10" + reservations: + - hostname: "server.example.com" + ip: "192.168.1.50" + mac: "AA:BB:CC:DD:EE:FF" +```