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