Skip to content
kweonminsungPublic

About

Open-source control plane for authoritative DNS

Topics

Resources

Contributing

Stars

16 stars

Watchers

1 watching

Forks

Repository files navigation

Bindizr

Open-source control plane for authoritative DNS


Documentation  ·  API Reference

Bindizr is a Rust-based DNS control plane that manages zones and records via an HTTP API or CLI, stores data in a database backend (MySQL, PostgreSQL, or SQLite), and propagates changes to secondaries such as BIND, Knot DNS, NSD, PowerDNS, Technitium, and Windows Server DNS via AXFR/IXFR, using DNS Catalog Zones where the secondary reads them.

 Bindizr control plane and XFR server feeding the secondaries, which answer client queries

Bindizr owns the zone data and the transfer path; any secondary that consumes a catalog zone (RFC 9432) — BIND, Knot DNS, NSD, PowerDNS, Technitium, or CoreDNS — discovers zones through it and answers client queries. Adding it in front of a server costs nothing on the query path — Bindizr + BIND9 serves 59,397 QPS against native BIND's 59,904, and the Knot DNS and PowerDNS pairings track their servers the same way.

Features

  • Zone and Record Management — full CRUD through the HTTP API, documented by OpenAPI, or the CLI, including bulk inserts, BIND master-file import/export, and dry-run diff previews.
  • Multiple Database Backends — MySQL, PostgreSQL, or SQLite.
  • Zone Transfers (AXFR/IXFR) — automatic SOA serial management and a per-serial transfer cache, on by default. A zone served elsewhere moves over in one command.
  • Transfers over TLS — XoT (RFC 9103) to the BIND, Knot DNS, and NSD versions that speak it.
  • Automatic Zone Provisioning — DNS Catalog Zones (RFC 9432) let secondaries discover created and deleted zones without configuration changes.
  • DNS NOTIFY — configurable retries and timeouts, plus an optional batching window that collapses a burst into one NOTIFY per zone.
  • nsupdate — RFC 2136 updates with TSIG-signed requests and managed keys.
  • Role-Based Access Control — API tokens and TSIG keys authenticate into roles whose grants set the zones, actions, record names, and record types each may touch.
  • Logs — every management change (audit), API request and nsupdate (access), and zone transfer (transfer) is logged with who made it, when, and how it ended; a zone's own changes are its versions.
  • DNSSEC — named signing policies, automatic signing and re-signing, ZSK rollovers the scheduler starts and completes on a policy's key lifetime, operator-started CSK/KSK rollovers that complete once the parent serves the new DS, BIND-format key import/export, and a parent-DS check before a zone goes insecure.
  • ExternalDNS Provider — a webhook adapter that lets Kubernetes ExternalDNS manage records in the zones and subtrees its token's role is granted, through the authenticated API.
  • Zone Versions — a version per serial, with diffs between serials and rollback.
  • Observability — health probe, Prometheus metrics at /metrics, text or JSON logs, and bindizr status / bindizr doctor diagnostics.

Supported DNS Servers

BIND, Knot DNS, NSD, PowerDNS, Technitium, and CoreDNS follow Bindizr's catalog zone; Windows Server DNS, YADIFA, and Unbound take its zones one by one

Every server above has been run as a Bindizr secondary: transfers, updates on NOTIFY (Unbound, which refuses NOTIFY, picks them up on its SOA refresh), and DNSSEC-signed zones. The left column learns zones from the catalog zone; the right one is given each zone by hand. Versions, TSIG support, and each server's configuration are in Secondary Servers.

Roadmap

  • Cloud DNS Providers — a secondary today is a server that takes AXFR/IXFR. Pushing zones to Route 53, Cloud DNS, Azure DNS, and Cloudflare through their APIs lets a managed provider hold a copy where no transfer reaches.
  • Webhooks — a change is visible today only by polling the API or the zone versions. Posting each zone, record, and DNSSEC key event to a configured URL lets other systems react as it happens.
  • More Record Types — fifteen types are parsed and validated today, including WKS. Other ordinary types are rejected. Adding SVCB/HTTPS would let those records be managed through the same API and CLI.
  • Terraform Provider — infrastructure as code reaches Bindizr through the ExternalDNS adapter alone. A provider over the HTTP API lets zones, records, and access rights be declared beside the rest of the stack.

Quick Start

Pick one. Each is walked through in full on the documentation site.

Kubernetes

The chart can bring its own PostgreSQL for a first look; in production, point it at your database instead. The default BIND image is amd64-only. On arm64, use the image override in the Kubernetes guide.

$ helm install bindizr oci://registry-1.docker.io/kweonminsung/bindizr-chart \
  --version 0.2.0-rc.1 --set postgresql.enabled=true

Docker Compose

Builds the image from the working tree and brings up Bindizr, PostgreSQL, and two BIND secondaries on one host.

On amd64:

$ docker compose -f examples/compose/docker-compose.yml up -d --build

On arm64, add the BIND image overlay:

$ docker compose -f examples/compose/docker-compose.yml \
  -f examples/compose/docker-compose.arm.yml up -d --build

Docker Swarm

Brings up Bindizr, PostgreSQL, and BIND on an overlay network. The stack mounts a transfer key as a Swarm secret, created once before deploying. The example's BIND image is amd64-only; on arm64 nodes build examples/swarm/bind9 on each node and deploy with BIND9_IMAGE, as in the Swarm walkthrough.

$ printf 'key "swarm-xfr" {\n  algorithm hmac-sha256;\n  secret "%s";\n};\n' \
  "$(openssl rand -base64 32)" | docker secret create bindizr_xfr_key -
$ docker stack deploy -c examples/swarm/docker-compose.yml bindizr

Package install

$ sudo dpkg -i bindizr_*_amd64.deb    # Debian, Ubuntu (bindizr_*_arm64.deb on arm64)
$ sudo rpm -i bindizr-*.x86_64.rpm    # Fedora, CentOS, RHEL (bindizr-*.aarch64.rpm on arm64)
$ sudo apk add --allow-untrusted bindizr-*.x86_64.apk    # Alpine (bindizr-*.aarch64.apk on arm64)

The package runs on SQLite out of the box and serves zone transfers on port 5300, leaving 53 to the secondary. Point the secondary at the catalog zone — Secondary Servers has the configuration for each supported server — then start.

$ sudo systemctl start bindizr    # Alpine: sudo rc-service bindizr start
$ sudo bindizr doctor
$ sudo bindizr token create admin --role admin

For container installs, run doctor through docker compose exec or kubectl exec as shown in the Docker Compose and Kubernetes walkthroughs. Kubernetes also needs its first API token created in the pod; the Compose example disables API authentication.

Documentation

Deployment, configuration, the CLI, the HTTP API, and the benchmarks are all at kweonminsung.github.io/bindizr.

Contributing

Bug reports, documentation fixes, and pull requests are welcome — see CONTRIBUTING.md for the development setup, the test and lint commands, and the project conventions a review will check against.

License

This project is licensed under the Apache License 2.0.

About

Open-source control plane for authoritative DNS

Topics

Resources

Contributing

Stars

16 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages