Initial revison of reasonable automatic remctl setup.
[invirt/packages/invirt-remote.git] / files / etc / remctl / sipb-xen-auto / README
1 This is Tim Abbott's initial draft at our automatic remctl
2 configuration.
3
4 /etc/remctl/sipb-xen-auto/remctl-update.sh is the magic script.  Run
5 it with "all" as an argument, and it will update everything.
6
7 The inputs to this system are as follows:
8
9 /etc/remctl/sipb-xen-auto/acl/MACHINENAME
10
11   This directory contains files named MACHINENAME for each machine.
12 These ACL files specify who is allowed to administer the machine.  You
13 can use entries that are Kerberos principles, or entries of the form
14
15 include /etc/remctl/sipb-xen-auto/moira-acl/sipb-xen
16
17 to include AFS groups in ACLs.  To add a new machine to the system,
18 you simply need to create /etc/remctl/sipb-xen-auto/acl/MACHINENAME
19 and then run
20
21 /etc/remctl/sipb-xen-auto/remctl-update.sh all
22
23 Everything else is autogenerated from that information.
24
25
26 Other files of interest:
27
28 /etc/remctl/sipb-xen-auto/auto-machine-list
29
30   The list of machines that should have their remctl configuration
31 files generated from the template.  This is generated from
32 listing /etc/remctl/sipb-xen-auto/acl/*.
33  
34 /etc/remctl/sipb-xen-auto/auto-moira-list
35
36   The list of Athena AFS groups from which acl files should be
37 generated.  The ACL files are placed in
38 /etc/remctl/sipb-xen-auto/moira-acl/, and named GROUPNAME.  Ths list
39 is generated by parsing the ACL files in /etc/remctl/sipb-xen-auto/acl/.
40
41
42 This package also includes a crontab to run
43
44 /etc/remctl/sipb-xen-auto/remctl-update.sh all
45
46 every 15 minutes or so to keep our Moira mapping up to date.  One can
47 request an update of our Moira mapping for group X by running
48
49 /etc/remctl/sipb-xen-auto/remctl-update.sh moiragroup X
50
51 The web interface should probably run this when it adds a group.  We
52 may want to make this also available to users, but I've been lame.
53
54 This package includes a remctl interface available to anyone to invoke
55 the command:
56
57 /etc/remctl/sipb-xen-auto/remctl-update.sh all
58
59 using the following command from your favorite machine with remctl:
60
61 remctl black-mesa.mit.edu remctl-auto-update all
62
63 It requires no special permission to run; there is a potential DOS
64 issue here, but I don't think it is serious.
65
66 Thought should be put into how to ensure that the servers stay in sync.