README
author Tero Marttila <terom@paivola.fi>
Mon, 19 Mar 2012 13:59:34 +0200
changeset 34 d2e187c1f548
parent 33 2c65ec147afa
child 56 12e098a732ed
permissions -rw-r--r--
README: update opts
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
34
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
     8
    -d
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
     9
        Do data operations under given dir-root, as opposed to CWD.
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    10
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    11
    -q
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    12
        Quiet. No log messages. XXX: still outputs diffs, though..
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    13
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    14
    -vDV
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    15
        Increasing logging verbosity.
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    16
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    17
    -p
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    18
        Show diffs for changed output.
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    19
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    20
    -F
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    21
        Force-update output files, even if newer than input files.
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    22
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    23
    -S
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    24
        Do not generate new serials for zones.
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    25
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    26
    -n
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    27
        Fake-update; show changes, but don't actually commit/deploy them.
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    28
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    29
    -C
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    30
        Do not commit source changes.
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    31
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    32
    -c
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    33
        Force-commit source changes, even though -n
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    34
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    35
    -m
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    36
        Commit message for source changes; optional
d2e187c1f548 README: update opts
Tero Marttila <terom@paivola.fi>
parents: 33
diff changeset
    37
33
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    38
bin/update-serial:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    39
    Increment DNS SOA record serials in the given .serial files.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    40
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    41
    Uses a YYYYMMDDXX format, but supports XX overflow.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    42
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    43
bin/process-zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    44
    Read zonefile containing records, and generate any of:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    45
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    46
    --check-hosts:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    47
        Check for duplicate host names/IPs.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    48
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    49
    --forward-zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    50
        Generate additional TXT/MX records to supplement A/CNAME records.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    51
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    52
    --reverse-zone=NET
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    53
        Generate PTR records for all matching A records.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    54
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    55
    --meta-zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    56
        Generate additional TXT records from zonefile metadata, read from:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    57
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    58
            hg annotate -q --date | ./bin/process-zone --input-line-date ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    59
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    60
bin/expand-zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    61
    Expand template vars in a zone textfile; does not parse records, just passes through lines.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    62
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    63
    Used to substitute e.g. `--serial .../foo.serial` values into SOA '{serial}' fields.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    64
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    65
bin/update:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    66
    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
    67
    source files under settings/
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    68
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    69
    Also supports hg diff/commit/annotate integration with settings.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    70
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    71
settings/:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    72
    Input files, fed through update to generate files under zones/
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    73
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    74
    *.serial:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    75
        Zone serial numbers for corresponding *.zone
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    76
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    77
    *.zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    78
        Zone header, passed through process-zone with `--serial *.serial` and any appropriate `--expand view=...`.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    79
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    80
        May include a view-based $INCLUDE to include different zone data for different views.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    81
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    82
    *.zone.*:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    83
        Additional common zone data; copied to zones/, and $INCLUDE'd from *.zone.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    84
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    85
    *.txt:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    86
        Hosts zone data, used to generate forwards/reverse -hosts zones
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    87
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    88
zones/:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    89
    Output files, loaded by bind.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    90
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    91
    *.zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    92
        View-independent zone headers with expanded serial.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    93
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    94
    *.zone.hosts:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    95
        View-independent generated zones for hosts.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    96
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    97
    *.zone.$view:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    98
        Per-view copied zone data.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    99
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   100
    *.zone.*:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   101
        Additional view-independent copied zone data.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   102
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   103
    $view/*.zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   104
        Per-view zone header with expanded $INCLUDE:s and serial.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   105
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   106
    $view/*.zone.hosts:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   107
        Per-view generated zones for hosts.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   108
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   109
    $view/*.zone -> .../$.zone:
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   110
        Symlinked generic-zone data for some specific zone; either view-specific or view-independent.
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   111