Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
matejv committed Jul 25, 2023
1 parent 2e96eba commit c5127d0
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ DNS records in PowerDNS based on netbox IP Address and Device objects.

## Features

- Automatically generates A & AAAA records based on IP Address & Device objects
and DNS zone settings
- Automatically generates A, AAAA & PTR records based on IP Address & Device
objects and DNS zone settings
- Can manage multiple DNS Zones across multiple PowerDNS servers
- Flexible rules to match netbox IP Addresses into DNS zones
- Multiple options how to generate DNS name from IP address or Device
- Option to schedule sync of DNS zones from netbox to PowerDNS
- Can add DNS records for new zones immediately
- Setup synchronization schedule for each zone individually

## Generating DNS names

Expand All @@ -35,7 +36,7 @@ VirtualMachine.tags, Device.device_role, VM.role.
If there is still not matching zone found, default zone is used (if set).

When a zone is set for an IP address, the DNS name is generated by using
set methods set on the zone. THe IP naming method is tried first, then the
set methods set on the zone. The IP naming method is tried first, then the
device and lastly the FHRP group method.

## Compatibility
Expand All @@ -44,7 +45,7 @@ This plugin requires netbox version 3.5.x to work. Here is s compatibility table

| NetBox Version | Plugin Version |
|----------------|----------------|
| 3.5 | 1.0.x |
| 3.5 | 0.0.1 - 1.0.x |

## Installing

Expand Down Expand Up @@ -115,6 +116,7 @@ PLUGINS_CONFIG = {
# in README.md for all possible settings
"ttl_custom_field": "",
"powerdns_managed_record_comment": None,
| "post_save_enabled": False,
},
}
```
Expand All @@ -123,8 +125,9 @@ PLUGINS_CONFIG = {

| Setting | Default value | Description |
|---------|---------------|-------------|
| `ttl_custom_field` | `None`| Name of netbox Custom field applied to IP Address objects. See [Custom TTL field](#CustomTTLfield) below. |
| `ttl_custom_field` | `None`| Name of netbox Custom field applied to IP Address objects. See [Custom TTL field](#custom-ttl-field) below. |
| `powerdns_managed_record_comment` | `"netbox-powerdns-sync"`| Is set, the plugin will only touch records in PowerDNS API that have matching comment and ignore others. Set to `None` to make plugin manage all supported records. |
| `post_save_enabled` | `False`| When creating or updating an IP Address, Device or FHRP Group, immediately create its DNS records using `post_save` signals. |

#### Custom TTL field

Expand All @@ -138,3 +141,21 @@ of type integer and apply it to IP Address objects. Then set plugin option

Now you can set TTL on each IP Address and any corresponding DNS records will get
that TTL value.

## Screenshots

List of DNS zones:

![DNS Zone list](docs/img/netbox_powerdns_sync-zone_list.png)

DNS Zone details:

![DNS Zone details](docs/img/netbox_powerdns_sync-zone_details.png)

Scheduling Zone sync:

![Sync schedule](docs/img/netbox_powerdns_sync-sync_schedule.png)

Sync results for Zone:

![Sync result](docs/img/netbox_powerdns_sync-sync_result.png)
Binary file added docs/img/netbox_powerdns_sync-sync_result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/netbox_powerdns_sync-sync_schedule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/netbox_powerdns_sync-zone_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/netbox_powerdns_sync-zone_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c5127d0

Please sign in to comment.