default_config.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2
   3 <!--
   4 Default PLC configuration file
   5
   6 Mark Huang <mlhuang@cs.princeton.edu>
   7 Copyright (C) 2006 The Trustees of Princeton University
   8
   9 $Id$
  10 $URL$
  11 -->
  12
  13 <!DOCTYPE configuration PUBLIC "-//PlanetLab Central//DTD PLC configuration//EN" "plc_config.dtd">
  14
  15 <configuration>
  16   <variables>
  17     <category id="plc">
  18       <name>System</name>
  19       <description>Basic system variables. Be sure that the values of
  20       these variables are the same across all machines in your
  21       installation.</description>
  22
  23       <variablelist>
  24         <variable id="name" type="string">
  25           <name>Name</name>
  26           <value>PlanetLab Test</value>
  27           <description>The name of this PLC installation. It is used in
  28           the name of the default system site (e.g., PlanetLab Central)
  29           and in the names of various administrative entities (e.g.,
  30           PlanetLab Support).</description>
  31         </variable>
  32
  33         <variable id="shortname" type="string">
  34           <name>Shortame</name>
  35           <value>Tlab</value>
  36           <description>The short name of this PLC installation. It is
  37           mostly used in the web interface when displaying local
  38           objects.</description>
  39         </variable>
  40
  41         <variable id="hrn_root" type="string">
  42           <name>Root in Hierarchical Naming Space </name>
  43           <value>planetlab.test</value>
  44           <description> The root of this peer in the hierarchical federation naming space.</description>
  45         </variable>
  46
  47         <variable id="slice_prefix" type="string">
  48           <name>Slice Prefix</name>
  49           <value>pl</value>
  50           <description>The abbreviated name of this PLC
  51           installation. It is used as the prefix for system slices
  52           (e.g., pl_conf). Warning: Currently, this variable should
  53           not be changed.</description>
  54         </variable>
  55
  56         <variable id="root_user" type="email">
  57           <name>Root Account</name>
  58           <value>root@localhost.localdomain</value>
  59           <description>The name of the initial administrative
  60           account. We recommend that this account be used only to create
  61           additional accounts associated with real
  62           administrators, then disabled.</description>
  63         </variable>
  64
  65         <variable id="root_password" type="password">
  66           <name>Root Password</name>
  67           <value>root</value>
  68           <description>The password of the initial administrative
  69           account. Also the password of the root account on the Boot
  70           CD.</description>
  71         </variable>
  72
  73         <!-- The following are not actually meant to be configurable
  74              as variables. The web interface should allow the file to
  75              be downloaded, or its contents replaced by a file upload,
  76              but the actual <value> shouldn't need to be changed.  -->
  77
  78         <variable id="debug_ssh_key_pub" type="file">
  79           <name>Debug SSH Public Key</name>
  80           <value>/etc/planetlab/debug_ssh_key.pub</value>
  81           <description>The SSH public key used to access the root
  82           account on your nodes when they are in Debug mode.</description>
  83         </variable>
  84
  85         <variable id="debug_ssh_key" type="file">
  86           <name>Debug SSH Private Key</name>
  87           <value>/etc/planetlab/debug_ssh_key.rsa</value>
  88           <description>The SSH private key used to access the root
  89           account on your nodes when they are in Debug mode.</description>
  90         </variable>
  91
  92         <variable id="root_gpg_key_pub" type="file">
  93           <name>Root GPG Public Keyring</name>
  94           <value>/etc/planetlab/pubring.gpg</value>
  95           <description>The GPG public keyring used to sign the Boot
  96           Manager and all node packages.</description>
  97         </variable>
  98
  99         <variable id="root_gpg_key" type="file">
 100           <name>Root GPG Private Keyring</name>
 101           <value>/etc/planetlab/secring.gpg</value>
 102           <description>The SSH private key used to access the root
 103           account on your nodes.</description>
 104         </variable>
 105       </variablelist>
 106     </category>
 107
 108     <category id="plc_net">
 109       <name>Network</name>
 110       <description>Network environment.</description>
 111
 112       <variablelist>
 113         <variable id="dns1" type="ip">
 114           <name>Primary DNS Server</name>
 115           <value>127.0.0.1</value>
 116           <description>Primary DNS server address.</description>
 117         </variable>
 118
 119         <variable id="dns2" type="ip">
 120           <name>Secondary DNS Server</name>
 121           <value></value>
 122           <description>Secondary DNS server address.</description>
 123         </variable>
 124       </variablelist>
 125     </category>
 126
 127     <category id="plc_dns">
 128       <name>DNS</name>
 129       <description>MyPLC can provide forward DNS resolution for itself
 130       and for its nodes. To enable resolution for MyPLC itself, set
 131       the Primary DNS Server address to 127.0.0.1 and provide external
 132       IP addresses for the database, API, web, and boot servers
 133       below. To enable resolution for nodes, use the external IP
 134       address of this machine as the primary DNS server address for
 135       each node.</description>
 136
 137       <variablelist>
 138         <variable id="enabled" type="boolean">
 139           <name>Enable DNS</name>
 140           <value>true</value>
 141           <description>Enable the internal DNS server. The server does
 142           not provide reverse resolution and is not a production
 143           quality or scalable DNS solution. Use the internal DNS
 144           server only for small deployments or for
 145           testing.</description>
 146         </variable>
 147       </variablelist>
 148     </category>
 149
 150     <category id="plc_mail">
 151       <name>Mail</name>
 152       <description>Many maintenance scripts, as well as the API and
 153       web site themselves, send e-mail notifications and
 154       warnings.</description>
 155
 156       <variablelist>
 157         <variable id="enabled" type="boolean">
 158           <name>Enable Mail</name>
 159           <value>false</value>
 160           <description>Set to false to suppress all e-mail notifications
 161           and warnings.</description>
 162         </variable>
 163
 164         <variable id="support_address" type="email">
 165           <name>Support Address</name>
 166           <value>root+support@localhost.localdomain</value>
 167           <description>This address is used for support
 168           requests. Support requests may include traffic complaints,
 169           security incident reporting, web site malfunctions, and
 170           general requests for information. We recommend that the
 171           address be aliased to a ticketing system such as Request
 172           Tracker.</description>
 173         </variable>
 174
 175         <variable id="boot_address" type="email">
 176           <name>Boot Messages Address</name>
 177           <value>root+install-msgs@localhost.localdomain</value>
 178           <description>The API will notify this address when a problem
 179           occurs during node installation or boot.</description>
 180         </variable>
 181
 182         <variable id="mom_list_address" type="email">
 183           <name>Mom List Address</name>
 184           <value>root+mom@localhost.localdomain</value>
 185           <description>This address is used by operations staff
 186           to monitor Mom (formerly pl_mom) messages indicating
 187           excessive BW or memory usage by a slice.  Mom messages sent
 188           to slices will be cc'ed to this list so as not to clog
 189           the Support Address list.</description>
 190         </variable>
 191
 192         <variable id="slice_address" type="email">
 193           <name>Slice Address</name>
 194           <value>root+SLICE@localhost.localdomain</value>
 195           <description>This address template is used for sending
 196           e-mail notifications to slices. SLICE will be replaced with
 197           the name of the slice.</description>
 198         </variable>
 199       </variablelist>
 200     </category>
 201
 202     <category id="plc_db">
 203       <name>Database Server</name>
 204       <description>Database server definitions.</description>
 205
 206       <variablelist>
 207         <variable id="enabled" type="boolean">
 208           <name>Enabled</name>
 209           <value>true</value>
 210           <description>Enable the database server on this
 211           machine.</description>
 212         </variable>
 213
 214         <variable id="type" type="string">
 215           <name>Type</name>
 216           <value>postgresql</value>
 217           <description>The type of database server. Currently, only
 218           postgresql is supported.</description>
 219         </variable>
 220
 221         <variable id="host" type="hostname">
 222           <name>Hostname</name>
 223           <value>localhost.localdomain</value>
 224           <description>The fully qualified hostname of the database
 225           server.</description>
 226         </variable>
 227
 228         <variable id="ip" type="ip">
 229           <name>IP Address</name>
 230           <value/>
 231           <description>The IP address of the database server, if not
 232           resolvable.</description>
 233         </variable>
 234
 235         <variable id="port" type="int">
 236           <name>Port</name>
 237           <value>5432</value>
 238           <description>The TCP port number through which the database
 239           server should be accessed.</description>
 240         </variable>
 241
 242         <variable id="name" type="string">
 243           <name>Database Name</name>
 244           <value>planetlab5</value>
 245           <description>The name of the database to access.</description>
 246         </variable>
 247
 248         <variable id="user" type="string">
 249           <name>Database Username</name>
 250           <value>pgsqluser</value>
 251           <description>The username to use when accessing the
 252           database.</description>
 253         </variable>
 254
 255         <variable id="password" type="password">
 256           <name>Database Password</name>
 257           <value></value>
 258           <description>The password to use when accessing the
 259           database. If left blank, one will be
 260           generated.</description>
 261         </variable>
 262       </variablelist>
 263     </category>
 264
 265     <category id="plc_api">
 266       <name>API Server</name>
 267       <description>API (XML-RPC) server definitions.</description>
 268
 269       <variablelist>
 270         <variable id="enabled" type="boolean">
 271           <name>Enabled</name>
 272           <value>true</value>
 273           <description>Enable the API server on this
 274           machine.</description>
 275         </variable>
 276
 277         <variable id="debug" type="boolean">
 278           <name>Debug</name>
 279           <value>false</value>
 280           <description>Enable verbose API debugging. Do not enable on
 281           a production system!</description>
 282         </variable>
 283
 284         <variable id="host" type="hostname">
 285           <name>Hostname</name>
 286           <value>localhost.localdomain</value>
 287           <description>The fully qualified hostname of the API
 288           server.</description>
 289         </variable>
 290
 291         <variable id="ip" type="ip">
 292           <name>IP Address</name>
 293           <value/>
 294           <description>The IP address of the API server, if not
 295           resolvable.</description>
 296         </variable>
 297
 298         <variable id="ipod_subnet" type="ip">
 299           <name>IP Subnet</name>
 300           <value>127.0.0.1</value>
 301           <description>The IP Subnet for all API servers.
 302           Used to identify IPoD packet senders.</description>
 303         </variable>
 304
 305         <variable id="ipod_mask" type="ip">
 306           <name>IP Mask</name>
 307           <value>255.255.255.255</value>
 308           <description>The IP Mask that should be applied to incoming
 309           packets to match the IP Subnet for IPoD packets.</description>
 310         </variable>
 311
 312         <variable id="port" type="int">
 313           <name>Port</name>
 314           <value>443</value>
 315           <description>The TCP port number through which the API
 316           should be accessed.</description>
 317         </variable>
 318
 319         <variable id="path" type="string">
 320           <name>Path</name>
 321           <value>/PLCAPI/</value>
 322           <description>The base path of the API URL.</description>
 323         </variable>
 324
 325         <variable id="maintenance_user" type="string">
 326           <name>Maintenance User</name>
 327           <value>maint@localhost.localdomain</value>
 328           <description>The username of the maintenance account. This
 329           account is used by local scripts that perform automated
 330           tasks, and cannot be used for normal logins.</description>
 331         </variable>
 332
 333         <variable id="maintenance_password" type="password">
 334           <name>Maintenance Password</name>
 335           <value></value>
 336           <description>The password of the maintenance account. If
 337           left blank, one will be generated. We recommend that the
 338           password be changed periodically.</description>
 339         </variable>
 340
 341         <variable id="maintenance_sources" type="hostname">
 342           <name>Authorized Hosts</name>
 343           <value></value>
 344           <description>A space-separated list of IP addresses allowed
 345           to access the API through the maintenance account. The value
 346           of this variable is set automatically to allow only the API,
 347           web, and boot servers, and should not be
 348           changed.</description>
 349         </variable>
 350
 351         <!-- The following are not actually meant to be configurable
 352              as variables. The web interface should allow the file to
 353              be downloaded, or its contents replaced by a file upload,
 354              but the actual <value> shouldn't need to be changed.  -->
 355
 356         <variable id="ssl_key" type="file">
 357           <name>SSL Private Key</name>
 358           <value>/etc/planetlab/api_ssl.key</value>
 359           <description>The SSL private key to use for encrypting HTTPS
 360           traffic. If non-existent, one will be
 361           generated.</description>
 362         </variable>
 363
 364         <variable id="ssl_crt" type="file">
 365           <name>SSL Public Certificate</name>
 366           <value>/etc/planetlab/api_ssl.crt</value>
 367           <description>The corresponding SSL public certificate. By
 368           default, this certificate is self-signed. You may replace
 369           the certificate later with one signed by a root
 370           CA.</description>
 371         </variable>
 372
 373         <variable id="ca_ssl_crt" type="file">
 374           <name>Root CA SSL Public Certificate</name>
 375           <value>/etc/planetlab/api_ca_ssl.crt</value>
 376           <description>The certificate of the root CA, if any, that
 377           signed your server certificate. If your server certificate is
 378           self-signed, then this file is the same as your server
 379           certificate.</description>
 380         </variable>
 381       </variablelist>
 382     </category>
 383
 384     <category id="plc_www">
 385       <name>Web Server</name>
 386       <description>Web server definitions.</description>
 387
 388       <variablelist>
 389         <variable id="enabled" type="boolean">
 390           <name>Enabled</name>
 391           <value>true</value>
 392           <description>Enable the web server on this
 393           machine.</description>
 394         </variable>
 395
 396         <variable id="debug" type="boolean">
 397           <name>Debug</name>
 398           <value>false</value>
 399           <description>Enable debugging output on web pages. Do not
 400           enable on a production system!</description>
 401         </variable>
 402
 403         <variable id="host" type="hostname">
 404           <name>Hostname</name>
 405           <value>localhost.localdomain</value>
 406           <description>The fully qualified hostname of the web
 407           server.</description>
 408         </variable>
 409
 410         <variable id="ip" type="ip">
 411           <name>IP Address</name>
 412           <value/>
 413           <description>The IP address of the web server, if not
 414           resolvable.</description>
 415         </variable>
 416
 417         <variable id="port" type="int">
 418           <name>Port</name>
 419           <value>80</value>
 420           <description>The TCP port number through which the
 421           unprotected portions of the web site should be
 422           accessed.</description>
 423         </variable>
 424
 425         <variable id="ssl_port" type="int">
 426           <name>SSL Port</name>
 427           <value>443</value>
 428           <description>The TCP port number through which the protected
 429           portions of the web site should be accessed.</description>
 430         </variable>
 431
 432         <!-- The following are not actually meant to be configurable
 433              as variables. The web interface should allow the file to
 434              be downloaded, or its contents replaced by a file upload,
 435              but the actual <value> shouldn't need to be changed.  -->
 436
 437         <variable id="ssl_key" type="file">
 438           <name>SSL Private Key</name>
 439           <value>/etc/planetlab/www_ssl.key</value>
 440           <description>The SSL private key to use for encrypting HTTPS
 441           traffic. If non-existent, one will be
 442           generated.</description>
 443         </variable>
 444
 445         <variable id="ssl_crt" type="file">
 446           <name>SSL Public Certificate</name>
 447           <value>/etc/planetlab/www_ssl.crt</value>
 448           <description>The corresponding SSL public certificate for
 449           the HTTP server. By default, this certificate is
 450           self-signed. You may replace the certificate later with one
 451           signed by a root CA.</description>
 452         </variable>
 453
 454         <variable id="ca_ssl_crt" type="file">
 455           <name>Root CA SSL Public Certificate</name>
 456           <value>/etc/planetlab/www_ca_ssl.crt</value>
 457           <description>The certificate of the root CA, if any, that
 458           signed your server certificate. If your server certificate is
 459           self-signed, then this file is the same as your server
 460           certificate.</description>
 461         </variable>
 462       </variablelist>
 463     </category>
 464
 465     <category id="plc_boot">
 466       <name>Boot Server</name>
 467       <description>Boot server definitions. Multiple boot servers
 468       may be brought up for load balancing, but we recommend that a
 469       single DNS round-robin system be implemented so that the
 470       following variables are the same across all of
 471       them.</description>
 472
 473       <variablelist>
 474         <variable id="enabled" type="boolean">
 475           <name>Enabled</name>
 476           <value>true</value>
 477           <description>Enable the boot server on this
 478           machine.</description>
 479         </variable>
 480
 481         <variable id="host" type="hostname">
 482           <name>Hostname</name>
 483           <value>localhost.localdomain</value>
 484           <description>The fully qualified hostname of the boot
 485           server.</description>
 486         </variable>
 487
 488         <variable id="ip" type="ip">
 489           <name>IP Address</name>
 490           <value/>
 491           <description>The IP address of the boot server, if not
 492           resolvable.</description>
 493         </variable>
 494
 495         <variable id="port" type="int">
 496           <name>Port</name>
 497           <value>80</value>
 498           <description>The TCP port number through which the
 499           unprotected portions of the boot server should be
 500           accessed.</description>
 501         </variable>
 502
 503         <variable id="ssl_port" type="int">
 504           <name>SSL Port</name>
 505           <value>443</value>
 506           <description>The TCP port number through which the protected
 507           portions of the boot server should be
 508           accessed.</description>
 509         </variable>
 510
 511         <!-- The following are not actually meant to be configurable
 512              as variables. The web interface should allow the file to
 513              be downloaded, or its contents replaced by a file upload,
 514              but the actual <value> shouldn't need to be changed.  -->
 515
 516         <variable id="ssl_key" type="file">
 517           <name>SSL Private Key</name>
 518           <value>/etc/planetlab/boot_ssl.key</value>
 519           <description>The SSL private key to use for encrypting HTTPS
 520           traffic.</description>
 521         </variable>
 522
 523         <variable id="ssl_crt" type="file">
 524           <name>SSL Public Certificate</name>
 525           <value>/etc/planetlab/boot_ssl.crt</value>
 526           <description>The corresponding SSL public certificate for
 527           the HTTP server. By default, this certificate is
 528           self-signed. You may replace the certificate later with one
 529           signed by a root CA.</description>
 530         </variable>
 531
 532         <variable id="ca_ssl_crt" type="file">
 533           <name>Root CA SSL Public Certificate</name>
 534           <value>/etc/planetlab/boot_ca_ssl.crt</value>
 535           <description>The certificate of the root CA, if any, that
 536           signed your server certificate. If your server certificate is
 537           self-signed, then this file is the same as your server
 538           certificate.</description>
 539         </variable>
 540       </variablelist>
 541     </category>
 542
 543
 544     <category id="plc_planetflow">
 545       <name>PlanetFlow Service Configuration</name>
 546       <description>Planetflow service definitions used in the netflow slice. </description>
 547
 548       <variablelist>
 549         <variable id="host" type="hostname">
 550                 <name>Hostname</name>
 551                 <value>localhost.localdomain</value>
 552                 <description>The fully qualified hostname.</description>
 553         </variable>
 554       </variablelist>
 555     </category>
 556     <category id="plc_monitor">
 557       <name>Monitoring Service</name>
 558       <description>The Monitor service that tracks node availablity and repair.</description>
 559       <variablelist>
 560         <variable id="enabled" type="boolean">
 561           <name>Enabled</name>
 562           <value>false</value>
 563           <description>Enable on this machine.</description>
 564         </variable>
 565         <variable id="host" type="hostname">
 566           <name>Hostname</name>
 567           <value>localhost.localdomain</value>
 568           <description>The fully qualified hostname.</description>
 569         </variable>
 570         <variable id="ip" type="ip">
 571           <name>IP Address</name>
 572           <value></value>
 573           <description>The IP address of the monitor server.</description>
 574         </variable>
 575         <variable id="from_email" type="email">
 576           <name>Monitor Email Address</name>
 577           <value>root+monitor@localhost.localdomain</value>
 578           <description>All messages from Monitor will appear to come from this address.</description>
 579         </variable>
 580         <variable id="cc_email" type="email">
 581           <name>CC Email Address</name>
 582           <value>root+monitor@localhost.localdomain</value>
 583           <description>All messages from Monitor will be copied to this address.</description>
 584         </variable>
 585         <variable id="rt_queue" type="email">
 586           <name>Queue Name in RT for new messages</name>
 587           <value>support</value>
 588           <description>All messages from Monitor will be copied to this address.</description>
 589         </variable>
 590         <variable id="dbpassword" type="password">
 591           <name>Database Password</name>
 592           <value></value>
 593           <description>The password to use when accessing the
 594           database, Monitor user account in the local PLC.</description>
 595         </variable>
 596
 597             <variable id="ssl_key" type="file">
 598                   <name>SSL Private Key</name>
 599                   <value>/etc/planetlab/monitor_ssl.key</value>
 600                   <description>The SSL private key to use for encrypting HTTPS
 601                   traffic.</description>
 602                 </variable>
 603
 604                 <variable id="ssl_crt" type="file">
 605                   <name>SSL Public Certificate</name>
 606                   <value>/etc/planetlab/monitor_ssl.crt</value>
 607                   <description>The corresponding SSL public certificate for
 608                   the HTTP server. By default, this certificate is
 609                   self-signed. You may replace the certificate later with one
 610                   signed by a root CA.</description>
 611                 </variable>
 612
 613                 <variable id="ca_ssl_crt" type="file">
 614                   <name>Root CA SSL Public Certificate</name>
 615                   <value>/etc/planetlab/monitor_ca_ssl.crt</value>
 616                   <description>The certificate of the root CA, if any, that
 617                   signed your server certificate. If your server certificate is
 618                   self-signed, then this file is the same as your server
 619                   certificate.</description>
 620                 </variable>
 621
 622       </variablelist>
 623     </category>
 624     <category id="plc_rt">
 625       <name>RT Configuration</name>
 626       <description>RT</description>
 627       <variablelist>
 628         <variable id="enabled" type="boolean">
 629           <name>Enabled</name>
 630           <value>false</value>
 631           <description>Enable on this machine.</description>
 632         </variable>
 633         <variable id="host" type="hostname">
 634           <name>Hostname</name>
 635           <value>localhost.localdomain</value>
 636           <description>The fully qualified hostname.</description>
 637         </variable>
 638         <variable id="ip" type="ip">
 639           <name>IP Address</name>
 640           <value/>
 641           <description>The IP address of the RT server.</description>
 642         </variable>
 643         <variable id="cc_address" type="email">
 644           <name>CC Email Address</name>
 645           <value>root+cclist@localhost.localdomain</value>
 646           <description>All messages to and from PLCRT will be copied to this address.</description>
 647         </variable>
 648         <variable id="web_user" type="string">
 649           <name>root</name>
 650           <value>root</value>
 651           <description>Username of a privileged user in RT who can create
 652                   tickets for any RT Queue.</description>
 653         </variable>
 654         <variable id="web_password" type="password">
 655           <name>password</name>
 656           <value>password</value>
 657           <description>Password for RT web user.</description>
 658         </variable>
 659         <variable id="dbpassword" type="password">
 660           <name>Database Password</name>
 661           <value></value>
 662           <description>Password to use when accessing the RT database.</description>
 663         </variable>
 664       </variablelist>
 665     </category>
 666   </variables>
 667
 668   <comps>
 669     <!-- deprecated - not used anymore - use .lst files instead -->
 670   </comps>
 671
 672 </configuration>