From 44d7867a0c91587588bd666340d2de19d88f334a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ask=20Bj=C3=B8rn=20Hansen?= Date: Sun, 1 Mar 2026 18:22:46 -0800 Subject: [PATCH] Add example config and zones.txt files Provide catz.yaml.example and zones.txt.example as starting points for new users. The config follows RFC 9432's recommendation to use "invalid." for SOA mname/rname. The zones file demonstrates all supported features: single/multiple catalog assignment, group property, coo property, and combinations. --- catz.yaml.example | 17 +++++++++++++++++ zones.txt.example | 23 +++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 catz.yaml.example create mode 100644 zones.txt.example diff --git a/catz.yaml.example b/catz.yaml.example new file mode 100644 index 0000000..f0f5fdf --- /dev/null +++ b/catz.yaml.example @@ -0,0 +1,17 @@ +# catalog-zone-gen configuration +# +# Each catalog becomes an output zone file named .zone +# Catalog names here are referenced in zones.txt + +catalogs: + prod: + zone: catalog-prod.example.com. + staging: + zone: catalog-staging.example.com. + +# SOA fields for all generated zone files +# RFC 9432 recommends "invalid." for both since catalog zones +# are not queried via normal DNS resolution. +soa: + mname: invalid. + rname: invalid. diff --git a/zones.txt.example b/zones.txt.example new file mode 100644 index 0000000..80b759f --- /dev/null +++ b/zones.txt.example @@ -0,0 +1,23 @@ +# Zones to include in catalog zones +# +# Format: [, ...] [, group=] [, coo=] +# +# - Catalogs are bare names matching keys in catz.yaml +# - group: RFC 9432 property — consumers apply shared config to grouped zones +# - coo: RFC 9432 change-of-ownership — points to the old catalog during migration + +# Simple: zone in one catalog +app.example.com prod + +# Zone served by multiple catalogs +example.com prod, staging + +# Group property — lets consumers apply per-group policy +api.example.com prod, group=critical +dev.example.net staging, group=testing + +# Change-of-ownership — zone migrating from another catalog +legacy.example.org prod, coo=old-catalog.example.com. + +# Both properties +internal.example.org prod, group=internal, coo=old-catalog.example.com.