3050fa2c33cc0b224feaac6e25f9fed5674403b0
[hcoop/domtool2.git] / lib / domain.dtl
1 {{Configuring shared daemons with respect to a particular Internet domain name}}
2
3 extern type no_spaces;
4 {{Any string with no space characters}}
5
6 extern type no_newlines;
7 {{Any string with no newline characters}}
8
9 extern type ip;
10 {{An IP address}}
11
12 extern type host;
13 {{A hostname; that is, (more or less) an alphanumeric string}}
14
15 extern type domain;
16 {{An Internet domain name}}
17
18 extern type your_domain;
19 {{A domain that you're allowed to configure}}
20
21 extern type your_domain_host;
22 {{Some host (as a fully-qualified domain name) in one of your domains}}
23
24 extern type node;
25 {{The name of a server controlled by domtool}}
26
27 extern val ip_of_node : node -> ip;
28 {{Look up the IP address of a node.}}
29
30 extern type user;
31 extern type group;
32 {{UNIX users and groups}}
33
34 extern type your_user;
35 extern type your_group;
36 {{UNIX users and groups that you're allowed to run as}}
37
38 extern type your_path;
39 {{A filesystem path that you're allowed to use.
40 The set of permitted values is generated from a set of roots by closing it
41 under the subdirectory relation.}}
42
43 context Domain;
44 {{Configuration directives specific to an Internet domain}}
45
46 extern type serial;
47 {{Domain zone serial numbers}}
48 extern val serialAuto : serial;
49 {{Whenever DNS data changes, choose a sensible serial number automatically.}
50 extern val serialConst : int -> serial;
51 {{Use this particular serial number.}}
52
53 extern type soa;
54 {{DNS start-of-authority record}}
55 extern val soa : domain -> serial -> int -> int -> int -> int -> soa;
56
57 val defaultSoa = soa "ns.hcoop.net" serialAuto 172800 900 1209600 3600;
58
59 extern type master;
60 {{Information on the master DNS server for a domain}}
61 extern val externalMaster : ip -> master;
62 {{A server not controlled by domtool will serve as master.}}
63 extern val internalMaster : node -> master;
64 {{A server controlled by domtool will serve as master.}}
65
66 extern type dnsKind;
67 {{How should DNS for this domain be handled?}}
68 extern val useDns : soa -> master -> [node] -> dnsKind;
69 {{We do want DNS services for this domain. Specify the SOA record, information
70 on the server in charge of zone data, and a list of slave servers.}}
71 extern val noDns : dnsKind;
72 {{No DNS services for this domain.}}
73
74 extern val domain : your_domain -> Domain => [Root] {DNS : dnsKind, TTL : int};
75 {{Configure a domain to which you have access rights.}}