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>
123 <category id="plc_flavour">
124 <name>Flavours</name>
125 <description>Defaults for nodes and slices contents.</description>
128 <variable id="node_arch" type="string">
129 <name>arch for nodes</name>
130 <value>@ARCH@</value>
131 <description>The default 'arch' to use when installing nodes.
132 This is offered mostly for consistency with the rest of the
133 PLC_FLAVOUR category, but does not have much of a practical
134 interest. In any case, you need to have the corresponding
135 bootstrapfs images available for nodes.</description>
138 <variable id="node_fcdistro" type="string">
139 <name>fcdistro for nodes</name>
140 <value>@FCDISTRO@</value>
141 <description>THIS CURRENTLY HAS NO EFFECT.
142 The default 'fcdistro' to use when installing
143 nodes.You need to have the corresponding bootstrapfs images
144 available for nodes. THIS CURRENTLY HAS NO EFFECT.</description>
147 <variable id="node_pldistro" type="string">
148 <name>pldistro for nodes</name>
149 <value>@PLDISTRO@</value>
150 <description>The default 'pldistro' to use when installing
151 nodes. You need to have the corresponding bootstrapfs
152 images available for nodes.</description>
155 <variable id="slice_arch" type="string">
156 <name>arch for slivers</name>
157 <value>@ARCH@</value>
158 <description>The default 'arch' to use for slivers. This is
159 useful if you have heterogeneous nodes (i686 and x86_64),
160 but want slivers to be homogeneous. You need to have the
161 corresponding vserver variant rpm available for
165 <variable id="slice_fcdistro" type="string">
166 <name>fcdistro for slivers</name>
167 <value>@FCDISTRO@</value>
168 <description>The default 'fcdistro' to use for creating
169 slivers. You need to have the corresponding vserver variant
170 rpm available for nodes.</description>
173 <variable id="slice_pldistro" type="string">
174 <name>pldistro for slivers</name>
175 <value>@PLDISTRO@</value>
176 <description>The default 'pldistro' to use for creating
177 slivers. You need to have the corresponding vserver variant
178 rpm available for nodes.</description>
184 <category id="plc_net">
186 <description>Network environment.</description>
189 <variable id="dns1" type="ip">
190 <name>Primary DNS Server</name>
191 <value>127.0.0.1</value>
192 <description>Primary DNS server address.</description>
195 <variable id="dns2" type="ip">
196 <name>Secondary DNS Server</name>
198 <description>Secondary DNS server address.</description>
203 <category id="plc_dns">
205 <description>MyPLC can provide forward DNS resolution for itself
206 and for its nodes. To enable resolution for MyPLC itself, set
207 the Primary DNS Server address to 127.0.0.1 and provide external
208 IP addresses for the database, API, web, and boot servers
209 below. To enable resolution for nodes, use the external IP
210 address of this machine as the primary DNS server address for
211 each node.</description>
214 <variable id="enabled" type="boolean">
215 <name>Enable DNS</name>
217 <description>Enable the internal DNS server. The server does
218 not provide reverse resolution and is not a production
219 quality or scalable DNS solution. Use the internal DNS
220 server only for small deployments or for
221 testing.</description>
226 <category id="plc_hosts">
227 <name>/etc/hosts</name>
228 <description>MyPLC can setup /etc/hosts with the hostnames and
229 IP addresses specified for *_NAME and *_IP, or look up the IP
230 addresses if they are not specified in this configuration.
234 <variable id="enabled" type="boolean">
235 <name>Enable /etc/hosts configuration</name>
237 <description>Let PLC manage /etc/hosts</description>
242 <category id="plc_mail">
244 <description>Many maintenance scripts, as well as the API and
245 web site themselves, send e-mail notifications and
246 warnings.</description>
249 <variable id="enabled" type="boolean">
250 <name>Enable Mail</name>
252 <description>Set to false to suppress all e-mail notifications
253 and warnings.</description>
256 <variable id="support_address" type="email">
257 <name>Support Address</name>
258 <value>root+support@localhost.localdomain</value>
259 <description>This address is used for support
260 requests. Support requests may include traffic complaints,
261 security incident reporting, web site malfunctions, and
262 general requests for information. We recommend that the
263 address be aliased to a ticketing system such as Request
264 Tracker.</description>
267 <variable id="boot_address" type="email">
268 <name>Boot Messages Address</name>
269 <value>root+install-msgs@localhost.localdomain</value>
270 <description>The API will notify this address when a problem
271 occurs during node installation or boot.</description>
274 <variable id="mom_list_address" type="email">
275 <name>Mom List Address</name>
276 <value>root+mom@localhost.localdomain</value>
277 <description>This address is used by operations staff
278 to monitor Mom (formerly pl_mom) messages indicating
279 excessive BW or memory usage by a slice. Mom messages sent
280 to slices will be cc'ed to this list so as not to clog
281 the Support Address list.</description>
284 <variable id="slice_address" type="email">
285 <name>Slice Address</name>
286 <value>root+SLICE@localhost.localdomain</value>
287 <description>This address template is used for sending
288 e-mail notifications to slices. SLICE will be replaced with
289 the name of the slice.</description>
294 <category id="plc_db">
295 <name>Database Server</name>
296 <description>Database server definitions.</description>
299 <variable id="enabled" type="boolean">
302 <description>Enable the database server on this
303 machine.</description>
306 <variable id="type" type="string">
308 <value>postgresql</value>
309 <description>The type of database server. Currently, only
310 postgresql is supported.</description>
313 <variable id="host" type="hostname">
314 <name>Hostname</name>
315 <value>localhost.localdomain</value>
316 <description>The fully qualified hostname of the database
317 server.</description>
320 <variable id="ip" type="ip">
321 <name>IP Address</name>
323 <description>The IP address of the database server, if not
324 resolvable.</description>
327 <variable id="port" type="int">
330 <description>The TCP port number through which the database
331 server should be accessed.</description>
334 <variable id="name" type="string">
335 <name>Database Name</name>
336 <value>planetlab5</value>
337 <description>The name of the database to access.</description>
340 <variable id="user" type="string">
341 <name>Database Username</name>
342 <value>pgsqluser</value>
343 <description>The username to use when accessing the
344 database.</description>
347 <variable id="password" type="password">
348 <name>Database Password</name>
350 <description>The password to use when accessing the
351 database. If left blank, one will be
352 generated.</description>
357 <category id="plc_api">
358 <name>API Server</name>
359 <description>API (XML-RPC) server definitions.</description>
362 <variable id="enabled" type="boolean">
365 <description>Enable the API server on this
366 machine.</description>
369 <variable id="debug" type="boolean">
372 <description>Enable verbose API debugging. Do not enable on
373 a production system!</description>
376 <variable id="host" type="hostname">
377 <name>Hostname</name>
378 <value>localhost.localdomain</value>
379 <description>The fully qualified hostname of the API
380 server.</description>
383 <variable id="ip" type="ip">
384 <name>IP Address</name>
386 <description>The IP address of the API server, if not
387 resolvable.</description>
390 <variable id="ipod_subnet" type="ip">
391 <name>IP Subnet</name>
392 <value>127.0.0.1</value>
393 <description>The IP Subnet for all API servers.
394 Used to identify IPoD packet senders.</description>
397 <variable id="ipod_mask" type="ip">
399 <value>255.255.255.255</value>
400 <description>The IP Mask that should be applied to incoming
401 packets to match the IP Subnet for IPoD packets.</description>
404 <variable id="port" type="int">
407 <description>The TCP port number through which the API
408 should be accessed.</description>
411 <variable id="path" type="string">
413 <value>/PLCAPI/</value>
414 <description>The base path of the API URL.</description>
417 <variable id="maintenance_user" type="string">
418 <name>Maintenance User</name>
419 <value>maint@localhost.localdomain</value>
420 <description>The username of the maintenance account. This
421 account is used by local scripts that perform automated
422 tasks, and cannot be used for normal logins.</description>
425 <variable id="maintenance_password" type="password">
426 <name>Maintenance Password</name>
428 <description>The password of the maintenance account. If
429 left blank, one will be generated. We recommend that the
430 password be changed periodically.</description>
433 <variable id="maintenance_sources" type="hostname">
434 <name>Authorized Hosts</name>
436 <description>A space-separated list of IP addresses allowed
437 to access the API through the maintenance account. The value
438 of this variable is set automatically to allow only the API,
439 web, and boot servers, and should not be
440 changed.</description>
443 <!-- The following are not actually meant to be configurable
444 as variables. The web interface should allow the file to
445 be downloaded, or its contents replaced by a file upload,
446 but the actual <value> shouldn't need to be changed. -->
448 <variable id="ssl_key" type="file">
449 <name>SSL Private Key</name>
450 <value>/etc/planetlab/api_ssl.key</value>
451 <description>The SSL private key to use for encrypting HTTPS
452 traffic. If non-existent, one will be
453 generated.</description>
456 <variable id="ssl_crt" type="file">
457 <name>SSL Public Certificate</name>
458 <value>/etc/planetlab/api_ssl.crt</value>
459 <description>The corresponding SSL public certificate. By
460 default, this certificate is self-signed. You may replace
461 the certificate later with one signed by a root
465 <variable id="ca_ssl_crt" type="file">
466 <name>Root CA SSL Public Certificate</name>
467 <value>/etc/planetlab/api_ca_ssl.crt</value>
468 <description>The certificate of the root CA, if any, that
469 signed your server certificate. If your server certificate is
470 self-signed, then this file is the same as your server
471 certificate.</description>
476 <category id="plc_www">
477 <name>Web Server</name>
478 <description>Web server definitions.</description>
481 <variable id="enabled" type="boolean">
484 <description>Enable the web server on this
485 machine.</description>
488 <variable id="debug" type="boolean">
491 <description>Enable debugging output on web pages. Do not
492 enable on a production system!</description>
495 <variable id="host" type="hostname">
496 <name>Hostname</name>
497 <value>localhost.localdomain</value>
498 <description>The fully qualified hostname of the web
499 server.</description>
502 <variable id="ip" type="ip">
503 <name>IP Address</name>
505 <description>The IP address of the web server, if not
506 resolvable.</description>
509 <variable id="port" type="int">
512 <description>The TCP port number through which the
513 unprotected portions of the web site should be
514 accessed.</description>
517 <variable id="ssl_port" type="int">
518 <name>SSL Port</name>
520 <description>The TCP port number through which the protected
521 portions of the web site should be accessed.</description>
524 <!-- The following are not actually meant to be configurable
525 as variables. The web interface should allow the file to
526 be downloaded, or its contents replaced by a file upload,
527 but the actual <value> shouldn't need to be changed. -->
529 <variable id="ssl_key" type="file">
530 <name>SSL Private Key</name>
531 <value>/etc/planetlab/www_ssl.key</value>
532 <description>The SSL private key to use for encrypting HTTPS
533 traffic. If non-existent, one will be
534 generated.</description>
537 <variable id="ssl_crt" type="file">
538 <name>SSL Public Certificate</name>
539 <value>/etc/planetlab/www_ssl.crt</value>
540 <description>The corresponding SSL public certificate for
541 the HTTP server. By default, this certificate is
542 self-signed. You may replace the certificate later with one
543 signed by a root CA.</description>
546 <variable id="ca_ssl_crt" type="file">
547 <name>Root CA SSL Public Certificate</name>
548 <value>/etc/planetlab/www_ca_ssl.crt</value>
549 <description>The certificate of the root CA, if any, that
550 signed your server certificate. If your server certificate is
551 self-signed, then this file is the same as your server
552 certificate.</description>
557 <category id="plc_boot">
558 <name>Boot Server</name>
559 <description>Boot server definitions. Multiple boot servers
560 may be brought up for load balancing, but we recommend that a
561 single DNS round-robin system be implemented so that the
562 following variables are the same across all of
566 <variable id="enabled" type="boolean">
569 <description>Enable the boot server on this
570 machine.</description>
573 <variable id="host" type="hostname">
574 <name>Hostname</name>
575 <value>localhost.localdomain</value>
576 <description>The fully qualified hostname of the boot
577 server.</description>
580 <variable id="ip" type="ip">
581 <name>IP Address</name>
583 <description>The IP address of the boot server, if not
584 resolvable.</description>
587 <variable id="port" type="int">
590 <description>The TCP port number through which the
591 unprotected portions of the boot server should be
592 accessed.</description>
595 <variable id="ssl_port" type="int">
596 <name>SSL Port</name>
598 <description>The TCP port number through which the protected
599 portions of the boot server should be
600 accessed.</description>
603 <!-- The following are not actually meant to be configurable
604 as variables. The web interface should allow the file to
605 be downloaded, or its contents replaced by a file upload,
606 but the actual <value> shouldn't need to be changed. -->
608 <variable id="ssl_key" type="file">
609 <name>SSL Private Key</name>
610 <value>/etc/planetlab/boot_ssl.key</value>
611 <description>The SSL private key to use for encrypting HTTPS
612 traffic.</description>
615 <variable id="ssl_crt" type="file">
616 <name>SSL Public Certificate</name>
617 <value>/etc/planetlab/boot_ssl.crt</value>
618 <description>The corresponding SSL public certificate for
619 the HTTP server. By default, this certificate is
620 self-signed. You may replace the certificate later with one
621 signed by a root CA.</description>
624 <variable id="ca_ssl_crt" type="file">
625 <name>Root CA SSL Public Certificate</name>
626 <value>/etc/planetlab/boot_ca_ssl.crt</value>
627 <description>The certificate of the root CA, if any, that
628 signed your server certificate. If your server certificate is
629 self-signed, then this file is the same as your server
630 certificate.</description>
635 <category id="plc_ratelimit">
636 <name>Planetlab Ratelimit Settings</name>
637 <description>Planetlab Ratelimit Settings</description>
639 <variable id="enabled" type="bolean">
640 <name>Enable Ratelimit</name>
642 <description>Enable Ratelimit for sites</description>
647 <category id="plc_omf">
648 <name>Planetlab - OMF Integration</name>
649 <description>Planetlab - OMF integration</description>
651 <variable id="enabled" type="boolean">
652 <name>OMF integration</name>
654 <description>Enable OMF integration.</description>
657 <!-- xmpp server configuration -->
658 <variable id="xmpp_server" type="string">
659 <name>XMPP server</name>
660 <value>localhost.localdomain</value>
661 <description>The fully qualified hostname of the XMPP server.</description>
664 <variable id="xmpp_user" type="string">
665 <name>XMPP username</name>
667 <description>XMPP username (which has admin rights).</description>
670 <variable id="xmpp_password" type="string">
671 <name>XMPP password</name>
673 <description>The password of the XMPP user.</description>
676 <!-- omf-slicemgr -->
677 <variable id="slicemgr_url" type="string">
678 <name>OMF Slicemgr URL</name>
679 <value>http://localhost.localdomain:5053</value>
680 <description>.</description>
686 <category id="plc_reservation">
687 <name> Reservable Nodes</name>
688 <description> Settings related to reservable nodes </description>
691 <variable id="granularity" type="int">
692 <name>Lease granularity</name>
694 <description>The smallest timeslot that can be allocated to
695 a node. All leases will be rounded to this granularity, so
696 e.g. if you set 3600 all leases will start and stop at round
702 <category id="plc_planetflow">
703 <name>PlanetFlow Service Configuration</name>
704 <description>Planetflow service definitions used in the netflow slice. </description>
707 <variable id="host" type="hostname">
708 <name>Hostname</name>
709 <value>localhost.localdomain</value>
710 <description>The fully qualified hostname.</description>
715 <category id="plc_monitor">
716 <name>Monitoring Service</name>
717 <description>The Monitor service that tracks node availablity and repair.</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 monitor server.</description>
734 <variable id="from_email" type="email">
735 <name>Monitor Email Address</name>
736 <value>root+monitor@localhost.localdomain</value>
737 <description>All messages from Monitor will appear to come from this address.</description>
739 <variable id="cc_email" type="email">
740 <name>CC Email Address</name>
741 <value>root+monitor@localhost.localdomain</value>
742 <description>All messages from Monitor will be copied to this address.</description>
744 <variable id="rt_queue" type="email">
745 <name>Queue Name in RT for new messages</name>
746 <value>support</value>
747 <description>All messages from Monitor will be copied to this address.</description>
749 <variable id="dbhost" type="hostname">
750 <name>Database Hostname</name>
751 <value>localhost</value>
752 <description>The hostname for the monitor database.</description>
754 <variable id="dbuser" type="string">
755 <name>Database User</name>
756 <value>monitoruser</value>
757 <description>The username for connecting to the monitor database.</description>
759 <variable id="dbname" type="string">
760 <name>Database Name</name>
761 <value>monitor</value>
762 <description>Name of monitor database.</description>
764 <variable id="dbpassword" type="password">
765 <name>Database Password</name>
767 <description>The password to use when accessing the
768 database, Monitor user account in the local PLC.</description>
771 <variable id="ssl_key" type="file">
772 <name>SSL Private Key</name>
773 <value>/etc/planetlab/monitor_ssl.key</value>
774 <description>The SSL private key to use for encrypting HTTPS
775 traffic.</description>
778 <variable id="ssl_crt" type="file">
779 <name>SSL Public Certificate</name>
780 <value>/etc/planetlab/monitor_ssl.crt</value>
781 <description>The corresponding SSL public certificate for
782 the HTTP server. By default, this certificate is
783 self-signed. You may replace the certificate later with one
784 signed by a root CA.</description>
787 <variable id="ca_ssl_crt" type="file">
788 <name>Root CA SSL Public Certificate</name>
789 <value>/etc/planetlab/monitor_ca_ssl.crt</value>
790 <description>The certificate of the root CA, if any, that
791 signed your server certificate. If your server certificate is
792 self-signed, then this file is the same as your server
793 certificate.</description>
798 <category id="plc_rt">
799 <name>RT Configuration</name>
800 <description>RT</description>
802 <variable id="enabled" type="boolean">
805 <description>Enable on this machine.</description>
807 <variable id="host" type="hostname">
808 <name>Hostname</name>
809 <value>localhost.localdomain</value>
810 <description>The fully qualified hostname.</description>
812 <variable id="ip" type="ip">
813 <name>IP Address</name>
815 <description>The IP address of the RT server.</description>
817 <variable id="cc_address" type="email">
818 <name>CC Email Address</name>
819 <value>root+cclist@localhost.localdomain</value>
820 <description>All messages to and from PLCRT will be copied to this address.</description>
822 <variable id="web_user" type="string">
825 <description>Username of a privileged user in RT who can create
826 tickets for any RT Queue.</description>
828 <variable id="web_password" type="password">
829 <name>password</name>
830 <value>password</value>
831 <description>Password for RT web user.</description>
833 <variable id="dbpassword" type="password">
834 <name>Database Password</name>
836 <description>Password to use when accessing the RT database.</description>
840 <category id="myslice">
842 <description>MySlice configuration parameters</description>
844 <variable id="comon_url" type="string">
847 <description>The address of the CoMon url that provides information for this PLC's nodes (if not the default http://comon.cs.princeton.edu/)</description>
849 <variable id="comon_available" type="boolean">
852 <description>True, if comon data are available for this PLC's nodes</description>
854 <variable id="tophat_available" type="boolean">
857 <description>True, if tophat data are available for this PLC's nodes</description>
864 <!-- deprecated - not used anymore - use .lst files instead -->