1 <?xml version="1.0" encoding="utf-8"?>
4 Default PLC configuration file
6 Mark Huang <mlhuang@cs.princeton.edu>
7 Copyright (C) 2006 The Trustees of Princeton University
13 <!DOCTYPE configuration PUBLIC "-//PlanetLab Central//DTD PLC configuration//EN" "plc_config.dtd">
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>
24 <variable id="name" type="string">
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>
33 <variable id="shortname" type="string">
36 <description>The short name of this PLC installation. It is
37 mostly used in the web interface when displaying local
38 objects.</description>
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>
47 <variable id="slice_prefix" type="string">
48 <name>Slice Prefix</name>
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>
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>
65 <variable id="root_password" type="password">
66 <name>Root Password</name>
68 <description>The password of the initial administrative
69 account. Also the password of the root account on the Boot
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. -->
78 <variable id="root_ssh_key_pub" type="file">
79 <name>Root SSH Public Key</name>
80 <value>/etc/planetlab/root_ssh_key.pub</value>
81 <description>The SSH public key used to access the root
82 account on your nodes.</description>
85 <variable id="root_ssh_key" type="file">
86 <name>Root SSH Private Key</name>
87 <value>/etc/planetlab/root_ssh_key.rsa</value>
88 <description>The SSH private key used to access the root
89 account on your nodes.</description>
92 <variable id="debug_ssh_key_pub" type="file">
93 <name>Debug SSH Public Key</name>
94 <value>/etc/planetlab/debug_ssh_key.pub</value>
95 <description>The SSH public key used to access the root
96 account on your nodes when they are in Debug mode.</description>
99 <variable id="debug_ssh_key" type="file">
100 <name>Debug SSH Private Key</name>
101 <value>/etc/planetlab/debug_ssh_key.rsa</value>
102 <description>The SSH private key used to access the root
103 account on your nodes when they are in Debug mode.</description>
106 <variable id="root_gpg_key_pub" type="file">
107 <name>Root GPG Public Keyring</name>
108 <value>/etc/planetlab/pubring.gpg</value>
109 <description>The GPG public keyring used to sign the Boot
110 Manager and all node packages.</description>
113 <variable id="root_gpg_key" type="file">
114 <name>Root GPG Private Keyring</name>
115 <value>/etc/planetlab/secring.gpg</value>
116 <description>The SSH private key used to access the root
117 account on your nodes.</description>
122 <category id="plc_flavour">
123 <name>Flavours</name>
124 <description>Defaults for nodes and slices contents.</description>
127 <variable id="node_arch" type="string">
128 <name>arch for nodes</name>
129 <value>@ARCH@</value>
130 <description>The default 'arch' to use when installing nodes.
131 This is offered mostly for consistency with the rest of the
132 PLC_FLAVOUR category, but does not have much of a practical
133 interest. In any case, you need to have the corresponding
134 bootstrapfs images available for nodes.</description>
137 <variable id="node_fcdistro" type="string">
138 <name>fcdistro for nodes</name>
139 <value>@FCDISTRO@</value>
140 <description>THIS CURRENTLY HAS NO EFFECT.
141 The default 'fcdistro' to use when installing
142 nodes.You need to have the corresponding bootstrapfs images
143 available for nodes. THIS CURRENTLY HAS NO EFFECT.</description>
146 <variable id="node_pldistro" type="string">
147 <name>pldistro for nodes</name>
148 <value>@PLDISTRO@</value>
149 <description>The default 'pldistro' to use when installing
150 nodes. You need to have the corresponding bootstrapfs
151 images available for nodes.</description>
154 <variable id="slice_arch" type="string">
155 <name>arch for slivers</name>
156 <value>@ARCH@</value>
157 <description>The default 'arch' to use for slivers. This is
158 useful if you have heterogeneous nodes (i686 and x86_64),
159 but want slivers to be homogeneous. You need to have the
160 corresponding vserver variant rpm available for
164 <variable id="slice_fcdistro" type="string">
165 <name>fcdistro for slivers</name>
166 <value>@FCDISTRO@</value>
167 <description>The default 'fcdistro' to use for creating
168 slivers. You need to have the corresponding vserver variant
169 rpm available for nodes.</description>
172 <variable id="slice_pldistro" type="string">
173 <name>pldistro for slivers</name>
174 <value>@PLDISTRO@</value>
175 <description>The default 'pldistro' to use for creating
176 slivers. You need to have the corresponding vserver variant
177 rpm available for nodes.</description>
183 <category id="plc_net">
185 <description>Network environment.</description>
188 <variable id="dns1" type="ip">
189 <name>Primary DNS Server</name>
190 <value>127.0.0.1</value>
191 <description>Primary DNS server address.</description>
194 <variable id="dns2" type="ip">
195 <name>Secondary DNS Server</name>
197 <description>Secondary DNS server address.</description>
202 <category id="plc_dns">
204 <description>MyPLC can provide forward DNS resolution for itself
205 and for its nodes. To enable resolution for MyPLC itself, set
206 the Primary DNS Server address to 127.0.0.1 and provide external
207 IP addresses for the database, API, web, and boot servers
208 below. To enable resolution for nodes, use the external IP
209 address of this machine as the primary DNS server address for
210 each node.</description>
213 <variable id="enabled" type="boolean">
214 <name>Enable DNS</name>
216 <description>Enable the internal DNS server. The server does
217 not provide reverse resolution and is not a production
218 quality or scalable DNS solution. Use the internal DNS
219 server only for small deployments or for
220 testing.</description>
225 <category id="plc_hosts">
226 <name>/etc/hosts</name>
227 <description>MyPLC can setup /etc/hosts with the hostnames and
228 IP addresses specified for *_NAME and *_IP, or look up the IP
229 addresses if they are not specified in this configuration.
233 <variable id="enabled" type="boolean">
234 <name>Enable /etc/hosts configuration</name>
236 <description>Let PLC manage /etc/hosts</description>
241 <category id="plc_mail">
243 <description>Many maintenance scripts, as well as the API and
244 web site themselves, send e-mail notifications and
245 warnings.</description>
248 <variable id="enabled" type="boolean">
249 <name>Enable Mail</name>
251 <description>Set to false to suppress all e-mail notifications
252 and warnings.</description>
255 <variable id="support_address" type="email">
256 <name>Support Address</name>
257 <value>root+support@localhost.localdomain</value>
258 <description>This address is used for support
259 requests. Support requests may include traffic complaints,
260 security incident reporting, web site malfunctions, and
261 general requests for information. We recommend that the
262 address be aliased to a ticketing system such as Request
263 Tracker.</description>
266 <variable id="boot_address" type="email">
267 <name>Boot Messages Address</name>
268 <value>root+install-msgs@localhost.localdomain</value>
269 <description>The API will notify this address when a problem
270 occurs during node installation or boot.</description>
273 <variable id="mom_list_address" type="email">
274 <name>Mom List Address</name>
275 <value>root+mom@localhost.localdomain</value>
276 <description>This address is used by operations staff
277 to monitor Mom (formerly pl_mom) messages indicating
278 excessive BW or memory usage by a slice. Mom messages sent
279 to slices will be cc'ed to this list so as not to clog
280 the Support Address list.</description>
283 <variable id="slice_address" type="email">
284 <name>Slice Address</name>
285 <value>root+SLICE@localhost.localdomain</value>
286 <description>This address template is used for sending
287 e-mail notifications to slices. SLICE will be replaced with
288 the name of the slice.</description>
293 <category id="plc_db">
294 <name>Database Server</name>
295 <description>Database server definitions.</description>
298 <variable id="enabled" type="boolean">
301 <description>Enable the database server on this
302 machine.</description>
305 <variable id="type" type="string">
307 <value>postgresql</value>
308 <description>The type of database server. Currently, only
309 postgresql is supported.</description>
312 <variable id="host" type="hostname">
313 <name>Hostname</name>
314 <value>localhost.localdomain</value>
315 <description>The fully qualified hostname of the database
316 server.</description>
319 <variable id="ip" type="ip">
320 <name>IP Address</name>
322 <description>The IP address of the database server, if not
323 resolvable.</description>
326 <variable id="port" type="int">
329 <description>The TCP port number through which the database
330 server should be accessed.</description>
333 <variable id="name" type="string">
334 <name>Database Name</name>
335 <value>planetlab5</value>
336 <description>The name of the database to access.</description>
339 <variable id="user" type="string">
340 <name>Database Username</name>
341 <value>pgsqluser</value>
342 <description>The username to use when accessing the
343 database.</description>
346 <variable id="password" type="password">
347 <name>Database Password</name>
349 <description>The password to use when accessing the
350 database. If left blank, one will be
351 generated.</description>
356 <category id="plc_api">
357 <name>API Server</name>
358 <description>API (XML-RPC) server definitions.</description>
361 <variable id="enabled" type="boolean">
364 <description>Enable the API server on this
365 machine.</description>
368 <variable id="debug" type="boolean">
371 <description>Enable verbose API debugging. Do not enable on
372 a production system!</description>
375 <variable id="host" type="hostname">
376 <name>Hostname</name>
377 <value>localhost.localdomain</value>
378 <description>The fully qualified hostname of the API
379 server.</description>
382 <variable id="ip" type="ip">
383 <name>IP Address</name>
385 <description>The IP address of the API server, if not
386 resolvable.</description>
389 <variable id="ipod_subnet" type="ip">
390 <name>IP Subnet</name>
391 <value>127.0.0.1</value>
392 <description>The IP Subnet for all API servers.
393 Used to identify IPoD packet senders.</description>
396 <variable id="ipod_mask" type="ip">
398 <value>255.255.255.255</value>
399 <description>The IP Mask that should be applied to incoming
400 packets to match the IP Subnet for IPoD packets.</description>
403 <variable id="port" type="int">
406 <description>The TCP port number through which the API
407 should be accessed.</description>
410 <variable id="path" type="string">
412 <value>/PLCAPI/</value>
413 <description>The base path of the API URL.</description>
416 <variable id="maintenance_user" type="string">
417 <name>Maintenance User</name>
418 <value>maint@localhost.localdomain</value>
419 <description>The username of the maintenance account. This
420 account is used by local scripts that perform automated
421 tasks, and cannot be used for normal logins.</description>
424 <variable id="maintenance_password" type="password">
425 <name>Maintenance Password</name>
427 <description>The password of the maintenance account. If
428 left blank, one will be generated. We recommend that the
429 password be changed periodically.</description>
432 <variable id="maintenance_sources" type="hostname">
433 <name>Authorized Hosts</name>
435 <description>A space-separated list of IP addresses allowed
436 to access the API through the maintenance account. The value
437 of this variable is set automatically to allow only the API,
438 web, and boot servers, and should not be
439 changed.</description>
442 <!-- The following are not actually meant to be configurable
443 as variables. The web interface should allow the file to
444 be downloaded, or its contents replaced by a file upload,
445 but the actual <value> shouldn't need to be changed. -->
447 <variable id="ssl_key" type="file">
448 <name>SSL Private Key</name>
449 <value>/etc/planetlab/api_ssl.key</value>
450 <description>The SSL private key to use for encrypting HTTPS
451 traffic. If non-existent, one will be
452 generated.</description>
455 <variable id="ssl_crt" type="file">
456 <name>SSL Public Certificate</name>
457 <value>/etc/planetlab/api_ssl.crt</value>
458 <description>The corresponding SSL public certificate. By
459 default, this certificate is self-signed. You may replace
460 the certificate later with one signed by a root
464 <variable id="ca_ssl_crt" type="file">
465 <name>Root CA SSL Public Certificate</name>
466 <value>/etc/planetlab/api_ca_ssl.crt</value>
467 <description>The certificate of the root CA, if any, that
468 signed your server certificate. If your server certificate is
469 self-signed, then this file is the same as your server
470 certificate.</description>
475 <category id="plc_www">
476 <name>Web Server</name>
477 <description>Web server definitions.</description>
480 <variable id="enabled" type="boolean">
483 <description>Enable the web server on this
484 machine.</description>
487 <variable id="debug" type="boolean">
490 <description>Enable debugging output on web pages. Do not
491 enable on a production system!</description>
494 <variable id="host" type="hostname">
495 <name>Hostname</name>
496 <value>localhost.localdomain</value>
497 <description>The fully qualified hostname of the web
498 server.</description>
501 <variable id="ip" type="ip">
502 <name>IP Address</name>
504 <description>The IP address of the web server, if not
505 resolvable.</description>
508 <variable id="port" type="int">
511 <description>The TCP port number through which the
512 unprotected portions of the web site should be
513 accessed.</description>
516 <variable id="ssl_port" type="int">
517 <name>SSL Port</name>
519 <description>The TCP port number through which the protected
520 portions of the web site should be accessed.</description>
523 <!-- The following are not actually meant to be configurable
524 as variables. The web interface should allow the file to
525 be downloaded, or its contents replaced by a file upload,
526 but the actual <value> shouldn't need to be changed. -->
528 <variable id="ssl_key" type="file">
529 <name>SSL Private Key</name>
530 <value>/etc/planetlab/www_ssl.key</value>
531 <description>The SSL private key to use for encrypting HTTPS
532 traffic. If non-existent, one will be
533 generated.</description>
536 <variable id="ssl_crt" type="file">
537 <name>SSL Public Certificate</name>
538 <value>/etc/planetlab/www_ssl.crt</value>
539 <description>The corresponding SSL public certificate for
540 the HTTP server. By default, this certificate is
541 self-signed. You may replace the certificate later with one
542 signed by a root CA.</description>
545 <variable id="ca_ssl_crt" type="file">
546 <name>Root CA SSL Public Certificate</name>
547 <value>/etc/planetlab/www_ca_ssl.crt</value>
548 <description>The certificate of the root CA, if any, that
549 signed your server certificate. If your server certificate is
550 self-signed, then this file is the same as your server
551 certificate.</description>
556 <category id="plc_boot">
557 <name>Boot Server</name>
558 <description>Boot server definitions. Multiple boot servers
559 may be brought up for load balancing, but we recommend that a
560 single DNS round-robin system be implemented so that the
561 following variables are the same across all of
565 <variable id="enabled" type="boolean">
568 <description>Enable the boot server on this
569 machine.</description>
572 <variable id="host" type="hostname">
573 <name>Hostname</name>
574 <value>localhost.localdomain</value>
575 <description>The fully qualified hostname of the boot
576 server.</description>
579 <variable id="ip" type="ip">
580 <name>IP Address</name>
582 <description>The IP address of the boot server, if not
583 resolvable.</description>
586 <variable id="port" type="int">
589 <description>The TCP port number through which the
590 unprotected portions of the boot server should be
591 accessed.</description>
594 <variable id="ssl_port" type="int">
595 <name>SSL Port</name>
597 <description>The TCP port number through which the protected
598 portions of the boot server should be
599 accessed.</description>
602 <!-- The following are not actually meant to be configurable
603 as variables. The web interface should allow the file to
604 be downloaded, or its contents replaced by a file upload,
605 but the actual <value> shouldn't need to be changed. -->
607 <variable id="ssl_key" type="file">
608 <name>SSL Private Key</name>
609 <value>/etc/planetlab/boot_ssl.key</value>
610 <description>The SSL private key to use for encrypting HTTPS
611 traffic.</description>
614 <variable id="ssl_crt" type="file">
615 <name>SSL Public Certificate</name>
616 <value>/etc/planetlab/boot_ssl.crt</value>
617 <description>The corresponding SSL public certificate for
618 the HTTP server. By default, this certificate is
619 self-signed. You may replace the certificate later with one
620 signed by a root CA.</description>
623 <variable id="ca_ssl_crt" type="file">
624 <name>Root CA SSL Public Certificate</name>
625 <value>/etc/planetlab/boot_ca_ssl.crt</value>
626 <description>The certificate of the root CA, if any, that
627 signed your server certificate. If your server certificate is
628 self-signed, then this file is the same as your server
629 certificate.</description>
635 <category id="plc_planetflow">
636 <name>PlanetFlow Service Configuration</name>
637 <description>Planetflow service definitions used in the netflow slice. </description>
640 <variable id="host" type="hostname">
641 <name>Hostname</name>
642 <value>localhost.localdomain</value>
643 <description>The fully qualified hostname.</description>
647 <category id="plc_monitor">
648 <name>Monitoring Service</name>
649 <description>The Monitor service that tracks node availablity and repair.</description>
651 <variable id="enabled" type="boolean">
654 <description>Enable on this machine.</description>
656 <variable id="host" type="hostname">
657 <name>Hostname</name>
658 <value>localhost.localdomain</value>
659 <description>The fully qualified hostname.</description>
661 <variable id="ip" type="ip">
662 <name>IP Address</name>
664 <description>The IP address of the monitor server.</description>
666 <variable id="from_email" type="email">
667 <name>Monitor Email Address</name>
668 <value>root+monitor@localhost.localdomain</value>
669 <description>All messages from Monitor will appear to come from this address.</description>
671 <variable id="cc_email" type="email">
672 <name>CC Email Address</name>
673 <value>root+monitor@localhost.localdomain</value>
674 <description>All messages from Monitor will be copied to this address.</description>
676 <variable id="rt_queue" type="email">
677 <name>Queue Name in RT for new messages</name>
678 <value>support</value>
679 <description>All messages from Monitor will be copied to this address.</description>
681 <variable id="dbpassword" type="password">
682 <name>Database Password</name>
684 <description>The password to use when accessing the
685 database, Monitor user account in the local PLC.</description>
688 <variable id="ssl_key" type="file">
689 <name>SSL Private Key</name>
690 <value>/etc/planetlab/monitor_ssl.key</value>
691 <description>The SSL private key to use for encrypting HTTPS
692 traffic.</description>
695 <variable id="ssl_crt" type="file">
696 <name>SSL Public Certificate</name>
697 <value>/etc/planetlab/monitor_ssl.crt</value>
698 <description>The corresponding SSL public certificate for
699 the HTTP server. By default, this certificate is
700 self-signed. You may replace the certificate later with one
701 signed by a root CA.</description>
704 <variable id="ca_ssl_crt" type="file">
705 <name>Root CA SSL Public Certificate</name>
706 <value>/etc/planetlab/monitor_ca_ssl.crt</value>
707 <description>The certificate of the root CA, if any, that
708 signed your server certificate. If your server certificate is
709 self-signed, then this file is the same as your server
710 certificate.</description>
715 <category id="plc_rt">
716 <name>RT Configuration</name>
717 <description>RT</description>
719 <variable id="enabled" type="boolean">
722 <description>Enable on this machine.</description>
724 <variable id="host" type="hostname">
725 <name>Hostname</name>
726 <value>localhost.localdomain</value>
727 <description>The fully qualified hostname.</description>
729 <variable id="ip" type="ip">
730 <name>IP Address</name>
732 <description>The IP address of the RT server.</description>
734 <variable id="cc_address" type="email">
735 <name>CC Email Address</name>
736 <value>root+cclist@localhost.localdomain</value>
737 <description>All messages to and from PLCRT will be copied to this address.</description>
739 <variable id="web_user" type="string">
742 <description>Username of a privileged user in RT who can create
743 tickets for any RT Queue.</description>
745 <variable id="web_password" type="password">
746 <name>password</name>
747 <value>password</value>
748 <description>Password for RT web user.</description>
750 <variable id="dbpassword" type="password">
751 <name>Database Password</name>
753 <description>Password to use when accessing the RT database.</description>
760 <!-- deprecated - not used anymore - use .lst files instead -->