Change v3 to v4 yumgroups.xml
[myplc.git] / db-config
1 #!/usr/bin/env /usr/bin/plcsh
2 #
3 # Bootstraps the PLC database with a default administrator account and
4 # a default site, defines default slice attribute types, and
5 # creates/updates default system slices.
6 #
7 # Mark Huang <mlhuang@cs.princeton.edu>
8 # Copyright (C) 2006 The Trustees of Princeton University
9 #
10 # $Id: db-config,v 1.21 2007/02/02 19:56:21 mlhuang Exp $
11 #
12
13 from plc_config import PLCConfiguration
14 import sys
15
16 def main():
17     cfg = PLCConfiguration()
18     cfg.load()
19     variables = cfg.variables()
20
21     # Load variables into dictionaries
22     for category_id, (category, variablelist) in variables.iteritems():
23         globals()[category_id] = dict(zip(variablelist.keys(),
24                                        [variable['value'] for variable in variablelist.values()]))
25
26     # Create/update the default administrator account (should be
27     # person_id 2).
28     admin = { 'person_id': 2,
29               'first_name': "Default",
30               'last_name': "Administrator",
31               'email': plc['root_user'],
32               'password': plc['root_password'] }
33     persons = GetPersons([admin['person_id']])
34     if not persons:
35         person_id = AddPerson(admin)
36         if person_id != admin['person_id']:
37             # Huh? Someone deleted the account manually from the database.
38             DeletePerson(person_id)
39             raise Exception, "Someone deleted the \"%s %s\" account from the database!" % \
40                   (admin['first_name'], admin['last_name'])
41         UpdatePerson(person_id, { 'enabled': True })
42     else:
43         person_id = persons[0]['person_id']
44         UpdatePerson(person_id, admin)
45
46     # Create/update the default site (should be site_id 1)
47     if plc_www['port'] == '80':
48         url = "http://" + plc_www['host'] + "/"
49     elif plc_www['port'] == '443':
50         url = "https://" + plc_www['host'] + "/"
51     else:
52         url = "http://" + plc_www['host'] + ":" + plc_www['port'] + "/"
53     site = { 'site_id': 1,
54              'name': plc['name'] + " Central",
55              'abbreviated_name': plc['name'],
56              'login_base': plc['slice_prefix'],
57              'is_public': False,
58              'url': url,
59              'max_slices': 100 }
60
61     sites = GetSites([site['site_id']])
62     if not sites:
63         site_id = AddSite(site['name'], site['abbreviated_name'], site['login_base'], site)
64         if site_id != site['site_id']:
65             DeleteSite(site_id)
66             raise Exception, "Someone deleted the \"%s\" site from the database!" % \
67                   site['name']
68         sites = [site]
69
70     # Must call UpdateSite() even after AddSite() to update max_slices
71     site_id = sites[0]['site_id']
72     UpdateSite(site_id, site)
73
74     # The default administrator account must be associated with a site
75     # in order to login.
76     AddPersonToSite(admin['person_id'], site['site_id'])
77     SetPersonPrimarySite(admin['person_id'], site['site_id'])
78
79     # Grant admin and PI roles to the default administrator account
80     AddRoleToPerson(10, admin['person_id'])
81     AddRoleToPerson(20, admin['person_id'])
82
83     # Setup default PlanetLabConf entries
84     default_conf_files = [
85         # NTP configuration
86         {'enabled': True,
87          'source': 'PlanetLabConf/ntp.conf.php',
88          'dest': '/etc/ntp.conf',
89          'file_permissions': '644',
90          'file_owner': 'root',
91          'file_group': 'root',
92          'preinstall_cmd': '',
93          'postinstall_cmd': '/etc/rc.d/init.d/ntpd restart',
94          'error_cmd': '',
95          'ignore_cmd_errors': False,
96          'always_update': False},
97         {'enabled': True,
98          'source': 'PlanetLabConf/ntp/step-tickers.php',
99          'dest': '/etc/ntp/step-tickers',
100          'file_permissions': '644',
101          'file_owner': 'root',
102          'file_group': 'root',
103          'preinstall_cmd': '',
104          'postinstall_cmd': '/etc/rc.d/init.d/ntpd restart',
105          'error_cmd': '',
106          'ignore_cmd_errors': False,
107          'always_update': False},
108
109         # SSH server configuration
110         {'enabled': True,
111          'source': 'PlanetLabConf/sshd_config',
112          'dest': '/etc/ssh/sshd_config',
113          'file_permissions': '600',
114          'file_owner': 'root',
115          'file_group': 'root',
116          'preinstall_cmd': '',
117          'postinstall_cmd': '/etc/init.d/sshd restart',
118          'error_cmd': '',
119          'ignore_cmd_errors': False,
120          'always_update': False},
121
122         # Administrative SSH keys
123         {'enabled': True,
124          'source': 'PlanetLabConf/keys.php?root',
125          'dest': '/root/.ssh/authorized_keys',
126          'file_permissions': '644',
127          'file_owner': 'root',
128          'file_group': 'root',
129          'preinstall_cmd': '',
130          'postinstall_cmd': '/bin/chmod 700 /root/.ssh',
131          'error_cmd': '',
132          'ignore_cmd_errors': False,
133          'always_update': False},
134         {'enabled': True,
135          'source': 'PlanetLabConf/keys.php?site_admin',
136          'dest': '/home/site_admin/.ssh/authorized_keys',
137          'file_permissions': '644',
138          'file_owner': 'site_admin',
139          'file_group': 'site_admin',
140          'preinstall_cmd': 'grep -q site_admin /etc/passwd',
141          'postinstall_cmd': '/bin/chmod 700 /home/site_admin/.ssh',
142          'error_cmd': '',
143          'ignore_cmd_errors': False,
144          'always_update': False},
145         {'enabled': True,
146          'source': 'PlanetLabConf/keys.php?role=admin',
147          'dest': '/home/pl_admin/.ssh/authorized_keys',
148          'file_permissions': '644',
149          'file_owner': 'pl_admin',
150          'file_group': 'pl_admin',
151          'preinstall_cmd': 'grep -q pl_admin /etc/passwd',
152          'postinstall_cmd': '/bin/chmod 700 /home/pl_admin/.ssh',
153          'error_cmd': '',
154          'ignore_cmd_errors': False,
155          'always_update': False},
156
157         # Log rotation configuration
158         {'enabled': True,
159          'source': 'PlanetLabConf/logrotate.conf',
160          'dest': '/etc/logrotate.conf',
161          'file_permissions': '644',
162          'file_owner': 'root',
163          'file_group': 'root',
164          'preinstall_cmd': '',
165          'postinstall_cmd': '',
166          'error_cmd': '',
167          'ignore_cmd_errors': False,
168          'always_update': False},
169
170         # updatedb/locate nightly cron job
171         {'enabled': True,
172          'source': 'PlanetLabConf/slocate.cron',
173          'dest': '/etc/cron.daily/slocate.cron',
174          'file_permissions': '755',
175          'file_owner': 'root',
176          'file_group': 'root',
177          'preinstall_cmd': '',
178          'postinstall_cmd': '',
179          'error_cmd': '',
180          'ignore_cmd_errors': False,
181          'always_update': False},
182
183         # YUM configuration
184         {'enabled': True,
185          'source': 'PlanetLabConf/yum.conf.php?gpgcheck=1',
186          'dest': '/etc/yum.conf',
187          'file_permissions': '644',
188          'file_owner': 'root',
189          'file_group': 'root',
190          'preinstall_cmd': '',
191          'postinstall_cmd': '',
192          'error_cmd': '',
193          'ignore_cmd_errors': False,
194          'always_update': False},
195         {'enabled': True,
196          'source': 'PlanetLabConf/delete-rpm-list-production',
197          'dest': '/etc/planetlab/delete-rpm-list',
198          'file_permissions': '644',
199          'file_owner': 'root',
200          'file_group': 'root',
201          'preinstall_cmd': '',
202          'postinstall_cmd': '',
203          'error_cmd': '',
204          'ignore_cmd_errors': False,
205          'always_update': False},
206
207         # PLC configuration
208         {'enabled': True,
209          'source': 'PlanetLabConf/get_plc_config.php',
210          'dest': '/etc/planetlab/plc_config',
211          'file_permissions': '644',
212          'file_owner': 'root',
213          'file_group': 'root',
214          'preinstall_cmd': '',
215          'postinstall_cmd': '',
216          'error_cmd': '',
217          'ignore_cmd_errors': False,
218          'always_update': False},
219         {'enabled': True,
220          'source': 'PlanetLabConf/get_plc_config.php?python',
221          'dest': '/etc/planetlab/plc_config.py',
222          'file_permissions': '644',
223          'file_owner': 'root',
224          'file_group': 'root',
225          'preinstall_cmd': '',
226          'postinstall_cmd': '',
227          'error_cmd': '',
228          'ignore_cmd_errors': False,
229          'always_update': False},
230         {'enabled': True,
231          'source': 'PlanetLabConf/get_plc_config.php?perl',
232          'dest': '/etc/planetlab/plc_config.pl',
233          'file_permissions': '644',
234          'file_owner': 'root',
235          'file_group': 'root',
236          'preinstall_cmd': '',
237          'postinstall_cmd': '',
238          'error_cmd': '',
239          'ignore_cmd_errors': False,
240          'always_update': False},
241         {'enabled': True,
242          'source': 'PlanetLabConf/get_plc_config.php?php',
243          'dest': '/etc/planetlab/php/plc_config.php',
244          'file_permissions': '644',
245          'file_owner': 'root',
246          'file_group': 'root',
247          'preinstall_cmd': '',
248          'postinstall_cmd': '',
249          'error_cmd': '',
250          'ignore_cmd_errors': False,
251          'always_update': False},
252
253         # XXX Required for old Node Manager
254         # Node Manager configuration
255         {'enabled': True,
256          'source': 'PlanetLabConf/pl_nm.conf',
257          'dest': '/etc/planetlab/pl_nm.conf',
258          'file_permissions': '644',
259          'file_owner': 'root',
260          'file_group': 'root',
261          'preinstall_cmd': '',
262          'postinstall_cmd': '/etc/init.d/pl_nm restart',
263          'error_cmd': '',
264          'ignore_cmd_errors': False,
265          'always_update': False},
266         {'enabled': True,
267          'source': 'PlanetLabConf/RootResources/plc_slice_pool.php',
268          'dest': '/home/pl_nm/RootResources/plc_slice_pool',
269          'file_permissions': '644',
270          'file_owner': 'pl_nm',
271          'file_group': 'pl_nm',
272          'preinstall_cmd': '',
273          'postinstall_cmd': '',
274          'error_cmd': '',
275          'ignore_cmd_errors': False,
276          'always_update': False},
277         {'enabled': True,
278          'source': 'PlanetLabConf/RootResources/pl_conf.py',
279          'dest': '/home/pl_nm/RootResources/pl_conf',
280          'file_permissions': '644',
281          'file_owner': 'pl_nm',
282          'file_group': 'pl_nm',
283          'preinstall_cmd': '',
284          'postinstall_cmd': '/etc/init.d/pl_nm restart',
285          'error_cmd': '',
286          'ignore_cmd_errors': False,
287          'always_update': False},
288         {'enabled': True,
289          'source': 'PlanetLabConf/RootResources/pl_netflow.py',
290          'dest': '/home/pl_nm/RootResources/pl_netflow',
291          'file_permissions': '644',
292          'file_owner': 'pl_nm',
293          'file_group': 'pl_nm',
294          'preinstall_cmd': '',
295          'postinstall_cmd': '',
296          'error_cmd': '',
297          'ignore_cmd_errors': False,
298          'always_update': False},
299
300         # XXX Required for old Node Manager
301         # Proper configuration
302         {'enabled': True,
303          'source': 'PlanetLabConf/propd.conf',
304          'dest': '/etc/proper/propd.conf',
305          'file_permissions': '644',
306          'file_owner': 'root',
307          'file_group': 'root',
308          'preinstall_cmd': '',
309          'postinstall_cmd': '/etc/init.d/proper restart',
310          'error_cmd': '',
311          'ignore_cmd_errors': True,
312          'always_update': False},
313
314         # XXX Required for old Node Manager
315         # Bandwidth cap
316         {'enabled': True,
317          'source': 'PlanetLabConf/bwlimit.php',
318          'dest': '/etc/planetlab/bwcap',
319          'file_permissions': '644',
320          'file_owner': 'root',
321          'file_group': 'root',
322          'preinstall_cmd': '',
323          'postinstall_cmd': '/etc/init.d/pl_nm restart',
324          'error_cmd': '',
325          'ignore_cmd_errors': True,
326          'always_update': False},
327
328         # Proxy ARP setup
329         {'enabled': True,
330          'source': 'PlanetLabConf/proxies.php',
331          'dest': '/etc/planetlab/proxies',
332          'file_permissions': '644',
333          'file_owner': 'root',
334          'file_group': 'root',
335          'preinstall_cmd': '',
336          'postinstall_cmd': '',
337          'error_cmd': '',
338          'ignore_cmd_errors': False,
339          'always_update': False},
340
341         # Firewall configuration
342         {'enabled': True,
343          'source': 'PlanetLabConf/iptables',
344          'dest': '/etc/sysconfig/iptables',
345          'file_permissions': '600',
346          'file_owner': 'root',
347          'file_group': 'root',
348          'preinstall_cmd': '',
349          'postinstall_cmd': '',
350          'error_cmd': '',
351          'ignore_cmd_errors': False,
352          'always_update': False},
353         {'enabled': True,
354          'source': 'PlanetLabConf/blacklist.php',
355          'dest': '/etc/planetlab/blacklist',
356          'file_permissions': '600',
357          'file_owner': 'root',
358          'file_group': 'root',
359          'preinstall_cmd': '',
360          'postinstall_cmd': '/sbin/iptables-restore --noflush < /etc/planetlab/blacklist',
361          'error_cmd': '',
362          'ignore_cmd_errors': True,
363          'always_update': False},
364
365         # /etc/issue
366         {'enabled': True,
367          'source': 'PlanetLabConf/issue.php',
368          'dest': '/etc/issue',
369          'file_permissions': '644',
370          'file_owner': 'root',
371          'file_group': 'root',
372          'preinstall_cmd': '',
373          'postinstall_cmd': '',
374          'error_cmd': '',
375          'ignore_cmd_errors': False,
376          'always_update': False},
377
378         # Kernel parameters
379         {'enabled': True,
380          'source': 'PlanetLabConf/sysctl.php',
381          'dest': '/etc/sysctl.conf',
382          'file_permissions': '644',
383          'file_owner': 'root',
384          'file_group': 'root',
385          'preinstall_cmd': '',
386          'postinstall_cmd': '/sbin/sysctl -e -p /etc/sysctl.conf',
387          'error_cmd': '',
388          'ignore_cmd_errors': False,
389          'always_update': False},
390
391         # Sendmail configuration
392         {'enabled': True,
393          'source': 'PlanetLabConf/sendmail.mc',
394          'dest': '/etc/mail/sendmail.mc',
395          'file_permissions': '644',
396          'file_owner': 'root',
397          'file_group': 'root',
398          'preinstall_cmd': '',
399          'postinstall_cmd': '',
400          'error_cmd': '',
401          'ignore_cmd_errors': False,
402          'always_update': False},
403         {'enabled': True,
404          'source': 'PlanetLabConf/sendmail.cf',
405          'dest': '/etc/mail/sendmail.cf',
406          'file_permissions': '644',
407          'file_owner': 'root',
408          'file_group': 'root',
409          'preinstall_cmd': '',
410          'postinstall_cmd': 'service sendmail restart',
411          'error_cmd': '',
412          'ignore_cmd_errors': False,
413          'always_update': False},
414
415         # GPG signing keys
416         {'enabled': True,
417          'source': 'PlanetLabConf/RPM-GPG-KEY-fedora',
418          'dest': '/etc/pki/rpm-gpg/RPM-GPG-KEY-fedora',
419          'file_permissions': '644',
420          'file_owner': 'root',
421          'file_group': 'root',
422          'preinstall_cmd': '',
423          'postinstall_cmd': 'rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora',
424          'error_cmd': '',
425          'ignore_cmd_errors': False,
426          'always_update': False},
427         {'enabled': True,
428          'source': 'PlanetLabConf/get_gpg_key.php',
429          'dest': '/etc/pki/rpm-gpg/RPM-GPG-KEY-planetlab',
430          'file_permissions': '644',
431          'file_owner': 'root',
432          'file_group': 'root',
433          'preinstall_cmd': '',
434          'postinstall_cmd': 'rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-planetlab',
435          'error_cmd': '',
436          'ignore_cmd_errors': False,
437          'always_update': False},
438
439         # Ping of death configuration
440         {'enabled': True,
441          'source': 'PlanetLabConf/ipod.conf.php',
442          'dest': '/etc/ipod.conf',
443          'file_permissions': '644',
444          'file_owner': 'root',
445          'file_group': 'root',
446          'preinstall_cmd': '',
447          'postinstall_cmd': '',
448          'error_cmd': '',
449          'ignore_cmd_errors': False,
450          'always_update': False},
451
452         # sudo configuration
453         {'enabled': True,
454          'source': 'PlanetLabConf/sudoers',
455          'dest': '/etc/sudoers',
456          'file_permissions': '440',
457          'file_owner': 'root',
458          'file_group': 'root',
459          'preinstall_cmd': '',
460          'postinstall_cmd': '/usr/sbin/visudo -c',
461          'error_cmd': '',
462          'ignore_cmd_errors': False,
463          'always_update': False}
464         ]
465
466     # Get list of existing (enabled, global) files
467     conf_files = GetConfFiles()
468     conf_files = filter(lambda conf_file: conf_file['enabled'] and \
469                                           not conf_file['node_ids'] and \
470                                           not conf_file['nodegroup_ids'],
471                         conf_files)
472     dests = [conf_file['dest'] for conf_file in conf_files]
473     conf_files = dict(zip(dests, conf_files))
474
475     # Create/update default PlanetLabConf entries
476     for default_conf_file in default_conf_files:
477         if default_conf_file['dest'] not in dests:
478             AddConfFile(default_conf_file)
479         else:
480             conf_file = conf_files[default_conf_file['dest']]
481             UpdateConfFile(conf_file['conf_file_id'], default_conf_file)
482
483     # Setup default slice attribute types
484     default_attribute_types = [
485         # Slice type (only vserver is supported)
486         {'name': "type",
487          'description': "Type of slice (e.g. vserver)",
488          'min_role_id': 20},
489
490         # System slice
491         {'name': "system",
492          'description': "Is a default system slice (1) or not (0 or unset)",
493          'min_role_id': 10},
494
495         # Slice enabled (1) or suspended (0)
496         {'name': "enabled",
497          'description': "Slice enabled (1 or unset) or suspended (0)",
498          'min_role_id': 10},
499
500         # Slice reference image
501         {'name': "vref",
502          'description': "Reference image",
503          'min_role_id': 30},
504
505         # Slice initialization script
506         {'name': "initscript",
507          'description': "Slice initialization script",
508          'min_role_id': 10},
509
510         # CPU share
511         {'name': "cpu_min",
512          'description': "Minimum CPU share (ms/s)",
513          'min_role_id': 10},
514         {'name': "cpu_share",
515          'description': "Number of CPU shares",
516          'min_role_id': 10},
517
518         # Bandwidth limits
519         {'name': "net_min_rate",
520          'description': "Minimum bandwidth (kbps)",
521          'min_role_id': 10},
522         {'name': "net_max_rate",
523          'description': "Maximum bandwidth (kbps)",
524          'min_role_id': 10},
525         {'name': "net_i2_min_rate",
526          'description': "Minimum bandwidth over I2 routes (kbps)",
527          'min_role_id': 10},
528         {'name': "net_i2_max_rate",
529          'description': "Maximum bandwidth over I2 routes (kbps)",
530          'min_role_id': 10},
531         {'name': "net_max_kbyte",
532          'description': "Maximum daily network Tx KByte limit.",
533          'min_role_id': 10},
534         {'name': "net_thresh_kbyte",
535          'description': "KByte limit before warning and throttling.",
536          'min_role_id': 10},
537         {'name': "net_i2_max_kbyte",
538          'description': "Maximum daily network Tx KByte limit to I2 hosts.",
539          'min_role_id': 10},
540         {'name': "net_i2_thresh_kbyte",
541          'description': "KByte limit to I2 hosts before warning and throttling.",
542          'min_role_id': 10},
543         {'name': "net_share",
544          'description': "Number of bandwidth shares",
545          'min_role_id': 10},
546         {'name': "net_i2_share",
547          'description': "Number of bandwidth shares over I2 routes",
548          'min_role_id': 10},
549  
550         # Disk quota
551         {'name': "disk_max",
552          'description': "Disk quota (1k disk blocks)",
553          'min_role_id': 10},
554
555         # Proper operations
556         {'name': "proper_op",
557          'description': "Proper operation (e.g. bind_socket)",
558          'min_role_id': 10},
559
560         # XXX Required for old Node Manager
561         # Special attributes applicable to Slice Creation Service (pl_conf) slice
562         {'name': "plc_slice_type",
563          'description': "Type of slice rspec to be created",
564          'min_role_id': 20},
565         {'name': "plc_agent_version",
566          'description': "Version of PLC agent (slice creation service) software to be deployed",
567          'min_role_id': 10},
568         {'name': "plc_ticket_pubkey",
569          'description': "Public key used to verify PLC-signed tickets",
570          'min_role_id': 10}
571         ]
572
573     # Get list of existing attribute types
574     attribute_types = GetSliceAttributeTypes()
575     attribute_types = [attribute_type['name'] for attribute_type in attribute_types]
576
577     # Create/update default slice attribute types
578     for default_attribute_type in default_attribute_types:
579         if default_attribute_type['name'] not in attribute_types:
580             AddSliceAttributeType(default_attribute_type)
581         else:
582             UpdateSliceAttributeType(default_attribute_type['name'], default_attribute_type)
583
584     # Create/update system slices
585     legacy_slices = [
586         # XXX Required for old Node Manager
587         {'name': "pl_conf",
588          'description': "PlanetLab Slice Creation Service (SCS)",
589          'url': url,
590          'instantiation': "plc-instantiated",
591          # Renew forever
592          'expires': sys.maxint,
593          'attributes': [('plc_slice_type', "VServerSlice"),
594                         ('plc_agent_version', "1.0"),
595                         ('plc_ticket_pubkey', "")]},
596
597         # XXX Required for old Node Manager
598         {'name': "pl_conf_vserverslice",
599          'description': "Default attributes for vserver slices",
600          'url': url,
601          'instantiation': "plc-instantiated",
602          # Renew forever
603          'expires': sys.maxint,
604          'attributes': [('cpu_share', "32"),
605                         ('plc_slice_type', "VServerSlice"),
606                         ('disk_max', "5000000")]},
607         ]
608     default_slices = [
609          # PlanetFlow
610         {'name': plc['slice_prefix'] + "_netflow",
611          'description': "PlanetFlow Traffic Auditing Service",
612          'url': url,
613          'instantiation': "plc-instantiated",
614          # Renew forever
615          'expires': sys.maxint,
616          'attributes': [('system', "1"),
617                         ('vref', "planetflow"),
618                         ('proper_op', "open file=/etc/passwd, flags=r"),
619                         ('proper_op', "create_socket"),
620                         ('proper_op', "bind_socket")]},
621         ]
622          
623     ### xxx - to review once new node manager rolls out
624     # if PLC_SLICE_PREFIX is left to default - this is meant for the public PL only
625     if plc['slice_prefix'] == 'pl':
626         # create both legacy slices together with netflow through default_slices
627         default_slices += legacy_slices
628     else:
629         # we use another slice prefix : disable legacy slices if already created
630         for legacy_slice in legacy_slices:
631             try:
632                 DeleteSlice(legacy_slice['name'])
633             except:
634                 pass
635     
636     for default_slice in default_slices:
637         slices = GetSlices([default_slice['name']])
638         if slices:
639             slice = slices[0]
640             UpdateSlice(slice['slice_id'], default_slice)
641         else:
642             AddSlice(default_slice)
643             slice = GetSlices([default_slice['name']])[0]
644
645         # Create/update all attributes
646         slice_attributes = []
647         if slice['slice_attribute_ids']:
648             # Delete unknown attributes
649             for slice_attribute in GetSliceAttributes(slice['slice_attribute_ids']):
650                 if (slice_attribute['name'], slice_attribute['value']) \
651                    not in default_slice['attributes']:
652                     DeleteSliceAttribute(slice_attribute['slice_attribute_id'])
653                 else:
654                     slice_attributes.append((slice_attribute['name'], slice_attribute['value']))
655
656         for (name, value) in default_slice['attributes']:
657             if (name, value) not in slice_attributes:
658                 AddSliceAttribute(slice['name'], name, value)
659
660     installfailed = """
661 Once the node meets these requirements, please reinitiate the install
662 by visiting:
663
664 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
665
666 Click the Reinstall link, then reboot the node.
667
668 If you have already performed this step and are still receiving this
669 message, please reply so that we may investigate the problem.
670 """
671
672     # Load default message templates
673     message_templates = [
674         {'message_id': 'Verify account',
675          'subject': "Verify account registration",
676          'template': """
677 Please verify that you registered for a %(PLC_NAME)s account with the
678 username %(email)s by visiting:
679
680 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/register.php?id=%(person_id)d&key=%(verification_key)s
681
682 If you did not register for a %(PLC_NAME)s account, please ignore this
683 message, or contact %(PLC_NAME)s Support <%(PLC_MAIL_SUPPORT_ADDRESS)s>.
684 """
685          },
686
687         {'message_id': 'New PI account',
688          'subject': "New PI account registration from %(first_name)s %(last_name)s <%(email)s> at %(site_name)s",
689          'template': """
690 %(first_name)s %(last_name)s <%(email)s> has signed up for a new
691 %(PLC_NAME)s account at %(site_name)s and has requested a PI role. PIs
692 are responsible for enabling user accounts, creating slices, and
693 ensuring that all users abide by the %(PLC_NAME)s Acceptable Use
694 Policy.
695
696 Only %(PLC_NAME)s administrators may enable new PI accounts. If you
697 are a PI at %(site_name)s, please respond and indicate whether this
698 registration is acceptable.
699
700 To view the request, visit:
701
702 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/index.php?id=%(person_id)d
703 """
704          },
705
706         {'message_id': 'New account',
707          'subject': "New account registration from %(first_name)s %(last_name)s <%(email)s> at %(site_name)s",
708          'template': """
709 %(first_name)s %(last_name)s <%(email)s> has signed up for a new
710 %(PLC_NAME)s account at %(site_name)s and has requested the following
711 roles: %(roles)s.
712
713 To deny the request or enable the account, visit:
714
715 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/index.php?id=%(person_id)d
716 """
717          },
718
719         {'message_id': 'Password reset requested',
720          'subject': "Password reset requested",
721          'template': """
722 Someone has requested that the password of your %(PLC_NAME)s account
723 %(email)s be reset. If this person was you, you may continue with the
724 reset by visiting:
725
726 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/reset_password.php?id=%(person_id)d&key=%(verification_key)s
727
728 If you did not request that your password be reset, please contact
729 %(PLC_NAME)s Support <%(PLC_MAIL_SUPPORT_ADDRESS)s>. Do not quote or
730 otherwise include any of this text in any correspondence.
731 """
732          },
733
734         {'message_id': 'Password reset',
735          'subject': "Password reset",
736          'template': """
737 The password of your %(PLC_NAME)s account %(email)s has been
738 temporarily reset to:
739
740 %(password)s
741
742 Please change it at as soon as possible by visiting:
743
744 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/index.php?id=%(person_id)d
745
746 If you did not request that your password be reset, please contact
747 %(PLC_NAME)s Support <%(PLC_MAIL_SUPPORT_ADDRESS)s>. Do not quote or
748 otherwise include any of this text in any correspondence.
749 """
750          },
751
752         # Boot Manager messages
753         {'message_id': "installfinished",
754          'subject': "%(hostname)s completed installation",
755          'template': """
756 %(hostname)s just completed installation.
757
758 The node should be usable in a couple of minutes if installation was
759 successful.
760 """
761          },
762
763         {'message_id': "insufficientdisk",
764          'subject': "%(hostname)s does not have sufficient disk space",
765          'template': """
766 %(hostname)s failed to boot because it does not have sufficent disk
767 space, or because its disk controller was not recognized.
768
769 Please replace the current disk or disk controller or install
770 additional disks to meet the current hardware requirements.
771 """ + installfailed
772          },
773
774         {'message_id': "insufficientmemory",
775          'subject': "%(hostname)s does not have sufficient memory",
776          'template': """
777 %(hostname)s failed to boot because it does not have sufficent
778 memory.
779
780 Please install additional memory to meet the current hardware
781 requirements.
782 """ + installfailed
783          },
784
785         {'message_id': "authfail",
786          'subject': "%(hostname)s failed to authenticate",
787          'template':
788 """
789 %(hostname)s failed to authenticate for the following reason:
790
791 %(fault)s
792
793 The most common reason for authentication failure is that the
794 authentication key stored in the node configuration file, does not
795 match the key on record. Regenerate the node configuration file by
796 visiting:
797
798 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
799
800 Click the Configuration File link, and save the downloaded file as
801 plnode.txt on either a floppy disk or a USB flash drive. Click the
802 Boot link, then reboot the node.
803
804 If you have already performed this step and are still receiving this
805 message, please reply so that we may investigate the problem.
806 """
807          },
808
809         {'message_id': "notinstalled",
810          'subject': "%(hostname)s is not installed",
811          'template':
812 """
813 %(hostname)s failed to boot because it has either never been
814 installed, or the installation is corrupt.
815
816 Please check if the hard drive has failed, and replace it if so. After
817 doing so, visit:
818
819 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
820
821 Click the Reinstall link, then reboot the node.
822
823 If you have already performed this step and are still receiving this
824 message, please reply so that we may investigate the problem.
825 """
826          },
827
828         {'message_id': "hostnamenotresolve",
829          'subject': "%(hostname)s does not resolve",
830          'template':
831 """
832 %(hostname)s failed to boot because its hostname does not resolve, or
833 does resolve but does not match its configured IP address.
834
835 Please check the network settings for the node, especially its
836 hostname, IP address, and DNS servers, by visiting:
837
838 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
839
840 Correct any errors, click the Reinstall link, then reboot the node.
841
842 If you have already performed this step and are still receiving this
843 message, please reply so that we may investigate the problem.
844 """
845          },
846
847         # XXX N.B. I don't think these are necessary, since there's no
848         # way that the Boot Manager would even be able to contact the
849         # API to send these messages.
850
851         {'message_id': "noconfig",
852          'subject': "%(hostname)s does not have a configuration file",
853          'template': """
854 %(hostname)s failed to boot because it could not find a PlanetLab
855 configuration file. To create this file, visit:
856
857 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
858
859 Click the Configuration File link, and save the downloaded file as
860 plnode.txt on either a floppy disk or a USB flash drive. Click the
861 Reinstall link, then reboot the node.
862
863 If you have already performed this step and are still receiving this
864 message, please reply so that we may investigate the problem.
865 """
866          },
867
868         {'message_id': "nodetectednetwork",
869          'subject': "%(hostname)s has unsupported network hardware",
870          'template':
871 """
872
873 %(hostname)s failed to boot because it has network hardware that is
874 unsupported by the current production kernel. If it has booted
875 successfully in the past, please try re-installing it by visiting:
876
877 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
878
879 Click the Reinstall link, then reboot the node.
880
881 If you have already performed this step and are still receiving this
882 message, please reply so that we may investigate the problem.
883 """
884          },
885         ]
886
887     for template in message_templates:
888         messages = GetMessages([template['message_id']])
889         if not messages:
890             AddMessage(template)        
891
892 if __name__ == '__main__':
893     main()
894
895 # Local variables:
896 # tab-width: 4
897 # mode: python
898 # End: