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
12 <!DOCTYPE configuration PUBLIC "-//PlanetLab Central//DTD PLC configuration//EN" "plc_config.dtd">
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>
23 <variable id="name" type="string">
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>
32 <variable id="shortname" type="string">
35 <description>The short name of this PLC installation. It is
36 mostly used in the web interface when displaying local
37 objects.</description>
40 <variable id="hrn_root" type="string">
41 <name>Root in Hierarchical Naming Space </name>
42 <value>planetlab.test</value>
43 <description> The root of this peer in the hierarchical federation naming space.</description>
46 <variable id="slice_prefix" type="string">
47 <name>Slice Prefix</name>
49 <description>The abbreviated name of this PLC
50 installation. It is used as the prefix for system slices
51 (e.g., pl_conf). Warning: Currently, this variable should
52 not be changed.</description>
55 <variable id="root_user" type="email">
56 <name>Root Account</name>
57 <value>root@localhost.localdomain</value>
58 <description>The name of the initial administrative
59 account. We recommend that this account be used only to create
60 additional accounts associated with real
61 administrators, then disabled.</description>
64 <variable id="root_password" type="password">
65 <name>Root Password</name>
67 <description>The password of the initial administrative
68 account. Also the password of the root account on the Boot
72 <!-- The following are not actually meant to be configurable
73 as variables. The web interface should allow the file to
74 be downloaded, or its contents replaced by a file upload,
75 but the actual <value> shouldn't need to be changed. -->
77 <variable id="root_ssh_key_pub" type="file">
78 <name>Root SSH Public Key</name>
79 <value>/etc/planetlab/root_ssh_key.pub</value>
80 <description>The SSH public key used to access the root
81 account on your nodes.</description>
84 <variable id="root_ssh_key" type="file">
85 <name>Root SSH Private Key</name>
86 <value>/etc/planetlab/root_ssh_key.rsa</value>
87 <description>The SSH private key used to access the root
88 account on your nodes.</description>
91 <variable id="debug_ssh_key_pub" type="file">
92 <name>Debug SSH Public Key</name>
93 <value>/etc/planetlab/debug_ssh_key.pub</value>
94 <description>The SSH public key used to access the root
95 account on your nodes when they are in Debug mode.</description>
98 <variable id="debug_ssh_key" type="file">
99 <name>Debug SSH Private Key</name>
100 <value>/etc/planetlab/debug_ssh_key.rsa</value>
101 <description>The SSH private key used to access the root
102 account on your nodes when they are in Debug mode.</description>
105 <variable id="root_gpg_key_pub" type="file">
106 <name>Root GPG Public Keyring</name>
107 <value>/etc/planetlab/pubring.gpg</value>
108 <description>The GPG public keyring used to sign the Boot
109 Manager and all node packages.</description>
112 <variable id="root_gpg_key" type="file">
113 <name>Root GPG Private Keyring</name>
114 <value>/etc/planetlab/secring.gpg</value>
115 <description>The SSH private key used to access the root
116 account on your nodes.</description>
121 <category id="plc_net">
123 <description>Network environment.</description>
126 <variable id="dns1" type="ip">
127 <name>Primary DNS Server</name>
128 <value>127.0.0.1</value>
129 <description>Primary DNS server address.</description>
132 <variable id="dns2" type="ip">
133 <name>Secondary DNS Server</name>
135 <description>Secondary DNS server address.</description>
140 <category id="plc_dns">
142 <description>MyPLC can provide forward DNS resolution for itself
143 and for its nodes. To enable resolution for MyPLC itself, set
144 the Primary DNS Server address to 127.0.0.1 and provide external
145 IP addresses for the database, API, web, and boot servers
146 below. To enable resolution for nodes, use the external IP
147 address of this machine as the primary DNS server address for
148 each node.</description>
151 <variable id="enabled" type="boolean">
152 <name>Enable DNS</name>
154 <description>Enable the internal DNS server. The server does
155 not provide reverse resolution and is not a production
156 quality or scalable DNS solution. Use the internal DNS
157 server only for small deployments or for
158 testing.</description>
163 <category id="plc_mail">
165 <description>Many maintenance scripts, as well as the API and
166 web site themselves, send e-mail notifications and
167 warnings.</description>
170 <variable id="enabled" type="boolean">
171 <name>Enable Mail</name>
173 <description>Set to false to suppress all e-mail notifications
174 and warnings.</description>
177 <variable id="support_address" type="email">
178 <name>Support Address</name>
179 <value>root+support@localhost.localdomain</value>
180 <description>This address is used for support
181 requests. Support requests may include traffic complaints,
182 security incident reporting, web site malfunctions, and
183 general requests for information. We recommend that the
184 address be aliased to a ticketing system such as Request
185 Tracker.</description>
188 <variable id="boot_address" type="email">
189 <name>Boot Messages Address</name>
190 <value>root+install-msgs@localhost.localdomain</value>
191 <description>The API will notify this address when a problem
192 occurs during node installation or boot.</description>
195 <variable id="mom_list_address" type="email">
196 <name>Mom List Address</name>
197 <value>root+mom@localhost.localdomain</value>
198 <description>This address is used by operations staff
199 to monitor Mom (formerly pl_mom) messages indicating
200 excessive BW or memory usage by a slice. Mom messages sent
201 to slices will be cc'ed to this list so as not to clog
202 the Support Address list.</description>
205 <variable id="slice_address" type="email">
206 <name>Slice Address</name>
207 <value>root+SLICE@localhost.localdomain</value>
208 <description>This address template is used for sending
209 e-mail notifications to slices. SLICE will be replaced with
210 the name of the slice.</description>
215 <category id="plc_db">
216 <name>Database Server</name>
217 <description>Database server definitions.</description>
220 <variable id="enabled" type="boolean">
223 <description>Enable the database server on this
224 machine.</description>
227 <variable id="type" type="string">
229 <value>postgresql</value>
230 <description>The type of database server. Currently, only
231 postgresql is supported.</description>
234 <variable id="host" type="hostname">
235 <name>Hostname</name>
236 <value>localhost.localdomain</value>
237 <description>The fully qualified hostname of the database
238 server.</description>
241 <variable id="ip" type="ip">
242 <name>IP Address</name>
244 <description>The IP address of the database server, if not
245 resolvable.</description>
248 <variable id="port" type="int">
251 <description>The TCP port number through which the database
252 server should be accessed.</description>
255 <variable id="name" type="string">
256 <name>Database Name</name>
257 <value>planetlab5</value>
258 <description>The name of the database to access.</description>
261 <variable id="user" type="string">
262 <name>Database Username</name>
263 <value>pgsqluser</value>
264 <description>The username to use when accessing the
265 database.</description>
268 <variable id="password" type="password">
269 <name>Database Password</name>
271 <description>The password to use when accessing the
272 database. If left blank, one will be
273 generated.</description>
278 <category id="plc_api">
279 <name>API Server</name>
280 <description>API (XML-RPC) server definitions.</description>
283 <variable id="enabled" type="boolean">
286 <description>Enable the API server on this
287 machine.</description>
290 <variable id="debug" type="boolean">
293 <description>Enable verbose API debugging. Do not enable on
294 a production system!</description>
297 <variable id="host" type="hostname">
298 <name>Hostname</name>
299 <value>localhost.localdomain</value>
300 <description>The fully qualified hostname of the API
301 server.</description>
304 <variable id="ip" type="ip">
305 <name>IP Address</name>
307 <description>The IP address of the API server, if not
308 resolvable.</description>
311 <variable id="ipod_subnet" type="ip">
312 <name>IP Subnet</name>
313 <value>127.0.0.1</value>
314 <description>The IP Subnet for all API servers.
315 Used to identify IPoD packet senders.</description>
318 <variable id="ipod_mask" type="ip">
320 <value>255.255.255.255</value>
321 <description>The IP Mask that should be applied to incoming
322 packets to match the IP Subnet for IPoD packets.</description>
325 <variable id="port" type="int">
328 <description>The TCP port number through which the API
329 should be accessed.</description>
332 <variable id="path" type="string">
334 <value>/PLCAPI/</value>
335 <description>The base path of the API URL.</description>
338 <variable id="maintenance_user" type="string">
339 <name>Maintenance User</name>
340 <value>maint@localhost.localdomain</value>
341 <description>The username of the maintenance account. This
342 account is used by local scripts that perform automated
343 tasks, and cannot be used for normal logins.</description>
346 <variable id="maintenance_password" type="password">
347 <name>Maintenance Password</name>
349 <description>The password of the maintenance account. If
350 left blank, one will be generated. We recommend that the
351 password be changed periodically.</description>
354 <variable id="maintenance_sources" type="hostname">
355 <name>Authorized Hosts</name>
357 <description>A space-separated list of IP addresses allowed
358 to access the API through the maintenance account. The value
359 of this variable is set automatically to allow only the API,
360 web, and boot servers, and should not be
361 changed.</description>
364 <!-- The following are not actually meant to be configurable
365 as variables. The web interface should allow the file to
366 be downloaded, or its contents replaced by a file upload,
367 but the actual <value> shouldn't need to be changed. -->
369 <variable id="ssl_key" type="file">
370 <name>SSL Private Key</name>
371 <value>/etc/planetlab/api_ssl.key</value>
372 <description>The SSL private key to use for encrypting HTTPS
373 traffic. If non-existent, one will be
374 generated.</description>
377 <variable id="ssl_crt" type="file">
378 <name>SSL Public Certificate</name>
379 <value>/etc/planetlab/api_ssl.crt</value>
380 <description>The corresponding SSL public certificate. By
381 default, this certificate is self-signed. You may replace
382 the certificate later with one signed by a root
386 <variable id="ca_ssl_crt" type="file">
387 <name>Root CA SSL Public Certificate</name>
388 <value>/etc/planetlab/api_ca_ssl.crt</value>
389 <description>The certificate of the root CA, if any, that
390 signed your server certificate. If your server certificate is
391 self-signed, then this file is the same as your server
392 certificate.</description>
397 <category id="plc_www">
398 <name>Web Server</name>
399 <description>Web server definitions.</description>
402 <variable id="enabled" type="boolean">
405 <description>Enable the web server on this
406 machine.</description>
409 <variable id="debug" type="boolean">
412 <description>Enable debugging output on web pages. Do not
413 enable on a production system!</description>
416 <variable id="host" type="hostname">
417 <name>Hostname</name>
418 <value>localhost.localdomain</value>
419 <description>The fully qualified hostname of the web
420 server.</description>
423 <variable id="ip" type="ip">
424 <name>IP Address</name>
426 <description>The IP address of the web server, if not
427 resolvable.</description>
430 <variable id="port" type="int">
433 <description>The TCP port number through which the
434 unprotected portions of the web site should be
435 accessed.</description>
438 <variable id="ssl_port" type="int">
439 <name>SSL Port</name>
441 <description>The TCP port number through which the protected
442 portions of the web site should be accessed.</description>
445 <!-- The following are not actually meant to be configurable
446 as variables. The web interface should allow the file to
447 be downloaded, or its contents replaced by a file upload,
448 but the actual <value> shouldn't need to be changed. -->
450 <variable id="ssl_key" type="file">
451 <name>SSL Private Key</name>
452 <value>/etc/planetlab/www_ssl.key</value>
453 <description>The SSL private key to use for encrypting HTTPS
454 traffic. If non-existent, one will be
455 generated.</description>
458 <variable id="ssl_crt" type="file">
459 <name>SSL Public Certificate</name>
460 <value>/etc/planetlab/www_ssl.crt</value>
461 <description>The corresponding SSL public certificate for
462 the HTTP server. By default, this certificate is
463 self-signed. You may replace the certificate later with one
464 signed by a root CA.</description>
467 <variable id="ca_ssl_crt" type="file">
468 <name>Root CA SSL Public Certificate</name>
469 <value>/etc/planetlab/www_ca_ssl.crt</value>
470 <description>The certificate of the root CA, if any, that
471 signed your server certificate. If your server certificate is
472 self-signed, then this file is the same as your server
473 certificate.</description>
478 <category id="plc_boot">
479 <name>Boot Server</name>
480 <description>Boot server definitions. Multiple boot servers
481 may be brought up for load balancing, but we recommend that a
482 single DNS round-robin system be implemented so that the
483 following variables are the same across all of
487 <variable id="enabled" type="boolean">
490 <description>Enable the boot server on this
491 machine.</description>
494 <variable id="host" type="hostname">
495 <name>Hostname</name>
496 <value>localhost.localdomain</value>
497 <description>The fully qualified hostname of the boot
498 server.</description>
501 <variable id="ip" type="ip">
502 <name>IP Address</name>
504 <description>The IP address of the boot 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 boot server 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 boot server should be
521 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/boot_ssl.key</value>
532 <description>The SSL private key to use for encrypting HTTPS
533 traffic.</description>
536 <variable id="ssl_crt" type="file">
537 <name>SSL Public Certificate</name>
538 <value>/etc/planetlab/boot_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/boot_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>
557 <category id="plc_planetflow">
558 <name>PlanetFlow Service Configuration</name>
559 <description>Planetflow service definitions used in the netflow slice. </description>
562 <variable id="host" type="hostname">
563 <name>Hostname</name>
564 <value>localhost.localdomain</value>
565 <description>The fully qualified hostname.</description>
569 <category id="plc_monitor">
570 <name>Monitoring Service</name>
571 <description>The Monitor service that tracks node availablity and repair.</description>
573 <variable id="enabled" type="boolean">
576 <description>Enable on this machine.</description>
578 <variable id="host" type="hostname">
579 <name>Hostname</name>
580 <value>localhost.localdomain</value>
581 <description>The fully qualified hostname.</description>
583 <variable id="ip" type="ip">
584 <name>IP Address</name>
586 <description>The IP address of the monitor server.</description>
588 <variable id="email" type="email">
589 <name>Monitor Email Address</name>
590 <value>root+monitor@localhost.localdomain</value>
591 <description>The source address for all out-going messages from Monitor.</description>
593 <variable id="dbpassword" type="password">
594 <name>Database Password</name>
596 <description>The password to use when accessing the
597 database, Monitor user account in the local PLC.</description>
604 <!-- deprecated - not used anymore - use .lst files instead -->