README
author Tero Marttila <terom@paivola.fi>
Mon, 19 Mar 2012 13:56:47 +0200
changeset 33 2c65ec147afa
child 34 d2e187c1f548
permissions -rw-r--r--
README
33
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     1
Manage DNS/bind9 zonefiles.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     2
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     3
update:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     4
    ./bin/update reads data from settings/, and generates zonefiles under zones/.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     5
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     6
    `update` also shows and commits changes in settings/ data.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     7
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     8
bin/update-serial:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     9
    Increment DNS SOA record serials in the given .serial files.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    10
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    11
    Uses a YYYYMMDDXX format, but supports XX overflow.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    12
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    13
bin/process-zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    14
    Read zonefile containing records, and generate any of:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    15
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    16
    --check-hosts:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    17
        Check for duplicate host names/IPs.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    18
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    19
    --forward-zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    20
        Generate additional TXT/MX records to supplement A/CNAME records.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    21
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    22
    --reverse-zone=NET
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    23
        Generate PTR records for all matching A records.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    24
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    25
    --meta-zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    26
        Generate additional TXT records from zonefile metadata, read from:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    27
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    28
            hg annotate -q --date | ./bin/process-zone --input-line-date ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    29
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    30
bin/expand-zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    31
    Expand template vars in a zone textfile; does not parse records, just passes through lines.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    32
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    33
    Used to substitute e.g. `--serial .../foo.serial` values into SOA '{serial}' fields.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    34
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    35
bin/update:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    36
    Runs update-serial/process-zone/expand-zone to keep various generated zones/views up-to-date with respect to
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    37
    source files under settings/
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    38
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    39
    Also supports hg diff/commit/annotate integration with settings.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    40
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    41
settings/:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    42
    Input files, fed through update to generate files under zones/
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    43
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    44
    *.serial:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    45
        Zone serial numbers for corresponding *.zone
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    46
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    47
    *.zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    48
        Zone header, passed through process-zone with `--serial *.serial` and any appropriate `--expand view=...`.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    49
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    50
        May include a view-based $INCLUDE to include different zone data for different views.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    51
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    52
    *.zone.*:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    53
        Additional common zone data; copied to zones/, and $INCLUDE'd from *.zone.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    54
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    55
    *.txt:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    56
        Hosts zone data, used to generate forwards/reverse -hosts zones
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    57
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    58
zones/:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    59
    Output files, loaded by bind.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    60
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    61
    *.zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    62
        View-independent zone headers with expanded serial.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    63
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    64
    *.zone.hosts:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    65
        View-independent generated zones for hosts.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    66
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    67
    *.zone.$view:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    68
        Per-view copied zone data.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    69
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    70
    *.zone.*:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    71
        Additional view-independent copied zone data.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    72
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    73
    $view/*.zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    74
        Per-view zone header with expanded $INCLUDE:s and serial.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    75
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    76
    $view/*.zone.hosts:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    77
        Per-view generated zones for hosts.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    78
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    79
    $view/*.zone -> .../$.zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    80
        Symlinked generic-zone data for some specific zone; either view-specific or view-independent.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    81