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 7454 2007-12-11 18:55:00Z faiyaza $
  11 # $HeadURL$
  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         # Log rotation configuration
 146         {'enabled': True,
 147          'source': 'PlanetLabConf/logrotate.conf',
 148          'dest': '/etc/logrotate.conf',
 149          'file_permissions': '644',
 150          'file_owner': 'root',
 151          'file_group': 'root',
 152          'preinstall_cmd': '',
 153          'postinstall_cmd': '',
 154          'error_cmd': '',
 155          'ignore_cmd_errors': False,
 156          'always_update': False},
 157
 158         # updatedb/locate nightly cron job
 159         {'enabled': True,
 160          'source': 'PlanetLabConf/slocate.cron',
 161          'dest': '/etc/cron.daily/slocate.cron',
 162          'file_permissions': '755',
 163          'file_owner': 'root',
 164          'file_group': 'root',
 165          'preinstall_cmd': '',
 166          'postinstall_cmd': '',
 167          'error_cmd': '',
 168          'ignore_cmd_errors': False,
 169          'always_update': False},
 170
 171         # YUM configuration
 172         {'enabled': True,
 173          'source': 'PlanetLabConf/yum.conf.php?gpgcheck=1',
 174          'dest': '/etc/yum.conf',
 175          'file_permissions': '644',
 176          'file_owner': 'root',
 177          'file_group': 'root',
 178          'preinstall_cmd': '',
 179          'postinstall_cmd': '',
 180          'error_cmd': '',
 181          'ignore_cmd_errors': False,
 182          'always_update': False},
 183         {'enabled': True,
 184          'source': 'PlanetLabConf/delete-rpm-list-production',
 185          'dest': '/etc/planetlab/delete-rpm-list',
 186          'file_permissions': '644',
 187          'file_owner': 'root',
 188          'file_group': 'root',
 189          'preinstall_cmd': '',
 190          'postinstall_cmd': '',
 191          'error_cmd': '',
 192          'ignore_cmd_errors': False,
 193          'always_update': False},
 194
 195         # PLC configuration
 196         {'enabled': True,
 197          'source': 'PlanetLabConf/get_plc_config.php',
 198          'dest': '/etc/planetlab/plc_config',
 199          'file_permissions': '644',
 200          'file_owner': 'root',
 201          'file_group': 'root',
 202          'preinstall_cmd': '',
 203          'postinstall_cmd': '',
 204          'error_cmd': '',
 205          'ignore_cmd_errors': False,
 206          'always_update': False},
 207         {'enabled': True,
 208          'source': 'PlanetLabConf/get_plc_config.php?python',
 209          'dest': '/etc/planetlab/plc_config.py',
 210          'file_permissions': '644',
 211          'file_owner': 'root',
 212          'file_group': 'root',
 213          'preinstall_cmd': '',
 214          'postinstall_cmd': '',
 215          'error_cmd': '',
 216          'ignore_cmd_errors': False,
 217          'always_update': False},
 218         {'enabled': True,
 219          'source': 'PlanetLabConf/get_plc_config.php?perl',
 220          'dest': '/etc/planetlab/plc_config.pl',
 221          'file_permissions': '644',
 222          'file_owner': 'root',
 223          'file_group': 'root',
 224          'preinstall_cmd': '',
 225          'postinstall_cmd': '',
 226          'error_cmd': '',
 227          'ignore_cmd_errors': False,
 228          'always_update': False},
 229         {'enabled': True,
 230          'source': 'PlanetLabConf/get_plc_config.php?php',
 231          'dest': '/etc/planetlab/php/plc_config.php',
 232          'file_permissions': '644',
 233          'file_owner': 'root',
 234          'file_group': 'root',
 235          'preinstall_cmd': '',
 236          'postinstall_cmd': '',
 237          'error_cmd': '',
 238          'ignore_cmd_errors': False,
 239          'always_update': False},
 240
 241         # XXX Required for old Node Manager
 242         # Proper configuration
 243         {'enabled': True,
 244          'source': 'PlanetLabConf/propd.conf',
 245          'dest': '/etc/proper/propd.conf',
 246          'file_permissions': '644',
 247          'file_owner': 'root',
 248          'file_group': 'root',
 249          'preinstall_cmd': '',
 250          'postinstall_cmd': '/etc/init.d/proper restart',
 251          'error_cmd': '',
 252          'ignore_cmd_errors': True,
 253          'always_update': False},
 254
 255         # XXX Required for old Node Manager
 256         # Bandwidth cap
 257         {'enabled': True,
 258          'source': 'PlanetLabConf/bwlimit.php',
 259          'dest': '/etc/planetlab/bwcap',
 260          'file_permissions': '644',
 261          'file_owner': 'root',
 262          'file_group': 'root',
 263          'preinstall_cmd': '',
 264          'postinstall_cmd': '',
 265          'error_cmd': '',
 266          'ignore_cmd_errors': True,
 267          'always_update': False},
 268
 269         # Proxy ARP setup
 270         {'enabled': True,
 271          'source': 'PlanetLabConf/proxies.php',
 272          'dest': '/etc/planetlab/proxies',
 273          'file_permissions': '644',
 274          'file_owner': 'root',
 275          'file_group': 'root',
 276          'preinstall_cmd': '',
 277          'postinstall_cmd': '',
 278          'error_cmd': '',
 279          'ignore_cmd_errors': False,
 280          'always_update': False},
 281
 282         # Firewall configuration
 283         {'enabled': True,
 284          'source': 'PlanetLabConf/iptables',
 285          'dest': '/etc/sysconfig/iptables',
 286          'file_permissions': '600',
 287          'file_owner': 'root',
 288          'file_group': 'root',
 289          'preinstall_cmd': '',
 290          'postinstall_cmd': '',
 291          'error_cmd': '',
 292          'ignore_cmd_errors': False,
 293          'always_update': False},
 294         {'enabled': True,
 295          'source': 'PlanetLabConf/blacklist.php',
 296          'dest': '/etc/planetlab/blacklist',
 297          'file_permissions': '600',
 298          'file_owner': 'root',
 299          'file_group': 'root',
 300          'preinstall_cmd': '',
 301          'postinstall_cmd': '/sbin/iptables-restore --noflush < /etc/planetlab/blacklist',
 302          'error_cmd': '',
 303          'ignore_cmd_errors': True,
 304          'always_update': False},
 305
 306         # /etc/issue
 307         {'enabled': True,
 308          'source': 'PlanetLabConf/issue.php',
 309          'dest': '/etc/issue',
 310          'file_permissions': '644',
 311          'file_owner': 'root',
 312          'file_group': 'root',
 313          'preinstall_cmd': '',
 314          'postinstall_cmd': '',
 315          'error_cmd': '',
 316          'ignore_cmd_errors': False,
 317          'always_update': False},
 318
 319         # Kernel parameters
 320         {'enabled': True,
 321          'source': 'PlanetLabConf/sysctl.php',
 322          'dest': '/etc/sysctl.conf',
 323          'file_permissions': '644',
 324          'file_owner': 'root',
 325          'file_group': 'root',
 326          'preinstall_cmd': '',
 327          'postinstall_cmd': '/sbin/sysctl -e -p /etc/sysctl.conf',
 328          'error_cmd': '',
 329          'ignore_cmd_errors': False,
 330          'always_update': False},
 331
 332         # Sendmail configuration
 333         {'enabled': True,
 334          'source': 'PlanetLabConf/sendmail.mc',
 335          'dest': '/etc/mail/sendmail.mc',
 336          'file_permissions': '644',
 337          'file_owner': 'root',
 338          'file_group': 'root',
 339          'preinstall_cmd': '',
 340          'postinstall_cmd': '',
 341          'error_cmd': '',
 342          'ignore_cmd_errors': False,
 343          'always_update': False},
 344         {'enabled': True,
 345          'source': 'PlanetLabConf/sendmail.cf',
 346          'dest': '/etc/mail/sendmail.cf',
 347          'file_permissions': '644',
 348          'file_owner': 'root',
 349          'file_group': 'root',
 350          'preinstall_cmd': '',
 351          'postinstall_cmd': 'service sendmail restart',
 352          'error_cmd': '',
 353          'ignore_cmd_errors': False,
 354          'always_update': False},
 355
 356         # GPG signing keys
 357         {'enabled': True,
 358          'source': 'PlanetLabConf/RPM-GPG-KEY-fedora',
 359          'dest': '/etc/pki/rpm-gpg/RPM-GPG-KEY-fedora',
 360          'file_permissions': '644',
 361          'file_owner': 'root',
 362          'file_group': 'root',
 363          'preinstall_cmd': '',
 364          'postinstall_cmd': 'rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora',
 365          'error_cmd': '',
 366          'ignore_cmd_errors': False,
 367          'always_update': False},
 368         {'enabled': True,
 369          'source': 'PlanetLabConf/get_gpg_key.php',
 370          'dest': '/etc/pki/rpm-gpg/RPM-GPG-KEY-planetlab',
 371          'file_permissions': '644',
 372          'file_owner': 'root',
 373          'file_group': 'root',
 374          'preinstall_cmd': '',
 375          'postinstall_cmd': 'rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-planetlab',
 376          'error_cmd': '',
 377          'ignore_cmd_errors': False,
 378          'always_update': False},
 379
 380         # Ping of death configuration
 381         # the 'restart' postcommand doesn't work, b/c the pod script doesn't support it.
 382         {'enabled': True,
 383          'source': 'PlanetLabConf/ipod.conf.php',
 384          'dest': '/etc/ipod.conf',
 385          'file_permissions': '644',
 386          'file_owner': 'root',
 387          'file_group': 'root',
 388          'preinstall_cmd': '',
 389          'postinstall_cmd': '/etc/init.d/pod start',
 390          'error_cmd': '',
 391          'ignore_cmd_errors': False,
 392          'always_update': False},
 393
 394         # sudo configuration
 395         {'enabled': True,
 396          'source': 'PlanetLabConf/sudoers',
 397          'dest': '/etc/sudoers',
 398          'file_permissions': '440',
 399          'file_owner': 'root',
 400          'file_group': 'root',
 401          'preinstall_cmd': '',
 402          'postinstall_cmd': '/usr/sbin/visudo -c',
 403          'error_cmd': '',
 404          'ignore_cmd_errors': False,
 405          'always_update': False}
 406         ]
 407
 408     # Get list of existing (enabled, global) files
 409     conf_files = GetConfFiles()
 410     conf_files = filter(lambda conf_file: conf_file['enabled'] and \
 411                                           not conf_file['node_ids'] and \
 412                                           not conf_file['nodegroup_ids'],
 413                         conf_files)
 414     dests = [conf_file['dest'] for conf_file in conf_files]
 415     conf_files = dict(zip(dests, conf_files))
 416
 417     # Create/update default PlanetLabConf entries
 418     for default_conf_file in default_conf_files:
 419         if default_conf_file['dest'] not in dests:
 420             AddConfFile(default_conf_file)
 421         else:
 422             conf_file = conf_files[default_conf_file['dest']]
 423             UpdateConfFile(conf_file['conf_file_id'], default_conf_file)
 424
 425     # Setup default slice attribute types
 426     default_attribute_types = [
 427         # Slice type (only vserver is supported)
 428         {'name': "type",
 429          'description': "Type of slice (e.g. vserver)",
 430          'min_role_id': 20},
 431
 432         # System slice
 433         {'name': "system",
 434          'description': "Is a default system slice (1) or not (0 or unset)",
 435          'min_role_id': 10},
 436
 437         # Slice enabled (1) or suspended (0)
 438         {'name': "enabled",
 439          'description': "Slice enabled (1 or unset) or suspended (0)",
 440          'min_role_id': 10},
 441
 442         # Slice reference image
 443         {'name': "vref",
 444          'description': "Reference image",
 445          'min_role_id': 30},
 446
 447         # Slice initialization script
 448         {'name': "initscript",
 449          'description': "Slice initialization script",
 450          'min_role_id': 10},
 451
 452         # CPU share
 453         {'name': "cpu_min",
 454          'description': "Minimum CPU share (ms/s)",
 455          'min_role_id': 10},
 456         {'name': "cpu_share",
 457          'description': "Number of CPU shares",
 458          'min_role_id': 10},
 459
 460         # Bandwidth limits
 461         {'name': "net_min_rate",
 462          'description': "Minimum bandwidth (kbps)",
 463          'min_role_id': 10},
 464         {'name': "net_max_rate",
 465          'description': "Maximum bandwidth (kbps)",
 466          'min_role_id': 10},
 467         {'name': "net_i2_min_rate",
 468          'description': "Minimum bandwidth over I2 routes (kbps)",
 469          'min_role_id': 10},
 470         {'name': "net_i2_max_rate",
 471          'description': "Maximum bandwidth over I2 routes (kbps)",
 472          'min_role_id': 10},
 473         {'name': "net_max_kbyte",
 474          'description': "Maximum daily network Tx KByte limit.",
 475          'min_role_id': 10},
 476         {'name': "net_thresh_kbyte",
 477          'description': "KByte limit before warning and throttling.",
 478          'min_role_id': 10},
 479         {'name': "net_i2_max_kbyte",
 480          'description': "Maximum daily network Tx KByte limit to I2 hosts.",
 481          'min_role_id': 10},
 482         {'name': "net_i2_thresh_kbyte",
 483          'description': "KByte limit to I2 hosts before warning and throttling.",
 484          'min_role_id': 10},
 485         {'name': "net_share",
 486          'description': "Number of bandwidth shares",
 487          'min_role_id': 10},
 488         {'name': "net_i2_share",
 489          'description': "Number of bandwidth shares over I2 routes",
 490          'min_role_id': 10},
 491
 492         # Disk quota
 493         {'name': "disk_max",
 494          'description': "Disk quota (1k disk blocks)",
 495          'min_role_id': 10},
 496
 497         # Proper operations
 498         {'name': "proper_op",
 499          'description': "Proper operation (e.g. bind_socket)",
 500          'min_role_id': 10}
 501         ]
 502
 503     # Get list of existing attribute types
 504     attribute_types = GetSliceAttributeTypes()
 505     attribute_types = [attribute_type['name'] for attribute_type in attribute_types]
 506
 507     # Create/update default slice attribute types
 508     for default_attribute_type in default_attribute_types:
 509         if default_attribute_type['name'] not in attribute_types:
 510             AddSliceAttributeType(default_attribute_type)
 511         else:
 512             UpdateSliceAttributeType(default_attribute_type['name'], default_attribute_type)
 513
 514     # Setup default slice attribute types
 515     default_setting_types = [
 516
 517         {'category' : "general",
 518          'name' : "ifname",
 519          'description': "Set interface name, instead of eth0 or the like",
 520          'min_role_id' : 40},
 521         {'category' : "general",
 522          'name' : "driver",
 523          'description': "Use this to specify an alternate driver",
 524          'min_role_id' : 40 },
 525         {'category' : "general",
 526          'name' : "alias",
 527          'description': "Allows to reuse an interface as eth0:alias",
 528          'min_role_id' : 40},
 529
 530         {'category' : "hidden",
 531          'name' : "backdoor",
 532          'description': "For testing new settings",
 533          'min_role_id' : 10},
 534
 535         ] + [
 536         { "category" : "WiFi",
 537           "name" : x,
 538           "description" : "802.11 %s -- see %s"%(y,z),
 539           "min_role_id" : 40 } for (x,y,z) in [
 540             ("mode","Mode","iwconfig"),
 541             ("essid","ESSID","iwconfig"),
 542             ("nw","Network Id","iwconfig"),
 543             ("freq","Frequency","iwconfig"),
 544             ("channel","Channel","iwconfig"),
 545             ("sens","sensitivity threshold","iwconfig"),
 546             ("rate","Rate","iwconfig"),
 547             ("key","key","iwconfig key"),
 548             ("key1","key1","iwconfig key [1]"),
 549             ("key2","key2","iwconfig key [2]"),
 550             ("key3","key3","iwconfig key [3]"),
 551             ("key4","key4","iwconfig key [4]"),
 552             ("securitymode","Security mode","iwconfig enc"),
 553             ("iwconfig","Additional parameters to iwconfig","ifup-wireless"),
 554             ("iwpriv","Additional parameters to iwpriv","ifup-wireless"),
 555             ]
 556         ]
 557
 558
 559     # Get list of existing attribute types
 560     setting_types = GetNodeNetworkSettingTypes()
 561     setting_types = [setting_type['name'] for setting_type in setting_types]
 562
 563     # Create/update default slice setting types
 564     for default_setting_type in default_setting_types:
 565         if default_setting_type['name'] not in setting_types:
 566             AddNodeNetworkSettingType(default_setting_type)
 567         else:
 568             UpdateNodeNetworkSettingType(default_setting_type['name'], default_setting_type)
 569
 570     # Create/update system slices
 571     default_slices = [
 572          # PlanetFlow
 573         {'name': plc['slice_prefix'] + "_netflow",
 574          'description': "PlanetFlow Traffic Auditing Service",
 575          'url': url,
 576          'instantiation': "plc-instantiated",
 577          # Renew forever
 578          'expires': sys.maxint,
 579          'attributes': [('system', "1"),
 580                         ('vref', "planetflow"),
 581                         ('proper_op', "open file=/etc/passwd, flags=r"),
 582                         ('proper_op', "create_socket"),
 583                         ('proper_op', "bind_socket")]},
 584         ]
 585
 586     for default_slice in default_slices:
 587         slices = GetSlices([default_slice['name']])
 588         if slices:
 589             slice = slices[0]
 590             UpdateSlice(slice['slice_id'], default_slice)
 591         else:
 592             AddSlice(default_slice)
 593             slice = GetSlices([default_slice['name']])[0]
 594
 595         # Create/update all attributes
 596         slice_attributes = []
 597         if slice['slice_attribute_ids']:
 598             # Delete unknown attributes
 599             for slice_attribute in GetSliceAttributes(slice['slice_attribute_ids']):
 600                 if (slice_attribute['name'], slice_attribute['value']) \
 601                    not in default_slice['attributes']:
 602                     DeleteSliceAttribute(slice_attribute['slice_attribute_id'])
 603                 else:
 604                     slice_attributes.append((slice_attribute['name'], slice_attribute['value']))
 605
 606         for (name, value) in default_slice['attributes']:
 607             if (name, value) not in slice_attributes:
 608                 AddSliceAttribute(slice['name'], name, value)
 609
 610     installfailed = """
 611 Once the node meets these requirements, please reinitiate the install
 612 by visiting:
 613
 614 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
 615
 616 Update the BootState to 'Reinstall', then reboot the node.
 617
 618 If you have already performed this step and are still receiving this
 619 message, please reply so that we may investigate the problem.
 620 """
 621
 622     # Load default message templates
 623     message_templates = [
 624         {'message_id': 'Verify account',
 625          'subject': "Verify account registration",
 626          'template': """
 627 Please verify that you registered for a %(PLC_NAME)s account with the
 628 username %(email)s by visiting:
 629
 630 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/register.php?id=%(person_id)d&key=%(verification_key)s
 631
 632 If you did not register for a %(PLC_NAME)s account, please ignore this
 633 message, or contact %(PLC_NAME)s Support <%(PLC_MAIL_SUPPORT_ADDRESS)s>.
 634 """
 635          },
 636
 637         {'message_id': 'New PI account',
 638          'subject': "New PI account registration from %(first_name)s %(last_name)s <%(email)s> at %(site_name)s",
 639          'template': """
 640 %(first_name)s %(last_name)s <%(email)s> has signed up for a new
 641 %(PLC_NAME)s account at %(site_name)s and has requested a PI role. PIs
 642 are responsible for enabling user accounts, creating slices, and
 643 ensuring that all users abide by the %(PLC_NAME)s Acceptable Use
 644 Policy.
 645
 646 Only %(PLC_NAME)s administrators may enable new PI accounts. If you
 647 are a PI at %(site_name)s, please respond and indicate whether this
 648 registration is acceptable.
 649
 650 To view the request, visit:
 651
 652 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/index.php?id=%(person_id)d
 653 """
 654          },
 655
 656         {'message_id': 'New account',
 657          'subject': "New account registration from %(first_name)s %(last_name)s <%(email)s> at %(site_name)s",
 658          'template': """
 659 %(first_name)s %(last_name)s <%(email)s> has signed up for a new
 660 %(PLC_NAME)s account at %(site_name)s and has requested the following
 661 roles: %(roles)s.
 662
 663 To deny the request or enable the account, visit:
 664
 665 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/index.php?id=%(person_id)d
 666 """
 667          },
 668
 669         {'message_id': 'Password reset requested',
 670          'subject': "Password reset requested",
 671          'template': """
 672 Someone has requested that the password of your %(PLC_NAME)s account
 673 %(email)s be reset. If this person was you, you may continue with the
 674 reset by visiting:
 675
 676 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/reset_password.php?id=%(person_id)d&key=%(verification_key)s
 677
 678 If you did not request that your password be reset, please contact
 679 %(PLC_NAME)s Support <%(PLC_MAIL_SUPPORT_ADDRESS)s>. Do not quote or
 680 otherwise include any of this text in any correspondence.
 681 """
 682          },
 683
 684         {'message_id': 'Password reset',
 685          'subject': "Password reset",
 686          'template': """
 687 The password of your %(PLC_NAME)s account %(email)s has been
 688 temporarily reset to:
 689
 690 %(password)s
 691
 692 Please change it at as soon as possible by visiting:
 693
 694 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/persons/index.php?id=%(person_id)d
 695
 696 If you did not request that your password be reset, please contact
 697 %(PLC_NAME)s Support <%(PLC_MAIL_SUPPORT_ADDRESS)s>. Do not quote or
 698 otherwise include any of this text in any correspondence.
 699 """
 700          },
 701
 702         # Boot Manager messages
 703         {'message_id': "installfinished",
 704          'subject': "%(hostname)s completed installation",
 705          'template': """
 706 %(hostname)s just completed installation.
 707
 708 The node should be usable in a couple of minutes if installation was
 709 successful.
 710 """
 711          },
 712
 713         {'message_id': "insufficientdisk",
 714          'subject': "%(hostname)s does not have sufficient disk space",
 715          'template': """
 716 %(hostname)s failed to boot because it does not have sufficent disk
 717 space, or because its disk controller was not recognized.
 718
 719 Please replace the current disk or disk controller or install
 720 additional disks to meet the current hardware requirements.
 721 """ + installfailed
 722          },
 723
 724         {'message_id': "insufficientmemory",
 725          'subject': "%(hostname)s does not have sufficient memory",
 726          'template': """
 727 %(hostname)s failed to boot because it does not have sufficent
 728 memory.
 729
 730 Please install additional memory to meet the current hardware
 731 requirements.
 732 """ + installfailed
 733          },
 734
 735         {'message_id': "authfail",
 736          'subject': "%(hostname)s failed to authenticate",
 737          'template':
 738 """
 739 %(hostname)s failed to authenticate for the following reason:
 740
 741 %(fault)s
 742
 743 The most common reason for authentication failure is that the
 744 authentication key stored in the node configuration file, does not
 745 match the key on record.
 746
 747 There are two possible steps to resolve the problem.
 748
 749 1. If you have used an All-in-one BootCD that includes the plnode.txt file,
 750     then please check your machine for any old boot media, either in the
 751     floppy drive, or on a USB stick.  It is likely that an old configuration
 752     is being used instead of the new configuration stored on the BootCD.
 753 Or,
 754 2. If you are using Generic BootCD image, then regenerate the node
 755     configuration file by visiting:
 756
 757     https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
 758
 759     Under 'Download', follow the 'Download plnode.txt file for %(hostname)s'
 760     option, and save the downloaded file as plnode.txt on either a floppy
 761     disk or a USB flash drive.  Be sure the 'Boot State' is set to 'Boot',
 762     and, then reboot the node.
 763
 764 If you have already performed this step and are still receiving this
 765 message, please reply so that we can help investigate the problem.
 766 """
 767          },
 768
 769         {'message_id': "notinstalled",
 770          'subject': "%(hostname)s is not installed",
 771          'template':
 772 """
 773 %(hostname)s failed to boot because it has either never been
 774 installed, or the installation is corrupt.
 775
 776 Please check if the hard drive has failed, and replace it if so. After
 777 doing so, visit:
 778
 779 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
 780
 781 Change the 'Boot State' to 'Reinstall', and then reboot the node.
 782
 783 If you have already performed this step and are still receiving this
 784 message, please reply so that we may investigate the problem.
 785 """
 786          },
 787
 788         {'message_id': "hostnamenotresolve",
 789          'subject': "%(hostname)s does not resolve",
 790          'template':
 791 """
 792 %(hostname)s failed to boot because its hostname does not resolve, or
 793 does resolve but does not match its configured IP address.
 794
 795 Please check the network settings for the node, especially its
 796 hostname, IP address, and DNS servers, by visiting:
 797
 798 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
 799
 800 Correct any errors, and change the 'Boot State' to 'Reinstall', and then
 801 reboot the node.
 802
 803 If you have already performed this step and are still receiving this
 804 message, please reply so that we may investigate the problem.
 805 """
 806          },
 807
 808         # XXX N.B. I don't think these are necessary, since there's no
 809         # way that the Boot Manager would even be able to contact the
 810         # API to send these messages.
 811
 812         {'message_id': "noconfig",
 813          'subject': "%(hostname)s does not have a configuration file",
 814          'template': """
 815 %(hostname)s failed to boot because it could not find a PlanetLab
 816 configuration file. To create this file, visit:
 817
 818 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
 819
 820 Click the Configuration File link, and save the downloaded file as
 821 plnode.txt on either a floppy disk or a USB flash drive.  Change the
 822 'Boot State' to 'Reinstall', and then reboot the node.
 823
 824 If you have already performed this step and are still receiving this
 825 message, please reply so that we may investigate the problem.
 826 """
 827          },
 828
 829         {'message_id': "nodetectednetwork",
 830          'subject': "%(hostname)s has unsupported network hardware",
 831          'template':
 832 """
 833
 834 %(hostname)s failed to boot because it has network hardware that is
 835 unsupported by the current production kernel. If it has booted
 836 successfully in the past, please try re-installing it by visiting:
 837
 838 https://%(PLC_WWW_HOST)s:%(PLC_WWW_SSL_PORT)d/db/nodes/?id=%(node_id)d
 839
 840 Change the 'Boot State' to 'Reinstall', and 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
 848     for template in message_templates:
 849         messages = GetMessages([template['message_id']])
 850         if not messages:
 851             AddMessage(template)
 852
 853
 854     ### Setup Initial PCU information
 855     pcu_types = [{'model': 'AP79xx',
 856           'name': 'APC AP79xx',
 857           'pcu_protocol_types': [{ 'port': 80,
 858                                   'protocol': 'APC79xxHttp',
 859                                   'supported': False},
 860                                  { 'port': 23,
 861                                   'protocol': 'APC79xx',
 862                                   'supported': True},
 863                                  { 'port': 22,
 864                                   'protocol': 'APC79xx',
 865                                   'supported': True}],
 866           },
 867          {'model': 'Masterswitch',
 868           'name': 'APC Masterswitch',
 869           'pcu_protocol_types': [{ 'port': 80,
 870                                   'protocol': 'APCMasterHttp',
 871                                   'supported': False},
 872                                  { 'port': 23,
 873                                   'protocol': 'APCMaster',
 874                                   'supported': True},
 875                                  { 'port': 22,
 876                                   'protocol': 'APCMaster',
 877                                   'supported': True}],
 878           },
 879          {'model': 'DS4-RPC',
 880           'name': 'BayTech DS4-RPC',
 881           'pcu_protocol_types': [{ 'port': 80,
 882                                   'protocol': 'BayTechHttp',
 883                                   'supported': False},
 884                                  { 'port': 23,
 885                                   'protocol': 'BayTech',
 886                                   'supported': True},
 887                                  { 'port': 22,
 888                                   'protocol': 'BayTech',
 889                                   'supported': True}],
 890           },
 891          {'model': 'IP-41x_IP-81x',
 892           'name': 'Dataprobe IP-41x & IP-81x',
 893           'pcu_protocol_types': [ { 'port': 23,
 894                                   'protocol': 'IPALTelnet',
 895                                   'supported': True},
 896                                   { 'port': 80,
 897                                   'protocol': 'IPALHttp',
 898                                   'supported': False}],
 899           },
 900          {'model': 'DRAC3',
 901           'name': 'Dell RAC Version 3',
 902           'pcu_protocol_types': [],
 903           },
 904          {'model': 'DRAC4',
 905           'name': 'Dell RAC Version 4',
 906           'pcu_protocol_types': [{ 'port': 443,
 907                                   'protocol': 'DRACRacAdm',
 908                                   'supported': True},
 909                                  { 'port': 80,
 910                                   'protocol': 'DRACRacAdm',
 911                                   'supported': False},
 912                                  { 'port': 22,
 913                                   'protocol': 'DRAC',
 914                                   'supported': True}],
 915           },
 916          {'model': 'ePowerSwitch',
 917           'name': 'ePowerSwitch 1/4/8x',
 918           'pcu_protocol_types': [{ 'port': 80,
 919                                   'protocol': 'ePowerSwitch',
 920                                   'supported': True}],
 921           },
 922          {'model': 'ilo2',
 923           'name': 'HP iLO2 (Integrated Lights-Out)',
 924           'pcu_protocol_types': [{ 'port': 443,
 925                                   'protocol': 'HPiLOHttps',
 926                                   'supported': True},
 927                                  { 'port': 22,
 928                                   'protocol': 'HPiLO',
 929                                   'supported': True}],
 930           },
 931          {'model': 'ilo1',
 932           'name': 'HP iLO version 1',
 933           'pcu_protocol_types': [],
 934           },
 935          {'model': 'PM211-MIP',
 936           'name': 'Infratec PM221-MIP',
 937           'pcu_protocol_types': [],
 938           },
 939          {'model': 'AMT2.5',
 940           'name': 'Intel AMT v2.5 (Active Management Technology)',
 941           'pcu_protocol_types': [],
 942           },
 943          {'model': 'AMT3.0',
 944           'name': 'Intel AMT v3.0 (Active Management Technology)',
 945           'pcu_protocol_types': [],
 946           },
 947          {'model': 'WTI_IPS-4',
 948           'name': 'Western Telematic (WTI IPS-4)',
 949           'pcu_protocol_types': [],
 950           },
 951          {'model': 'unknown',
 952           'name': 'Unknown Vendor or Model',
 953           'pcu_protocol_types': [{ 'port': 443,
 954                                   'protocol': 'UnknownPCU',
 955                                   'supported': False},
 956                                  { 'port': 80,
 957                                   'protocol': 'UnknownPCU',
 958                                   'supported': False},
 959                                  { 'port': 23,
 960                                   'protocol': 'UnknownPCU',
 961                                   'supported': False},
 962                                  { 'port': 22,
 963                                   'protocol': 'UnknownPCU',
 964                                   'supported': False}],
 965           }]
 966
 967     # Get all model names
 968     pcu_models = [type['model'] for type in GetPCUTypes()]
 969     for type in pcu_types:
 970         protocol_types = type['pcu_protocol_types']
 971         # Take this value out of the struct.
 972         del type['pcu_protocol_types']
 973         if type['model'] not in pcu_models:
 974             # Add the name/model info into DB
 975             id = AddPCUType(type)
 976             # for each protocol, also add this.
 977             for ptype in protocol_types:
 978                 AddPCUProtocolType(id, ptype)
 979
 980
 981 if __name__ == '__main__':
 982     main()
 983
 984 # Local variables:
 985 # tab-width: 4
 986 # mode: python
 987 # End: